O que é Argo API?

A API Argo permite a utilização de serviços de alteração, listagem, recuperação e inserção de dados como por exemplo solicitações, centros de custo, faturamento, usuários, estruturas de aprovação, informações de adiantamento/prestações de contas, etc. Além de permitir a execução de ações como, pagamento de adiantamento e/ou prestação de contas, criações de requisições (OS), aprovações de solicitações etc.

Quem pode usar?

Agências de viagens ou corporações que tenham acesso de “Admin” a aplicação Argo e desejam gerenciar seus dados e informações de forma prática, segura e automatizada.

Resumo geral – Argo API

Essa documentação tem como objetivo orientar os desenvolvedores sobre como integrar com a Argo API, representando as funcionalidades e os métodos a serem utilizados com exemplos, facilitando a compreensão e a utilização dos serviços.

Conhecimentos intermediários em linguagem de programação Web (HTTP/HTTPS) e manipulação de arquivos Web, são suficientes para integração junto a solução ARGO API.

Nesta documentação é possível encontrar as indicações e principais operações disponíveis na Argo API.

Características da API

A API Argo está relacionada aos produtos disponibilizados pela Argo Solutions (Travel e Expense), desenvolvida em RestFul (padrão de tecnologia utilizada no mercado), sendo possível integrar-se utilizando as mais variáveis linguagens de programação:

  • Net
  • Java
  • PHP
  • Ruby
  • Python

Arquitetura

A integração é realizada através de serviços disponibilizados como Web Services, sendo as operações e transações realizadas através dos métodos GET, POST, PUT, DELETE ou PATCH.

GET Utilizado para consulta de registros já existentes na aplicação: Exemplo: Consultar solicitações (OS´s – Ordem de serviço).

POST Utilizado para submeter uma entidade a um recurso específico. Exemplo: Inserção de usuários.

PUT Utilizado para atualização de um recurso específico já existente: Exemplo: Atualização dos dados cadastrais de um usuário.

DELETE Utilizado para deletar um recurso já existente: Exemplo: Finalizar uma estrutura de aprovação.

PATCH Utilizado para atualização em lote de recursos já existentes. Exemplo: Atualização de Centros de Custo.

Ferramentas para integração

O Postman é um API Rest Client que facilita aos desenvolvedores criar, compartilhar, testar e documentar APIs. Isso é feito permitindo aos usuários criar e salvar solicitações HTTPs simples e complexas, bem como ler suas respostas.

Entendendo a aplicação

Para que seja possível utilizar os métodos e recursos disponíveis em nossa API, é importante o entendimento sobre os conceitos da aplicação, no link abaixo é possível encontrar as principais funcionalidades e regras de negócio da Argo:
Argo Wiki

Resumo dos recursos e operações

Para facilitar o entendimento da aplicação, temos abaixo um glossário com os principais termos relacionados aos produtos Travel e Expense:

Serviço Descrição
ConfigsAccountingAccount Gerenciamento de contas contábeis.
ConfigsApprovals Cadastro/atualização das estruturas de aprovação. Saiba mais
ConfigsBudgets Cadastro/atualização dos orçamentos
ConfigsCities Recupera a lista de cidades cadastradas na base de dados
ConfigsClients Cadastro/atualização dos clientes. Saiba mais
ConfigsCommunities Cadastro/atualização das comunidades
ConfigsCompanies Cadastro/atualização das empresas. Saiba mais
ConfigsCostCenters Cadastro/atualização dos Centros de Custo da corporação
ConfigsCreditCards Recupera a lista dos cartões cadastrados
ConfigsExpenses Cadastro/atualização das despesas
ConfigsFormsPayments Cadastro/atualização das formas de pagamento utilizadas pela corporação
ConfigsHotels Cadastro/atualização do diretório de hotéis das agências/corporações
ConfigsJustifications Cadastro/atualização das justificativas de escolha
ConfigsLevels Recupera a lista dos níveis dos usuários
ConfigsManagementFields Cadastro/atualização dos campos gerenciais
ConfigsProjects Cadastro/atualização dos projetos da corporação
ConfigsReasonsTravel Cadastro/atualização dos “motivos de viagem” utilizados no cliente
ConfigsUsers Cadastro/atualização dos usuários da corporação
ConfigsUsersProfile Cadastro/atualização do perfil dos usuários da corporação
ExpenseAdvancePayments Lista as solicitações que contenham adiantamento
ExpenseBlockedRequests Lista as solicitações bloqueadas e as pendentes para bloqueio
ExpensePayments Permite pagar solicitações de adiantamento/prestações de contas
ExpenseRefunds Lista as solicitações que contenham prestações de contas/reembolso
ExpenseTypesPayments Lista as formas de pagamento cadastradas para adiantamento/reembolso/devolução
PriceSummary Lista o resumo de valores dos produtos dos trechos de uma solicitação
Requests Recupera o resumo das solicitações
RequestsAgents Recupera os dados do atendente/consultor da solicitação
RequestsAllocations Recupera os dados da alocação de débito da solicitação
RequestsApprovals Recupera os dados do aprovador da solicitação (GET) além de permitir aprovar/reprovar uma solicitação (PUT)
RequestsFees Recupera os dados do Fee da solicitação
RequestsFlightsQuotations Recupera os dados da cotação érea da solicitação
RequestsFlightsRequesteds Recupera os dados da emissão aérea da solicitação
RequestsHotelsQuotations Recupera os dados da cotação de hospedagem da solicitação
RequestsHotelsRequesteds Recupera os dados da emissão de hospedagem da solicitação
RequestsManagementFields Recupera os campos gerenciais da solicitação
RequestsReasonsTravel Recupera o motivo de viagem inserido na solicitação
RequestsRentalsQuotations Recupera os dados da cotação de locação da solicitação
RequestsRentalsRequesteds Recupera os dados da emissão da locação da solicitação
RequestsRequesters Recupera os dados do solicitante da solicitação
RequestsRoadsQuotations Recupera os dados da cotação do rodoviário da solicitação
RequestsRoadsRequesteds Recupera os dados da emissão do rodoviário da solicitação
RequestsServicesQuotations Recupera os dados da cotação do serviço da solicitação
RequestsServicesRequests Recupera os dados da emissão do serviço da solicitação
RequestsTravelers Recupera os dados do viajante da solicitação

Ocorrências

A seguir temos a lista dos principais códigos e descrições que podem ser apresentadas no retorno dos serviços disponibilizados, facilitando o entendimento e possíveis ajustes para o correto funcionamento da requisição.

Código Erro Descrição
200 OK Sucesso.
400 Bad Request A requisição possui parâmetro(s) inválido(s).
401 Unauthorized O token de acesso não foi informado ou não possui acesso as APIs.
404 Not Found O recurso informado no request não foi encontrado.
413 Request is to Large A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso.
422 Unprocessable Entity A requisição possui erros de negócio.
429 Too Many Requests O consumidor estourou o limite de requisições por tempo.
500 Internal Server Error Erro não esperado, algo está quebrado na API.

Primeiros passos para a utilização da API Argo

1. Crie a sua conta

Acesse o portal e crie a sua conta.

2. Crie sua app

Após criar a sua conta, crie sua app:

crie sua app
  • O campo "nome" deve representar o licenciado que utilizará a APP.
    • Caso o licenciado seja a "Agência 1", o campo deverá ser preenchido como "AGENCIA1-HML"
    • Caso a APP seja de acesso exclusivo de uma corporação, o campo deverá ser preenchido como "AGENCIA1-NOME-DA-CORPORACAO-HML"
  • O campo "descrição" pode ser preenchido a critério do criador da APP.
  • Para preencher o campo "Link para a sua APP" utilize "https://api-hml.useargo.com/argo/v2/".
Observação: A APP criada diretamente pelo usuário é automaticamente direcionada para o plano de Homologação.
No momento em que a APP passar o plano de Produção, a sigla "HML" será alterada para "PRD".
Alinhe com seu Executivo de Contas para saber sobre os planos de acessos aos ambientes de Homologação e Produção.

3. Faça o encode para base 64

Acesse sua app e faça o encode do “Client ID/Client Secret” para base 64.

Client ID e Client Secret

Observação: Quando for realizar o encode para base 64 retire os “espaços” e a “/” e adicione “:”
Exemplo:

De:

23v5vtb56-b8sd-7ac2-1e12-11ffe12i19c0 / 123d2266-82jj9-82jkl-982k0-1e32jj293jau30

Para:

23v5vtb56-b8sd-7ac2-1e12-11ffe12i19c0:123d2266-82jj9-82jkl-982k0-1e32jj293jau30

4. Criação do token para a autenticação

Para a criação do access-token é necessário primeiro saber qual é o plano de contrato da sua APP.

  • Caso seja um plano de Homologação, você deverá fazer uma requisição POST para a URL https://api-hml.useargo.com/oauth/access-token/
  • Caso seja um plano de Produção, você deverá fazer uma requisição POST para a URL https://api.useargo.com/oauth/access-token/
Observação: Alinhe com seu Executivo de Contas para saber em qual plano está inserida sua APP.

A requisição efetuada deverá enviar as seguintes informações:

Headers

  • Content-Type: application/json
  • Authorization: Encode base 64
Headers
Propriedade Tipo Obrigatório Descrição
Content-Type String Sim Incluir o Value: application/json
Content-Type String Sim Incluir no Authorization do o encode em base 64. Exemplo: Basic KTliMCNiNDvtYjQjZC0bMxOThlNjYtMTVuAYY2M2YzYjAzOjQwOWQyNjU1KTY3YzktMzE3ZS04YzMwLTJlOGU5ZBAxYzA5ZC==

Body

A requisição do Body deve ser preenchida conforme detalhes abaixo:

{
    "username": "argo.argo",
    "password": "teste@",
    "reseller": "argo",
    "corp": "solutions",
    "grant_type": "password"
}
Propriedade Obrigatório Descrição
Username Sim Login do usuário utilizado para acessar o sistema Argo
password Sim Senha do usuário utilizada para acessar o sistema Argo
reseller Sim URL da agência de viagens.
Exemplo: www.argoit.com.br/URLdaAGÊNCIA
corp Sim URL do cliente (corporação) atendida pela agência de viagens. Exemplo: www.argo.com.br/URLdaAGÊNCIA/URLdaCORPORAÇÃO
grant_type Sim Preencher com “password”

Após esse procedimento, será gerado o token para ser utilizado na autenticação da API.
Esse token terá validade de 60 minutos e poderá ser utilizado para todos os requests dentro deste período.

5. Utilize a API

Através do Token gerado conforme passo 4, é possível utilizar os métodos da API Argo, para isso, siga os procedimentos abaixo:

  • Vá para a sessão Detalhes dos Recursos e Operações e selecione o método que deseja utilizar.
  • Passe no Header as informações:
    • access_token: gerado no método de autenticação
    • client_id: conforme mencionado anteriormente é possível encontrar em Dev Tools -> Minhas Apps -> Client ID
  • Para todos os serviços disponíveis existe o Header abaixo:

5.1 Urls de Acesso

Para que as requisições sejam feitas, é necessário utilizar a url correta de acordo com o plano da sua APP.

Homologação: https://api-hml.useargo.com/argo/v2/{metodo-escolhido}

Exemplo:

Caso queira consultar os usuários encontrados em um ambiente de homologação, a url de cosulta ficará da seguinte forma: https://api-hml.useargo.com/argo/v2/users

Produção: https://api.useargo.com/argo/v2/{metodo-escolhido}

Exemplo:

Caso queira consultar os usuários encontrados em um ambiente de produção, a url de cosulta ficará da seguinte forma: https://api.useargo.com/argo/v2/users

Observação: O "metodo escolhido" pode ser consultado em Detalhes dos Recursos e Operações

Propriedade Tipo Tamanho Obrigatório Descrição
reseller String 20 Não URL da agência de viagens. Exemplo: www.argoit.com.br/URLdaAGÊNCIA
client_id Guid 36 Sim ID gerado na criação da app. (Vide 2º passo para a utilização da API Argo)
access_token String 36 Sim Token gerado através da API de autenticação. Exemplo: 5b035b1c-9acc-3c22-b40a-f2d3c9bb0d54
corp String 20 Não URL do cliente (corporação) atendida pela agência de viagens. Exemplo: www.argo.com.br/URLdaAGÊNCIA/URLdaCORPORAÇÃO
login String 50 Não Login do usuário utilizado para acessar o sistema Argo
password String 12 Não Senha do usuário utilizada para acessar o sistema Argo

Tabela de Status das Solicitações

Adiantamento/Despesa

Status utilizado na API Status
awaitingIssue Aguardando emissão (quando associada a uma viagem/adiantamento)
awaitingLaunch Aguardando lançamento
awaitingConfirmation Aguardando conferência
awaitingApproval Aguardando autorização
awaitingPayment Aguardando pagamento
finalized Encerrada

Status da Viagem

Status utilizado na API Status
open Aberta
requested Solicitada
awaitingPermissionAuthorization Aguardando autorização de mérito
awaitingQuotation Aguardando cotação
awaitingDefinitionOfReserve Aguardando definição de reserva
reserving Reservando
awaitingBudget Aguardando orçamento
awaitingSelection Aguardando escolha
waitingDefinitionApprover Aguardando definição de aprovador
awaitingApprovalOfCost Aguardando autorização de custo
awaitingIssue Aguardando emissão
issued Emitida (liberada para faturamento)
canceled Cancelada
expired Expirada
rejected Reprovada

Tabela de Produtos

Produto Descrição
air Aéreo
hotel Hospedagem
rental Locação de carro
service Serviços adicionais
road Rodoviário
advancedPayment Adiantamento
refound Prestação de contas/Reembolso

Detalhes dos recursos e operações

ConfigsAccountingAccount

Através deste serviço o licenciado pode obter todas as informações relacionadas as contas contábeis presentes em sua base de dados. Por meio deste serviço é possível também o gerenciamento (inserção e alteração) das contas contábeis encontradas no cliente.

GET /accountingAccount

Requisição

requisição GET
Propriedade Tipo Tamanho Descrição
filters.active String 3 Propriedade que indica se a conta contábil está ativa. Exemplo: Yes/No
filters.companyId Guid 36 ID de identificação da empresa da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
filters.description String 50 Descrição da conta contábil. Exemplo: Conta Contábil da Corregedoria
filters.integrationCode String 3 Código de integração da conta contábil (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'ACC1010'
filters.typeTrip String 13 Tipo da viagem da conta contábil. Exemplo: 'both', 'international', 'domestic'

Resposta

[
  {
    "active": "yes",
    "description": "string",
    "accountingAccountId": "00000000-0000-0000-0000-000000000000"
  }
]
Propriedade Tipo Tamanho Descrição
accountingAccountId Guid 36 ID de identificação da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descrição da conta contábil. Exemplo: Conta Contábil da Corregedoria
active String 3 Propriedade que indica se a conta contábil está ativa. Exemplo: Yes/No

GET /accountingAccount/accountingAccountId

Requisição

requisição GET

Resposta

{
  "clientId": "00000000-0000-0000-0000-000000000000",
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "active": "yes",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"expense",
  ]
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descrição da conta contábil. Exemplo: Conta Contábil da Corregedoria
integrationCode String 3 Código de integração da conta contábil (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'ACC1010'
typeTrip String 13 Tipo da viagem da conta contábil. Exemplo: 'both', 'international', 'domestic'
companyId Guid 36 ID de identificação da empresa da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
active String 3 Propriedade que indica se a conta contábil está ativa. Exemplo: Yes/No
requestsProject String 3 Propriedade que indica se a conta contábil obriga projeto. Exemplo: Yes/No
expenseType String 15 Tipo de despesa que a conta contábil é vinculada. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

POST /accountingAccount

Requisição

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}
Propriedade Tipo Tamanho Obrigatório Descrição
description String 50 Sim Descrição da conta contábil. Exemplo: Conta Contábil da Corregedoria
integrationCode String 20 Sim Código de integração da conta contábil (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'ACC1010'
typeTrip String 13 Não Tipo da viagem da conta contábil. Exemplo: 'both', 'international', 'domestic'
companyId Guid 36 Não ID de identificação da empresa da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
requestsProject String 3 Não Propriedade que indica se a conta contábil obriga projeto. Exemplo: Yes/No
expenseType String 15 Não Tipo de despesa que a conta contábil é vinculada. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

PUT /accountingAccount

Requisição

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}
Propriedade Tipo Tamanho Obrigatório Descrição
description String 50 Sim Descrição da conta contábil. Exemplo: Conta Contábil da Corregedoria
integrationCode String 20 Sim Código de integração da conta contábil (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'ACC1010'
typeTrip String 13 Não Tipo da viagem da conta contábil. Exemplo: 'both', 'international', 'domestic'
companyId Guid 36 Não ID de identificação da empresa da conta contábil. Exemplo: 00000000-0000-0000-0000-000000000000
requestsProject String 3 Não Propriedade que indica se a conta contábil obriga projeto. Exemplo: Yes/No
expenseType String 15 Não Tipo de despesa que a conta contábil é vinculada. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

ConfigsApprovals

Através do cadastro de Estrutura de Aprovação é possível configurar e definir o fluxo de aprovação das solicitações.

1º Para Quem:

A estrutura pode ser efetuada para todo o cliente, neste caso mantenha os campos citados abaixo em branco.

  • EMPRESA - Estabelece se o workflow será exclusivo para a empresa informada, sendo que esta deverá estar previamente cadastrada no sistema.
  • CENTRO DE CUSTO - Estabelece se o workflow será exclusivo para o centro de custo informado, sendo que este deverá estar previamente cadastrado no sistema.
  • COMUNIDADE - Estabelece se o workflow será exclusivo para a comunidade, sendo esta já cadastrada no ambiente.
  • USUÁRIO - A estrutura será exclusiva para o usuário informado, sendo que este deverá estar previamente cadastrado no sistema.
  • CONTA CONTÁBIL - A estrutura será exclusiva para a conta contábil informada, sendo que esta deverá estar previamente cadastrada no sistema.
  • PROJETO - Define que a estrutura será exclusiva para o projeto informado, sendo que este deverá estar previamente cadastrado no sistema.

2º O Que:

Estabelece o que será aprovado na solicitação: Tipo de viagem (Nacional ou Internacional) Controle de verbas (Conferência, reembolso ou pagamento de despesas).

3º Como: Determina como será a estrutura de aprovação, seguindo o critério:

  • Única - Somente um aprovador da lista será escolhido para aprovar.
  • Sequencial - Serão enviados e-mails do primeiro ao último aprovador cadastrado de forma sequencial. Todos os aprovadores da lista deverão aprovar.
  • Paralela - Serão enviados e-mails ao mesmo tempo para todos os aprovadores cadastrados. Todos os aprovadores da lista deverão aprovar.
  • Nível - Somente um aprovador da lista será escolhido para aprovar e ele deverá ser de um nível acima do viajante.

Executar os métodos GET, POST, PUT, GET ou DELETE de uma Estrutura de Aprovação.

Para mais informações acesse o Argo Wiki.

GET /approvals (Obsoleto)

Este método está obsoleto e será removido futuramente. Utilize o método "GET /approvals/v2"

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.actives String (Boolean) 5 Não Status da estrutura de aprovação (Ativa/Inativa) Exemplo: true/false

Resposta

[
    {
        "approvalId": "00000000-0000-0000-0000-000000000000",
        "forWhoDescription": "string",
        "structurePer": [],
         "approvals": [
            "additional"
        ],
        "project": "string",
        "companyName": "string",
        "community": "string",
        "costCenterDescription": "string",
        "reasonTravel": "string",
        "accountingAccount": "string",
        "costCenterCode": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            },
        ],
        "active": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
approvalId Guid 36 ID relacionado ao registro da estrutura de aprovação. Exemplo: 00000000-0000-0000-0000-000000000000
active String 3 Status da estrutura de aprovação (Ativo/Inativo). Exemplo: Yes/no
forWhoDescription String 255 Login de usuário para quem é destinada a estrutura de aprovação.
structurePer String (Enum) 17 “Para quem” (vide introdução do serviço). Exemplo: client, company, costCenter, user, accountingAccount, project, community
project string 50 Projeto que a estrutura de aprovação está relacionada. Exemplo: Projeto Travel
companyName String 50 Descrição da empresa que a estrutura de aprovação está relacionada. Exemplo: Argo
costCenterCode String 30 Código do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: 001
costCenterDescription String 50 Descrição do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: Desenvolvimento
reasonTravel String 50 Motivo da viagem que a estrutura de aprovação está relacionada. Exemplo: Reunião com cliente
accountingAccount String 50 Conta Contábil que a estrutura de aprovação está relacionada. Exemplo: Departamento de desenvolvimento
community String 50 Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
typeApproval String (Enum) 10 “Como” (vide introdução do serviço). Exemplo: parallel, sequential, single
approvers ApproverVM 1 Objeto responsável por transportar as informações dos aprovadores da estrutura de aprovação
approvers Objeto responsável por transportar as informações dos aprovadores da estrutura de aprovação
Propriedade Tipo Tamanho Descrição
login String 255 Login do usuário aprovador. Exemplo: aprovador.um
email String 255 Email do usuário aprovador. Exemplo: aprovador.um@argo.com
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal

GET /approvals/v2

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.status String (Boolean) 5 Não Status da estrutura de aprovação (Ativa/Inativa) Exemplo: true/false
filters.companyId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a uma determinada empresa. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” da empresa vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
filters.costCenterId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a um determinado Centro de Custo. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” do Centro de Custo vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
filters.userId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a um determinado usuário. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” do Usuário vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
filters.projectId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a um determinado Projeto. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” do Projeto vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
filters.accountingAccountId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a uma determinada Conta Contábil. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” da Conta Contábil vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
filters.communityId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a uma determinada Comunidade. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” da Comunidade vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
filters.reasonTravelId Guid 36 Não O Argo permite vincular uma Estrutura de Aprovação a um determinado Motivo de Viagem. Essa propriedade permite filtrar a Estrutura de Aprovação utilizando o “ID” do Motivo de Viagem vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
filters.approverId Guid 36 Não Através dessa propriedade é possível encontrar a Estrutura de Aprovação contendo um determinado usuário aprovador. Exemplo: 00000000-0000-0000-0000-000000000000
filters.approval String (Enum) 10 Não “Como” (vide introdução do serviço). Possibilita consultar estruturas de um determinado tipo. Exemplo: parallel, sequential, single
filters.typeApproval String (Enum) 15 Não “O que” (vide introdução do serviço). Permite consultar estruturas com as características. Exemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
filters.page Number 100 Não Essa propriedade permite carregar mais OSs por página caso ultrapasse o número padrão de 3000 e a cada número passado no filtro será acrescentado mais 3000.Exemplo: Caso precisemos acessar o registro 3090 utilizamos o número 2 no filtro. Ou caso precisemos acesssar o registro 7000 utilizaremos o filtro 3.

Resposta

[
	{
		"approvalId": "00000000-0000-0000-0000-000000000000",
		"forWhoDescription": "string",
		"structurePer": [
			"user"
		],
		"project": "string",
		"companyName": "string",
		"costCenterCode": "string",
		"costCenterDescription": "string",
		"reasonTravel": "string",
		"accountingAccount": "string",
		"community": "string",
		"approvals": [
			"international",
			"domestic"
		],
        "typeApproval": "single",
		"active": "yes",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            },
        ]
	}
]
Propriedade Tipo Tamanho Descrição
approvalId Guid 36 ID relacionado ao registro da estrutura de aprovação. Exemplo: 00000000-0000-0000-0000-000000000000
forWhoDescription String 255 Login de usuário para quem é destinada a estrutura de aprovação.
structurePer String (Enum) 17 “Para quem” (vide introdução do serviço). Exemplo: client, company, costCenter, user, accountingAccount, project, community
project string 50 Projeto que a estrutura de aprovação está relacionada. Exemplo: Projeto Travel
companyName String 50 Descrição da empresa que a estrutura de aprovação está relacionada. Exemplo: Argo
costCenterCode String 30 Código do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: 001
costCenterDescription String 50 Descrição do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: Desenvolvimento
reasonTravel String 50 Motivo da viagem que a estrutura de aprovação está relacionada. Exemplo: Reunião com cliente
accountingAccount String 50 Conta Contábil que a estrutura de aprovação está relacionada. Exemplo: Departamento de desenvolvimento
community String 50 Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
typeApproval String (Enum) 10 “Como” (vide introdução do serviço). Exemplo: parallel, sequential, single
active String 3 Status da estrutura de aprovação (Ativo/Inativo). Exemplo: Yes/no
approvers ApproverVM 1 Objeto responsável por transportar as informações dos aprovadores da estrutura de aprovação
approvers Objeto responsável por transportar as informações dos aprovadores da estrutura de aprovação
Propriedade Tipo Tamanho Descrição
login String 255 Login do usuário aprovador. Exemplo: aprovador.um
email String 255 Email do usuário aprovador. Exemplo: aprovador.um@argo.com
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal

POST /approvals

Requisição

[
    {
        "companyName": "string",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "costCenterCode": "string",
        "costCenterDescription": "string",
        "community": "string",
        "userLogin": "string",
        "userEmail": "string",
        "accountingAccount": "string",
        "project": "string",
        "reasonTravel": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
companyName String 50 Não Descrição da empresa que a estrutura de aprovação será relacionada. Exemplo: Argo
costCenterId String (Guid) 36 Não ID do Centro de Custo que a estrutura de aprovação será relacionada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterCode String 30 Não Código do Centro de Custo que a estrutura de aprovação será relacionada. Exemplo: ABHA87
costCenterDescription String 50 Não Descrição do Centro de Custo que a estrutura de aprovação será relacionada. Exemplo: Desenvolvimento
community String 50 Não Comunidade que a estrutura de aprovação será relacionada. Exemplo: Equipe técnica
userLogin String 50 Não Login do usuário que a estrutura de aprovação será relacionada. Exemplo: argo.solutions
userEmail String 100 Não E-mail do usuário que a estrutura de aprovação será relacionada. Exemplo: useargo@argo.com
accountingAccount String 50 Não Conta Contábil que a estrutura de aprovação será relacionada. Exemplo: Departamento de desenvolvimento
project String 50 Não Projeto que a estrutura de aprovação será relacionada. Exemplo: Projeto Travel
reasonTravel String 40 Não Motivo da viagem que a estrutura de aprovação será relacionada. Exemplo: Reunião com cliente
typeApproval String (Enum) 10 Não “Como” (vide introdução do serviço). Exemplo: parallel, sequential, single
approvers ApproverVM 1 Não Objeto responsável por transportar as informações dos aprovadores da estrutura de aprovação
scopes Number 100 Não O Argo permite criar estruturas de aprovação por alçada de valores para os tipos de “sequential” e “single”. Essa propriedade permite definir a alçada cadastrada na estrutura
secondLevel String (Enum) 3 Não Usuário aprovador de segundo nível. Exemplo: (Yes/No)
secondLevelMaster String (Enum) 3 Não Usuário aprovador de segundo nível master. Exemplo: Yes/No
approvals String (Enum) 15 Não “O que” (vide introdução do serviço). Exemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
approvers Dados do aprovador da estrutura
Propriedade Tipo Tamanho Obrigatório Descrição
email String 50 Sim E-mail do usuário aprovador. Exemplo: argo@useargo.com
login String 50 Sim Login do usuário aprovador. Exemplo: argo.teste
fullName String 50 Não Nome completo do usuário aprovador. Exemplo: João Silva

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "index": "0",
        "success": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
id Guid 36 ID do registro realizado. Exemplo: 00000000-0000-0000-0000-000000000000
index String 5 Posição na lista inserida de aprovações. Exemplo: Index 1
success String (Enum) 3 Sucesso ou falha na transação. Exemplo: Yes ou No

PUT /approvals

Requisição

[
    {
        "approvalId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "costCenterCode": "string",
        "costCenterDescription": "string",
        "community": "string",
        "userLogin": "string",
        "userEmail": "string",
        "accountingAccount": "string",
        "project": "string",
        "reasonTravel": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
approvalId Guid 36 Sim ID relacionado ao registro da estrutura de aprovação. Exemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Não Descrição da empresa que a estrutura de aprovação está relacionada. Exemplo: Argo
costCenterId String(Guid) 36 Não ID do Centro de Custo que a estrutura de aprovação será relacionada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterCode String 30 Não Código do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: ABHA87
costCenterDescription String 50 Não Descrição do Centro de Custo que a estrutura de aprovação está relacionada. Exemplo: Desenvolvimento
community String 50 Não Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
userLogin String 50 Não Login do usuário que a estrutura de aprovação está relacionada. Exemplo: argo.solutions
userEmail String 100 Não E-mail do usuário que a estrutura de aprovação está relacionada. Exemplo: useargo@argo.com
accountingAccount String 50 Não Conta Contábil que a estrutura de aprovação está relacionada. Exemplo: Departamento de desenvolvimento
project String 50 Não Projeto que a estrutura de aprovação está relacionada Exemplo: Projeto Travel
reasonTravel String 50 Não Motivo da viagem que a estrutura de aprovação está relacionada. Exemplo: Reunião com cliente
typeApproval String (Enum) 10 Não “Como” (vide introdução do serviço). Exemplo: parallel, sequential, single
approvers String 50 Não Usuário que será aprovador da estrutura. Exemplo: João Silva
scopes Number 100 Não O Argo permite criar estruturas de aprovação por alçada de valores para os tipos de “sequential” e “single”. Essa propriedade permite definir a alçada cadastrada na estrutura
secondLevel String (Enum) 3 Não Usuário aprovador de segundo nível. Exemplo: (Yes/No)
secondLevelMaster String (Enum) 3 Não Usuário aprovador de segundo nível master. Exemplo: Yes/No
approvals String (Enum) 15 Não “O que” (vide introdução do serviço). Exemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
approvers Dados do aprovador da estrutura
Propriedade Tipo Tamanho Obrigatório Descrição
email String 50 Sim E-mail do usuário aprovador. Exemplo: argo@useargo.com
login String 50 Sim Login do usuário aprovador. Exemplo: argo.teste
fullName String 50 Não Nome completo do usuário aprovador. Exemplo: João Silva

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "index": "0",
        "success": "yes"
    }
]
Propriedade Tipo Tamanho Formato
id Guid 36 ID do registro realizado. Exemplo: 00000000-0000-0000-0000-000000000000
index String 5 Posição na lista inserida de aprovações. Exemplo: Index 1
success String (Enum) 3 Sucesso ou falha na transação. Exemplo: Yes ou No

DELETE approvals/{approvalId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
approvalId Guid 36 Sim ID relacionado ao registro da estrutura de aprovação. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 50 Sucesso ou falha na utilização do serviço. Exemplo: True/False

GET /approvals/{approvalId}

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
approvalId Guid 36 Sim ID relacionado ao registro da estrutura de aprovação. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
	{
		"approvalId": "00000000-0000-0000-0000-000000000000",
		"forWhoDescription": "string",
		"structurePer": [
			"user"
		],
		"project": "string",
		"companyName": "string",
		"costCenterCode": "string",
		"costCenterDescription": "string",
		"reasonTravel": "string",
		"accountingAccount": "string",
		"community": "string",
		"approvals": [
			"international",
			"domestic"
		],
        "typeApproval": "single",
		"active": "yes",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            },
        ]
	}
]

ConfigsCompanies

O sistema Argo permite o vínculo de empresas às corporações, possibilitado relacionar configurações como (políticas, centro de custo, conta contábeis, usuários, etc) as respectivas empresas (subunidades). A gestão/manutenção dessas empresas pode ser realizada através da API conforme detalhes dos métodos abaixo.

GET /companies

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.active String (Enum) 3 Não Filtro - Status do cadastro da empresa (Ativa/Inativa). Exemplo: Yes/No
filters.companyName String 50 Não Filtro - Nome da empresa
filters.flagProject String (Enum) 3 Não Filtro - Empresas que estão vinculadas a um projeto
filters.integrationCode String 50 Não Filtro - Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
filters.iata String 20 Não Filtro - Código da Associação Internacional de Transportes Aéreos
filters.star String 50 Não Filtro - Dados cadastrais do cliente em globalizadores (GDS)
filters.referenceCode String 30 Não Filtro - Código de referência da empresa cadastrada

Resposta

[
    {
        "companyId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "active": "yes",
        "inclusionDate": "2020-10-29T10:32:26.367Z",
        "flagProject": "yes",
        "integrationCode": "string",
        "iata": "string",
        "star": "string",
        "referenceCode": "string"
    }
]
Propriedade Tipo Tamanho Descrição
companyId Guid 36 ID de identificação da empresa consultada. Exemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Nome da empresa
active String (Enum) 3 Status do cadastro da empresa (Ativa/Inativa). Exemplo: Yes/No
inclusionDate String (Date Time 2 Data/hora de inclusão/criação da empresa. Exemplo: 2019-09-18T16:48:22.490Z
flagProject String (Enum) 3 Indica se a empresa está vinculada a um projeto
integrationCode String 50 Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
iata String 20 Código da Associação Internacional de Transportes Aéreos
star String 50 Dados cadastrais do cliente em globalizadores (GDS)
referenceCode String 30 Código de referência da empresa cadastrada

POST /companies

Requisição

{
    "companyName": "string",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
companyName String 50 Sim Nome da empresa
flagProject String (Enum) 3 Não Indica se a empresa está vinculada a um projeto. Exemplo: Yes/No
integrationCode String 50 Não Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
iata String 20 Não Código da Associação Internacional de Transportes Aéreos
star String 50 Não Dados cadastrais do cliente em globalizadores (GDS)
referenceCode String 30 Não Código de referência da empresa cadastrada

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
companyId String 50 ID de identificação da empresa cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000

GET /companies/{companyId}

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
companyId Guid 36 Sim ID de identificação da empresa que deseja atualizar. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
    {
        "companyId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "active": "yes",
        "inclusionDate": "2020-10-29T10:32:26.367Z",
        "flagProject": "yes",
        "integrationCode": "string",
        "iata": "string",
        "star": "string",
        "referenceCode": "string"
    }
]
Propriedade Tipo Tamanho Descrição
companyId Guid 36 ID de identificação da empresa consultada. Exemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Nome da empresa
active String (Enum) 3 Status do cadastro da empresa (Ativa/Inativa). Exemplo: Yes/No
inclusionDate String (Date Time 2 Data/hora de inclusão/criação da empresa. Exemplo: 2019-09-18T16:48:22.490Z
flagProject String (Enum) 3 Indica se a empresa está vinculada a um projeto
integrationCode String 50 Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
iata String 20 Código da Associação Internacional de Transportes Aéreos
star String 50 Dados cadastrais do cliente em globalizadores (GDS)
referenceCode String 30 Código de referência da empresa cadastrada

PUT /companies/{companyId}

Requisição

{
    "companyName": "string",
    "active": "yes",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
companyId Guid 36 Sim ID de identificação da empresa que deseja atualizar. Exemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Sim Nome da empresa
active String (Enum) 3 Não Indica o status da empresa (Ativa/Inativa). Exemplo: Yes/No
flagProject String (Enum) 3 Não Indica se a empresa está vinculada a um projeto. Exemplo: Yes/No
integrationCode String 50 Não Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
iata String 20 Não Código da Associação Internacional de Transportes Aéreos. Exemplo: 957
star String 50 Não Dados cadastrais do cliente em globalizadores (GDS). Exemplo: 89289
referenceCode String 30 Não Código de referência da empresa cadastrada. Exemplo: 892k11

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
companyName String 50 Nome da empresa
flagProject String 3 Indica se a empresa está vinculada a um projeto. Exemplo: Yes/No
integrationCode String 50 Código de integração da empresa. Normalmente utilizado para integrar com outras aplicações. Exemplo: Argo1673
iata String 50 Código da Associação Internacional de Transportes Aéreos. Exemplo: 957
star String 50 Dados cadastrais do cliente em globalizadores (GDS). Exemplo: 89289
referenceCode String 50 Código de referência da empresa cadastrada. Exemplo: 892k11

ExpenseAdvancePayments

Esse serviço permite listar as solicitações que contenham ao menos um pedido de adiantamento.
Argo Wiki

GET

Requisição

requisição GET

Resposta

[
  {
    "initialDate": "2020-10-28T14:32:13.629Z",
    "finalDate": "2020-10-28T14:32:13.629Z",
    "expenseName": "string",
    "reasonTravelling": "string",
    "coin": "string",
    "bacenCode": "string",
    "exchange": 0,
    "typePaymentName": "string",
    "integrationCodeCompany": "string",
    "companyName": "string",
    "typePaymentId": "00000000-0000-0000-0000-000000000000",
    "departureCity": "string",
    "arrivalCity": "string",
    "departureCountry": "string",
    "arrivalCountry": "string",
    "quantity": 0,
    "price": 0,
    "amount": 0,
    "observation": "string",
    "inclusionDate": "2020-10-28T14:32:13.630Z",
    "paymentDate": "2020-10-28T14:32:13.630Z",
    "ledgerAccountId": "00000000-0000-0000-0000-000000000000",
    "ledgerAccount": "string",
    "codeLedgerAccount": "string",
    "advancePaymentId": 1
  }
]
Propriedade Tipo Tamanho Descrição
bacenCode String 50 Código do país referente ao banco central. Exemplo: 1058
initialDate String (DataTime) 24 É possível incluir no pedido de adiantamento e/ou prestação de contas o período da viagem, sendo as propriedades “initialDate” e “finalDate” as datas da mesma. Exemplo: 2019-10-02T19:47:10.450Z
finalDate String (DataTime) 24 É possível incluir no pedido de adiantamento e/ou prestação de contas o período da viagem, sendo as propriedades “initialDate” e “finalDate” as datas da mesma. Exemplo: 2019-10-02T19:47:10.450Z
expenseName String 50 Nome da despesa relacionada ao pedido do adiantamento. Exemplo: Taxi
reasonTravelling String 50 Motivo do pedido de adiantamento. Exemplo: Reunião com cliente
coin String 3 Moeda solicitada no adiantamento. Exemplo: BRL
exchange Number 14 Câmbio utilizado na solicitação em caso de pedidos de adiantamento em moedas diferentes da utilizada na corporação. Exemplo: 4.891,00
typePaymentName String 50 Descrição do “Pagamento Preferencial” (forma de pagamento) solicitado pelo usuário no pedido do adiantamento. Exemplo: Depósito bancário
integrationCodeCompany String 50 Código de integração da empresa selecionada no pedido do adiantamento. Exemplo: 18982
companyName String 50 Nome da empresa selecionada no pedido do adiantamento. Exemplo: Argo
typePaymentId Guid 36 ID do “Pagamento Preferencial” (forma de pagamento) solicitado pelo usuário no pedido do adiantamento
departureCity Através de configuração na aplicação, é possível adicionar no pedido de adiantamento os campos “Cidade de Origem” e “Cidade de Destino”. Uma vez preenchidos esses campos na abertura da OS, as cidades serão exibidas no retorno do serviço. Exemplo: São Paulo
arrivalCity Através de configuração na aplicação, é possível adicionar no pedido de adiantamento os campos “Cidade de Origem” e “Cidade de Destino”. Uma vez preenchidos esses campos na abertura da OS, as cidades serão exibidas no retorno do serviço. Exemplo: Salvador
departureCountry Através de configuração na aplicação, é possível adicionar no pedido de adiantamento os campos “País de Origem” e “País de Destino”. Uma vez preenchidos esses campos na abertura da OS, as cidades serão exibidas no retorno do serviço. Exemplo: Brasil
arrivalCountry Através de configuração na aplicação, é possível adicionar no pedido de adiantamento os campos “País de Origem” e “País de Destino”. Uma vez preenchidos esses campos na abertura da OS, as cidades serão exibidas no retorno do serviço. Exemplo: Argentina
quantity Number 5 Quantidade de adiantamento(s) solicitado(s). Exemplo: 1
price Number 14 Valor unitário do adiantamento solicitado. Exemplo: 100.0000
amount Number 14 Valor total do(s) adiantamento(s) solicitado(s). Exemplo: 100.000000
observation String 255 Observação inserida pelo usuário no momento da solicitação do adiantamento. Exemplo: Visita cliente externo
inclusionDate String (DataTime) 24 Data/hora do pedido do adiantamento. Exemplo: 2019-10-02T19:47:10.450Z
paymentDate String (DataTime) 23 Data/hora do pagamento do adiantamento. Exemplo: 2019-10-02T19:47:10.450Z
ledgerAccount String 36 Descrição da conta contabil da solicitação. Exemplo: Pagamentos API
ledgerAccountId Guid 36 ID da conta contabil da solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
codeLedgerAccount String 36 Código da conta contabil da solicitação. Exemplo: 235ARGO12
advancePaymentId Number 10 ID do adiantamento na solicitação. Exemplo: 1

ExpenseBlockedRequests

Esse serviço permite listar todas as solicitações pendentes de prestação de conta. Antes de listar, ela verifica se a solicitação necessita ser bloqueada dependendo do valor determinado pela agência para o cliente na política BLOPRE. Se o valor determinado for excedido, a solicitação é bloqueada e listada, caso contrário, a solicitação é listada informando a data de previsão para o bloqueio.
Argo Wiki

GET /expense/blockedrequests

Requisição

requisição GET

Resposta

[
    {
    "RequestNumber": 0,
    "RequestId": "00000000-0000-0000-0000-000000000000",
    "ManualBlock": "string",
    "Name": "string",
    "Blocked": true,
    "Message": "string",
    "FinalDate": "2021-03-17T15:11:31.732Z",
    "FinalDateAdvance": "string",
    "BlockForecastDate": "string",
    "BlockedBy": "string",
    "BlockedDate": "string",
    "UnblockedDate": "string"
    }
]
Propriedade Tipo Tamanho Descrição
RequestNumber Number (int) 100 Número da requisição retornada. Exemplo: 50
RequestId Guid 36 ID de identificação da requisição retornada. Exemplo: 00000000-0000-0000-0000-000000000000.
ManualBlock String 3 Indica se a solicitação foi manualmente bloqueada.
Name String 50 Nome da despesa relacionada ao pedido do adiantamento. Exemplo: Alimentação.
Blocked String (boolean) 4 Informa se a solicitação está bloqueada Exemplo: True/False.
Message String (boolean) 4 Mensagem de informação sobre bloqueio/desbloqueio
FinalDate String (Date-Time) 24 Data final da solicitação. Exemplo: 2019-08-22
FinalDateAdvance String (Date-Time) 24 Data final da solicitação formatada. Exemplo: 08/22/2019.
BlockForecastDate String (Date-Time) 24 Data de previsão para o bloqueio da solicitação. Exemplo: 2019-08-22.
BlockedBy String 50 Usuário responsável por bloquear a solicitação.
BlockedDate Guid 36 Data que a solicitação foi bloqueada. Exemplo: 2019-08-22.
UnblockedDate String (Date-Time) 24 Data que a solicitação foi desbloqueada. Exemplo: 2019-08-22.

ExpensePayments

Esse serviço permite realizar o pagamento de um adiantamento ou prestação de contas

POST

Este método será descontinuado futuramente, uma nova implementação está no método POST /expense/payments/v2

Requisição

[
    {
        "typePayment": "all",
        "amount": 100,
        "coin": "BRL",
        "typePaymentId": "bfd2223d-3ff6-4021-8116-46ce6bd824ce",
        "requestId": "ea7982cd-4be5-e911-943d-90b11c25f05b",
        "paymentDate": "2019-10-02T20:40:56.004z",
        "observation": "Pago"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
typePayment String (Enum) 15 Sim Determina o que está sendo pago na solicitação: all = Tudo, advancedPayment = Adiantamento, refund = Prestação de contas/reembolso, dropOff. Exemplo: advancedPayment
amount Number 14 Sim Valor total pago do adiantamento. Exemplo: 100.000000
coin String 3 Sim Moeda utilizada no pagamento do adiantamento. Exemplo: BRL
typePaymentId Guid 36 Sim ID da “Forma de Pagamento” utilizada para pagar o adiantamento. Exemplo: 00000000-0000-0000-0000-000000000000
requestId Guid 36 Sim ID da solicitação que deseja realizar o pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
paymentDate String (DataTime) 24 Sim Data de pagamento do adiantamento. Exemplo: 2019-10-02T19:47:10.450Z
observation String 255 Não Observação inserida no momento do pagamento do adiantamento. Exemplo: O depósito será realizado em 02 dias

Resposta

Resposta POST
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

POST /expense/payments/v2

Requisição

[
    {
        "advancePaymentId": 0,
        "refundId": 0,
        "typePayment": "all",
        "amount": 100,
        "coin": "BRL",
        "typePaymentId": "bfd2223d-3ff6-4021-8116-46ce6bd824ce",
        "requestId": "ea7982cd-4be5-e911-943d-90b11c25f05b",
        "paymentDate": "2019-10-02T20:40:56.004z",
        "observation": "Pago"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
advancePaymentId Number (int) 10 Sim ID do adiantamento na solicitação. Propriedade obrigatória caso tipo de pagamento for 'advancePayment'. Exemplo: 1
refundId Number (int) 10 Sim ID do reembolso/devolução na solicitação. Propriedade obrigatória caso tipo de pagamento for 'refund'. Exemplo: 1
typePayment String (Enum) 15 Sim Determina o que está sendo pago na solicitação: all = Tudo, advancedPayment = Adiantamento, refund = Prestação de contas/reembolso, dropOff. Exemplo: advancedPayment
amount Number 14 Sim Valor total pago do adiantamento. Exemplo: 100.000000
coin String 3 Sim Moeda utilizada no pagamento do adiantamento. Exemplo: BRL
typePaymentId Guid 36 Sim ID da “Forma de Pagamento” utilizada para pagar o adiantamento. Exemplo: 00000000-0000-0000-0000-000000000000
requestId Guid 36 Sim ID da solicitação que deseja realizar o pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
paymentDate String (DataTime) 24 Sim Data de pagamento do adiantamento. Exemplo: 2019-10-02T19:47:10.450Z
observation String 255 Não Observação inserida no momento do pagamento do adiantamento. Exemplo: O depósito será realizado em 02 dias

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

GET

Recupera a forma de pagamento/informações inseridas no pagamento do adiantamento/prestação de contas

Requisição

requisição GET

Resposta

[
    {
        "requestPaymentId": "5f6e100e-f102-424e-9723-4e9ccf8f8713",
        "typePayment": "advancedPayment",
        "requireId": "54b8dbf0-ebe6-e911-943d-90b11c25f05b",
        "amount": 100.0000,
        "coin": "BRL",
        "coinCodeBacen": "790",
        "paymentDescription": "Cash01",
        "paymentDate": "2019-10-04T03:00:00",
        "inclusionDate": "2019-10-04T18:18:10.817",
        "observation": "Pago"
    }
]
Propriedade Tipo Tamanho Descrição
requestPaymentId Guid 36 ID do pagamento utilizado na OS, Exemplo: 00000000-0000-0000-0000-000000000000
typePayment String (Enum) 15 Tipo de despesa que foi paga: all, advancedPayment, refund, dropOff. Exemplo: advancedPayment
requireId Guid 36 ID da solicitação consultada. Exemplo: 54b8dbf0-ebe6-e911-943d-90b11c25f05b
amount Number 14 Valor total pago. Exemplo: 100.0000
coin String 3 Moeda utilizada no pagamento. Exemplo: BRL
paymentDescription String 50 Descrição da forma de pagamento utilizada na solicitação. Exemplo: Depósito Bancário
paymentDate String (Date-Time) 24 Data que o pagamento foi programado. Exemplo: 2018-11-02
inclusionDate String (Date-Time) 24 Data/hora de inclusão da programação do pagamento. Exemplo: 2018-11-02T21:36:00
observation String 255 Observação inserida no momento do pagamento. Exemplo: Pagamento realizado com sucesso

ExpenseCards

Este serviço permite a inserção de uma lista cartões expense para usuários, assim como a inserção de uma lista de despesas de faturas dos cartões expense.

POST /expense/invoicecards

O limite por requisição é de no máximo 100 despesas

Requisição

[
  {
    "cardNumber": "string",
    "owner": "string",
    "description": "string",
    "authorizationCode": "string",
    "currency": "string",
    "value": 0,
    "transactionDate": "2020-12-01T12:16:26.827Z",
    "billingDate": "2020-12-01T12:16:26.827Z",
    "companyId": "00000000-0000-0000-0000-000000000000"
  }
]
Propriedade Tipo Tamanho Obrigatório Descrição
cardNumber String 50 Sim Numero do cartão em que a despesa foi efetuada. Exemplo: 5261400319746371
owner String 155 Não Nome do titular do cartão. Exemplo: Virgilio Dante
description String 100 Sim Descrição da despesa na fatura. Exemplo: BOA COMPRA STORE
authorizationCode String 20 Sim Código de segurança do cartão. Exemplo: 897
currency String 3 Sim Moeda utilizada na despesa. Exemplo: MXN
value Number (Decimal) 10 Sim Valor da despesa. Exemplo: 150.00
transactionDate DateTime 24 Sim Data da transação da despesa. Exemplo: 2020-02-10T15:40:01.022Z
billingDate DateTime 24 Não Data da fechamento da fatura da despesa. Exemplo: 2020-02-10T15:40:01.022Z
companyId Guid 36 Não ID da empresa. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta POST /expense/invoicecards
Propriedade Tipo Tamanho Descrição
transactionId Guid 36 ID da transação gerada na base de dados. Exemplo: 00000000-0000-0000-0000-000000000000

POST /expense/usercards

O limite por requisição é de no máximo 100 cartões

Requisição

[
  {
    "userId": "00000000-0000-0000-0000-000000000000",
    "cardNumber": "string",
    "flag": "string",
    "refundable": "yes"
  }
]
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID do usuário a qual o cartão pertence. Exemplo: 00000000-0000-0000-0000-000000000000
cardNumber String 50 Sim Numero do cartão do usuário. Exemplo: 5261400319746371
flag String 50 Sim Bandeira do cartão. Exemplo: VI
refundable String (Enum) 3 Sim Se as despesas efetuadas neste cartão são Reembolsáveis. Exemplo: Yes/No

Resposta

resposta POST /expense/usercards
Propriedade Tipo Tamanho Descrição
Mensagem String 155 User cards successfully inserted

ExpenseRefunds

Esse serviço permite listar as solicitações que contenham ao menos uma prestação de contas/reembolso.

GET /expense/{requestId}/refunds

Requisição GET

Resposta

[
  {
    "expenseCard": {
      "cardNumber": "string",
      "autorizationCode": 0,
      "invoiceDate": "2020-10-29T11:37:37.995Z"
    },
    "closingExpenseCard": {
      "cardNumber": "string",
      "autorizationCode": 0,
      "invoiceDate": "2020-10-29T11:37:37.995Z"
    },
    "companyName": "string",
    "typePaymentName": "string",
    "integrationCodeCompany": "string",
    "expenseCategory": "string",
    "expenseTypePayment": "all",
    "ledgerAccount": "string",
    "bacenCode": 0,
    "exchange": 0,
    "expenseName": "string",
    "amount": 0,
    "amountPrice": 0,
    "descriptiveExpense": "string",
    "coin": "string",
    "active": "yes",
    "proven": "yes",
    "refunded": "yes",
    "approved": "yes",
    "vouchers": [
      "string"
    ],
    "changeDate": "2020-10-29T11:37:37.995Z",
    "inclusionDate": "2020-10-29T11:37:37.995Z",
    "paymentDate": "2020-10-29T11:37:37.995Z",
    "initialExpenseDate": "2020-10-29T11:37:37.995Z",
    "finalExpenseDate": "2020-10-29T11:37:37.995Z",
    "ledgerAccountId": "00000000-0000-0000-0000-000000000000",
    "codeLedgerAccount": "string",
    "refundId": 1,
    "valueIVA": 0,
    "percentualIVA": 0,
    "totalValue": 0,
    "observation":"string",
    "uuid":"00000000-0000-0000-0000-000000000000"
  }
]
Propriedade Tipo Tamanho Descrição
expenseCard Object (ExpenseCardVM) 1 Objeto responsável por transferir informações que constam na fatura do cartão corporativo
closingExpenseCard Object (ExpenseCardVM) 1 Objeto responsável por transferir informações dos cartões lançados como “fechamento do cartão” em despesas
companyName String 50 Nome da empresa selecionada na prestação de contas. Exemplo: Argo
typePaymentName String 50 Descrição do “Pagamento Preferencial” solicitado pelo usuário referente para o pagamento da prestação de contas. Exemplo: Depósito bancário
integrationCodeCompany String 50 Código de integração da empresa selecionada na solicitação de prestação de contas. Exemplo: 18982
expenseCategory String 100 Descrição da categoria da despesa. Exemplo: Alimentação
expenseTypePayment String (Enum) 16 Tipo de pagamento da despesa. Exemplo: 'advancedPayment', 'dropOff', 'refund'
exchange Number 14 Câmbio utilizado na solicitação em caso de prestações de contas em moedas diferentes da utilizada na corporação. Exemplo: 4.891,00
expenseName String 50 Nome da despesa inserida na prestação de contas. Exemplo: Taxi
amount Number 14 Valor total do(s) adiantamento(s) solicitado(s). Exemplo: 100.000000
amountPrice Number 100 Valor total da despesa (sem a Taxa IVA). Exemplo: 200
descriptiveExpense String 255 Descrição da criação da despesa. Exemplo: Almoço com fornecedor
coin String 3 Moeda solicitada na prestação de contas. Exemplo: BRL
active String (Enum) 3 Informa se a despesa lançada se encontra ativa ou inativa. Exemplo: Yes/No
bacenCode String 50 Código do país referente ao banco central. Exemplo: 1058
proven String (Enum) 3 Permite identificar se a despesa foi lançada com comprovante. Exemplo: Yes/No
refunded String (Enum) 3 Permite identificar se a despesa foi lançada como “reembolsável”. Exemplo: Yes/No
approved String (Enum) 3 Permite identificar se a despesa foi aprovada. Exemplo: Yes/No
vouchers String 100 Lista os links para fazer o download das imagens/recibos relacionadas as despesas. Exemplo: argo.imagem.html
changeDate String (DataTime) 24 Data da última alteração da despesa. Exemplo: 2019-10-02T19:47:10.450Z
inclusionDate String (DataTime) 24 Data de inclusão da prestação de contas. Exemplo: 2019-10-02T19:47:10.450Z
paymentDate String (DataTime) 24 Data do pagamento da prestação de contas/reembolso. Exemplo: 2019-10-02T19:47:10.450Z
initialExpenseDate String (DataTime) 24 É possível incluir no pedido de adiantamento e/ou prestação de contas o período da viagem, sendo as propriedades “initialExpenseDate” e “finalExpenseDate” as datas relacionadas ao período. Exemplo: 2019-10-02T19:47:10.450Z
finalExpenseDate String (DataTime) 24 É possível incluir no pedido de adiantamento e/ou prestação de contas o período da viagem, sendo as propriedades “initialExpenseDate” e “finalExpenseDate” as datas relacionadas ao período. Exemplo: 2019-10-02T19:47:10.450Z
ledgerAccount String 100 Descrição da conta contabil da solicitação. Exemplo: Pagamentos API
ledgerAccountId Guid 36 ID da conta contabil da solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
codeLedgerAccount String 100 Código da conta contabil da solicitação. Exemplo: 235ARGO12
refundId Number 10 ID do reembolso na solicitação. Exemplo: 1
valueIVA Number 10 Propriedade referente ao Valor IVA inserido no reembolso. Exemplo: 100
percentualIVA Number 3 Propriedade referente ao Percentual IVA inserido no reembolso. Exemplo: 15
totalValue Number 10 Valor total do reembolso com aplicação do valor/porcentagem IVA. Exemplo: 85
observation String 255 Observação inserida ao editar despesa de cartão em prestação de contas. Exemplo: Almoço de negócios com fornecedor
uuid Guid 36 Identificador único da nota fiscal do tipo CFDI. (Informação disponível apenas para clientes com assinatura BTC). Exemplo: 00000000-0000-0000-0000-000000000000
expenseCard O Expense permite o usuário prestar contas das informações que constam na fatura do cartão corporativo
Propriedade Tipo Tamanho Descrição
cardNumber Int 16 Número do cartão vinculada a despesa. Exemplo: 4569-7654-9876-1678
autorizationCode Int 4 Código de autorização do cartão vinculada a despesa. Exemplo: 9573
invoiceDate String (Date-Time) 10 Data de fechamento da fatura do cartão vinculada a despesa. Exemplo: 10-10-2020
closingExpenseCard O Expense permite no momento da prestação de contas lançar a despesa como “fechamento do cartão”
Propriedade Tipo Tamanho Descrição
cardNumber Int 16 Número do cartão vinculada a despesa. Exemplo: 4569-7654-9876-1678
autorizationCode Int 4 Código de autorização do cartão vinculada a despesa. Exemplo: 9573
invoiceDate String (Date-Time) 10 Data de fechamento da fatura do cartão vinculada a despesa. Exemplo: 10-10-2020

ExpenseTypesPayments

Esse serviço permite listar as formas de pagamento cadastradas para adiantamento/reembolso/devolução.
Argo Wiki

GET

Requisição

Requisição GET

Resposta

[
    {
        "typePaymentId": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "typePayment": "string",
        "userUpdateDescription": "string"
    }
]
Propriedade Tipo Tamanho Descrição
typePaymentId Guid 36 ID da forma de pagamento cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000
name String 50 Descrição da forma de pagamento
typePayment String (Enum) 15 Tipo(s) de despesa(s) que a forma de pagamento contempla: all, advancedPayment, refund, dropOff. Exemplo: advancedPayment
companyId Guid 36 ID da empresa que a forma de pagamento está vinculada. Exemplo: Argo
companyName String 50 Descrição da empresa que a forma de pagamento está relacionada. Exemplo: Argo
userUpdateDescription String 50 Nome do último usuário que realizou a alteração na forma de pagamento cadastrada. Exemplo: João Silva

PriceSummary

Esse serviço permite listar os valores Maior, Menor, Médio e Escolhido dos produtos dos trechos de uma determinada solicitação
Os valores são apresentados na mesma moeda da solicitação e possui um indicador 'currency' espcificando qual o tipo retornado. Obs: Os valores retornados são referentes a tarifa do produto (bilhete, diária, passagem e valor de serviço) sem o valor das taxas.

GET

Requisição

requisição GET

Resposta

[
    {
        "selected": 350.00,
        "higher": 600.00,
        "lower": 200.00,
        "average": 400.00,
        "product": "air",
        "currency": "BRL"
      }
]
Propriedade Tipo Tamanho Descrição
selected Number 50 Valor do produto escolhido no trecho da solicitação
higher Number 50 Maior valor dos produtos cotados para o trecho da solicitação
lower Number 50 Menor valor dos produtos cotados para o trecho da solicitação
average Number 50 Média entre os valores maior e menor dos produtos do trecho da solicitação
product String 10 Descrição do produto do trecho. Exemplo: 'air', 'hotels', 'rental', 'service' e 'road'
currency String 3 Tipo da moeda do produto da solicitação. Exemplo: BRL, COP, USD

ConfigsCostCenters

Todo novo cliente/corporação inserido no sistema Argo (Travel e Expense) obrigatoriamente necessita ter ao menos um Centro de Custo cadastrado, caso contrário, não será permitida a criação de solicitações. É possível que diversas configurações sejam vinculadas a um centro de custo, como por exemplo, políticas de viagens, controle orçamentário etc. Devido a importância desse dado, a Argo possibilita através da API a gestão da relação de Centros de Custo da corporação.
Argo Wiki

GET

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.active String (Enum) 3 Não Filtro - Status do cadastro do Centro de Custo (Ativo/Inativo). Exemplo: Yes/No
filters.code String 30 Não Filtro - Código de integração do centro de custo. Exemplo: 001
filters.acronym String 10 Não Filtro – Sigla do centro de custo. Exemplo: 7829
filters.parentCostCenterId Guid 36 Não Filtro - O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite filtrar o Centro de Custo utilizando o “ID” do “Pai”. Exemplo: 00000000-0000-0000-0000-000000000000
filters.companyId Guid 36 Não Filtro - O sistema Argo permite vincular um Centro de Custo a uma determinada empresa). Essa propriedade permite filtrar o Centro de Custo utilizando o “ID” da empresa vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
Page Int 100 Não Propriedade utilizada para paginar os centros de custo. Exemplo: 1

Resposta

[
  {
    "costCenterId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes",
    "flagProject": "yes",
    "parentCostCenterId": "00000000-0000-0000-0000-000000000000",
    "initialDebitDate": "2020-10-29T14:45:55.690Z",
    "inclusionDate": "2020-10-29T14:45:55.690Z",
    "finalDebitDate": "2020-10-29T14:45:55.690Z",
    "parentCostCenterDescription": "string",
    "parentCostCenterCode": "string",
    "parentCostCenterAcronym": "string",
    "companyName": "string",
    "code": "string",
    "acronym": "string",
    "description": "string"
  }
]
Propriedade Tipo Tamanho Descrição
costCenterId Guid 36 ID de registro do Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 ID da empresa vinculado ao Centro de Custo retornado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Status do Centro de Custo (Ativo/InativO). Exemplo: Yes/No
flagProject String (Enum) 3 Indica se o Centro de Custo está vinculado a um projeto. Exemplo: Yes/No
parentCostCenterId Guid 36 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar o “Pai” do Centro de Custo retornado. Exemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (DataTime 24 Data que o Centro de Custo foi cadastrado. Exemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
parentCostCenterDescription String 50 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar a descrição do Centro de Custo retornado. Exemplo: Compras
parentCostCenterCode String 30 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar o código do Centro de Custo retornado. Exemplo: 92898
parentCostCenterAcronym String 10 Sigla do centro de custo. Exemplo: 7829
companyName String 50 O sistema Argo permite vincular um Centro de Custo a uma determinada empresa. Essa propriedade permite identificar a empresa vinculado ao Centro de Custo retornado. Exemplo: Argo
code String 30 Código do centro de custo. Exemplo: 001
acronym String 10 Sigla do centro de custo. Exemplo: 7829
description String 50 Descrição do Centro de Custo cadastrado. Exemplo: Centro de Treinamento

GET /costcenters/{costCenterId}

Requisição

requisição GET /costcenters/{costCenterId}

Resposta

{
    "costCenterId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes",
    "flagProject": "yes",
    "parentCostCenterId": "00000000-0000-0000-0000-000000000000",
    "initialDebitDate": "2020-10-29T14:45:55.690Z",
    "inclusionDate": "2020-10-29T14:45:55.690Z",
    "finalDebitDate": "2020-10-29T14:45:55.690Z",
    "parentCostCenterDescription": "string",
    "parentCostCenterCode": "string",
    "parentCostCenterAcronym": "string",
    "companyName": "string",
    "code": "string",
    "acronym": "string",
    "description": "string"
  }
Propriedade Tipo Tamanho Descrição
costCenterId Guid 36 ID de registro do Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 ID da empresa vinculado ao Centro de Custo retornado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Status do Centro de Custo (Ativo/InativO). Exemplo: Yes/No
flagProject String (Enum) 3 Indica se o Centro de Custo está vinculado a um projeto. Exemplo: Yes/No
parentCostCenterId Guid 36 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar o “Pai” do Centro de Custo retornado. Exemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (DataTime 24 Data que o Centro de Custo foi cadastrado. Exemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
parentCostCenterDescription String 50 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar a descrição do Centro de Custo retornado. Exemplo: Compras
parentCostCenterCode String 30 O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite identificar o código do Centro de Custo retornado. Exemplo: 92898
parentCostCenterAcronym String 10 Sigla do centro de custo. Exemplo: 7829
companyName String 50 O sistema Argo permite vincular um Centro de Custo a uma determinada empresa. Essa propriedade permite identificar a empresa vinculado ao Centro de Custo retornado. Exemplo: Argo
code String 30 Código do centro de custo. Exemplo: 001
acronym String 10 Sigla do centro de custo. Exemplo: 7829
description String 50 Descrição do Centro de Custo cadastrado. Exemplo: Centro de Treinamento

POST

Requisição

[
  {
    "companyId": "00000000-0000-0000-0000-000000000000",
    "flagProject": "yes",
    "parentCostCenterId": "00000000-0000-0000-0000-000000000000",
    "initialDebitDate": "2020-10-30T13:05:19.644Z",
    "finalDebitDate": "2020-10-30T13:05:19.644Z",
    "code": "string",
    "acronym": "string",
    "description": "string"
  }
]
Propriedade Tipo Tamanho Obrigatório Descrição
companyId Guid 36 Não ID da empresa vinculado ao Centro de Custo retornado. Exemplo: 00000000-0000-0000-0000-000000000000
flagProject String (Enum) 3 Não Indica se o Centro de Custo está vinculado a um projeto. Exemplo: Yes/No
parentCostCenterId Guid 36 Não O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite informar o “Pai” do Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 Não É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 Não É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
code String 30 Sim Código do centro de custo. Exemplo: 001
acronym String 10 Não Sigla do centro de custo. Exemplo: 7829
description String 50 Sim Descrição do Centro de Custo. Exemplo: Centro de Treinamento

Resposta

[
    {
        "id": "343c6d7d-4496-49b8-9ec0-90846e684091",
        "index": "0",
        "success": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
costCenterId Guid 36 ID de registro do Centro de Custo cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000

PATCH

Requisição

[
    {
        "costCenterId": "82c56fe0-2816-4871-8368-583020383dbf",
        "active": "yes",
        "flagProject": "yes",
        "code": "002",
        "acronym": "002",
        "description": "CCUsto Argo 002"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
costCenterId Guid 36 ID de registro do Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
Active String (Enum) 3 Sim Status do Centro de Custo (Ativo/Inativo). Exemplo: Yes/No
companyId Guid 36 Não ID da empresa vinculado ao Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
flagProject String (Enum) 3 Não Indica se o Centro de Custo deve ser vinculado a um projeto. Exemplo: Yes/No
parentCostCenterId Guid 36 Não O sistema Argo permite criar a relação de Centro de Custo (Pai – Filho). Essa propriedade permite informar o “Pai” do Centro de Custo. Exemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 Não É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 Não É possível determinar um período que poderá haver alocação de débito no Centro de Custo. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDebitDate e inclusionDate. Exemplo: 2019-09-18T16:48:22.490Z
code String 30 Sim Código do centro de custo. Exemplo: 001
acronym String 10 Não Sigla do centro de custo. Exemplo: 7829
description String 50 Sim Descrição do Centro de Custo. Exemplo: Centro de Treinamento

Resposta

[
    {
        "id": "82c56fe0-2816-4871-8368-583020383dbf",
        "index": "0",
        "success": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
costCenterId Guid 36 ID de registro do Centro de Custo cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000

ConfigsCreditCards

O sistema Argo permite ao licenciado, geralmente agências de viagem, realizar o registro de cartões de créditos dos seus clientes. Os itens obrigatórios são flags, actives e login. Flags diz respeito a bandeira do cartão, actives se este cartão está ativo ou inativo no sistema argo e o login é o nome do usuário no sistema.

GET

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.initialDate DateTime 24 Não Dada que o cartão foi inserido na base de dados. Exemplo: 2020-02-10T15:40:01.022Z
filters.finalDate DateTime 24 Não Dada que o cartão foi inativado na base de dados. Exemplo: 2020-02-10T15:40:01.022Z
filters.flag String (Enum) 15 Não Bandeira do cartão. Exemplo: 'visa', 'mastercard', 'dinersClub', 'americanExpress', 'hipercard', 'UATP', 'ELO'
filters.actives String 3 Não Se o cartão registrado na base de dados está ativo ou não. Exemplo: Sim, Não
filters.login String 256 Não Login do usuário que o cartão está relacionado. Exemplo: argo.solutions

Resposta

[
    {
        "cardId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-02-10T15:40:01.022Z",
        "changeDate": "2020-02-10T15:40:01.022Z",
        "flag": "string",
        "typePayment": "string",
        "cardNumber": "string",
        "active": "yes"
      },
]
Propriedade Tipo Tamanho Descrição
cardId String(Guid) 36 ID do cartão cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Data/hora de inclusão/criação do cartão. Exemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Data/hora da última alteração do cartão. Exemplo: 2019-09-18T16:48:22.490Z
flag String 15 Bandeira do cartão. Exemplo: Master card, Visa
typePayment String 100 Tipo de pagamento registrado no cartão. Exemplo: Faturado
cardNumber String 50 Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
active String(Enum) 3 Indica se o cartão está ativo ou inativo. Exemplo: Yes/No

POST

Requisição

{
  "typePayment": "string",
  "community": "string",
  "userEmail": "string",
  "userLogin": "string",
  "requester": "yes",
  "flag": "visa",
  "cardNumber": "string",
  "securityCode": "string",
  "expirationDate": "2020-09-03T13:43:30.927Z",
  "holder": "string",
  "holderCpf": "string",
  "holderPassport": "string",
  "address": "string",
  "neighborHood": "string",
  "city": "string",
  "acronymState": "string",
  "countryCode": "string",
  "cep": "string",
  "active": "yes",
  "virtual": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
typePayment String 100 Sim Tipo de pagamento registrado no cartão. Exemplo: Faturado
community String 50 Não Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
userEmail String 512 Não E-mail do usuário que o cartão está relacionado. Exemplo: useargo@argo.com
userLogin String 256 Não Login do usuário que o cartão está relacionado. Exemplo: argo.solutions
requester String 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários. Exemplo: Yes/No
flag String (Enum) 15 Não Bandeira do cartão. Exemplo: 'visa', 'mastercard', 'dinersClub', 'americanExpress', 'hipercard', 'UATP', 'ELO'
cardNumber String 50 Sim Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
securityCode String 4 Não Código de segurança do cartão cadastrado. Exemplo: 658
expirationDate DateTime 24 Sim Data de expiração do cartão cadastrado. Exemplo: 2019-09-18
holder String 50 Sim Nome que está impresso no cartão. Exemplo: Lorenzo M. Magalhães
holderCpf String 12 Não Cpf do titular do cartão. Exemplo: 123.321.231-23
holderPassport String 15 Não Numero do passaporte do titular do cartão. Exemplo: BR123456
address String 50 Não Endereço do titula do cartão registrado. Exemplo: Rua figueiroa barros 145
neighborHood String 30 Não Bairro do titular do cartão registrado. Exemplo: Vila das laranjeiras
city String 30 Não Cidade do titular do cartão registrado. Exemplo: São Paulo
acronymState String 2 Não Acrônimo/Sigla do estado do titular do cartão registrado no sistema. Exemplo: SP
countryCode String 3 Não Código do pais do titular do cartão registrado no sistema. Exemplo: 55
cep String 11 Não CEP do titular do cartão registrado no sistema. Exemplo: 89456-818
active String (Enum) 3 Sim Indica se o cartão está ativo ou inativo. Exemplo: Yes/No
virtual String (Enum) 3 Sim Indica se é cartão virtual ou não. Exemplo: Yes/No

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na criação de um cartão. Exemplo: True/False

GET /creditcards/{cardId}

Requisição

requisição GET by ID
Propriedade Tipo Tamanho Obrigatório Descrição
cardId Guid 36 Sim ID o cartão que o usuário deseja consultar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

{
        "cardId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-02-10T15:40:01.022Z",
        "changeDate": "2020-02-10T15:40:01.022Z",
        "userId": "00000000-0000-0000-0000-000000000000",
        "user": "string",
        "flag": "string",
        "typePayment": "string",
        "community": "string",
        "userEmail": "string",
        "userLogin": "string",
        "requester": "yes",
        "cardNumber": "string",
        "securityCode": "string",
        "expirationDate": "2020-02-10T15:40:01.022Z",
        "holder": "string",
        "holderCpf": "string",
        "holderPassport": "string",
        "address": "string",
        "neighborHood": "string",
        "city": "string",
        "acronymState": "string",
        "countryCode": "string",
        "cep": "string",
        "active": "yes",
        "virtual": "yes"
    }
Propriedade Tipo Tamanho Descrição
cardId String(Guid) 36 ID do cartão cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Data/hora de inclusão/criação do cartão. Exemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Data/hora da última alteração do cartão. Exemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
user String 256 Usuário do cartão registrado no sistema. Exemplo: Pedro
flag String 15 Bandeira do cartão. Exemplo: Master card, Visa
typePayment String 100 Tipo de pagamento registrado no cartão. Exemplo: Faturado
community String 50 Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
userEmail String 512 E-mail do usuário que o cartão está relacionado. Exemplo: useargo@argo.com
userLogin String 256 Login do usuário que o cartão está relacionado. Exemplo: argo.solutions
requester String 3 Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários. Exemplo: Yes/No
cardNumber String 50 Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
securityCode String 4 Código de segurança do cartão cadastrado. Exemplo: 658
expirationDate DateTime 24 Data de expiração do cartão cadastrado. Exemplo: 2019-09-18
holder String 50 Nome que está impresso no cartão. Exemplo: Lorenzo M. Magalhães
holderCpf String 12 Cpf do titular do cartão. Exemplo: 123.321.231-23
holderPassport String 15 Numero do passaporte do titular do cartão. Exemplo: BR123456
address String 50 Endereço do titula do cartão registrado. Exemplo: Rua figueiroa barros 145
neighborHood String 30 Bairro do titular do cartão registrado. Exemplo: Vila das laranjeiras
city String 30 Cidade do titular do cartão registrado. Exemplo: São Paulo
acronymState String 2 Acrônimo/Sigla do estado do titular do cartão registrado no sistema. Exemplo: SP
countryCode String 3 Código do pais do titular do cartão registrado no sistema. Exemplo: 55
cep String 11 CEP do titular do cartão registrado no sistema. Exemplo: 89456-818
active String(Enum) 3 Indica se o cartão está ativo ou inativo. Exemplo: Yes/No
virtual String(Enum) 3 Indica se é cartão virtual ou não. Exemplo: Yes/No

PUT /creditcards/{cardId}

Requisição

requisição PUT
Propriedade Tipo Tamanho Obrigatório Descrição
cardId Guid 36 Sim ID o cartão que o usuário deseja alterar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000
Propriedade Tipo Tamanho Obrigatório Descrição
typePayment String 100 Sim Tipo de pagamento registrado no cartão. Exemplo: Faturado
community String 50 Não Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
userEmail String 512 Não E-mail do usuário que o cartão está relacionado. Exemplo: useargo@argo.com
userLogin String 256 Não Login do usuário que o cartão está relacionado. Exemplo: argo.solutions
requester String 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários. Exemplo: Yes/No
flag String 15 Não Bandeira do cartão. Exemplo: Master card, Visa
cardNumber String 50 Sim Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
securityCode String 4 Não Código de segurança do cartão cadastrado. Exemplo: 658
expirationDate DateTime 24 Sim Data de expiração do cartão cadastrado. Exemplo: 2019-09-18
holder String 50 Sim Nome que está impresso no cartão. Exemplo: Lorenzo M. Magalhães
holderCpf String 12 Não Cpf do titular do cartão. Exemplo: 123.321.231-23
holderPassport String 15 Não Numero do passaporte do titular do cartão. Exemplo: BR123456
address String 50 Não Endereço do titula do cartão registrado. Exemplo: Rua figueiroa barros 145
neighborHood String 30 Não Bairro do titular do cartão registrado. Exemplo: Vila das laranjeiras
city String 30 Não Cidade do titular do cartão registrado. Exemplo: São Paulo
acronymState String 2 Não Acrônimo/Sigla do estado do titular do cartão registrado no sistema. Exemplo: SP
countryCode String 3 Não Código do pais do titular do cartão registrado no sistema. Exemplo: 55
cep String 11 Não CEP do titular do cartão registrado no sistema. Exemplo: 89456-818
active String(Enum) 3 Sim Indica se o cartão está ativo ou inativo. Exemplo: Yes/No
virtual String(Enum) 3 Sim Indica se é cartão virtual ou não. Exemplo: Yes/No

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização de um cartão. Exemplo: True/False

DELETE /creditCards/{cardId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
cardId Guid 36 Sim ID o cartão que o usuário deseja deletar. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na exclusão de um cartão. Exemplo: True/False

ConfigsExpenseManagementFields

Este módulo é responsável por gerenciar os campos gerenciais de expense.

GET /expensemanagementsfields

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.list String (Enum) 3 Não Filtrar campos gerenciais com ou sem valores (Os valores são vinculados a campos de auto complete). Exemplo: Yes/No
filters.type String 12 Não Filtro referente ao tipo do campo gerencial. Exemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time
filters.fieldId String 100 Não Filtro referente ao identificador do campo gerencial. Exemplo: sustentacao_29396_Hora_3despesas, sustentacao_29396_autocomplete_1despesa
filters.description String 255 Não Filtro referente a descrição dada ao campo gerencial. Exemplo: Vencimento da Fatura
filters.active String 3 Não Filtro referente ao status do campo gerencial (Ativo/Inativo). Exemplo: yes/no
filters.expenseId Guid 36 Não Filtro referente ao identificador da despesa vinculada ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
filters.expenseManagementFieldId Guid 36 Não Filtro referente ao identificador do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
filters.order Number (Int) 100 Não Filtro referente a ordem do campo gerencial. Exemplo: 1, 2, 3
filters.integrationCode String 255 Não Filtro referente ao código de integração do campo gerencial. Exemplo: CMP-GER-001
filters.initialChangeDate String (Date Time) 24 Não Filtro referente a data inicial de alteração. Exemplo: 2019-09-18T16:48:22.490Z
filters.finalChangeDate String (Date Time) 24 Não Filtro referente a data final de alteração. Exemplo: 2019-09-18T16:48:22.490Z
filters.initialFinalizationDate String (Date Time) 24 Não Filtro referente a data inicial de finalização. Exemplo: 2019-09-18T16:48:22.490Z
filters.finalFinalizationDate String (Date Time) 24 Não Filtro referente a data final de finalização. Exemplo: 2019-09-18T16:48:22.490Z
filters.initialInclusionDate String (Date Time) 24 Não Filtro referente a data inicial de inclusão. Exemplo: 2019-09-18T16:48:22.490Z
filters.finalInclusionDate String (Date Time) 24 Não Filtro referente a data final de inclusão. Exemplo: 2019-09-18T16:48:22.490Z
filters.regularExpression String 255 Não Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
filters.required String 3 Não Filtro referente a obrigatoriedade do campo gerencial. Exemplo: yes/no
filters.changedUserId Guid 36 Não Filtro referente ao identificador do usuário que alterou o campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
  {
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "clientId": "00000000-0000-0000-0000-000000000000",
    "fieldId": "string",
    "description": "string",
    "type": "string",
    "regularExpression": "string",
    "active": "yes",
    "order": 0,
    "integrationCode": "string",
    "expenseId": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-10-27T14:21:58.347Z",
    "changedUserId": "00000000-0000-0000-0000-000000000000",
    "changeDate": "2020-10-27T14:21:58.347Z",
    "finalizationDate": "2020-10-27T14:21:58.347Z",
    "required": "yes"
  }
]
Propriedade Tipo Tamanho Descrição
expenseManagementFieldId Guid 36 ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que o campo gerencial está vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
fieldId String 255 Identificador do campo gerencial. Exemplo: sustentacao_29396_Hora_3despesas
description String 255 Descrição dada ao campo gerencial. Exemplo: Vencimento da Fatura
type String 12 Tipo do campo gerencial. Exemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
regularExpression String 255 Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
active String (Enum) 3 Indica se o campo gerencial está ativo ou inativo. Exemplo: Yes/No
order Number (Int) 100 Ordem do campo gerencial. Exemplo: 1, 2, 3
integrationCode String 255 Código de integração do campo gerencial. Exemplo: CMP-GER-001
expenseId Guid 36 ID da despesa vinculada ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora do cadastro do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date Time) 24 Data/hora da finalização do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
required String 3 Campo referente a obrigatoriedade do campo gerencial. Exemplo: yes/no

POST /expensemanagementsfields

Requisição

{
  "description": "string",
  "fieldId": "string",
  "expensesIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "type": "string",
  "order": 0,
  "regularExpression": "string",
  "integrationCode": "string",
  "required": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
description String 255 Sim Descrição dada ao campo gerencial. Exemplo: Vencimento da Fatura
fieldId String 255 Sim Identificador do campo gerencial. Exemplo: sustentacao_29396_Hora_3despesas
expensesIds Array (Guid) 1 Sim Lista de despesas que serão vinculadas ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 12 Sim Tipo do campo gerencial. Exemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
order Number (Int) 100 Sim Ordem do campo gerencial. Exemplo: 1, 2, 3
regularExpression String 255 Não Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
integrationCode String 255 Não Código de integração do campo gerencial. Exemplo: CMP-GER-001
required String 3 Não Campo referente a obrigatoriedade do campo gerencial. Exemplo: yes/no

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /expensemanagementsfields/{expenseManagementfieldId}

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
expenseManagementFieldId Guid 36 Sim ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
  {
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "clientId": "00000000-0000-0000-0000-000000000000",
    "fieldId": "string",
    "description": "string",
    "type": "string",
    "regularExpression": "string",
    "active": "yes",
    "order": 0,
    "integrationCode": "string",
    "expenseId": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-10-27T14:21:58.347Z",
    "changedUserId": "00000000-0000-0000-0000-000000000000",
    "changeDate": "2020-10-27T14:21:58.347Z",
    "finalizationDate": "2020-10-27T14:21:58.347Z",
    "required": "yes"
  }
]
Propriedade Tipo Tamanho Descrição
expenseManagementFieldId Guid 36 ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que o campo gerencial está vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
fieldId String 255 Identificador do campo gerencial. Exemplo: sustentacao_29396_Hora_3despesas
description String 255 Descrição dada ao campo gerencial. Exemplo: Vencimento da Fatura
type String 12 Tipo do campo gerencial. Exemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
regularExpression String 255 Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
active String (Enum) 3 Indica se o campo gerencial está ativo ou inativo. Exemplo: Yes/No
order Number (Int) 100 Ordem do campo gerencial. Exemplo: 1, 2, 3
integrationCode String 255 Código de integração do campo gerencial. Exemplo: CMP-GER-001
expenseId Guid 36 ID da despesa vinculada ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora do cadastro do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date Time) 24 Data/hora da finalização do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
required String 3 Campo referente a obrigatoriedade do campo gerencial. Exemplo: yes/no

PUT /expensemanagementsfields/{expenseManagementfieldId}

Requisição

{
  "description": "string",
  "fieldId": "string",
  "expensesIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "type": "string",
  "order": 0,
  "regularExpression": "string",
  "integrationCode": "string",
  "required": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
description String 255 Sim Descrição dada ao campo gerencial. Exemplo: Vencimento da Fatura
fieldId String 255 Sim Identificador do campo gerencial. Exemplo: sustentacao_29396_Hora_3despesas
expensesIds Array (Guid) 1 Sim Lista de despesas que serão vinculadas ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 12 Sim Tipo do campo gerencial. Exemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
order Number (Int) 100 Sim Ordem do campo gerencial. Exemplo: 1, 2, 3
regularExpression String 255 Não Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
integrationCode String 255 Não Código de integração do campo gerencial. Exemplo: CMP-GER-001
required String 3 Não Campo referente a obrigatoriedade do campo gerencial. Exemplo: yes/no

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na alteração do campo gerencial. Exemplo: True/False

GET /expensemanagementsfields/{expenseManagementfieldId}/values

Os valores são vinculados apenas em campos gerenciais do tipo "AutoComplete"

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
expenseManagementFieldId Guid 36 Sim ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
  {
    "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "value": "string",
    "order": 0,
    "code": "string"
  }
]
Propriedade Tipo Tamanho Descrição
expenseManagementFieldValueId Guid 36 ID do valor vinculado ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldId Guid 36 ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
value String 50 Descrição do valor vinculado ao campo gerencial. Exemplo: 1, 2, 3
order Number (Int) 100 Ordem do campo gerencial. Exemplo: 1, 2, 3
code String 50 Código do valor vinculado ao campo gerencial. Exemplo: Cod-01, 2

POST /expensemanagementsfields/{expenseManagementfieldId}/values

Requisição

  {
    "value": "string",
    "order": 0,
    "code": "string"
  }
Propriedade Tipo Tamanho Obrigatório Descrição
value String 50 Sim Descrição do valor vinculado ao campo gerencial. Exemplo: 1, 2, 3
order Number (Int) 100 Não Ordem do campo gerencial. Exemplo: 1, 2, 3
code String 50 Não Código do valor vinculado ao campo gerencial. Exemplo: Cod-01, 2

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na alteração do campo gerencial. Exemplo: True/False

DELETE /expensemanagementsfields/{expenseManagementfieldId}/values/{expenseManagementFieldValueId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
expenseManagementFieldId Guid 36 Sim ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldValueId Guid 36 Sim ID do valor vinculado ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na exclusão de um cartão. Exemplo: True/False

GET /expensemanagementsfields/{expenseManagementfieldId}/values/{expenseManagementFieldValueId}

Os valores são vinculados apenas em campos gerenciais do tipo "AutoComplete"

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
expenseManagementFieldId Guid 36 Sim ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldValueId Guid 36 Sim ID do valor vinculado ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

{
  "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
  "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
  "value": "string",
  "order": 0,
  "code": "string"
}
Propriedade Tipo Tamanho Descrição
expenseManagementFieldValueId Guid 36 ID do valor vinculado ao campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldId Guid 36 ID do campo gerencial. Exemplo: 00000000-0000-0000-0000-000000000000
value String 50 Descrição do valor vinculado ao campo gerencial. Exemplo: 1, 2, 3
order Number (Int) 100 Ordem do campo gerencial. Exemplo: 1, 2, 3
code String 50 Código do valor vinculado ao campo gerencial. Exemplo: Cod-01, 2

ConfigsExpenses

O módulo Expense é uma solução que permite às corporações controlarem suas despesas. Através do módulo é possível que os usuários lancem as suas prestações de contas e todo o fluxo seja acompanhado pelos envolvidos (aprovadores, financeiro etc.). Através dos métodos abaixo é possível manter o gerenciamento das despesas conforme necessidade.
Argo Wiki

GET /expenses

Requisição

requisição GET

Resposta

[
    {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "expenseId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-10-30T10:26:04.483Z",
        "changeDate": "2020-10-30T10:26:04.483Z",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "accountingAccountId": "00000000-0000-0000-0000-000000000000",
        "active": "yes",
        "name": "string",
        "type": "advancedPayment",
        "day": 0,
        "air": 0,
        "hotel": 0,
        "rental": 0,
        "request": 0,
        "typeTrip": "both",
        "groupDay": 0,
        "groupRequest": 0,
        "plusLess": "yes",
        "plusLessValue": 0,
        "plusLessUtilization": "totalDay",
        "individualQuantity": "yes",
        "tax": 0,
        "category": "food",
        "kilometerValue": 0,
        "requiredVoucher": "yes",
        "requiredCFDI": "yes",
        "refundable": "yes",
        "proven": "yes",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "leveld": "00000000-0000-0000-0000-000000000000"
    }
]
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID do cliente que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID da despesa retornada do cadastro. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora do cadastro da despesa. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date-Time) 24 Data/hora da última alteração no cadastro da despesa. Exemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID da empresa que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 ID da conta contábil que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica se a despesa cadastrada está ativa ou inativa. Exemplo: Yes/No
name String 50 Descrição da despesa. Exemplo: Alimentação
type String (Enum) 15 Tipo da despesa cadastrada: advancedPayment = adiantamento refund - reembolso invoiceClosing - fechamento cartão. Exemplo: refund
day Int 3 Quantidade máxima da despesa permitida por dia. Exemplo: 2
air Int 3 Quantidade máxima da despesa permitida, conforme quantidade de aéreo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) aéreo, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) aéreos, o usuário poderá solicitar até (6) despesas)
hotel Int 3 Quantidade máxima da despesa permitida, conforme quantidade de hospedagem na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) hospedagem, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) hospedagens, o usuário poderá solicitar até (6) despesas)
rental Int 3 Quantidade máxima da despesa permitida, conforme quantidade de locação de veículo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) carro, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) carros, o usuário poderá solicitar até (6) despesas
request Int 3 Quantidade máxima da despesa por solicitação. Exemplo: 2
typeTrip String (Enum) 13 Tipo de viagem que a despesa está vinculada (both, international, domestic). Exemplo: domestic
groupDay Int 3 Através dessa propriedade é possível limitar a quantidade de um tipo específico de despesa que pode ser solicitado em uma OS. Exemplo: Configurado (2) para a despesa Taxi. Ao abrir uma solicitação o usuário poderá selecionar no máximo (2) Taxi.
groupRequest Int 3 Através dessa propriedade é possível limitar a quantidade de despesa(s) que pode ser solicitado em uma OS. Exemplo: Configurado (2). A solicitação (adiantamento ou prestação de contas) poderá ter no máximo duas despesas
plusLess String (Enum) 3 Propriedade para identificar se a despesa possui ou não quantidade a mais ou não em relação a quantidade já definida nas propriedade air, hotel, rental. Sendo "yes" para "+" e "no" para "-". Exemplo: yes/no
plusLessValue Int 3 Quantidade para mais ou menos em relação a quantidade definida nas propriedades air, hotel, rental. Exemplo: 2
plusLessUtilization String (Enum) 11 Específica para qual “produto” a quantidade para mais ou menos será válida em relação a configuração definida na propriedade “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Exemplo: totalAir
individualQuantity String (Enum) 3 Quando a despesa é configurada com essa propriedade, significa que o usuário não pode lançar duas despesas (Exemplo: Taxi) de uma vez e sim, incluir uma linha de despesa para cada item. Exemplo: Yes/No
tax Number (Decimal) 100 Valor do imposto da despesa. Exemplo: 115.00
category String (Enum) 16 Define a categoria da despesa cadastrada (food, hotels, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Exemplo: food
kilometerValue Int 6 Através dessa propriedade é possível definir o valor da categoria de despesa “Percurso” (por km). Exemplo: 1.50
requiredVoucher String (Enum) 3 Obriga inserção do comprovante quando selecionada a despesa. Exemplo: Yes
requiredCFDI String (Enum) 3 Vincula despesa com o XML CFDI. Exemplo: No
refundable String (Enum) 3 Define se a despesa será apresentada para o usuário sempre com o padrão “reembolsável”. Exemplo: Yes/No
proven String (Enum) 3 Define se a despesa será apresentada para o usuário sempre com o padrão “comprovado”. Exemplo: Yes/No
costCenterId Guid 36 ID do centro de custo que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 ID do nível que a despesa está vinculada (Exemplo: Diretoria). Quando vinculada uma despesa a um nível, a mesma será apresentada somente para os usuários com os níveis definidos. Exemplo: 00000000-0000-0000-0000-000000000000

POST /expenses

Requisição

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "accountingAccountId": "00000000-0000-0000-0000-000000000000",
  "active": "yes",
  "name": "string",
  "type": "advancedPayment",
  "day": 0,
  "air": 0,
  "hotel": 0,
  "rental": 0,
  "request": 0,
  "typeTrip": "both",
  "groupDay": 0,
  "groupRequest": 0,
  "plusLess": "yes",
  "plusLessValue": 0,
  "plusLessUtilization": "totalDay",
  "individualQuantity": "yes",
  "tax": 0,
  "category": "food",
  "kilometerValue": 0,
  "requiredVoucher": "yes",
  "requiredCFDI": "yes",
  "refundable": "yes",
  "proven": "yes",
  "costCenterId": "00000000-0000-0000-0000-000000000000",
  "leveld": "00000000-0000-0000-0000-000000000000"
}
Propriedade Tipo Tamanho Obrigatório Descrição
companyId Guid 36 Não ID da empresa que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 Não ID da conta contábil que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Indica se a despesa cadastrada está ativa ou inativa. Exemplo: Yes/No
name String 50 Sim Descrição da despesa. Exemplo: Alimentação
type String (Enum) 15 Não Tipo da despesa cadastrada: advancedPayment = adiantamento refund - reembolso invoiceClosing - fechamento cartão. Exemplo: refund
day Int 3 Não Quantidade máxima da despesa permitida por dia. Exemplo: 2
air Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de aéreo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) aéreo, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) aéreos, o usuário poderá solicitar até (6) despesas
hotel Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de hospedagem na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) hospedagem, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) hospedagens, o usuário poderá solicitar até (6) despesas
rental Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de locação de veículo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) carro, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) carros, o usuário poderá solicitar até (6) despesas
request Int 3 Não Quantidade máxima da despesa por solicitação. Exemplo: 2
typeTrip String (Enum) 13 Não Tipo de viagem que a despesa está vinculada (both, international, domestic). Exemplo: domestic
groupDay Int 3 Não Através dessa propriedade é possível limitar a quantidade de um tipo específico de despesa que pode ser solicitado em uma OS. Exemplo: Configurado (2) para a despesa Taxi. Ao abrir uma solicitação o usuário poderá selecionar no máximo (2) Taxi.
groupRequest Int 3 Não Através dessa propriedade é possível limitar a quantidade de despesa(s) que pode ser solicitado em uma OS. Exemplo: Configurado (2). A solicitação (adiantamento ou prestação de contas) poderá ter no máximo duas despesas
plusLess String (Enum) 3 Não Propriedade para identificar se a despesa possui ou não quantidade a mais ou não em relação a quantidade já definida nas propriedade air, hotel, rental. Sendo "yes" para "+" e "no" para "-". Exemplo: yes/no
plusLessValue Int 3 Não Quantidade para mais ou menos em relação a quantidade definida nas propriedades air, hotel, rental. Exemplo: 2
plusLessUtilization String (Enum) 11 Não Específica para qual “produto” a quantidade para mais ou menos será válida em relação a configuração definida na propriedade “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Exemplo: totalAir
individualQuantity String (Enum) 3 Não Quando a despesa é configurada com essa propriedade, significa que o usuário não pode lançar duas despesas (Exemplo: Taxi) de uma vez e sim, incluir uma linha de despesa para cada item. Exemplo: Yes/No
tax Number (Decimal) 100 Não Valor do imposto da despesa. Exemplo: 115.00
category String (Enum) 16 Não Define a categoria da despesa cadastrada (food, otel, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Exemplo: food
kilometerValue Int 6 Não Através dessa propriedade é possível definir o valor da categoria de despesa “Percurso”. Exemplo: 1.50
requiredVoucher String (Enum) 3 Não Obriga inserção do comprovante quando selecionada a despesa. Exemplo: Yes
requiredCFDI String (Enum) 3 Não Vincula despesa com o XML CFDI. Exemplo: No
refundable String (Enum) 3 Não Define se a despesa será apresentada para o usuário sempre com o padrão “reembolsável”. Exemplo: Yes/No
costCenterId Guid 36 Não ID do centro de custo que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
proven String (Enum) 3 Não Define se a despesa será apresentada para o usuário sempre com o padrão “comprovado”. Exemplo: Yes/No
leveld Guid 36 Não ID do nível que a despesa está vinculada (Exemplo: Diretoria). Quando vinculada uma despesa a um nível, a mesma será apresentada somente para os usuários com os níveis definidos. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
ID Guid 36 ID da despesa cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000

GET /expenses/{expenseId}

Requisição

requisição GET

Resposta

[
    {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "expenseId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-10-30T10:26:04.483Z",
        "changeDate": "2020-10-30T10:26:04.483Z",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "accountingAccountId": "00000000-0000-0000-0000-000000000000",
        "active": "yes",
        "name": "string",
        "type": "advancedPayment",
        "day": 0,
        "air": 0,
        "hotel": 0,
        "rental": 0,
        "request": 0,
        "typeTrip": "both",
        "groupDay": 0,
        "groupRequest": 0,
        "plusLess": "yes",
        "plusLessValue": 0,
        "plusLessUtilization": "totalDay",
        "individualQuantity": "yes",
        "tax": 0,
        "category": "food",
        "kilometerValue": 0,
        "requiredVoucher": "yes",
        "requiredCFDI": "yes",
        "refundable": "yes",
        "proven": "yes",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "leveld": "00000000-0000-0000-0000-000000000000"
    }
]
Propriedade Tipo Tamanho Descrição
expenseId Guid 36 Sim ID da despesa. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID da despesa retornada do cadastro. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora do cadastro da despesa. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date-Time) 24 Data/hora da última alteração no cadastro da despesa. Exemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID da empresa que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 ID da conta contábil que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica se a despesa cadastrada está ativa ou inativa. Exemplo: Yes/No
name String 50 Descrição da despesa. Exemplo: Alimentação
type String (Enum) 15 Tipo da despesa cadastrada: advancedPayment = adiantamento refund - reembolso invoiceClosing - fechamento cartão. Exemplo: refund
day Int 3 Quantidade máxima da despesa permitida por dia. Exemplo: 2
air Int 3 Quantidade máxima da despesa permitida, conforme quantidade de aéreo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) aéreo, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) aéreos, o usuário poderá solicitar até (6) despesas)
hotel Int 3 Quantidade máxima da despesa permitida, conforme quantidade de hospedagem na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) hospedagem, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) hospedagens, o usuário poderá solicitar até (6) despesas)
rental Int 3 Quantidade máxima da despesa permitida, conforme quantidade de locação de veículo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) carro, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) carros, o usuário poderá solicitar até (6) despesas
request Int 3 Quantidade máxima da despesa por solicitação. Exemplo: 2
typeTrip String (Enum) 13 Tipo de viagem que a despesa está vinculada (both, international, domestic). Exemplo: domestic
groupDay Int 3 Através dessa propriedade é possível limitar a quantidade de um tipo específico de despesa que pode ser solicitado em uma OS. Exemplo: Configurado (2) para a despesa Taxi. Ao abrir uma solicitação o usuário poderá selecionar no máximo (2) Taxi.
groupRequest Int 3 Através dessa propriedade é possível limitar a quantidade de despesa(s) que pode ser solicitado em uma OS. Exemplo: Configurado (2). A solicitação (adiantamento ou prestação de contas) poderá ter no máximo duas despesas
plusLess String (Enum) 3 Propriedade para identificar se a despesa possui ou não quantidade a mais ou não em relação a quantidade já definida nas propriedade air, hotel, rental. Sendo "yes" para "+" e "no" para "-". Exemplo: yes/no
plusLessValue Int 3 Quantidade para mais ou menos em relação a quantidade definida nas propriedades air, hotel, rental. Exemplo: 2
plusLessUtilization String (Enum) 11 Específica para qual “produto” a quantidade para mais ou menos será válida em relação a configuração definida na propriedade “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Exemplo: totalAir
individualQuantity String (Enum) 3 Quando a despesa é configurada com essa propriedade, significa que o usuário não pode lançar duas despesas (Exemplo: Taxi) de uma vez e sim, incluir uma linha de despesa para cada item. Exemplo: Yes/No
tax Number (Decimal) 100 Valor do imposto da despesa. Exemplo: 115.00
category String (Enum) 16 Define a categoria da despesa cadastrada (food, hotels, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Exemplo: food
kilometerValue Int 6 Através dessa propriedade é possível definir o valor da categoria de despesa “Percurso” (por km). Exemplo: 1.50
requiredVoucher String (Enum) 3 Obriga inserção do comprovante quando selecionada a despesa. Exemplo: Yes
requiredCFDI String (Enum) 3 Vincula despesa com o XML CFDI. Exemplo: No
refundable String (Enum) 3 Define se a despesa será apresentada para o usuário sempre com o padrão “reembolsável”. Exemplo: Yes/No
proven String (Enum) 3 Define se a despesa será apresentada para o usuário sempre com o padrão “comprovado”. Exemplo: Yes/No
costCenterId Guid 36 ID do centro de custo que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 ID do nível que a despesa está vinculada (Exemplo: Diretoria). Quando vinculada uma despesa a um nível, a mesma será apresentada somente para os usuários com os níveis definidos. Exemplo: 00000000-0000-0000-0000-000000000000

PUT /expenses/{expenseId}

Requisição

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "accountingAccountId": "00000000-0000-0000-0000-000000000000",
  "active": "yes",
  "name": "string",
  "type": "advancedPayment",
  "day": 0,
  "air": 0,
  "hotel": 0,
  "rental": 0,
  "request": 0,
  "typeTrip": "both",
  "groupDay": 0,
  "groupRequest": 0,
  "plusLess": "yes",
  "plusLessValue": 0,
  "plusLessUtilization": "totalDay",
  "individualQuantity": "yes",
  "tax": 0,
  "category": "food",
  "kilometerValue": 0,
  "requiredVoucher": "yes",
  "requiredCFDI": "yes",
  "refundable": "yes",
  "proven": "yes",
  "costCenterId": "00000000-0000-0000-0000-000000000000",
  "leveld": "00000000-0000-0000-0000-000000000000"
}
Propriedade Tipo Tamanho Obrigatório Descrição
expenseId Guid 36 Sim ID da despesa. Exemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 Não ID da empresa que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 Não ID da conta contábil que a despesa está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Indica se a despesa cadastrada está ativa ou inativa. Exemplo: Yes/No
name String 50 Sim Descrição da despesa. Exemplo: Alimentação
type String (Enum) 15 Não Tipo da despesa cadastrada: advancedPayment = adiantamento refund - reembolso invoiceClosing - fechamento cartão. Exemplo: refund
day Int 3 Não Quantidade máxima da despesa permitida por dia. Exemplo: 2
air Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de aéreo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) aéreo, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) aéreos, o usuário poderá solicitar até (6) despesas
hotel Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de hospedagem na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) hospedagem, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) hospedagens, o usuário poderá solicitar até (6) despesas)
rental Int 3 Não Quantidade máxima de despesa permitida conforme quantidade de locação de veículo na solicitação. Exemplo: Cadastrada a quantidade (3). Caso solicitado (1) carro, o usuário poderá solicitar até (3) despesas. Caso solicitado (2) carros, o usuário poderá solicitar até (6) despesas)
request Int 3 Não Quantidade máxima da despesa por solicitação. Exemplo: 2
typeTrip String (Enum) 13 Não Tipo de viagem que a despesa está vinculada (both, international, domestic). Exemplo: domestic
groupDay Int 3 Não Através dessa propriedade é possível limitar a quantidade de um tipo específico de despesa que pode ser solicitado em uma OS. Exemplo: Configurado (2) para a despesa Taxi. Ao abrir uma solicitação o usuário poderá selecionar no máximo (2) Taxi.
groupRequest Int 3 Não Através dessa propriedade é possível limitar a quantidade de despesa(s) que pode ser solicitado em uma OS. Exemplo: Configurado (2). A solicitação (adiantamento ou prestação de contas) poderá ter no máximo duas despesas
plusLess String (Enum) 3 Não Propriedade para identificar se a despesa possui ou não quantidade a mais ou não em relação a quantidade já definida nas propriedade air, hotel, rental. Sendo "yes" para "+" e "no" para "-". Exemplo: yes/no
plusLessValue Int 3 Não Quantidade para mais ou menos em relação a quantidade definida nas propriedades air, hotel, rental. Exemplo: 2
plusLessUtilization String (Enum) 11 Não Específica para qual “produto” a quantidade para mais ou menos será válida em relação a configuração definida na propriedade “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Exemplo: totalAir
individualQuantity String (Enum) 3 Não Quando a despesa é configurada com essa propriedade, significa que o usuário não pode lançar duas despesas (Exemplo: Taxi) de uma vez e sim, incluir uma linha de despesa para cada item. Exemplo: Yes/No
tax Number (Decimal) 100 Não Valor do imposto da despesa. Exemplo: 115.00
category String (Enum) 16 Não Define a categoria da despesa cadastrada. Exemplo: food, hotels, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip.
kilometerValue Int 6 Não Através dessa propriedade é possível definir o valor da categoria de despesa “Percurso” (por km). Exemplo: 1.50
requiredVoucher String (Enum) 3 Não Obriga inserção do comprovante quando selecionada a despesa. Exemplo: Yes
requiredCFDI String (Enum) 3 Não Vincula despesa com o XML CFDI. Exemplo: No
refundable String (Enum) 3 Não Define se a despesa será apresentada para o usuário sempre com o padrão “reembolsável”. Exemplo: Yes/No
proven String (Enum) 3 Não Define se a despesa será apresentada para o usuário sempre com o padrão “comprovado”. Exemplo: Yes/No
costCenterId Guid 36 Não ID do centro de custo que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 Não ID do nível que a despesa está vinculada (Exemplo: Diretoria). Quando vinculada uma despesa a um nível, a mesma será apresentada somente para os usuários com os níveis definidos. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

ConfigsFormsPayments

Uma das configurações obrigatórias no Argo é o cadastro das formas de pagamento (Exemplo: Cartão de Crédito, Faturado, etc). Sem essa customização os usuários não conseguem abrir as solicitações (Aéreo, hospedagem, locação etc.). Sendo assim, a Argo disponibiliza através da sua API a possibilidade de cadastro e gerenciamento das Formas de Pagamento utilizadas nas corporações.
Argo Wiki

GET

Requisição

requisição GET

Resposta

[
    {
        "clientId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "inclusionDate": "2016-08-01T12:44:34.123",
        "finalizationDate": "2018-0720T14:09:58.413",
        "typePaymentId": "695b6c38-def5-4ef6-bf99-8cb5c855d9f",
        "billed": "no",
        "name": "aaaa (Inativo)",
        "utilization": 0,
        "active": "no",
        "service": [
            "service",
            "rental",
            "hotels",
            "air"
        ],
        "thirdParty": "no",
        "reserve": "no",
        "government": "no",
        "direct": "no",
        "manual": "no",
        "integrationCode": "argoEx",
        "changedUser": "abd5d870-82a3-4896-8652-dc5404e452fe",
        "typeTrip": "both",
        "collaborator": "yes",
        "agencyId": "00000000-0000-0000-0000-000000000000",
        "restrictive": "no",
        "cnpj": "73.432.900/0001-81",
        "alternativeUATP": "no",
        "conferma": "no",
        "agency": "no",
        "wex": "no",
        "agencyTypePaymentId": "00000000-0000-0000-0000-000000000000",
        "b2bpay": "no",
        "companyId": "3801988d-3a6f-4dda-8d81-c16e3d3c544b",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "card": "yes",
        "userCard": "no"
    }
]
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID do cliente que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora de criação da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date-Time) 24 Data/hora de finalização/cancelamento da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
typePaymentId Guid 24 ID da forma de pagamento retornada na consulta. Exemplo: 00000000-0000-0000-0000-000000000000
billed String (Enum) 3 Indica que a forma de pagamento cadastrada é “Faturado”. Exemplo: Yes/No
name String 100 Descrição da forma de pagamento. Exemplo: Faturado
utilization String (Enum) 14 Através da política FATUTI (Argo Wiki) é possível segmentar os tipos de faturamento. Através dessa propriedade é possível definir a utilização: requestOnline = Forma de pagamento utilizada para solicitações On-Line, requestOffline = Forma de pagamento utilizada para solicitações Off-Line, issueOnline = Forma de pagamento utilizada para emissões On-Line, issueOffline = Forma de pagamento utilizada para emissões Off-Line. Exemplo: issueOffline
active String (Enum) 3 Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
service String (Enum) 3 Indica para qual produto a forma de pagamento pode ser utilizada (air, hotels, rental, service, bus). Exemplo: Air
thirdParty String (Enum) 3 Indica se a forma de pagamento pode ser utilizada para funcionários terceirizados. Exemplo: Yes/No
reserve String (Enum) 3 Essa opção estará marcada quando a forma de pagamento for utilizada somente para garantia de No-Show das reservas de hospedagem. Exemplo: Yes/No
government String (Enum) 3 Indica que a forma de pagamento é “Órgão Governamental”. Exemplo: Yes/No
direct String (Enum) 3 Indica que a forma de pagamento é “Direto”. Exemplo: Yes/No
manual String (Enum) 3 Indica se a forma de pagamento foi cadastrada devido a política CADCAR (Argo Wiki). Exemplo: Yes/No
integrationCode String 8 Código de integração da forma de pagamento retornada. Exemplo: 873837
changedUser Guid 36 ID do usuário que finalizou/alterou o cadastro do pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Tipo da viagem que a forma de pagamento pode ser utilizada (both, international, domestic). Exemplo: domestic
collaborator String (Enum) 3 Indica que a forma de pagamento pode ser utilizada somente quando a viagem for para colaboradores da corporação. Exemplo: Yes/No
agencyId Guid 36 ID da agência vinculada a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Indica se a forma de pagamento é restritiva. Exemplo: Yes/No
cnpj String 14 Cadastro Nacional da Pessoa Jurídica (CNPJ) da empresa que utiliza a forma de pagamento. Exemplo: 09096135000100
alternativeUATP String (Enum) 3 UATP é um cartão utilizado para pagamento de emissões de cias aéreas especificas, sendo possível cadastrar uma forma de pagamento alternativa, caso a emissão com UATP não seja realizada com sucesso. Exemplo: Yes/No
Conferma String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Conforme). Exemplo: Yes/No
agency String (Enum) 3 Determina que a forma de pagamento será visível somente usuários da agência de viagens. Exemplo: Yes/No
wex String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Wex). Exemplo: Yes/No
agencyTypePaymentId Guid 36 ID do tipo de faturamento da agência. Exemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (B2B P@y). Exemplo: Yes/No
companyId Guid 36 ID da empresa que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID do centro de custo que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Indica que a forma de pagamento é “Cartão de Crédito”. Exemplo: Yes/No
userCard String (Enum) 3 Determina que cartão é por usuário. Exemplo: Yes/No

GET /formspayments/{formPaymentId}

Requisição

requisição GET /formspayments/{formPaymentId}
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

{
        "clientId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "inclusionDate": "2016-08-01T12:44:34.123",
        "finalizationDate": "2018-0720T14:09:58.413",
        "typePaymentId": "695b6c38-def5-4ef6-bf99-8cb5c855d9f",
        "billed": "no",
        "name": "aaaa (Inativo)",
        "utilization": 0,
        "active": "no",
        "service": [
            "service",
            "rental",
            "hotels",
            "air"
        ],
        "thirdParty": "no",
        "reserve": "no",
        "government": "no",
        "direct": "no",
        "manual": "no",
        "integrationCode": "argoEx",
        "changedUser": "abd5d870-82a3-4896-8652-dc5404e452fe",
        "typeTrip": "both",
        "collaborator": "yes",
        "agencyId": "00000000-0000-0000-0000-000000000000",
        "restrictive": "no",
        "cnpj": "73.432.900/0001-81",
        "alternativeUATP": "no",
        "conferma": "no",
        "agency": "no",
        "wex": "no",
        "agencyTypePaymentId": "00000000-0000-0000-0000-000000000000",
        "b2bpay": "no",
        "companyId": "3801988d-3a6f-4dda-8d81-c16e3d3c544b",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "card": "yes",
        "userCard": "no"
    }
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID do cliente que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora de criação da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date-Time) 24 Data/hora de finalização/cancelamento da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
typePaymentId Guid 24 ID da forma de pagamento retornada na consulta. Exemplo: 00000000-0000-0000-0000-000000000000
billed String (Enum) 3 Indica que a forma de pagamento cadastrada é “Faturado”. Exemplo: Yes/No
name String 100 Descrição da forma de pagamento. Exemplo: Faturado
utilization String (Enum) 14 Através da política FATUTI (Argo Wiki) é possível segmentar os tipos de faturamento. Através dessa propriedade é possível definir a utilização: requestOnline = Forma de pagamento utilizada para solicitações On-Line, requestOffline = Forma de pagamento utilizada para solicitações Off-Line, issueOnline = Forma de pagamento utilizada para emissões On-Line, issueOffline = Forma de pagamento utilizada para emissões Off-Line. Exemplo: issueOffline
active String (Enum) 3 Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
service String (Enum) 3 Indica para qual produto a forma de pagamento pode ser utilizada (air, hotels, rental, service, bus). Exemplo: Air
thirdParty String (Enum) 3 Indica se a forma de pagamento pode ser utilizada para funcionários terceirizados. Exemplo: Yes/No
reserve String (Enum) 3 Essa opção estará marcada quando a forma de pagamento for utilizada somente para garantia de No-Show das reservas de hospedagem. Exemplo: Yes/No
government String (Enum) 3 Indica que a forma de pagamento é “Órgão Governamental”. Exemplo: Yes/No
direct String (Enum) 3 Indica que a forma de pagamento é “Direto”. Exemplo: Yes/No
manual String (Enum) 3 Indica se a forma de pagamento foi cadastrada devido a política CADCAR (Argo Wiki). Exemplo: Yes/No
integrationCode String 8 Código de integração da forma de pagamento retornada. Exemplo: 873837
changedUser Guid 36 ID do usuário que finalizou/alterou o cadastro do pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Tipo da viagem que a forma de pagamento pode ser utilizada (both, international, domestic). Exemplo: domestic
collaborator String (Enum) 3 Indica que a forma de pagamento pode ser utilizada somente quando a viagem for para colaboradores da corporação. Exemplo: Yes/No
agencyId Guid 36 ID da agência vinculada a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Indica se a forma de pagamento é restritiva. Exemplo: Yes/No
cnpj String 14 Cadastro Nacional da Pessoa Jurídica (CNPJ) da empresa que utiliza a forma de pagamento. Exemplo: 09096135000100
alternativeUATP String (Enum) 3 UATP é um cartão utilizado para pagamento de emissões de cias aéreas especificas, sendo possível cadastrar uma forma de pagamento alternativa, caso a emissão com UATP não seja realizada com sucesso. Exemplo: Yes/No
Conferma String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Conforme). Exemplo: Yes/No
agency String (Enum) 3 Determina que a forma de pagamento será visível somente usuários da agência de viagens. Exemplo: Yes/No
wex String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Wex). Exemplo: Yes/No
agencyTypePaymentId Guid 36 ID do tipo de faturamento da agência. Exemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (B2B P@y). Exemplo: Yes/No
companyId Guid 36 ID da empresa que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID do centro de custo que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Indica que a forma de pagamento é “Cartão de Crédito”. Exemplo: Yes/No
userCard String (Enum) 3 Determina que cartão é por usuário. Exemplo: Yes/No

POST

Requisição

{
  "name": "string",
  "utilization": 0,
  "active": "yes",
  "service": [
    "air"
  ],
  "thirdParty": "yes",
  "reserve": "yes",
  "government": "yes",
  "direct": "yes",
  "manual": "yes",
  "integrationCode": "string",
  "changedUser": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both",
  "collaborator": "yes",
  "agencyId": "00000000-0000-0000-0000-000000000000",
  "restrictive": "yes",
  "cnpj": "string",
  "alternativeUATP": "yes",
  "conferma": "yes",
  "agency": "yes",
  "wex": "yes",
  "agencyTypePaymentId": "00000000-0000-0000-0000-000000000000",
  "b2bPay": "yes",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "costCenterId": "00000000-0000-0000-0000-000000000000",
  "card": "yes",
  "userCard": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
name String 100 Sim Descrição da forma de pagamento. Exemplo: Faturado
utilization String (Enum) 14 Não Através da política FATUTI (Argo Wiki) é possível segmentar os tipos de faturamento. Através dessa propriedade é possível definir a utilização: requestOnline = Forma de pagamento utilizada para solicitações On-Line, requestOffline = Forma de pagamento utilizada para solicitações Off-Line, issueOnline = Forma de pagamento utilizada para emissões On-Line, issueOffline = Forma de pagamento utilizada para emissões Off-Line. Exemplo: issueOffline
active String (Enum) 3 Não Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
service String (Enum) 3 Sim Indica para qual produto a forma de pagamento pode ser utilizada (air, hotels, rental, service, bus). Exemplo: Air
thirdParty String (Enum) 3 Não Indica se a forma de pagamento pode ser utilizada para funcionários terceirizados. Exemplo: Yes/No
reserve String (Enum) 3 Não Essa opção deverá ser marcada quando a forma de pagamento for utilizada somente para garantia de No-Show das reservas de hospedagem. Exemplo: Yes/No
government String (Enum) 3 Não Indica que a forma de pagamento é “Órgão Governamental”. Exemplo: Yes/No
direct String (Enum) 3 Não Indica que a forma de pagamento é “Direto”. Exemplo: Yes/No
manual String (Enum) 3 Não Indica se a forma de pagamento foi cadastrada devido a política CADCAR (Argo Wiki). Exemplo: Yes/No
integrationCode String 8 Não Código de integração da forma de pagamento retornada. Exemplo: 2837
changedUser Guid 36 Não ID do usuário que finalizou/alterou o cadastro do pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Não Tipo da viagem que a forma de pagamento poderá ser utilizada (both, international, domestic). Exemplo: domestic
collaborator String (Enum) 3 Não Indica que a forma de pagamento poderá ser utilizada somente quando a viagem for para colaboradores da corporação. Exemplo: Yes/No
agencyId Guid 36 Não ID da agência vinculada a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Não Indica se a forma de pagamento é restritiva. Exemplo: Yes/No
cnpj String 14 Não Cadastro Nacional da Pessoa Jurídica (CNPJ) da empresa que utilizará a forma de pagamento. Exemplo: 09096135000100
alternativeUATP String (Enum) 3 Não UATP é um cartão utilizado para pagamento de emissões de cias aéreas especificas, sendo possível cadastrar uma forma de pagamento alternativa, caso a emissão com UATP não seja realizada com sucesso. Exemplo: Yes/No
Conferma String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Conforme). Exemplo: Yes/No
agency String (Enum) 3 Não Determina que a forma de pagamento será visível somente usuários da agência de viagens. Exemplo: Yes/No
wex String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Wex). Exemplo: Yes/No
agencyTypePaymentId Guid 36 Não ID do tipo de faturamento da agência. Exemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (B2B P@y). Exemplo: Yes/No
companyId Guid 36 Não ID da empresa que a forma de pagamento será vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 Não ID do centro de custo que a forma de pagamento será vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Não Indica que a forma de pagamento é “Cartão de Crédito”. Exemplo: Yes/No
userCard String (Enum) 3 Não Determina que o cartão é por usuário. Exemplo: Yes/No

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
id Guid 36 ID do registro realizado. Exemplo: 00000000-0000-0000-0000-000000000000

PUT

Requisição

{
  "name": "string",
  "utilization": 0,
  "active": "yes",
  "service": [
    "air"
  ],
  "thirdParty": "yes",
  "reserve": "yes",
  "government": "yes",
  "direct": "yes",
  "manual": "yes",
  "integrationCode": "string",
  "changedUser": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both",
  "collaborator": "yes",
  "agencyId": "00000000-0000-0000-0000-000000000000",
  "restrictive": "yes",
  "cnpj": "string",
  "alternativeUATP": "yes",
  "conferma": "yes",
  "agency": "yes",
  "wex": "yes",
  "agencyTypePaymentId": "00000000-0000-0000-0000-000000000000",
  "b2bPay": "yes",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "costCenterId": "00000000-0000-0000-0000-000000000000",
  "card": "yes",
  "userCard": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
name String 100 Sim Descrição da forma de pagamento. Exemplo: Faturado
utilization String (Enum) 14 Não Através da política FATUTI (Argo Wiki) é possível segmentar os tipos de faturamento. Através dessa propriedade é possível definir a utilização: requestOnline = Forma de pagamento utilizada para solicitações On-Line, requestOffline = Forma de pagamento utilizada para solicitações Off-Line, issueOnline = Forma de pagamento utilizada para emissões On-Line, issueOffline = Forma de pagamento utilizada para emissões Off-Line. Exemplo: issueOffline
active String (Enum) 3 Não Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
service String (Enum) 3 Sim Indica para qual produto a forma de pagamento pode ser utilizada (air, hotels, rental, service, bus). Exemplo: Air
thirdParty String (Enum) 3 Não Indica se a forma de pagamento pode ser utilizada para funcionários terceirizados. Exemplo: Yes/No
reserve String (Enum) 3 Não Essa opção deverá ser marcada quando a forma de pagamento for utilizada somente para garantia de No-Show das reservas de hospedagem. Exemplo: Yes/No
government String (Enum) 3 Não Indica que a forma de pagamento é “Órgão Governamental”. Exemplo: Yes/No
direct String (Enum) 3 Não Indica que a forma de pagamento é “Direto”. Exemplo: Yes/No
manual String (Enum) 3 Não Indica se a forma de pagamento foi cadastrada devido a política CADCAR (Argo Wiki). Exemplo: Yes/No
integrationCode String 8 Não Código de integração da forma de pagamento retornada
changedUser Guid 36 Não ID do usuário que finalizou/alterou o cadastro do pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Não Tipo da viagem que a forma de pagamento poderá ser utilizada (both, international, domestic). Exemplo: domestic
collaborator String (Enum) 3 Não Indica que a forma de pagamento poderá ser utilizada somente quando a viagem for para colaboradores da corporação. Exemplo: Yes/No
agencyId Guid 36 Não ID da agência vinculada a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Não Indica se a forma de pagamento é restritiva. Exemplo: Yes/No
cnpj String 14 Não Cadastro Nacional da Pessoa Jurídica (CNPJ) da empresa que utilizará a forma de pagamento. Exemplo: 09096135000100
alternativeUATP String (Enum) 3 Não UATP é um cartão utilizado para pagamento de emissões de cias aéreas especificas, sendo possível cadastrar uma forma de pagamento alternativa, caso a emissão com UATP não seja realizada com sucesso. Exemplo: Yes/No
Conferma String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Conforme). Exemplo: Yes/No
agency String (Enum) 3 Não Determina que a forma de pagamento será visível somente usuários da agência de viagens. Exemplo: Yes/No
wex String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (Wex). Exemplo: Yes/No
agencyTypePaymentId Guid 36 Não ID do tipo de faturamento da agência. Exemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Não Indica se a forma de pagamento está relacionada a plataforma de geração de cartão virtual (B2B P@y). Exemplo: Yes/No
companyId Guid 36 Não ID da empresa que a forma de pagamento será vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 Não ID do centro de custo que a forma de pagamento será vinculada 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Não Indica que a forma de pagamento é “Cartão de Crédito”. Exemplo: Yes/No
userCard String (Enum) 3 Não Determina que o cartão é por usuário. Exemplo: Yes/No

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização da forma de pagamento. Exemplo: True/False

DELETE

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Example: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização da forma de pagamento. Exemplo: True/False

GET /formspayments/{formPaymentId}/codesformspayments

Requisição

requisição GET /formspayments/{formPaymentId}/codesformspayments
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
  {
    "typePaymentCodeId": "00000000-0000-0000-0000-000000000000",
    "clientId": "00000000-0000-0000-0000-000000000000",
    "typePaymentId": "00000000-0000-0000-0000-000000000000",
    "active": "yes",
    "inclusionUser": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-11-05T15:08:44.511Z",
    "changeUser": "00000000-0000-0000-0000-000000000000",
    "changeDate": "2020-11-05T15:08:44.511Z",
    "webServiceId": "string",
    "description": "string",
    "paymentCode": "string"
  }
]
Propriedade Tipo Tamanho Descrição
typePaymentCodeId Guid 36 ID do código da forma de pagamento que está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
typePaymentId Guid 24 ID da forma de pagamento retornado na consulta. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
inclusionUser Guid 36 ID do usuário que criou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora de criação da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
changeUser Guid 36 ID do usuário que finalizou/alterou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
changeDate Guid 36 Data/hora em que se finalizou/alterou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
webServiceId String 10 Identificador do WebService da forma de pagamento (Apenas para cartão virtual). Exemplo: B2BPAY, WEX, CONFERMA
description String 100 Descrição da forma de pagamento. Exemplo: Pagamento direto
paymentCode String 20 Código da forma de pagamento. Exemplo: 2B55Argo

GET /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}

Requisição

requisição GET /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Exemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Sim ID do código da forma de pagamento que está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
  {
    "typePaymentCodeId": "00000000-0000-0000-0000-000000000000",
    "clientId": "00000000-0000-0000-0000-000000000000",
    "typePaymentId": "00000000-0000-0000-0000-000000000000",
    "active": "yes",
    "inclusionUser": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-11-05T15:08:44.511Z",
    "changeUser": "00000000-0000-0000-0000-000000000000",
    "changeDate": "2020-11-05T15:08:44.511Z",
    "webServiceId": "string",
    "description": "string",
    "paymentCode": "string"
  }
]
Propriedade Tipo Tamanho Descrição
typePaymentCodeId Guid 36 ID do código da forma de pagamento que está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que a forma de pagamento está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
typePaymentId Guid 24 ID da forma de pagamento retornada na consulta. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica se a forma de pagamento está ativa ou inativa. Exemplo: Yes/No
inclusionUser Guid 36 ID do usuário que criou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Data/hora de criação da forma de pagamento. Exemplo: 2019-09-18T16:48:22.490Z
changeUser Guid 36 ID do usuário que finalizou/alterou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
changeDate Guid 36 Data/hora em que se finalizou/alterou a forma de pagamento. Exemplo: 00000000-0000-0000-0000-000000000000
webServiceId String 10 Identificador do WebService da forma de pagamento. Exemplo: MOVIDA, TREND, AMADEUSWS
description String 100 Descrição da forma de pagamento. Exemplo: Pagamento direto
paymentCode String 20 Código da forma de pagamento. Exemplo: 2B55Argo

POST /formspayments/{formPaymentId}/codesformspayments

Requisição

requisição POST /formspayments/{formPaymentId}/codesformspayments
Propriedade Tipo Tamanho Obrigatório Descrição
webServiceId String 10 Sim Identificador do WebService da forma de pagamento. Exemplo: MOVIDA, TREND, AMADEUSWS
description String 100 Não Descrição da forma de pagamento. Exemplo: Pagamento direto
paymentCode String 20 Não Código da forma de pagamento. Exemplo: 2B55Argo

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha no cadastro da forma de pagamento. Exemplo: True/False

PUT /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}

Requisição

requisição PUT /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Exemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Sim ID do código da forma de pagamento que está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
Propriedade Tipo Tamanho Obrigatório Descrição
webServiceId String 10 Sim Identificador do WebService da forma de pagamento. Exemplo: MOVIDA, TREND, AMADEUSWS
description String 100 Não Descrição da forma de pagamento. Exemplo: Pagamento direto
paymentCode String 20 Não Código da forma de pagamento. Exemplo: 2B55Argo

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na alteração da forma de pagamento. Exemplo: True/False

DELETE /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}

Requisição

requisição DELETE /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propriedade Tipo Tamanho Obrigatório Descrição
formPaymentId Guid 36 Sim ID do tipo de faturamento. Exemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Sim ID do código da forma de pagamento que está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na exclusão da forma de pagamento. Exemplo: True/False

ConfigsUsers

O serviço permite o cadastro dos usuários da corporação, assim como parametrizações que definem as características dos usuários como por exemplo (solicitante, viajante master, etc).
Argo Wiki

GET /users/{userId}

Recupera os detalhes do usuário

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID do usuário que se deseja consultar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

{
    "active": "yes",
    "userId": "00000000-0000-0000-0000-000000000000",
    "requester": "yes",
    "levelId": "00000000-0000-0000-0000-000000000000",
    "levelDescription": "string",
    "employeeId": "string",
    "integrationCode": "string",
    "changeDate": "2021-01-12T10:32:14.121Z",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "costCenterId": "00000000-0000-0000-0000-000000000000",
    "serviceCenterId": "00000000-0000-0000-0000-000000000000",
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "communityId": "00000000-0000-0000-0000-000000000000",
    "thirdParty": "yes",
    "vip": "yes",
    "masterNational": "yes",
    "masterInternational": "yes",
    "clientName": "string",
    "agencyName": "string",
    "serviceCenterDescription": "string",
    "supplierName": "string",
    "companyName": "string",
    "costCenterDescription": "string",
    "costCenterCode": "string",
    "communityName": "string",
    "language": "portugueseBR",
    "requesterMaster": "yes",
    "masterAdvancePayment": "yes",
    "masterRefund": "yes",
    "master": "yes",
    "star": "string",
    "telephone": "string",
    "fax": "string",
    "office": "string",
    "department": "string",
    "local": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "bank": "string",
    "bankBranch": "string",
    "bankAccount": "string",
    "secretaryId": "00000000-0000-0000-0000-000000000000",
    "secretaryFullName": "string",
    "secretaryEmail": "string",
    "groups": [
        "admin"
    ],
    "email": "string",
    "login": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string"
}
Propriedade Tipo Tamanho Descrição
active String (Enum) 3 Indica se o usuário esta ativo ou inativo. Exemplo: Yes/No
userId Guid 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
requester String (Enum) 3 Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários. Exemplo: Yes/No
levelId Guid 36 ID do nível vinculado ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
levelDescription String 50 Descrição do nível vinculado ao usuário. Exemplo: Presidente
employeeId String 20 Matricula do usuário. Exemplo: 464545
integrationCode String 50 Código de integração do usuário. Exemplo: 454555
changeDate String (DateTime) 24 Data da última alteração no cadastro do usuário. Exemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID da empresa vinculada ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID do Centro de Custo vinculado ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
serviceCenterId Guid 36 ID relacionado ao posto de atendimento que o usuário esta vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
supplierId Guid 36 ID do fornecedor vinculado ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
communityId Guid 36 ID da comunidade vinculada ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
thirdParty String (Enum) 3 Indica se o usuário é “terceiro”. Exemplo: Yes/No
vip String (Enum) 3 Indica se o usuário é um viajante VIP. Exemplo: Yes/No
masterNational String (Enum) 3 Indica se o usuário é um viajante master nacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterInternational String (Enum) 3 Indica se o usuário é um viajante master internacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
clientName String 50 Nome do cliente/corporação que o usuário está inserido. Exemplo: Argo Solutions
agencyName String 50 Nome da agência de viagens que o usuário está inserido. Exemplo: Argo
serviceCenterDescription String 100 Descrição do posto de atendimento que o usuário está vinculado. Exemplo: Posto de Atendimento A
supplierName String 50 Descrição do fornecedor vinculado ao usuário. Exemplo: Argo
companyName String 50 Nome da empresa vinculada ao usuário. Exemplo: Argo
costCenterDescription String 50 Descrição do centro de custo vinculado ao usuário. Exemplo: Ccusto Teste
costCenterCode String 30 Código do Centro de Custo vinculada ao usuário. Exemplo: 001
communityName String 50 Nome da comunidade vinculada ao usuário. Exemplo: Desenvolvimento
language String (Enum) 12 Idioma do usuário: portugueseBR = Português (Brasil), portuguesePT = Português (Portugal), english, spanish = Espanhol (Espanha), mexico = Espanhol (México). Exemplo: portugueseBR
peopleDeficiency String (Enum) 3 Indica se o usuário é uma pessoa com deficiência. Exemplo: Yes/No
requesterMaster String (Enum) 3 Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar viagens para outros passageiros sem que a mesma passe por aprovação. Exemplo: Yes/No
masterAdvancePayment String (Enum) 3 Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar adiantamentos sem a necessidade de aprovação. Exemplo: Yes/No
masterRefund String (Enum) 3 Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar prestação de contas/reembolso sem a necessidade de aprovação. Exemplo: Yes/No
master String (Enum) 3 Indica que o usuário é um solicitante master. Usuários com essa característica podem criar uma solicitação sem a necessidade de aprovação. Exemplo: Yes/No
star String 50 Star está relacionado ao perfil do usuário no GDS Sabre. Exemplo: SILVA/1234567
telephone String 30 Telefone do usuário. Exemplo: 5511998525545
fax String 30 Fax do usuário. Exemplo: 5511998525545
office String 50 Cargo do usuário: Exemplo: Analista de Negócios
department String 50 Departamento vinculado ao cadastro do usuário. Exemplo: Desenvolvimento
local String 50 Endereço do usuário. Exemplo: Alameda Santos, 1978
city String 50 Cidade onde reside o usuário. Exemplo: São Paulo
state String 2 Estado onde reside o usuário. Exemplo: SP
zipCode String 11 CEP onde reside o usuário. Exemplo: 36544875421
bank String 20 Banco do usuário: Exemplo: Itaú
bankBranch String 30 Agência bancária do usuário: Exemplo: 5434
bankAccount String 30 Conta bancária do usuário: Exemplo: 36555454
secretaryId Guid 36 ID da secretária vinculada ao cadastro do usuário. Exemplo: 00000000-0000-0000-0000-000000000000
secretaryFullName String 100 Nome completo da secretária vinculada ao usuário. Exemplo: Maria Silva
secretaryEmail String 256 E-mail da secretária vinculada ao usuário. Exemplo: maria@silva.com
groups String (Enum) 9 Grupo que o usuário pertence: admin, financial, manager, user (Argo Wiki). Exemplo: user
email String 100 E-mail do usuário cadastrado. Exemplo: pedro@silva.com
login String 50 Login do usuário cadastrado. Exemplo: Argo2019
firstName Strting 20 Nome do usuário cadastrado. Exemplo: Pedro
lastName String 20 Sobrenome do usuário cadastrado. Exemplo: Silva
fullName String 50 Nome completo do usuário cadastrado. Exemplo: Pedro Silva

PUT /users/{userId}

Requisição

{
    "groups": [
        "admin"
    ],
    "fax": "string",
    "office": "string",
    "requester": "yes",
    "vip": "yes",
    "masterNational": "yes",
    "masterInternational": "yes",
    "masterAdvancePayment": "yes",
    "masterRefund": "yes",
    "requesterMaster": "yes",
    "thirdParty": "yes",
    "levelDescription": "string",
    "employeeId": "string",
    "integrationCode": "string",
    "companyName": "string",
    "costCenterDescription": "string",
    "costCenterCode": "string",
    "telephone": "string",
    "department": "string",
    "local": "string",
    "city": "string",
    "star": "string",
    "state": "string",
    "active": "yes",
    "zipCode": "string",
    "secretaryEmail": "string",
    "userCompanies": [
        {
            "companyName": "string",
            "referenceCode": "string"
        }
    ],
    "levelsCostCenter": [
        {
            "level": 0,
            "company": "string",
            "code": "string",
            "description": "string"
        }
    ],
    "communityId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "login": "string",
    "password": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
groups String (Enum) 9 Sim Grupo que o usuário pertence: admin, financial, manager, user. Argo Wiki .Exemplo: user
fax String 30 Não Fax do usuário. Exemplo: 5511998525545
office String 50 Não Cargo do usuário. Exemplo: Analista de Negócios
requester String (Enum) 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários). Exemplo: Yes/No
vip String (Enum) 3 Não Indica se o usuário é um viajante VIP. Exemplo: Yes/No
masterNational String (Enum) 3 Não Indica se o usuário é um viajante master nacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterInternational String (Enum) 3 Não Indica se o usuário é um viajante master internacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterAdvancePayment String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar adiantamentos sem a necessidade de aprovação. Exemplo: Yes/No
masterRefund String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar prestação de contas/reembolso sem a necessidade de aprovação. Exemplo: Yes/No
requesterMaster String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar viagens para outros passageiros sem que a mesma passe por aprovação. Exemplo: Yes/No
thirdParty String (Enum) 3 Não Indica se o usuário é “terceiro”. Exemplo: Yes/No
levelDescription String 50 Não Descrição do nível vinculado ao usuário. Exemplo: Presidente
employeeId String 20 Não Matrícula do usuário. Exemplo: 56565
integrationCode String 50 Não Código de integração do usuário. Exemplo: 454555
companyName String 50 Não Nome da empresa vinculada ao usuário. Exemplo: Argo
costCenterDescription String 50 Não Descrição do centro de custo vinculado ao usuário. Exemplo: Ccusto Teste
costCenterCode String 30 Não Código do Centro de Custo vinculada ao usuário. Exemplo: 001
telephone String 30 Não Telefone do usuário. Exemplo: 5511998525545
department String 50 Não Departamento vinculado ao cadastro do usuário. Exemplo: Desenvolvimento
local String 50 Não Endereço do usuário. Exemplo: Alameda Santos, 1978
city String 50 Não Cidade onde reside o usuário. Exemplo: São Paulo
star String 50 Não Star está relacionado ao perfil do usuário no GDS Sabre. Exemplo: SILVA/1234567
state String 2 Não Estado onde reside o usuário. Exemplo: SP
active String (Enum) 3 Não Indica se o usuário está ativo ou inativo. Exemplo: Yes/No
zipCode String 11 Não CEP onde reside o usuário. Exemplo: 36544875421
secretaryEmail String 256 Não E-mail da secretária vinculada ao usuário. Exemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 Não Objeto responsável por transportar informações da empresa do usuário
levelsCostCenter Object (LevelCostCenterVM) 1 Não Objeto responsável por transportar informações de centro de custo vinculado ao usuário
communityId Guid 36 Não ID da comunidade vinculada ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
email String 256 Sim E-mail do usuário que será cadastrado. Exemplo: pedro@silva.com
login String 256 Sim Login do usuário que será cadastrado. Exemplo: Argo2019
password String 256 Sim Senha do usuário que será cadastrado. Exemplo: Argo2019@
firstName Strting 20 Sim Nome do usuário que será cadastrado. Exemplo: Pedro
lastName String 20 Sim Sobrenome do usuário que será cadastrado. Exemplo: Silva
fullName String 100 Sim Nome completo do usuário que será cadastrado. Exemplo: Pedro Silva
userCompanies Empresa vinculada ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
companyName String 50 Não Descrição da empresa vinculada ao usuário. Exemplo: Argo
referenceCode String 50 Não Código da empresa vinculada ao usuário. Exemplo: 4545
levelsCostCenter Níveis dos Centros de Custo vinculados ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
level Int 3 Não Nível do Centro de Custo vinculado ao usuário. Exemplo: 1
company String 50 Não Nome da empresa que o Centro de Custo está vinculado. Exemplo: Argo
code String 30 Sim Código do Centro de Custo. Exemplo: 5654
acronym String 10 Não Sigla do Centro de Custo. Exemplo: AIO52
description String 50 Sim Descrição do Centro de Custo. Exemplo: Comercial

Resposta

{
    "id": "00000000-0000-0000-0000-000000000000",
    "success": "yes",
    "message": "string"
}
Propriedade Tipo Tamanho Descrição
id Guid 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Yes = sucesso, No = Falha. Exemplo: Yes
message String 500 Mensagem apresentada quando há algum erro na atualização do usuário

GET /users

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.actives String (Boolean) 5 Não Filtro referente ao status do usuário (Ativo/Inativo) . Exemplo: True/False
filters.login string 50 Não Filtro referente ao login do usuário.

Resposta

[
    {
      "changeDate": "2021-01-12T10:32:14.160Z",
      "userId": "00000000-0000-0000-0000-000000000000",
      "login": "string",
      "fullName": "string"
    }
]
Propriedade Tipo Tamanho Descrição
changeDate String (DateTime) 24 Data da última alteração no cadastro do usuário. Exemplo: 2019-09-18T16:48:22.490Z
userId Guid 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
login String 50 Login do usuário cadastrado. Exemplo: Argo2019
fullName String 50 Nome completo do usuário cadastrado. Exemplo: Pedro Silva

POST /users

Requisição

[
    {
        "groups": [
            "admin"
        ],
        "fax": "string",
        "office": "string",
        "requester": "yes",
        "vip": "yes",
        "masterNational": "yes",
        "masterInternational": "yes",
        "masterAdvancePayment": "yes",
        "masterRefund": "yes",
        "requesterMaster": "yes",
        "thirdParty": "yes",
        "levelDescription": "string",
        "employeeId": "string",
        "integrationCode": "string",
        "companyName": "string",
        "costCenterDescription": "string",
        "costCenterCode": "string",
        "telephone": "string",
        "department": "string",
        "local": "string",
        "city": "string",
        "star": "string",
        "state": "string",
        "active": "yes",
        "zipCode": "string",
        "secretaryEmail": "string",
        "userCompanies": [
            {
                "companyName": "string",
                "referenceCode": "string"
            }
        ],
        "levelsCostCenter": [
            {
                "level": 0,
                "company": "string",
                "code": "string",
                "description": "string"
            }
        ],
        "communityId": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "login": "string",
        "password": "string",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
groups String (Enum) 9 Sim Grupo que o usuário pertence: admin, financial, manager, user. Argo Wiki .Exemplo: user
fax String 30 Não Fax do usuário. Exemplo: 5511998525545
office String 50 Não Cargo do usuário. Exemplo: Analista de Negócios
requester String (Enum) 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários). Exemplo: Yes/No
vip String (Enum) 3 Não Indica se o usuário é um viajante VIP. Exemplo: Yes/No
masterNational String (Enum) 3 Não Indica se o usuário é um viajante master nacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterInternational String (Enum) 3 Não Indica se o usuário é um viajante master internacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterAdvancePayment String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar adiantamentos sem a necessidade de aprovação. Exemplo: Yes/No
masterRefund String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar prestação de contas/reembolso sem a necessidade de aprovação. Exemplo: Yes/No
requesterMaster String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar viagens para outros passageiros sem que a mesma passe por aprovação. Exemplo: Yes/No
thirdParty String (Enum) 3 Não Indica se o usuário é “terceiro”. Exemplo: Yes/No
levelDescription String 50 Não Descrição do nível vinculado ao usuário. Exemplo: Presidente
employeeId String 20 Não Matrícula do usuário. Exemplo: 56565
integrationCode String 50 Não Código de integração do usuário. Exemplo: 454555
companyName String 50 Não Nome da empresa vinculada ao usuário. Exemplo: Argo
costCenterDescription String 50 Não Descrição do centro de custo vinculado ao usuário. Exemplo: Ccusto Teste
costCenterCode String 30 Não Código do Centro de Custo vinculada ao usuário. Exemplo: 001
telephone String 30 Não Telefone do usuário. Exemplo: 5511998525545
department String 50 Não Departamento vinculado ao cadastro do usuário. Exemplo: Desenvolvimento
local String 50 Não Endereço do usuário. Exemplo: Alameda Santos, 1978
city String 50 Não Cidade onde reside o usuário. Exemplo: São Paulo
star String 50 Não Star está relacionado ao perfil do usuário no GDS Sabre. Exemplo: SILVA/1234567
state String 2 Não Estado onde reside o usuário. Exemplo: SP
active String (Enum) 3 Não Indica se o usuário está ativo ou inativo. Exemplo: Yes/No
zipCode String 11 Não CEP onde reside o usuário. Exemplo: 36544875421
secretaryEmail String 256 Não E-mail da secretária vinculada ao usuário. Exemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 Não Objeto responsável por transportar informações da empresa do usuário
levelsCostCenter Object (LevelCostCenterVM) 1 Não Objeto responsável por transportar informações de centro de custo vinculado ao usuário
communityId Guid 36 Não ID da comunidade vinculada ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
email String 256 Sim E-mail do usuário que será cadastrado. Exemplo: pedro@silva.com
login String 256 Sim Login do usuário que será cadastrado. Exemplo: Argo2019
password String 256 Sim Senha do usuário que será cadastrado. Exemplo: Argo2019@
firstName Strting 20 Sim Nome do usuário que será cadastrado. Exemplo: Pedro
lastName String 20 Sim Sobrenome do usuário que será cadastrado. Exemplo: Silva
fullName String 100 Sim Nome completo do usuário que será cadastrado. Exemplo: Pedro Silva
userCompanies Empresa vinculada ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
companyName String 50 Não Descrição da empresa vinculada ao usuário. Exemplo: Argo
referenceCode String 50 Não Código da empresa vinculada ao usuário. Exemplo: 4545
levelsCostCenter Níveis dos Centros de Custo vinculados ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
level Int 3 Não Nível do Centro de Custo vinculado ao usuário. Exemplo: 1
company String 50 Não Nome da empresa que o Centro de Custo está vinculado. Exemplo: Argo
code String 30 Sim Código do Centro de Custo. Exemplo: 5654
acronym String 10 Não Sigla do Centro de Custo. Exemplo: AIO52
description String 50 Sim Descrição do Centro de Custo. Exemplo: Comercial

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]
Propriedade Tipo Tamanho Descrição
id Guid 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Yes = sucesso, No = Falha. Exemplo: Yes
index String (Enum) 3 Posição do elemento no array. Exemplo: 1, 2, 3
message String 500 Mensagem apresentada quando há algum erro na atualização do usuário

GET /users/{userId}/requesters

Este método tem utilidade para os clientes que possuem a política "LISSOL" habilitada em seu ambiente

Requisição

requisição GET

Resposta

[
    {
        "userId": "00000000-0000-0000-0000-000000000000",
        "userFullName": "string",
        "requesterId": "00000000-0000-0000-0000-000000000000",
        "requesterFullName": "string",
        "inclusionDate": "2021-01-13T11:13:58.661Z",
        "finalDate": "2021-01-13T11:13:58.661Z"
    }
]
Propriedade Tipo Tamanho Descrição
userId Guid 36 ID do usuário viajante. Exemplo: 00000000-0000-0000-0000-000000000000
userFullName String 50 Nome completo do usuário viajante. Exemplo: Pedro Silva
requesterId Guid 36 ID do usuário solicitante. Exemplo: 00000000-0000-0000-0000-000000000000
requesterFullName String 100 Nome completo do usuário solicitante. Exemplo: Marcos Ribeiro
inclusionDate String (DateTime) 24 Data da inclusão do vínculo entre o usuário solicitante e usuário viajante. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Data de finalização do vínculo entre o usuário solicitante e usuário viajante. Exemplo: 2019-09-18T16:48:22.490Z

PATCH /users (Obsoleto)

Este método está obsoleto e será removido futuramente. Utilize o método "PUT /users/{userId}"

Requisição

[
    {
        "userId": "00000000-0000-0000-0000-000000000000",
        "groups": [
            "admin"
        ],
        "fax": "string",
        "office": "string",
        "requester": "yes",
        "vip": "yes",
        "masterNational": "yes",
        "masterInternational": "yes",
        "masterAdvancePayment": "yes",
        "masterRefund": "yes",
        "requesterMaster": "yes",
        "thirdParty": "yes",
        "levelDescription": "string",
        "employeeId": "string",
        "integrationCode": "string",
        "companyName": "string",
        "costCenterDescription": "string",
        "costCenterCode": "string",
        "telephone": "string",
        "department": "string",
        "local": "string",
        "city": "string",
        "star": "string",
        "state": "string",
        "active": "yes",
        "zipCode": "string",
        "secretaryEmail": "string",
        "userCompanies": [
            {
                "companyName": "string",
                "referenceCode": "string"
            }
        ],
        "levelsCostCenter": [
            {
                "level": 0,
                "company": "string",
                "code": "string",
                "description": "string"
            }
        ],
        "communityId": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "login": "string",
        "password": "string",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
userId Gui 36 Sim ID do usuário que deseja alterar. Exemplo: 00000000-0000-0000-0000-000000000000
groups String (Enum) 9 Sim Grupo que o usuário pertence: admin, financial, manager, user. Argo Wiki. Exemplo: user
fax String 30 Não Fax do usuário. Exemplo: 5511998525545
office String 50 Não Cargo do usuário. Exemplo: Analista de Negócios
requester String (Enum) 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários). Exemplo: Yes/No
vip String (Enum) 3 Não Indica se o usuário é um viajante VIP. Exemplo: Yes/No
masterNational String (Enum) 3 Não Indica se o usuário é um viajante master nacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterInternational String (Enum) 3 Não Indica se o usuário é um viajante master internacional (solicitações nacionais abertas para esse tipo de usuário, não passarão por aprovação). Exemplo: Yes/No
masterAdvancePayment String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar adiantamentos sem a necessidade de aprovação. Exemplo: Yes/No
masterRefund String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar prestação de contas/reembolso sem a necessidade de aprovação. Exemplo: Yes/No
requesterMaster String (Enum) 3 Não Indica que o usuário é um solicitante master. Usuários com essa característica podem solicitar viagens para outros passageiros sem que a mesma passe por aprovação. Exemplo: Yes/No
thirdParty String (Enum) 3 Não Indica se o usuário é “terceiro”. Exemplo: Yes/No
levelDescription String 50 Não Descrição do nível vinculado ao usuário. Exemplo: Presidente
employeeId String 20 Não Matrícula do usuário. Exemplo: 56565
integrationCode String 50 Não Código de integração do usuário. Exemplo: 454555
companyName String 50 Não Nome da empresa vinculada ao usuário. Exemplo: Argo
costCenterDescription String 50 Não Descrição do centro de custo vinculado ao usuário. Exemplo: Ccusto Teste
costCenterCode String 30 Não Código do Centro de Custo vinculada ao usuário. Exemplo: 001
telephone String 30 Não Telefone do usuário. Exemplo: 5511998525545
department String 50 Não Departamento vinculado ao cadastro do usuário. Exemplo: Desenvolvimento
local String 50 Não Endereço do usuário. Exemplo: Alameda Santos, 1978
city String 50 Não Cidade onde reside o usuário. Exemplo: São Paulo
star String 50 Não Star está relacionado ao perfil do usuário no GDS Sabre. Exemplo: SILVA/1234567
state String 2 Não Estado onde reside o usuário. Exemplo: SP
active String (Enum) 3 Não Indica se o usuário está ativo ou inativo. Exemplo: Yes/No
zipCode String 11 Não CEP onde reside o usuário. Exemplo: 36544875421
secretaryEmail String 256 Não E-mail da secretária vinculada ao usuário. Exemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 Não Objeto responsável por transportar informações da empresa do usuário
levelsCostCenter Object (LevelCostCenterVM) 1 Não Objeto responsável por transportar informações de centro de custo vinculado ao usuário
communityId Guid 36 Não ID da comunidade vinculada ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
email String 256 Sim E-mail do usuário que será cadastrado. Exemplo: pedro@silva.com
login String 256 Sim Login do usuário que será cadastrado. Exemplo: Argo2019
password String 256 Sim Senha do usuário que será cadastrado. Exemplo: Argo2019@
firstName Strting 20 Sim Nome do usuário que será cadastrado. Exemplo: Pedro
lastName String 20 Sim Sobrenome do usuário que será cadastrado. Exemplo: Silva
fullName String 100 Sim Nome completo do usuário que será cadastrado. Exemplo: Pedro Silva
userCompanies Empresa vinculada ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
companyName String 50 Não Descrição da empresa vinculada ao usuário. Exemplo: Argo
referenceCode String 50 Não Código da empresa vinculada ao usuário. Exemplo: 4545
levelsCostCenter Níveis dos Centros de Custo vinculados ao usuário
Propriedade Tipo Tamanho Obrigatório Descrição
level Int 3 Não Nível do Centro de Custo vinculado ao usuário. Exemplo: 1
company String 50 Não Nome da empresa que o Centro de Custo está vinculado. Exemplo: Argo
code String 30 Sim Código do Centro de Custo. Exemplo: 5654
acronym String 10 Não Sigla do Centro de Custo. Exemplo: AIO52
description String 50 Sim Descrição do Centro de Custo. Exemplo: Comercial

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]
Propriedade Tipo Tamanho Descrição
id Guid 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Yes = sucesso, No = Falha. Exemplo: Yes
index String (Enum) 3 Posição do elemento no array. Exemplo: 1, 2, 3
message String 500 Mensagem apresentada quando há algum erro na atualização do usuário

PUT /users/{userId}/requesters

Este método tem utilidade para os clientes que possuem a política "LISSOL" habilitada em seu ambiente

Requisição

[
    {
        "requesterId": "00000000-0000-0000-0000-000000000000",
        "requesterFullName": "string",
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
requesterId Guid 36 Sim ID relacionado ao usuário solicitante. Exemplo: 00000000-0000-0000-0000-000000000000
requesterFullName String 100 Sim Nome completo do usuário solicitante. Exemplo: Marcos Ribeiro

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String 5 Sucesso ou falha na utilização do serviço. Exemplo: True/False

DELETE /users/{userId}/requesters/{requesterId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID relacionado ao usuário viajante. Exemplo: 00000000-0000-0000-0000-000000000000
requesterId Guid 36 Sim ID relacionado ao usuário solicitante. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
Message String 5 Sucesso ou falha na utilização do serviço. Exemplo: True/False

GET /users/{userId}/representatives

Recupera os delegados vinculados ao usuário

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID do usuário que se deseja consultar os delegados. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
    {
      "whoReceivesEmail": "authorizerAndRepresentatives",
      "fullName": "string",
      "representativeId": "00000000-0000-0000-0000-000000000000",
      "initialDate": "2021-01-14T10:21:17.681Z",
      "finalDate": "2021-01-14T10:21:17.682Z",
      "active": "yes"
    }
  ]
Propriedade Tipo Tamanho Descrição
whoReceivesEmail String (Enum) 28 Tipo de usuário que receberá o email da solicitação. Exemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
fullName String 50 Nome completo do delegado. Exemplo: Cléber Machado
representativeId Guid 36 ID do usuário delegado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Data da inclusão do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Data de finalização do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z
active String (Enum) 3 Indica se o delegado esta ativo ou inativo. Exemplo: Yes/No

POST /users/{userId}/representatives

Requisição

[
    {
        "whoReceivesEmail": "authorizerAndRepresentatives",
        "representativeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-01-14T10:21:17.687Z",
        "finalDate": "2021-01-14T10:21:17.687Z"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID relacionado ao usuário viajante. Exemplo: 00000000-0000-0000-0000-000000000000
whoReceivesEmail String (Enum) 28 Sim Tipo de usuário que receberá o email da solicitação. Exemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
representativeId Guid 36 Sim ID do usuário delegado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Sim Data da inclusão do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Não Data de finalização do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
Message String 5 Sucesso ou falha na utilização do serviço. Exemplo: True/False

PUT /users/{userId}/representatives

Requisição

[
    {
        "whoReceivesEmail": "authorizerAndRepresentatives",
        "representativeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-01-14T10:21:17.687Z",
        "finalDate": "2021-01-14T10:21:17.687Z"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID relacionado ao usuário viajante. Exemplo: 00000000-0000-0000-0000-000000000000
whoReceivesEmail String (Enum) 28 Sim Tipo de usuário que receberá o email da solicitação. Exemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
representativeId Guid 36 Sim ID do usuário delegado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Sim Data da inclusão do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Não Data de finalização do vínculo entre o usuário e o delegado. Exemplo: 2019-09-18T16:48:22.490Z

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String 5 Sucesso ou falha na utilização do serviço. Exemplo: True/False

DELETE /users/{userId}/representatives/{representativeId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID relacionado ao usuário. Exemplo: 00000000-0000-0000-0000-000000000000
representativeId Guid 36 Sim ID relacionado ao delegado. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
Message String 5 Sucesso ou falha na utilização do serviço. Exemplo: True/False

ConfigsUsersProfile

O serviço permite cadastrar dados do perfil de cada um dos usuários.

  • Dados bancários
  • Cartões de milhagem
  • Passaporte
  • Visto
  • Data de nascimento
  • RG/CPF

GET /users/{userId}/profile

Requisição

requisição GET

Resposta

{
    "fullName": "string",
    "rg": "string",
    "cpf": "string",
    "birthDate": "2021-01-06T10:50:11.849Z",
    "observation": "string",
    "cellPhone": "string",
    "cellPhoneDDI": 0,
    "sendHTMLEmail": "yes",
    "sendPDFFile": "yes",
    "showMap": "yes",
    "smoker": "yes",
    "dashBoard": "yes",
    "aircraftPositions": [ "front" ],
    "seat": "window",
    "departureAirportIATA": "string",
    "typeOfMeal": "string",
    "gender": "male"
}
Propriedade Tipo Tamanho Descrição
fullName String 50 Nome completo do usuário aprovador. Exemplo: João Silva
rg String 14 RG (documento nacional de identificação civil no Brasil) do usuário que cancelou a OS. Exemplo: 265487745
cpf String 14 CPF (cadastro de pessoa física no Brasil) do usuário que cancelo a OS. Exemplo: 36548425612
birthDate String (Date-Time) 10 Data de nascimento do viajante. Exemplo: 2019-11-19T17:55:32.002Z
observation String 255 Observação inserida no perfil do usuário. Exemplo: Usuário com restrições alimentares
cellPhone Int 11 Telefone do usuário. Exemplo: 236548856
cellPhoneDDI Int 4 DDI (Discagem Direta Internacional) relacionado ao telefone do usuário. Exemplo: 55
sendHTMLEmail String (Enum) 3 Define o formato HTML para envio dos e-mails. Exemplo: Yes/No
sendPDFFile String (Enum) 3 Define o formato HTML para envio dos e-mails. Exemplo: Yes/No
showMap String (Enum) 3 Determina se o usuário terá acesso ao mapa de acentos. Exemplo Yes/No
smoker String (Enum) 3 Define se o usuário é fumante. Exemplo: Yes/No
dashBoard String 3 Informação que define se o usuário utiliza o menu Dashboard no sistema. Exemplo: Yes/No
aircraftPositions String (Enum) 6 Preferência do usuário no posicionamento da aeronave. Exemplo: front, middle ou back
seat String (Enum) 6 Preferência de assento do usuário. Exemplo: window ou aisle
departureAirportIATA String 50 Aeroporto de origem usado frequentemente pelo usuário. Exemplo: Congonhas
typeOfMeal String 50 Tipo de refeição preferencial do usuário. Exemplo: Massa
gender String 6 Gênero declarado no perfil do usuário. Exemplo: 'male' ou 'female'

PUT /users/{userId}/profile

Requisição

{
    "rg": "string",
    "cpf": "string",
    "birthDate": "2021-01-06T10:50:11.856Z",
    "observation": "string",
    "cellPhone": "string",
    "cellPhoneDDI": 0,
    "sendHTMLEmail": "yes",
    "sendPDFFile": "yes",
    "showMap": "yes",
    "smoker": "yes",
    "dashBoard": "yes",
    "aircraftPositions": ["front", "middle", "back"],
    "seat": "window",
    "typeOfMeal": "string",
    "gender": "male"
    "departureAirportIATA": "string",
}
Propriedade Tipo Tamanho Obrigatório Descrição
rg String 14 Não RG (documento nacional de identificação civil no Brasil) do usuário que cancelou a OS. Exemplo: 265487745
cpf String 12 Não CPF (cadastro de pessoa física no Brasil) do usuário que cancelo a OS. Exemplo: 36548425612
birthDate String (Date-Time) 10 Não Data de nascimento do viajante. Exemplo: 2019-11-19T17:55:32.002Z
observation String 255 Não Observação inserida no perfil do usuário. Exemplo: Usuário com restrições alimentares
cellPhone Int 30 Não Telefone do usuário. Exemplo: 236548856
cellPhoneDDI Int 4 Não DDI (Discagem Direta Internacional) relacionado ao telefone do usuário. Exemplo: 55
sendHTMLEmail String (Enum) 3 Não Define o formato HTML para envio dos e-mails. Exemplo: Yes/No
sendPDFFile String (Enum) 3 Não Define o formato HTML para envio dos e-mails. Exemplo: Yes/No
showMap String (Enum) 3 Não Determina se o usuário terá acesso ao mapa de acentos. Exemplo Yes/No
smoker String (Enum) 3 Não Define se o usuário é fumante. Exemplo: Yes/No
dashBoard String 3 Não Informação que define se o usuário utiliza o menu Dashboard no sistema. Exemplo: Yes/No
aircraftPositions String (Enum) 6 Não Preferência do usuário no posicionamento da aeronave. Exemplo: front, middle ou back
seat String (Enum) Não Preferência de assento do usuário. Exemplo: window ou aisle
typeOfMeal String 50 Não Tipo de refeição preferencial do usuário. Exemplo: Massa
gender String 6 Não Gênero declarado no perfil do usuário. Exemplo: 'male' ou 'female'
departureAirportIATA String 50 Não Aeroporto de origem usado frequentemente pelo usuário. Exemplo: Congonhas

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/frequentFlyers

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "number": "string",
  "marketingAirline": "string"
}
Propriedade Tipo Tamanho Descrição
sequence Number 1 Número sequencial das milhas. Exemplo: 1, 2, 3, 4, 5 ou 6
number String 20 Valor da quantidade de milhas disponíveis. Exemplo: 265487745
marketingAirline String 3 Sigla da CIA Aérea onde as milhas estão vinculadas. Exemplo: JJ, AD, AA

PUT /users/{userId}/profile/frequentFlyers

Requisição

[{
  "sequence": 0,
  "number": "string",
  "marketingAirline": "string"
}]
Propriedade Tipo Tamanho Obrigatório Descrição
sequence Number 1 Não Número sequencial das milhas. Exemplo: 1, 2, 3, 4, 5 ou 6
number String 20 Sim Valor da quantidade de milhas disponíveis. Exemplo: 15000
marketingAirline String 3 Sim Sigla da CIA Aérea onde as milhas estão vinculadas. Exemplo: JJ, AD, AA

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/passports

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "passport": "string",
  "validity": "2021-01-06T10:50:11.867Z",
  "country": "string"
}
Propriedade Tipo Tamanho Descrição
sequence Number 1 Número sequencial dos passaportes. Exemplo: 1, 2
passport String 30 Número do passaporte. Exemplo: BR123456
validity String (DateTime) 24 Data de validade do passaporte. Exemplo: 2026-01-06T10:50:11.867Z
country String 100 País de origem do passaporte. Exemplo: Brasil

PUT /users/{userId}/profile/passports

Requisição

[{
  "sequence": 0,
  "passport": "string",
  "validity": "2021-01-06T10:50:11.867Z",
  "country": "string"
}]
Propriedade Tipo Tamanho Obrigatório Descrição
sequence Number 1 Não Número sequencial dos passaportes. Exemplo: 1, 2
passport String 30 Sim Número do passaporte. Exemplo: BR123456
validity String (DateTime) 24 Sim Data de validade do passaporte. Exemplo: 2026-01-06T10:50:11.867Z
country String 2 Sim Sigla do País de origem do passaporte. Exemplo: BR

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/visas

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "visa": "string",
  "validity": "2021-01-06T10:50:11.875Z",
  "country": "string",
  "type": "tourism"
}
Propriedade Tipo Tamanho Descrição
sequence Number 1 Número sequencial dos vistos. Exemplo: 1, 2, 3
visa String 30 Valor do visto. Exemplo: 60444378
validity String (DateTime) 24 Data de validade do visto. Exemplo: 2026-01-06T10:50:11.867Z
country String 100 País de origem do visto. Exemplo: Brasil
type String (Enum) 8 Tipo do visto. Exemplo: 'tourism', 'business'

PUT /users/{userId}/profile/visas

Requisição

[{
  "sequence": 0,
  "visa": "string",
  "validity": "2021-01-06T10:50:11.875Z",
  "country": "string",
  "type": "tourism"
}]
Propriedade Tipo Tamanho Obrigatório Descrição
sequence Number 1 Não Número sequencial dos vistos. Exemplo: 1, 2, 3
visa String 30 Sim Valor do visto. Exemplo: 60444378
validity String (DateTime) 24 Sim Data de validade do visto. Exemplo: 2026-01-06T10:50:11.867Z
country String 2 Sim Sigla do País de origem do visto. Exemplo: BR
type String (Enum) 8 Sim Tipo do visto. Exemplo: 'tourism', 'business'

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/vaccines

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "vaccine": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}
Propriedade Tipo Tamanho Descrição
sequence Number 1 Número sequencial da vacina. Exemplo: 1, 2, 3
vaccine String 30 Nome da vacina. Exemplo: Coronavac
validity String (DateTime) 24 Data de validade da vacina. Exemplo: 2026-01-06T10:50:11.867Z

PUT /users/{userId}/profile/vaccines

Requisição

[{
  "sequence": 0,
  "vaccine": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}]
Propriedade Tipo Tamanho Obrigatório Descrição
sequence Number 1 Não Número sequencial da vacina. Exemplo: 1, 2, 3
vaccine String 30 Sim Nome da vacina. Exemplo: Coronavac
validity String (DateTime) 24 Sim Data de validade da vacina. Exemplo: 2026-01-06T10:50:11.867Z

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/creditcards

Requisição

requisição GET

Resposta

[{
  "cardNumber": "string",
  "holderName": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}]
Propriedade Tipo Tamanho Descrição
cardNumber string 20 Número do cartão vinculado ao perfil do usuário. Exemplo: 0000-XXXX-XXXX-0000
holderName String 255 Nome do titular do cartão. Exemplo: CLÉBER SOARES S. OLIVEIRA
validity String (DateTime) 24 Data de validade do cartão. Exemplo: 2026-01-06T10:50:11.867Z

GET /users/{userId}/profile/expensecards

Requisição

requisição GET

Resposta

[{
    "cardId": "00000000-0000-0000-0000-000000000000",
    "cardNumber": "string",
    "inclusionDate": "2020-02-10T15:40:01.022Z",
    "flagCard": "string"
}]
Propriedade Tipo Tamanho Descrição
cardId String(Guid) 36 ID do cartão cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
cardNumber string 20 Número do cartão vinculado ao perfil do usuário. Exemplo: 0000-XXXX-XXXX-0000
inclusionDate DateTime 24 Data/hora de inclusão/criação do cartão. Exemplo: 2019-09-18T16:48:22.490Z
flag String 15 Bandeira do cartão. Exemplo: Master card, Visa

PUT /users/{userId}/profile/vaccines

Requisição

{
    "cardNumber": "string",
    "flagCard": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
cardNumber string 20 Sim Número do cartão vinculado ao perfil do usuário. Exemplo: 0000-XXXX-XXXX-0000
flag String 15 Sim Bandeira do cartão. Exemplo: Master card, Visa

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

DELETE /users/{userId}/profile/expensecards/{expenseCardId}

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
expenseCardId Guid 36 Sim ID do cartão a ser deletado. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na exclusão de um cartão. Exemplo: True/False

ConfigsCommunities

As comunidades permitem organizar grupos de usuários corporativos que precisam visualizar e/ou interagir em solicitações uns dos outros. Confira na Wiki mais detalhes e customizações das comunidades.
Argo Wiki

GET

Requisição

requisição GET

Response

[
    {
        "communityId": "802720fe-c657-47d4-9e8d-76145001da38",
        "changeDate": "2019-09-19T17:20:43.837",
        "inclusionDate": "2019-09-19T17:20:43.837",
        "clienteId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "type": "close",
        "name": "Comunidade B",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "active": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
communityId Guid 36 ID da comunidade cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000
changeDate String (Date-Time) 24 Data/hora da última alteração do cadastro da comunidade. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date-Time) 24 Data/Hora do cadastro da comunidade. Exemplo: Exemplo: 2019-09-18T16:48:22.490Z
clienteId Guid 36 ID do cliente que a comunidade esta cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Se o usuário pertencer a uma comunidade aberta, ele vai visualizar e interagir com as solicitações dos solicitantes pertencentes a mesma comunidade. Se o usuário pertencer a uma comunidade fechada, eles não vai visualizar e nem interagir com as solicitações dos solicitantes dessa comunidade. Se o usuário se relacionar com uma comunidade(S) aberta ou fechada, ele vai enxergar as solicitações dos viajantes dessa comunidade(s) porém somente enxergar, sem interação. Exemplo: open/close
name String 50 Nome da comunidade. Exemplo: Comunidade Operacional
companyId Guid 36 ID da empresa que a comunidade está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Identifica se a comunidade está ativa ou inativa. Exemplo: Yes/No

GET /communities/{communityId}

Request

Request GET /communities/{communityId}

Response

[
    {
        "communityId": "802720fe-c657-47d4-9e8d-76145001da38",
        "changeDate": "2019-09-19T17:20:43.837",
        "inclusionDate": "2019-09-19T17:20:43.837",
        "clienteId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "type": "close",
        "name": "Comunidade B",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "active": "yes"
    }
]
Property Type Size Description
communityId Guid 36 ID de comunidade registrada. Exemplo: 00000000-0000-0000-0000-000000000000
changeDate String (Date-Time) 24 Data / hora da última alteração no registro da comunidade. Exemplo: 2019-09-18T16: 48: 22.490Z
inclusionDate String (Date-Time) 24 Data / hora do registro da comunidade. Exemplo: Exemplo: 2019-09-18T16: 48: 22.490Z
clienteId Guid 36 ID do cliente com o qual a comunidade está registrada. Exemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Se o usuário pertencer a uma comunidade aberta, ele visualizará e interagirá com as solicitações de candidatos pertencentes à mesma comunidade. Se o usuário pertencer a uma comunidade fechada, ele não poderá ver ou interagir com as solicitações dos candidatos dessa comunidade. Se o usuário se relacionar com uma comunidade aberta ou fechada (S), ele verá solicitações de viajantes nessa (s) comunidade (s), mas apenas verá, sem interação. Exemplo: abrir / fechar
name String 50 Nome da comunidade. Exemplo: comunidade operacional
companyId Guid 36 ID da empresa à qual a comunidade está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Identifica se a comunidade está ativa ou inativa. Exemplo: Yes / No

POST

Requisição

{
    "type": "open",
    "name": "Comunidade API ARGO",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
type String (Enum) 5 Sim Se o usuário pertencer a uma comunidade aberta, ele vai visualizar e interagir com as solicitações dos solicitantes pertencentes a mesma comunidade. Se o usuário pertencer a uma comunidade fechada, eles não vai visualizar e nem interagir com as solicitações dos solicitantes dessa comunidade. Se o usuário se relacionar com uma comunidade(S) aberta ou fechada, ele vai enxergar as solicitações dos viajantes dessa comunidade(s) porém somente enxergar, sem interação. Exemplo: open/close
name String 50 Sim Nome da comunidade. Exemplo: Comunidade Operacional
companyId Guid 36 Não ID da empresa que a comunidade está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Identifica se a comunidade está ativa ou inativa. Exemplo: Yes/No

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a comunidade foi cadastrada com sucesso. Exemplo: True/False

PUT

Requisição

{
    "communityId": "00000000-0000-0000-0000-000000000000",
    "type": "open",
    "name": "Comunidade API ARGO",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
communityId Guid 36 Sim ID da comunidade cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Sim Se o usuário pertencer a uma comunidade aberta, ele vai visualizar e interagir com as solicitações dos solicitantes pertencentes a mesma comunidade. Se o usuário pertencer a uma comunidade fechada, eles não vai visualizar e nem interagir com as solicitações dos solicitantes dessa comunidade. Se o usuário se relacionar com uma comunidade(S) aberta ou fechada, ele vai enxergar as solicitações dos viajantes dessa comunidade(s) porém somente enxergar, sem interação. Exemplo: open/close
name String 50 Sim Nome da comunidade. Exemplo: Comunidade Operacional
companyId Guid 36 Não ID da empresa que a comunidade está vinculada. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Identifica se a comunidade está ativa ou inativa. Exemplo: Yes/No

Resposta

Response PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a comunidade foi alterada com sucesso. Exemplo: True/False

DELETE

Requisição

requisição DELETE
Propriedade Tipo Tamanho Obrigatório Descrição
communityId Guid 36 Sim ID da comunidade cadastrada. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a comunidade foi atualizada com sucesso. Exemplo: True/False

ConfigsProjects

As corporações podem realizar uma série de controle, vinculando as solicitações à projetos, tais como, controle orçamentário, política de viagens, etc. Através da API Argo é possível manter os registros dos projetos sempre atualizados. Mais informações.

GET

Requisição

requisição GET

Resposta

[
    {
        "projectId": "e23c742b-8b3a-480e-9cad-bd9a1b33f1ac",
        "clientId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "inclusionDate": "2019-11-07T17:26:25.333",
        "changeDate": "2019-11-07T17:26:25.333",
        "code": "001",
        "name": "Projeto API ARGO",
        "acronym": "ABC",
        "initialDate": "2019-11-07T00:00:00",
        "finalDate": "2019-11-30T00:00:00",
        "companyId": "a00bed32-9f2d-4748-9b0b-6c761c348ecf",
        "active": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
projectId Guid 36 ID do projeto cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID do cliente que o projeto esta vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica se o projeto está ativo ou inativo. Exemplo: Yes/No
inclusionDate String (Data-Time) 24 Data/hora de inclusão/criação do cliente. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Data-Time) 24 Data/hora da última alteração do cliente. Exemplo: 2019-09-18T16:48:22.490Z
code String 30 Código relacionado ao projeto, utilizado em algumas situações para integração com sistemas terceiros
name String 50 Nome do projeto. Exemplo: Projeto API Argo
acronym String 10 Sigla do centro de custo. Exemplo: 7829
initialDate String (Data-Time) 24 É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-30T00:00:00
companyId Guid 36 ID da empresa vinculada ao Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 O sistema Argo permite criar a relação de Projetos (Pai – Filho). Essa propriedade permite identificar o “Pai” do Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000

POST

Requisição

{
    "code": "002",
    "name": "Projeto Argo",
    "acronym": "XYZ",
    "initialDate": "2019-11-07T20:37:57.461Z",
    "finalDate": "2019-11-07T20:37:57.461Z",
    "active": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
code String 30 Sim Código relacionado ao projeto, utilizado em algumas situações para integração com sistemas terceiros
name String 50 Sim Nome do projeto. Exemplo: Projeto API Argo
acronym String 10 Não Sigla do centro de custo. Exemplo: 7829
initialDate String (Data-Time) 24 Não É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 Não É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-30T00:00:00
companyId Guid 36 Não ID da empresa vinculada ao Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 Não O sistema Argo permite criar a relação de Projetos (Pai – Filho). Essa propriedade permite identificar o “Pai” do Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Indica se o projeto está ativo ou inativo. Exemplo: Yes/No

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
ID Guis 36 ID do projeto cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000

PUT

Requisição

{
    "code": "003",
    "name": "Projeto Argo",
    "acronym": "XYZ",
    "initialDate": "2019-11-07T20:37:57.461Z",
    "finalDate": "2020-11-07T20:37:57.461Z",
    "active": "yes"
}
Propriedade Tipo Tamanho Obrigatório Descrição
projectId Guid 36 Sim ID do projeto que deseja alterar. Exemplo: 00000000-0000-0000-0000-000000000000
code String 30 Sim Código relacionado ao projeto, utilizado em algumas situações para integração com sistemas terceiros
name String 50 Sim Nome do projeto. Exemplo: Projeto API Argo
acronym String 10 Não Sigla do centro de custo. Exemplo: 7829
initialDate String (Data-Time) 24 Não É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 Não É possível determinar um período que poderá haver alocação de débito no Projeto. Poderão ser abertas somente solicitações que estiverem dentro do período definido através das propriedades initialDate e finalDate. Exemplo: 2019-11-30T00:00:00
companyId Guid 36 Não ID da empresa vinculada ao Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 Não O sistema Argo permite criar a relação de Projetos (Pai – Filho). Essa propriedade permite identificar o “Pai” do Projeto retornado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Não Indica se o projeto está ativo ou inativo. Exemplo: Yes/No

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Informa se a comunidade foi atualizada com sucesso. Exemplo: True/False

ConfigsBudgets

Através do sistema Argo é possível realizar o controle orçamentário mensal ou por pedido. O orçamento deverá sempre ser vinculado a um centro de custo e conta contábil.

Além do cadastro, é possível realizar o ajuste orçamentário (para mais ou para menos), conforme a necessidade. Confira na Wiki mais detalhes sobre orçamento.

GET /budgets

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
filters.active String (Enum) 3 Não Filtrar referente ao Status do orçamento (Ativo/Inativo). Exemplo: Yes/No.
filters.costCenterId Guid 36 Não Filtro referente ao código do centro de custo vinculado ao orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
filters.ledgerAccountId Guid 36 Não Filtro referente ao código da Conta Contábil vinculada ao orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
filters.date String (Date Time) 24 Não Filtro referente ao período em que o orçamento funcionará. Será considerado mês e ano.
filters.companyId Guid 36 Não Filtro referente ao status do campo gerencial (Ativo/Inativo). Exemplo: yes/no
filters.observation String 255 Não Filtro referente a observação do Orçamento cadastrado.Exemplo: Orçamento disponível
filters.order String 30 Não Filtro referente ao Pedido do Orçamento. Um orçamento deverá ser por Período ou por Pedido
filters.budgetedValue Number (Decimal) 100 Não Filtro referente ao valor do orçamento criado. Exemplo: 50.00

Resposta

[ 
    { 
        "budgetId": "00000000-0000-0000-0000-000000000000", 
        "active": "yes", 
        "ledgerAccountDescription": "string", 
        "costCenterDescription": "string", 
        "costCenterCode": "string", 
        "companyName": "string", 
        "inclusionDate": "2020-02-10T14:45:59.709Z", 
        "changeDate": "2020-02-10T14:45:59.709Z", 
        "finalDate": "2020-02-10T14:45:59.709Z", 
        "changeUser": "string", 
        "finalUser": "string", 
        "budgetedValue": 0, 
        "adjustedValue": 0, 
        "companyId": "00000000-0000-0000-0000-000000000000", 
        "ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
        "costCenterId": "00000000-0000-0000-0000-000000000000", 
        "observation": "string", 
        "date": "2020-02-10T14:45:59.709Z", 
        "order": "string" 
    } 
]
Propriedade Tipo Tamanho Descrição
budgetId Guid 36 ID de identificação do orçamento consultado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Status do cadastro do orçamento (Ativa/Inativa). Exemplo: Yes/No
ledgerAccountDescription String 50 Descrição da Conta Contábil. Exemplo: Materiais
costCenterDescription String 50 Descrição do centro de custo vinculado ao orçamento. Exemplo: Desenvolvimento
costCenterCode String 30 Código do Centro de Custo. Exemplo: 001
companyName String 30 Nome da Empresa. Exemplo: Argo Solutions
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do orçamento. Exemplo: 2020-02-10T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora de alteração do orçamento. Exemplo: 2020-02-10T09:48:22.490Z
finalUser String 100 Usuário que finalizou a estrutura de orçamento. Exemplo: “João Tamboré”
budgetedValue Number 14 Valor do orçamento criado. Exemplo: 50.000
adjustedValue Number 14 Valor ajustado do orçamento. Pode ser positivo ou negativo. Exemplo: -10.000
companyId Guid 36 Código da empresa vinculada ao Orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
ledgerAccountId Guid 36 Código da Conta Contábil vinculada ao orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 Código do centro de custo vinculado ao orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
observation String 255 Observação do Orçamento cadastrado.Exemplo: Orçamento disponível
date String (Date Time) 24 Período em que o orçamento funcionará. Será considerado mês e ano.
order String 30 Pedido do Orçamento. Um orçamento deverá ser por Período ou por Pedido

POST /budgets

Requisição

{ 
    "companyId": "00000000-0000-0000-0000-000000000000", 
    "ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
    "costCenterId": "00000000-0000-0000-0000-000000000000", 
    "budgetedValue": 0, 
    "observation": "string", 
    "date": "2020-02-10T13:00:03.551Z", 
    "order": "string" 
}
Propriedade Tipo Tamanho Obrigatório Descrição
companyId Guid 36 Não Código da empresa. Exemplo: 09109
ledgerAccountId Guid 36 Sim Código da Conta contábil. Exemplo 2929
costCenterId Guid 36 Sim Código do Centro de Custo. Exemplo: 001
budgetedValue Number 14 Sim Valor disponível do orçamento que está sendo criado. Exemplo 1.000
observation String 255 Não Observação do Orçamento. Aqui ficará registrado maiores detalhes do Orçamento. Exemplo: Orçamento disponível para...
date String (dateTime) 24 Não Período vigente do Orçamento. Um orçamento deverá ser por Período ou por Pedido
order String 30 Não Pedido do Orçamento. Um orçamento deverá ser por Período ou por Pedido

Resposta

Propriedade Tipo Tamanho Descrição
budgetId Guid 36 Identificado do orçamento cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000

GET /budgets/{budgetId}

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
budgetId Guid 36 Sim ID do Orçamento que se deseja consultar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

{ 
    "budgetId": "00000000-0000-0000-0000-000000000000", 
    "active": "yes", 
    "ledgerAccountDescription": "string", 
    "costCenterDescription": "string", 
    "costCenterCode": "string", 
    "companyName": "string", 
    "inclusionDate": "2020-02-08T14:37:53.19", 
    "changeDate": "2020-02-08T14:37:53.19", 
    "finalUser": "string", 
    "budgetedValue": 0, 
    "adjustedValue": 0, 
    "companyId": "00000000-0000-0000-0000-000000000000", 
    "ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
    "costCenterId": "00000000-0000-0000-0000-000000000000", 
    "observation": "string", 
    "date": "2020-03-01T00:00:00",
    "balance": 0,
    "budgetAdjusted": [
        {
            "sequence": 0,
            "adjustedValue": 0,
            "changeUser": "string",
            "inclusionDate": "2020-10-29T10:32:26.302Z",
            "observation": "string"
        }
    ]
}
Propriedade Tipo Tamanho Descrição
budgetId Guid 36 ID de identificação do orçamento consultado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Status do cadastro do orçamento (Ativo/Inativo). Exemplo: Yes/No
ledgerAccountDescription String 50 Descrição da Conta Contábil vinculado ao orçamento. Exemplo: Material
costCenterDescription String 50 Descrição do centro de custo vinculado ao orçamento. Exemplo: Desenvolvimento
costCenterCode String 30 Código do Centro de Custo vinculado ao orçamento. Exemplo: 001
companyName String 30 Nome da Empresa vinculada ao orçamento Exemplo: Argo Solutions
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do orçamento. Exemplo: 2020-02-10T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora de alteração do orçamento. Exemplo: 2020-02-10T09:48:22.490Z
finalUser String 100 Usuário que finalizou a estrutura de orçamento. Exemplo: João Tamboré
budgetedValue Number 14 Valor do orçamento cadastrado. Exemplo: 50.000
adjustedValue Number 14 Valor ajustado do orçamento. Pode ser positivo ou negativo. Exemplo: -10.000
companyId Guid 36 Código da empresa vinculada ao Orçamento. Exemplo: 00000000-0000-0000-0000-000000000000
ledgerAccountId Guid 36 Código da Conta Contábil. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID do centro de custo.Exemplo: 00000000-0000-0000-0000-000000000000
observation String 255 Observação do Orçamento criado. Exemplo: Teste
date String (Date Time) 24 Período em que o orçamento será valido. Será considerado mês e ano. Exemplo: 01/2020
balance Number (Decimal) 100 Valor do saldo atual do orçamento. Exemplo: 150.00 ou -150.00
budgetAdjusted BudgetAdjustedRSVM (Object) 1 Histórico de ajustes do orçamento
budgetAdjusted Objeto responsável por transportar as informações do histórico do orçamento
Propriedade Tipo Tamanho Descrição
sequence Number (Int) 100 Identificador do ajuste feito. Exemplo: 1, 2, 3
adjustedValue Number (Decimal) 100 Valor ajustado. Exemplo: 150.00 ou -150.00
changeUser String 255 Nome completo do usuário que fez o ajuste. Exemplo: Jorge Machado
inclusionDate String (DateTime) 24 Data de inclusção do ajuste. Exemplo: 2018-12-12T17:25:00.980
observation String 255 Observação do ajuste feito ao orçamento. Exemplo: Aumento do valor para correção de taxas

PUT /budgets/{budgetId}

Requisição

{ 
    "active": "yes", 
    "observation": "string", 
    "adjustedObservation": "string", 
    "adjustedValue": 0 
}
Propriedade Tipo Tamanho Obrigatório Descrição
active String (Enum) 3 Sim Status do cadastro do orçamento (Ativa/Inativa). Exemplo: Yes/No
observation String 255 Não Observação do orçamento que será alterado. Exemplo: orçamento teste
adjustedObservation String 255 Sim Descrição/observação do ajuste do orçamento. O Orçamento pode ser ajustado para mais ou para menos. Exemplo: Ajuste referente a março
adjustedValue Number (Decimal) 14 Sim Valor do ajuste orçamentário: Exemplo: +10.000 ou -10.000

Resposta

Propriedade Tipo Tamanho Descrição
Mensagem String 5 Sucesso ou falha na atualização da forma de pagamento. Exemplo: True/False

ConfigsCards

O sistema Argo permite ao licenciado gerenciar os catões da corporação através da API, mantendo a forma de pagamento sempre atualizada para que sejam utilizadas nas solicitações de viagem. Para mais informações sobre configurações de cartão de crédito, consulte a Wiki.

GET

Requisição

requisição GET

Resposta

[
    {
        "cardId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-02-10T15:40:01.022Z",
        "changeDate": "2020-02-10T15:40:01.022Z",
        "userId": "00000000-0000-0000-0000-000000000000",
        "user": "string",
        "flag": "string",
        "typePayment": "string",
        "community": "string",
        "userEmail": "string",
        "userLogin": "string",
        "requester": "yes",
        "cardNumber": "string",
        "securityCode": "string",
        "expirationDate": "2020-02-10T15:40:01.022Z",
        "holder": "string",
        "holderCpf": "string",
        "holderPassport": "string",
        "address": "string",
        "neighborHood": "string",
        "city": "string",
        "acronymState": "string",
        "countryCode": "string",
        "cep": "string",
        "active": "yes",
        "virtual": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
cardId String(Guid) 36 ID do cartão cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Data/hora de inclusão/criação do cartão. Exemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Data/hora da última alteração do cartão. Exemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
user String 20 Usuário do cartão cadastrado no sistema. Exemplo: Pedro
flag String 15 Bandeira do cartão. Exemplo: Master card, Visa
typePayment String 100 Tipo de pagamento vinculado ao cartão. Exemplo: Faturado
community String 50 Comunidade vinculada ao cartão. Exemplo: Equipe técnica
userEmail String 512 E-mail do usuário que o cartão está relacionado. Exemplo: useargo@argo.com
userLogin String 256 Login do usuário que o cartão está relacionado. Exemplo: argo.solutions
requester String 3 Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários. Exemplo: Yes/No
cardNumber String 50 Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
securityCode String 4 Código de segurança do cartão cadastrado. Exemplo: 658
expirationDate DateTime 24 Data de expiração do cartão cadastrado. Exemplo: 2019-09-18
holder String 50 Nome que está impresso no cartão. Exemplo: Lorenzo M. Magalhães
holderCpf String 12 CPF (Cadastro de Pessoa Física) do titular do cartão. Exemplo: 123.321.231-23
holderPassport String 15 Número do passaporte do titular do cartão. Exemplo: BR123456
address String 50 Endereço do titular do cartão cadastrado. Exemplo: Rua figueiroa barros 145
neighborHood String 30 Bairro do titular do cartão cadastrado. Exemplo: Vila das laranjeiras
city String 30 Cidade do titular do cartão cadastrado. Exemplo: São Paulo
acronymState String 2 Acrônimo/Sigla do estado do titular do cartão cadastrado no sistema. Exemplo: SP
countryCode String 3 Código do país do titular do cartão cadastrado no sistema. Exemplo: 55
cep String 11 CEP do titular do cartão cadastrado no sistema. Exemplo: 89456-818
active String(Enum) 3 Indica se o cartão está ativo ou inativo. Exemplo: Yes/No
virtual String(Enum) 3 Indica se o cartão é virtual. Exemplo: Yes/No

POST

Requisição

requisição POST
Propriedade Tipo Tamanho Obrigatório Descrição
cardId String(Guid) 36 Não ID do cartão cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Não Data/hora de inclusão/criação do cartão. Exemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Não Data/hora da última alteração do cartão. Exemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 Não ID do usuário cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
user String 20 Não Usuário do cartão cadastrado no sistema. Exemplo: Pedro
flag String 15 Não Bandeira do cartão. Exemplo: Master card, Visa
typePayment String 100 Sim Tipo de pagamento cadastrado no cartão. Exemplo: Faturado
community String 50 Não Comunidade que a estrutura de aprovação está relacionada. Exemplo: Equipe técnica
userEmail String 512 Não E-mail do usuário que o cartão está relacionado. Exemplo: useargo@argo.com
userLogin String 256 Não Login do usuário que o cartão está relacionado. Exemplo: argo.solutions
requester String 3 Não Indica se o usuário é um “solicitante” (que pode solicitar viagens para outros usuários). Exemplo: Yes/No
cardNumber String 50 Sim Número do cartão cadastrado. Exemplo: 4569-7654-9876-1678
securityCode String 3 Sim Código de segurança do cartão cadastrado. Exemplo: 658
expirationDate DateTime 24 Sim Data de expiração do cartão cadastrado. Exemplo: 2019-09-18
holder String 50 Sim Nome que está impresso no cartão. Exemplo: Lorenzo M. Magalhães
holderCpf String 12 Não CPF (Cadastro de Pessoa Física) do titular do cartão. Exemplo: 123.321.231-23
holderPassport String 15 Não Número do passaporte do titular do cartão. Exemplo: BR123456
address String 50 Não Endereço do titula do cartão cadastrado. Exemplo: Rua figueiroa barros 145
neighborHood String 30 Não Bairro do titular do cartão cadastrado. Exemplo: Vila das laranjeiras
city String 30 Não Cidade do titular do cartão cadastrado. Exemplo: São Paulo
acronymState String 2 Não Acrônimo/Sigla do estado do titular do cartão cadastrado no sistema. Exemplo: SP
countryCode String 3 Não Código do país do titular do cartão cadastrado no sistema. Exemplo: 55
cep String 11 Não CEP do titular do cartão cadastrado no sistema. Exemplo: 89456-818
active String(Enum) 3 Sim Indica se o cartão está ativo ou inativo. Exemplo: Yes/No
virtual String(Enum) 3 Sim Indica se o cartão é virtual. Exemplo: Yes/No

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

ConfigsManagementFields

Através deste método o licenciado pode obter todas as informações relacionadas aos campos gerenciais de sua base de dados, além de permitir o gerenciamento (exclusão, inserção e alteração) dos campos gerenciais encontrados nos respectivos clientes

GET /managementsfields

Requisição

requisição GET

Resposta

[
    {
        "clientId": "string",
        "expenseId": "string",
        "fieldId": "string",
        "caracterQuantity": 0,
        "finalizationDate": "string",
        "inclusionDate": "string",
        "integrationCode": "string",
        "lenght" :0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "utilization": "string",
        "visibility": "string",
    }
]
Propriedade Tipo Tamanho Descrição
clientId String 36 ID de identificação do cliente onde o campo está cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID da despesa vinculada ao campo cadastro. Exemplo: 00000000-0000-0000-0000-000000000000
fieldId String 100 ID de identificação do campo gerencial. Exemplo: sustentacao_rdg_ser_cot_auto
caracterQuantity Number (int) 100 Quantidade de caracteres do campo. Exemplo: 60
finalizationDate String 3 Data/hora de finalização do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
integrationCode String 15 Código de integração do campo gerencial (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: '12345'
length Number (int?) 100 Tamanho do campo (podendo ser nulo). Exemplo: null, 30
name String 255 Nome do campo gerencial. Exemplo: Serviço/Cotação (Atualização - Campo Tipo AutoComplete)
order Number (int) 100 Ordem do campo gerencial. Exemplo: 63
product String (Enum) 7 Tipo do produto de utilização do campo gerencial. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
regularExpression String 255 Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
required String (Enum) 3 Informação de obrigatoriedade do campo gerencial. Exemplo: Yes/No
serviceId Guid 36 ID de identificação do tipo de serviço. Exemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Chaves de serviço de atuação do campo gerencial Exemplo: 'checkin', 'departure' e 'arrival'
type String (Enum) 12 Tipo do campo gerencial. Exemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viagem que a soliciação está vinculada. Exemplo: 'both', 'international', 'domestic'
utilization String (Enum) 21 Tipo de utilização do campo gerencial. Exemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
visibility String (Enum) 3 Informação de visibilidade do campo gerencial. Exemplo: Yes/No

POST /managementsfields

Requisição

{
    "fieldId": "string",
    "typeTrip": "both",
    "caracterQuantity": 0,
    "serviceId": "00000000-0000-0000-0000-000000000000",
    "serviceKey": "checkin",
    "integrationCode": "string",
    "name": "string",
    "utilization": "expenseAdvancePayment",
    "type": "text",
    "required": "yes",
    "regularExpression": "string",
    "order": 0,
    "product": "air",
    "visibility": "yes",
    "expenseId": "00000000-0000-0000-0000-000000000000",
    "lenght": 0,
    "sequential": true
}
Propriedade Tipo Tamanho Obrigatório Descrição
fieldId String 100 Sim ID de identificação do campo gerencial. Exemplo: sustentacao_rdg_ser_cot_auto
typeTrip Number (int) 100 Não Tipo de viagem que o campo gerencial está vinculado. Exemplo: 'both', 'international', 'domestic'
caracterQuantity Number (int) 100 Não Quantidade de caracteres que serão permitidos no preenchimento do campo. Exemplo: 60
integrationCode String 15 Código de integração do campo gerencial (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: '12345'
serviceId Guid 36 Não ID de identificação do tipo de serviço. Exemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Não Chaves de serviço de atuação do campo gerencial. Exemplo: 'checkin', 'departure' e 'arrival'
integrationCode String 15 Não Código de integração do campo gerencial (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: '12345'
name String 255 Sim Nome do campo gerencial. Exemplo: Serviço/Cotação (Atualização - Campo Tipo AutoComplete)
utilization String (Enum) 21 Sim Tipo de utilização do campo gerencial. Exemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
type String (Enum) 12 Sim Tipo do campo gerencial. Exemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
required String (Enum) 3 Não Informação de obrigatoriedade do campo gerencial. Exemplo: Yes/No
regularExpression String 255 Não Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
order Number (int) 100 Sim Ordem do campo gerencial. Exemplo: 63
product String (Enum) 7 Não Tipo do produto de utilização do campo gerencial. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
visibility String (Enum) 3 Não Informação de visibilidade do campo gerencial. Exemplo: Yes/No
expenseId Guid 36 Não ID da despesa onde o campo gerencial está vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
length Number (int?) 100 Não Tamanho do campo (podendo ser nulo). Exemplo: null, 30
sequential Boolean 5 Não Valor relacionado a campos do tipo 'autocomplete'. Ele informa se os registros retornados no autocomplete serão sequenciais ou não, de acordo com a 'ordem' de cada um. Exemplo: True/False

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na inserção do campo gerencial. Exemplo: True/False

GET /managementsfields/{managementsFieldId}/values/{value}

Requisição

requisição GET

Resposta

{
    "finalizationDate": "2020-02-17T18:28:31.228Z",
    "inclusionDate": "2020-02-17T18:28:31.228Z",
    "fieldId": "string",
    "value": "string",
    "order": 0,
    "code": "string"
}
Propriedade Tipo Tamanho Descrição
finalizationDate String 3 Data/hora de finalização do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
fieldId String 100 ID de identificação do campo gerencial. Exemplo: sustentacao_rdg_ser_cot_auto
value String 50 Valor do campo gerencial. Exemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 Ordem do valor. Exemplo: 0
code String 50 Código do valor. Exemplo: SC-0500-ML02-01-07

DELETE /managementsfields/{managementsFieldId}/values/{value}

DELETE
DELETE
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na exclusão do valor do campo gerencial. Exemplo: True/False

GET /managementsfields/{managementsFieldId}/values

Requisição

requisição GET

Resposta

[
    {
        "finalizationDate": "2020-02-17T20:54:33.871Z",
        "inclusionDate": "2020-02-17T20:54:33.871Z",
        "fieldId": "string",
        "value": "string",
        "order": 0,
        "code": "string"
    }
]
Propriedade Tipo Tamanho Descrição
finalizationDate String 3 Data/hora de finalização do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
fieldId String 100 ID de identificação do campo gerencial. Exemplo: sustentacao_rdg_ser_cot_auto
value String 50 Valor do campo gerencial. Exemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 Ordem do valor. Exemplo: 0
code String 50 Código do valor. Exemplo: SC-0500-ML02-01-07

POST /managementsfields/{managementsFieldId}/values

Requisição

{
    "value": "string",
    "order": 0,
    "code": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
value String 50 Sim Valor do campo gerencial. Exemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 Não Ordem do valor. Exemplo: 0
code String 50 Não Código do valor. Exemplo: SC-0500-ML02-01-07

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na inserção do valor do campo gerencial. Exemplo: True/False

DELETE /managementsfields/{managementsFieldId}

Requisição

requisição DELETE

Resposta

resposta DELETE

GET /managementsfields/{managementsFieldId}

Requisição

requisição GET

Resposta

[
    {
        "clientId": "string",
        "expenseId": "string",
        "fieldId": "string",
        "caracterQuantity": 0,
        "finalizationDate": "string",
        "inclusionDate": "string",
        "integrationCode": "string",
        "lenght" :0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "utilization": "string",
        "visibility": "string",
    }
]
Propriedade Tipo Tamanho Descrição
clientId String 36 ID de identificação do cliente onde o campo está cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID da despesa vinculada ao campo cadastro. Exemplo: 00000000-0000-0000-0000-000000000000
fieldId String 100 ID de identificação do campo gerencial. Exemplo: sustentacao_rdg_ser_cot_auto
caracterQuantity Number (int) 100 Quantidade de caracteres do campo. Exemplo: 60
finalizationDate String 24 Data/hora de finalização do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Data/hora de inclusão/criação do valor do campo gerencial. Exemplo: 2019-09-18T16:48:22.490Z
integrationCode String 15 Código de integração do campo gerencial (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: '12345'
length Number (int?) 100 Tamanho do campo (podendo ser nulo). Exemplo: null, 30
name String 255 Nome do campo gerencial. Exemplo: Serviço/Cotação (Atualização - Campo Tipo AutoComplete)
order Number (int?) 100 Ordem do valor. Exemplo: 0
product String (Enum) 7 Tipo do produto de utilização do campo gerencial. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
regularExpression String 255 Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
required String (Enum) 3 Informação de obrigatoriedade do campo gerencial. Exemplo: Yes/No
serviceId Guid 36 ID de identificação do tipo de serviço. Exemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Chaves de serviço de atuação do campo gerencial Exemplo: 'checkin', 'departure' e 'arrival'
type String (Enum) 12 Tipo do campo gerencial. Exemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viagem que a soliciação está vinculada. Exemplo: 'both', 'international', 'domestic'
utilization String (Enum) 21 Tipo de utilização do campo gerencial. Exemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
visibility String (Enum) 3 Informação de visibilidade do campo gerencial. Exemplo: Yes/No

PUT /managementsfields/{managementsFieldId}

Requisição

[
    {
        "expenseId": "string",
        "caracterQuantity": 0,
        "integrationCode": "string",
        "lenght": 0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "visibility": "string",
        "sequential": "string",
    }
]
Propriedade Tipo Tamanho Descrição
expenseId Guid 36 ID da despesa vinculada ao campo cadastro. Exemplo: 00000000-0000-0000-0000-000000000000
caracterQuantity Number (int) 100 Quantidade de caracteres do campo. Exemplo: 60
integrationCode String 15 Código de integração do campo gerencial (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: '12345'
length Number (int?) 100 Tamanho do campo (podendo ser nulo). Exemplo: null, 30
name String 255 Nome do campo gerencial. Exemplo: Serviço/Cotação (Atualização - Campo Tipo AutoComplete)
order Number (int?) 100 Ordem do valor. Exemplo: 0
product String (Enum) 7 Tipo do produto de utilização do campo gerencial. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
regularExpression String 255 Expressão regular do campo gerencial. Exemplo: ^([0-7]{1,9})$
required String (Enum) 3 Informação de obrigatoriedade do campo gerencial. Exemplo: Yes/No
serviceId Guid 36 ID de identificação do tipo de serviço. Exemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Chaves de serviço de atuação do campo gerencial Exemplo: 'checkin', 'departure' e 'arrival'
type String (Enum) 12 Tipo do campo gerencial. Exemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viagem que a soliciação está vinculada. Exemplo: 'both', 'international', 'domestic'
visibility String (Enum) 3 Informação de visibilidade do campo gerencial. Exemplo: Yes/No
sequential Boolean 5 Não Valor relacionado a campos do tipo 'autocomplete'. Ele informa se os registros retornados no autocomplete serão sequenciais ou não, de acordo com a 'ordem' de cada um. Exemplo: True/False

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

ConfigsCities

Este método permite listar as cidades cadastradas no sistema.

GET

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
countryName String 40 Sim Nome do país. Exemplo: Brasil
cityName String 50 Sim Nome da cidade. Exemplo: São Paulo

Resposta

[
    {
        "countryId": 0,
        "cityId": 0,
        "cityName": "string",
        "stateAcronym": "string",
        "stateName": "string",
        "countryAcronym": "string",
        "countryName": "string"
    }
]
Propriedade Tipo Tamanho Descrição
countryId Number(Integer) 36 Id do país referente a cidade. Exemplo: 55
cityId Number(Integer) 36 Id da cidade. Exemplo: 16
cityName String 50 Nome da Cidade. Exemplo: Osasco
stateAcronym String 2 Acrônimo/Sigla do estado referente a cidade. Exemplo: SP
stateName String 50 Nome do estado onde a cidade está localizada. Exemplo: São Paulo
countryAcronym String 2 Acrônimo/Sigla do país referente a cidade. Exemplo: BR
countryName String 40 Nome do país referente a cidade. Exemplo: Brasil

ConfigsClients

O sistema Argo permite ao licenciado, realizar o registro dos seus clientes, assim como dados cadastrais dos mesmos. A URL será o endereço por onde o cliente acessará o sistema, essa informação virá logo após a URL da agência.

Exemplo: www.argoit.com.br/nomedaagencia/nomedocliente

GET /clients

Requisição

requisição GET

Resposta

[
    {
        "clientId": "396605df-728e-4303-be3e-272ae4fe96d7",
        "active": "yes",
        "inclusionDate": "2019-02-25T00:41:46.613",
        "changeDate": "2019-02-25T00:41:46.613",
        "corporateName": "Yvonne Jacobs",
        "tradeName": "Yvonne Jacobs",
        "country": "BR",
        "language": "portugueseBR",
        "url": "11840"
    }
]
Propriedade Tipo Tamanho Obrigatório Descrição
filters.active String (Enum) 3 Não Status do cadastro do(s) cliente(s) que deseja consultar (Ativo/Inativo). Exemplo: Yes/No
filters.corporateName String 50 Não Filtro - Descrição do nome da corporação. Exemplo: Argo Solutions
filters.tradeName String 50 Não Filtro - Nome fantasia da corporação. Exemplo: Argo
filters.country String 2 Não Filtro - Sigla do País sede da empresa. Exemplo: BR (Brasil)
filters.expense String (Enum) 3 Não Filtro – Corporações que utilizam o modulo Expense. Exemplo: Yes/No
filters.url String 20 Não Filtro - URL da corporação utilizada para acesso dos usuários. Exemplo: https://www.argoit.com.br/ URLagência / URLcliente
filters.integrationCode String 50 Não Filtro - Código que pode ser utilizado por outros sistemas no processo de integração.Exemplo: 001
filters.iata String 50 Não Filtro - Código da Associação Internacional de Transportes Aéreos. Exemplo: BWN
filters.stars String 50 Não Filtro - Dados cadastrais do cliente em globalizadores (GDS).Exemplo: PortView
filters.email String 50 Não Filtro - E-mail principal da corporação.Exemplo: useargo@argo.com
filters.currency String 3 Não Filtro - Moeda da corporação. Exemplo: BRL

POST /clients

Requisição

{
    "corporateName": "string",
    "tradeName": "string",
    "country": "string",
    "clientType": "callCenter",
    "language": "portugueseBR",
    "url": "string",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "companyRegister": "string",
    "email": "string",
    "currency": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
corporateName String 50 Sim Descrição do nome da corporação. Exemplo: Argo Solutions
tradeName String 50 Sim Nome fantasia da corporação. Exemplo: Argo
country String 2 Sim País sede da empresa. Exemplo: BR (Brasil)
clientType String (Enum) 10 Não O tipo de cliente a ser cadastrado. Exemplo: 'callCenter' ou 'Expense'
language String (Enum) 12 Sim Idioma do cliente. Exemplo: 'portugueseBR', 'portuguesePT', 'english', 'spanish', 'mexico'
url String 20 Sim URL do cliente (corporação) atendida pela agência de viagens. Exemplo: www.argo.com.br/URLdaAGÊNCIA/URLdaCORPORAÇÃO
integrationCode String 50 Não Código que pode ser utilizado por outros sistemas no processo de integração. Exemplo: 001
iata String 50 Não Código da Associação Internacional de Transportes Aéreos Exemplo: 8292
star String 50 Não Dados cadastrais do cliente em globalizadores (GDS) Exemplo: 78374ks
companyRegister String 14 Não Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente. Exemplo: 09096135000100
email String 50 Não E-mail principal da corporação. Exemplo: useargo@argo.com
currency String 3 Não Moeda da corporação. Exemplo: BRL

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
clientId String 36 ID de identificação do cliente cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000

GET /clients/{clientId}

GET
{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "active": "yes",
    "inclusionDate": "2020-02-12T14:48:05.741Z",
    "changeDate": "2020-02-12T14:48:05.741Z",
    "corporateName": "string",
    "tradeName": "string",
    "country": "string",
    "clientType": "callCenter",
    "language": "portugueseBR",
    "url": "string",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "companyRegister": "string",
    "email": "string",
    "currency": "string"
}
Propriedade Tipo Tamanho Descrição
clientId String 36 ID de identificação do cliente cadastrado. Exemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Status do cadastro do cliente (Ativo/Inativo). Exemplo: Yes/No
inclusionDate Date Time 24 Data/hora do cadastro do cliente. Exemplo: 2019-10-02T19:47:10.450Z
changeDate Date Time 24 Data da última alteração do cliente. Exemplo: 2019-10-02T19:47:10.450Z
corporateName String 50 Descrição do nome da corporação. Exemplo: Argo Solutions
tradeName String 50 Nome fantasia da corporação. Exemplo: Argo
country String 2 País sede da empresa. Exemplo: BR (Brasil)
clientType String 10 O tipo de cliente a ser cadastrado. Exemplo: callCenter ou Expense
language String (Enum) 12 Idioma do cliente. Exemplo: portugueseBR, portuguesePT, english, spanish, mexico
url String 20 URL do cliente (corporação) atendida pela agência de viagens. Exemplo: www.argo.com.br/URLdaAGÊNCIA/URLdaCORPORAÇÃO
integrationCode String 50 Código que pode ser utilizado por outros sistemas no processo de integração. Exemplo: 001
iata String 50 Código da Associação Internacional de Transportes Aéreos Exemplo: 7273
star String 50 Dados cadastrais do cliente em globalizadores (GDS) Exemplo: 7878js
companyRegister String 14 Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente. Exemplo: 09096135000100
email String 50 E-mail principal da corporação. Exemplo: useargo@argo.com
currency String 3 Moeda da corporação. Exemplo: BRL

PUT /clients/{clientId}

Requisição

{
    "active": "string",
    "corporateName": "string",
    "tradeName": "string",
    "country": "string",
    "clientType": "callCenter",
    "language": "portugueseBR",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "companyRegister": "string",
    "email": "string",
    "currency": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
active String (Enum) 3 Sim Status do cliente (Ativo/Inativo). Exemplo: yes/no
corporateName String 50 Sim Descrição do nome da corporação. Exemplo: Argo Solutions
tradeName String 50 Sim Nome fantasia da corporação. Exemplo: Argo
country String 2 Não País sede da empresa. Exemplo: BR (Brasil)
clientType String (Enum) 10 Não Tipo de ambiente. Exemplo: 'callCenter' ou 'Expense'
language String (Enum) 12 Sim Idioma do cliente. Exemplo: 'portugueseBR', 'portuguesePT', 'english', 'spanish', 'mexico'
integrationCode String 50 Não Código que pode ser utilizado por outros sistemas no processo de integração. Exemplo: 001
iata String 50 Não Código da Associação Internacional de Transportes Aéreos Exemplo: 7878
star String 50 Não Dados cadastrais do cliente em globalizadores (GDS) Exemplo: 7832732js
companyRegister String 14 Não Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente. Exemplo: 09096135000100
email String 50 Não E-mail principal da corporação. Exemplo: useargo@argo.com
currency String 3 Não Moeda da corporação. Exemplo: BRL

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String (Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

ConfigsHotels

Através deste serviço o licenciado pode obter todas as informações relacionadas aos hotéis de sua base, bem como dados relacionados aos apartamentos destes hotéis.

Por meio deste método é possível também o gerenciamento (exclusão, inserção e alteração) dos hotéis e apartamentos do ambiente.

GET /hotels

Requisição

requisição GET

Resposta

[
    {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "hotelId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-02-06T19:27:06.987Z",
        "changeDate": "2020-02-06T19:27:06.987Z",
        "active": "yes",
        "cityId": 0,
        "name": "string",
        "address": "string",
        "neighborHood": "string",
        "cep": "string",
        "telephone": "string",
        "email": "string",
        "site": "string",
        "latitude": 0,
        "longitude": 0,
        "iss": 0,
        "tourismTax": 0,
        "serviceTax": 0,
        "coffee": "yes",
        "amenities": "string",
        "stars": 0,
        "cnpj": "string",
        "image": "string"
    }
]
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora de inclusão do hotel. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração. Exemplo: 2019-09-18T16:48:22.490Z
active String 3 Status do hotel (Ativo/Inativo). Exemplo: Yes/no
cityId Int 5 ID de identificação da cidade onde está localizado o hotel. Exemplo: 44363
name String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
address String 50 Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
neighborHood String 50 Bairro de localização do Hotel. Exemplo: Meirelles
cep String 8 CEP de localização do Hotel. Exemplo: 14815000
telefone String 23 Telefone de contato do Hotel: Exemplo: +55 (16) 3343-2325
email String 50 E-mail de contato do Hotel. Exemplo: hotelsb2b@hotelsbtwob
site String 50 Site do hotel. Exemplo: http://www.hotelsbtwob.com/
latitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 255348752
longitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 485526208
iss Number (Decimal?) 100 Tarifa tributária do serviço prestado pelo Hotel. Exemplo: 5,00
tourismTax Number (Decimal?) 100 Taxa de turismo do hotel. Exemplo: 10,00
serviceTax Number (Decimal?) 100 Taxa de serviço do hotel. Exemplo: 5,00
coffee String 3 Informação de existência do serviço de café no Hotel. Exemplo yes/no
amenities String 255 Amenidades encontradas no Hotel. Exemplo: WIFI
stars Number (int) 100 Classificação do Hotel. Exemplo: 3
cnpj String 18 CNPJ do Hotel. Exemplo: 07849999000197
Image String 100 Imagem do Hotel. Exemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

POST /hotels

Requisição

{
    "active": "yes",
    "cityId": 0,
    "name": "string",
    "address": "string",
    "neighborHood": "string",
    "cep": "string",
    "telephone": "string",
    "email": "string",
    "site": "string",
    "latitude": 0,
    "longitude": 0,
    "iss": 0,
    "tourismTax": 0,
    "serviceTax": 0,
    "coffee": "yes",
    "amenities": "string",
    "stars": 0,
    "cnpj": "string",
    "image": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
active String (Enum) 3 sim Status do hotel (Ativo/Inativo). Exemplo: Yes/no
cityId Number(Int) 5 sim ID de identificação da cidade onde está localizado o hotel. Exemplo: 44363
name String 50 sim Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
address String 50 Não Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
neighborHood String 50 Não Bairro de localização do Hotel. Exemplo: Meirelles
cep String 8 Não CEP de localização do Hotel. Exemplo: 14815000
telephone String 23 Não Telefone de contato do Hotel. Exemplo: +55 (16) 3343-2325
email String 50 Não E-mail de contato do Hotel. Exemplo: hotelsb2b@hotelsbtwob
site String 50 Não Site do hotel. Exemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 Não Coordenada geográfica de localização do Hotel. Exemplo: 255348752
longitude Number (Float?) 100 Não Coordenada geográfica de localização do Hotel. Exemplo: 485526208
iss Number (Decimal?) 100 Não Tarifa tributária do serviço prestado pelo Hotel. Exemplo: 5,00
tourismTax Number (Decimal?) 100 Não Taxa de turismo do hotel. Exemplo: 10,00
serviceTax Number (Decimal?) 100 Não Taxa de serviço do hotel. Exemplo: 5,00
coffee String 3 Não Informação de existência do serviço de café no Hotel. Exemplo yes/no
amenities String 255 Não Amenidades encontradas no Hotel. Exemplo: WIFI
stars Number (int) 100 Não Classificação do Hotel. Exemplo: 3
cnpj String 18 Não CNPJ do Hotel. Exemplo: 07849999000197
image String 100 Não Imagem do Hotel. Exemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na inclusão do hotel. Exemplo: True/False

GET /hotels/{hotelId}

Requisição

requisição GET

Resposta

{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "hotelId": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-02-07T19:59:19.778Z",
    "changeDate": "2020-02-07T19:59:19.778Z",
    "active": "yes",
    "cityId": 0,
    "name": "string",
    "address": "string",
    "neighborHood": "string",
    "cep": "string",
    "telephone": "string",
    "email": "string",
    "site": "string",
    "latitude": 0,
    "longitude": 0,
    "iss": 0,
    "tourismTax": 0,
    "serviceTax": 0,
    "coffee": "yes",
    "amenities": "string",
    "stars": 0,
    "cnpj": "string",
    "image": "string"
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora de inclusão do hotel. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração do cliente. Exemplo: 2019-09-18T16:48:22.490Z
active String 3 Status do hotel (Ativo/Inativo). Exemplo: Yes/No
cityId Int 5 ID de identificação da cidade onde está localizado o hotel. Exemplo: 44363
name String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
address String 50 Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
neighborHood String 50 Bairro de localização do Hotel. Exemplo: Meirelles
cep String 8 CEP de localização do Hotel. Exemplo: 14815000
telefone String 23 Telefone de contato do Hotel: Exemplo: +55 (16) 3343-2325
email String 50 E-mail de contato do Hotel. Exemplo: hotelsb2b@hotelsbtwob
site String 50 Site do hotel. Exemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 255348752
longitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 485526208
iss Number (Decimal?) 100 Tarifa tributária do serviço prestado pelo Hotel. Exemplo: 5,00
tourismTax Number (Decimal?) 100 Taxa de turismo do hotel. Exemplo: 10,00
serviceTax Number (Decimal?) 100 Taxa de serviço do hotel. Exemplo: 5,00
coffee String 3 Informação de existência do serviço de café no Hotel. Exemplo: yes/no
amenities String 255 Amenidades encontradas no Hotel. Exemplo: WIFI
stars Number (int) 100 Classificação do Hotel. Exemplo: 3
cnpj String 18 CNPJ do Hotel. Exemplo: 07849999000197
Image String 100 Imagem do Hotel. Exemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

PUT /hotels/{hotelId}

Requisição

{
    "active": "yes",
    "cityId": 0,
    "name": "string",
    "address": "string",
    "neighborHood": "string",
    "cep": "string",
    "telephone": "string",
    "email": "string",
    "site": "string",
    "latitude": 0,
    "longitude": 0,
    "iss": 0,
    "tourismTax": 0,
    "serviceTax": 0,
    "coffee": "yes",
    "amenities": "string",
    "stars": 0,
    "cnpj": "string",
    "image": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
active String (Enum) 3 sim Status do hotel (Ativo/Inativo). Exemplo: Yes/no
cityId Number(Int) 5 sim ID de identificação da cidade onde está localizado o hotel. Exemplo: 44363
name String 50 sim Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
address String 50 Não Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
neighborHood String 50 Não Bairro de localização do Hotel. Exemplo: Meirelles
cep String 8 Não CEP de localização do Hotel. Exemplo: 14815000
telephone String 23 Não Telefone de contato do Hotel. Exemplo: +55 (16) 3343-2325
email String 50 Não E-mail de contato do Hotel. Exemplo: hotelsb2b@hotelsbtwob
site String 50 Não Site do hotel. Exemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 Não Coordenada geográfica de localização do Hotel. Exemplo: 255348752
longitude Number (Float?) 100 Não Coordenada geográfica de localização do Hotel. Exemplo: 485526208
iss Number (Decimal?) 100 Não Tarifa tributária do serviço prestado pelo Hotel. Exemplo: 5,00
tourismTax Number (Decimal?) 100 Não Taxa de turismo do hotel. Exemplo: 10,00
serviceTax Number (Decimal?) 100 Não Taxa de serviço do hotel. Exemplo: 5,00
coffee String 3 Não Informação de existência do serviço de café no Hotel. Exemplo yes/no
amenities String 255 Não Amenidades encontradas no Hotel. Exemplo: WIFI
stars Number (int) 100 Não Classificação do Hotel. Exemplo: 3
cnpj String 18 Não CNPJ do Hotel. Exemplo: 07849999000197
image String 100 Não Imagem do Hotel. Exemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização do hotel. Exemplo: True/False

DELETE /hotes/{hotelId}

Requisição

requisição DELETE

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização do hotel. Exemplo: True/False

GET /hotels/{hotelId}/apartaments

Requisição

requisição GET

Resposta

[
    {
        "apartamentId": 0,
        "clientId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-02-10T12:37:08.356Z",
        "changeDate": "2020-02-10T12:37:08.356Z",
        "inativationDate": "2020-02-10T12:37:08.356Z",
        "HotelId": "00000000-0000-0000-0000-000000000000",
        "typeApartament": "string",
        "name": "string",
        "coin": "string",
        "dailyValue": 0,
        "agencyRates": "yes",
        "netCommissionedRate": "commissioned",
        "justification": "string"
    }
]
Propriedade Tipo Tamanho Descrição
apartamentId Number (int) 100 ID de identificação do apartamento retornado. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora de inclusão do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
inativationDate String (Date Time) 24 Data/hora de inativação do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo do apartamento. Exemplo: Individual, Double, Triple ou Quadruple
name String 50 Nome do apartamento. Exemplo: standard
coin String 3 Moeda relacionada a tarifa do apartamento. Exemplo: BRL
dailyValue Number (Double) 100 Valor da diária do apartamento. Exemplo: 45,00
agencyRates String 3 Indica se o tarifário será apresentado somente para o usuário da agência de viagens. Exemplo: yes/no
netCommissionedRate String 12 Indica se a tarifa do apartamento é Net ou Comissionada. Exemplo: Net/Comissionada
Justification String 255 Justificativa quando houver alteração no tarifário de hotéis.

POST /hotels/{hotelId}/apartaments

Requisição

{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "typeApartament": "string",
    "name": "string",
    "coin": "string",
    "dailyValue": 0,
    "agencyRates": "yes",
    "netCommissionedRate": "commissioned"
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente. Exemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo do apartamento Exemplo: Individual, Double, Triple ou Quadruple
name String 50 Nome do apartamento. Exemplo: standard
coin String 3 Moeda relacionada a tarifa do apartamento. Exemplo: BRL
dailyValue Number (Double) 100 Valor da diária do apartamento. Exemplo: 45,00
agencyRates String 3 Indicar se o tarifário será apresentado somente para o usuário da agência de viagens. Exemplo: yes/no
netCommissionedRate String 12 Indicar se a tarifa do apartamento é Net ou Comissionada. Exemplo: Net/Comissionada

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na inclusão do apartamento. Exemplo: True/False

GET /hotels/{hotelId}/apartaments/{apartamentId}

Requisição

requisição GET

Resposta

{
    "apartamentId": 0,
    "clientId": "00000000-0000-0000-0000-000000000000",
    "inclusionDate": "2020-02-10T12:37:08.356Z",
    "changeDate": "2020-02-10T12:37:08.356Z",
    "inativationDate": "2020-02-10T12:37:08.356Z",
    "HotelId": "00000000-0000-0000-0000-000000000000",
    "typeApartament": "string",
    "name": "string",
    "coin": "string",
    "dailyValue": 0,
    "agencyRates": "yes",
    "netCommissionedRate": "commissioned",
    "justification": "string"
}
Propriedade Tipo Tamanho Descrição
apartamentId Number (int) 100 ID de identificação do apartamento retornado. Exemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Data/hora de inclusão do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Data/hora da última alteração do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
inativationDate String (Date Time) 24 Data/hora de inativação do apartamento. Exemplo: 2019-09-18T16:48:22.490Z
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo do apartamento. Exemplo: Double, Triple ou Quadruple
name String 50 Nome do apartamento. Exemplo: standard
coin String 3 Moeda referente ao valor da tarifa do hotel. Exemplo: BRL
dailyValue Number (Double) 100 Valor da diária do apartamento. Exemplo: 45,00
agencyRates String 3 Indica se o tarifário será apresentado somente para o usuário da agência de viagens. Exemplo: yes/no
netCommissionedRate String 12 Indica se a tarifa do apartamento é Net ou Comissionada. Exemplo: Net
Justification String 255 Justificativa quando houver alteração no tarifário de hotéis.

PUT /hotels/{hotelId}/apartaments/{apartamentId}

Requisição

{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "typeApartament": "string",
    "name": "string",
    "coin": "string",
    "dailyValue": 0,
    "agencyRates": "yes",
    "netCommissionedRate": "commissioned"
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo do apartamento Exemplo: Individual, Double, Triple ou Quadruple
name String 50 Nome do apartamento. Exemplo: standard
coin String 3 Moeda relacionada a tarifa do apartamento. Exemplo: BRL
dailyValue Number (Double) 100 Valor da diária do apartamento. Exemplo: 45,00
agencyRates String 3 Indica se o tarifário será apresentado somente para o usuário da agência de viagens. Exemplo: yes/no
netCommissionedRate String 12 Indica se a tarifa do apartamento é Net ou Comissionada. Exemplo: Net/Comissionada

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na atualização do apartamento. Exemplo: True/False

DELETE /hotels/{hotelId}/apartaments

Requisição

requisição DELETE

Resposta

resposta DELETE
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na exclusão do apartamento. Exemplo: True/False

ConfigsJustifications

O sistema Argo permite aos seus licenciados, geralmente agência de viagens, por meio do serviço ConfigsJustifications, realizar o registro de justificativas, assim como o gerenciamento delas como a busca e atualização.

GET

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
description String 100 Não Filtro relacionado as descrições registradas nas justificativas. Exemplo: Reprovação por preço elevado.
active String(Enum) 3 Não Filtro relacionado aos status das justificativas, no caso se a mesma está ativa ou não. Exemplo: Yes, No.
integrationCode String 30 Não Filtro relacionado aos códigos de integração das justificativas. Exemplo: ST002A

Resposta

[
{
     "justificationId": "00000000-0000-0000-0000-000000000000",
     "description": "string",
     "active": "yes"
}
]
Propriedade Tipo Tamanho Descrição
justificationId String(Guid) 36 ID da justificativa. Exemplo: 00000000-0000-0000-0000-000000000000
description String 100 Descrição da justificativa. Exemplo: Reprovação por preço elevado
active String(Enum) 3 Status da justificativa, no caso se ela está ativa ou não. Exemplo: yes, No

POST

Requisição

requisição POST
    {
        "typeId": "String",
        "description": "String",
        "requireDescription": "String",
        "helpDescription": "String",
        "active": "String",
        "integrationCode": "String"
    }
Propriedade Tipo Tamanho Obrigatório Descrição
typeId String 6 Sim Tipo da justificativa. Exemplo: Para exemplos seguir a tabela de tipos de Justificativas.
description String 100 Sim Descrição da justificativa. Exemplo: Reprovação por preço elevado.
requireDescription String(Enum) 3 Sim Se a justificativa obriga uma descrição. Exemplo: Yes, No
helpDescription String 255 Não Caso seja obrigatório o preenchimento da descrição, um texto de auxilio pode ser inserido para ajudar a preencher a descrição.Exemplo: Deve informar o motivo da viagem.
active String(Enum) 3 Sim Status da justificativa, no caso se ela está ativa ou não. Exemplo: yes, No
integrationCode String 30 Não Código de integração da justificativa(Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: JUSTIFICATIVA19

Resposta

response POST
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na criação de uma justificativa. Exemplo: True/False

GET /justifications/{justificationId}

Requisição

requisição GET /justifications/{justificationId}
Propriedade Tipo Tamanho Obrigatório Descrição
justificationId Guid 36 Sim ID da justificativa que o usuário deseja consultar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

    {
        "justificationId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000",
        "typeId": "string",
        "typeDescription": "string",
        "description": "string",
        "requireDescription": "yes",
        "helpDescription": "string",
        "initialDate": "2020-04-06T10:40:24.695Z",
        "active": "yes",
        "integrationCode": "string"
    }
Propriedade Tipo Tamanho Descrição
justificationId String(Guid) 36 ID da justificativa. Exemplo: 00000000-0000-0000-0000-000000000000
clientId String(Guid) 36 ID do cliente relacionado a justificativa. Exemplo: 00000000-0000-0000-0000-000000000000
typeId String 6 Tipo da justificativa. Exemplo: Para exemplos seguir a tabela de tipos de Justificativas.
typeDescription String 30 Descrição do tipo de justificativa. Exemplo: Para exemplos seguir a tabela de tipos de Justificativas.
description String 100 Descrição da justificativa. Exemplo: Reprovação por preço elevado.
requireDescription String(Enum) 3 Se a justificativa obriga uma descrição. Exemplo: Yes, No
helpDescription String 255 Caso seja obrigatório o preenchimento da descrição, um texto de auxilio pode ser inserido para ajudar a preencher a descrição.Exemplo: Deve informar o motivo da viagem.
initialDate String(DateTime) 26 Data em que a justificativa foi cadastrada. Exemplo: 2020-04-06T10:36:14.586Z
active String(Enum) 3 Status da justificativa, no caso se ela está ativa ou não. Exemplo: yes, No
integrationCode String 30 Código de integração da justificativa(Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: JUSTIFICATIVA19

PUT /justifications/{justificationId}

Requisição

requisição GET
Propriedade Tipo Tamanho Obrigatório Descrição
justificationId Guid 36 Sim ID da justificativa que o usuário deseja consultar os detalhes. Exemplo: 00000000-0000-0000-0000-000000000000
typeId String 6 Sim Tipo da justificativa. Exemplo: Para exemplos seguir a tabela de tipos de Justificativas.
description String 100 Sim Descrição da justificativa. Exemplo: Reprovação por preço elevado.
requireDescription String(Enum) 3 Sim Se a justificativa obriga uma descrição. Exemplo: Yes, No
helpDescription String 255 Não Caso seja obrigatório o preenchimento da descrição, um texto de auxilio pode ser inserido para ajudar a preencher a descrição.Exemplo: Deve informar o motivo da viagem.
active String(Enum) 3 Sim Status da justificativa, no caso se ela está ativa ou não. Exemplo: yes, No
integrationCode String 30 Não Código de integração da justificativa(Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: JUSTIFICATIVA19

Resposta

response PUT
Propriedade Tipo Tamanho Descrição
message String 4 Sucesso ou falha na alteração da justificativa. Exemplo: True/False

ConfigsLevels

O sistema Argo permite atribuir níveis aos usuários (Exemplo: Diretoria, operacional, etc). Através deste método é possível recuperar os níveis cadastrados no ambiente.

GET

Requisição

requisição GET

Resposta

[
    {
        "levelId": "00000000-0000-0000-0000-000000000000",
        "order": 0,
        "name": "String"
    }
]
Propriedade Tipo Tamanho Descrição
levelId String (Guid) 36 ID relacionado ao registro do nível do usuário. Exemplo: 00000000-0000-0000-0000-000000000000
order Integer 3 Número relacionado a ordem dos usuários, no caso de uma hierarquia. Exemplo: 1
name String 50 Nome do usuário relacionado ao nível retornado. Exemplo: Pedro Cardoso

ConfigsReasonsTravel

Através deste serviço o licenciado pode obter todas as informações relacionadas aos motivos de viagem de sua base de dados. Por meio deste serviço é possível também realizar o gerenciamento (inserção e alteração) dos motivos de viagem cadastrados no cliente.

Para maiores informações sobre motivo de viagem, consulte a Wiki.

GET

Requisição

requisição GET

Resposta

[
    {
        "reasonTravelId": "00000000-0000-0000-0000-000000000000",
        "description": "string",
        "alert": "string",
        "initialDate": "2020-02-18T14:39:42.355Z",
        "finalDate": "2020-02-18T14:39:42.355Z",
        "legs": [
            "air"
        ],
        "requiresDescription": "yes",
        "requiresAuthorization": "yes",
        "quotationAvailable": "yes",
        "allowCompanions": "yes",
        "validateExpenseReport": "yes",
        "closingCard": "yes",
        "integrationCode": "string"
    }
]
Propriedade Tipo Tamanho Descrição
reasonTravelId Guid 36 ID de identificação do motivo de viagem. Exemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descrição do motivo de viagem. Exemplo: Viagem de Patrocinadores
alert String 2000 Alguns motivos de viagem possuem alertas para dar informações internas aos que irão utilizá-lo. Exemplo: "Eu estou ciente sobre a Política Global para Viagens Corporativas Internacionais e compreendo que [...] da sua localidade caso necessário.

Estou ciente ##Aceite##"
initialDate String (Date Time) 24 Data/hora de inclusão/criação do motivo de viagem. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (Date Time) 24 Data/hora de finalização do motivo de viagem. Exemplo: 2019-09-18T16:48:22.490Z
legs String 100 Campo que representa os produtos que estão relacionados ao motivo de viagem. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 36 Informação de obrigatoriedade de descrição para utilizar o motivo de viagem. Exemplo: Yes/No
requiresAuthorization String (Enum) 3 Informação de obrigatoriedade de autorização/aprovação para utilizar o motivo de viagem. Exemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa se o motivo de viagem possui cota. Exemplo: Yes/No
allowCompanions String (Enum) 3 Informação de permissão de acompanhante ao utilizar o motivo de viagem. Exemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa se terá validação de prestação do motivo de viagem. Exemplo: Yes/No
closingCard String (Enum) 3 Campo que informa se o motivo de viagem só será apresentado no fechamento de cartão. Exemplo: Yes/No
integrationCode String 3 Código de integração do motivo de viagem (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'MOTIVO1010'

POST /reasonstravel

Requisição

{
    "description": "string",
    "alert": "string",
    "legs": [
        "air"
    ],
    "requiresDescription": "yes",
    "requiresAuthorization": "yes",
    "quotationAvailable": "yes",
    "allowCompanions": "yes",
    "validateExpenseReport": "yes",
    "closingCard": "yes",
    "integrationCode": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
description String 50 Sim Descrição do motivo de viagem. Exemplo: Viagem de Patrocinadores
alert String 2000 Não Alguns motivos de viagem possuem alertas para dar informações internas aos que irão utilizá-lo. Exemplo: "Eu estou ciente sobre a Política Global para Viagens Corporativas Internacionais e compreendo que [...] da sua localidade caso necessário.

Estou ciente ##Aceite##"
legs String 100 Sim Campo que representa os produtos vinculados ao motivo de viagem. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 Não Informação de obrigatoriedade de descrição para utilizar o motivo de viagem. Exemplo: Yes/No
requiresAuthorization String (Enum) 3 Não Informação de obrigatoriedade de autorização para utilizar o motivo de viagem. Exemplo: Yes/No
quotationAvailable String (Enum) 3 Não Campo que informa se o motivo de viagem possui cota. Exemplo: Yes/No
allowCompanions String (Enum) 3 Não Informação de permissão de acompanhante ao utilizar o motivo de viagem. Exemplo: Yes/No
validateExpenseReport String (Enum) 3 Não Campo que informa se terá validação de prestação do motivo de viagem. Exemplo: Yes/No
closingCard String (Enum) 3 Não Campo que informa se o motivo de viagem só será apresentado no fechamento de cartão. Exemplo: Yes/No
integrationCode String 3 Não Código de integração do motivo de viagem (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'MOTIVO1010'

Resposta

Propriedade Tipo Tamanho Descrição
reasonTravelId Guid 36 ID de identificação do motivo de viagem. Exemplo: 00000000-0000-0000-0000-000000000000

GET /reasonstravel/{reasonTravelId}

Requisição

requisição GET

Resposta

{
    "reasonTravelId": "00000000-0000-0000-0000-000000000000",
    "description": "string",
    "alert": "string",
    "initialDate": "2020-02-18T19:37:36.697Z",
    "finalDate": "2020-02-18T19:37:36.697Z",
    "legs": [
        "air"
    ],
    "requiresDescription": "yes",
    "requiresAuthorization": "yes",
    "quotationAvailable": "yes",
    "allowCompanions": "yes",
    "validateExpenseReport": "yes",
    "closingCard": "yes",
    "integrationCode": "string"
}
Propriedade Tipo Tamanho Descrição
reasonTravelId Guid 36 ID de identificação do motivo de viagem. Exemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descrição do motivo de viagem. Exemplo: Viagem de Patrocinadores
alert String 2000 Alguns motivos de viagem possuem alertas para informações internas aos que irão utilizá-lo. Exemplo: "Eu estou ciente sobre a Política Global para Viagens Corporativas Internacionais e compreendo que [...] da sua localidade caso necessário.

Estou ciente ##Aceite##"
initialDate String (Date Time) 24 Data/hora de inclusão/criação do motivo de viagem. Exemplo: 2019-09-18T16:48:22.490Z
finalDate String (Date Time) 24 Data/hora de finalização do motivo de viagem. Exemplo: 2019-09-18T16:48:22.490Z
legs String 100 Campo que representa os produtos vinculados ao motivo de viagem. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 Informação de obrigatoriedade de descrição para utilizar o motivo de viagem. Exemplo: Yes/No
requiresAuthorization String (Enum) 3 Informação de obrigatoriedade de autorização para utilizar o motivo de viagem. Exemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa se o motivo de viagem possui cota. Exemplo: Yes/No
allowCompanions String (Enum) 3 Informação de permissão de acompanhante ao utilizar o motivo de viagem. Exemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa se terá validação de prestação do motivo de viagem. Exemplo: Yes/No
closingCard String (Enum) 3 Campo que informa se o motivo de viagem será apresentado somente no fechamento de cartão. Exemplo: Yes/No
integrationCode String 3 Código de integração do motivo de viagem (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'MOTIVO1010'

PUT /reasonstravel/{reasonTravelId}

Requisição

{
    "description": "string",
    "alert": "string",
    "legs": [
        "air"
    ],
    "requiresDescription": "yes",
    "requiresAuthorization": "yes",
    "quotationAvailable": "yes",
    "allowCompanions": "yes",
    "validateExpenseReport": "yes",
    "closingCard": "yes",
    "integrationCode": "string"
}
Propriedade Tipo Tamanho Descrição
description String 50 Descrição do motivo de viagem. Exemplo: Viagem de Patrocinadores
alert String 2000 Alguns motivos de viagem possuem alertas para informações internas aos que irão utilizá-lo. Exemplo: "Eu estou ciente sobre a Política Global para Viagens Corporativas Internacionais e compreendo que [...] da sua localidade caso necessário.

Estou ciente ##Aceite##"
legs String 100 Campo que representa os produtos permitidos para o uso do motivo de viagem. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 Informação de obrigatoriedade de descrição para utilizar o motivo de viagem. Exemplo: Yes/No
requiresAuthorization String (Enum) 3 Informação de obrigatoriedade de autorização para utilizar o motivo de viagem. Exemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa se o motivo de viagem possui cota. Exemplo: Yes/No
allowCompanions String (Enum) 3 Informação de permissão de acompanhante ao utilizar o motivo de viagem. Exemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa se terá validação de prestação do motivo de viagem. Exemplo: Yes/No
closingCard String (Enum) 3 Campo que informa se o motivo de viagem será apresentado somente no fechamento de cartão. Exemplo: Yes/No
integrationCode String 3 Código de integração do motivo de viagem (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'MOTIVO1010'

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na alteração do campo gerencial. Exemplo: True/False

Requests

Através deste serviço o licenciado pode obter todas as informações relacionadas as solicitações.

GET /requests

Requisição

requisição GET /requests
Propriedade Tipo Tamanho Obrigatório Descrição
filters.approverId Guid 100 Não ID de identificação do aprovador da solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
filters.tripStatus String (Enum) 36 Não Status da viagem da requisição. Exemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
filters.expenseStatus String (Enum) 24 Não Status de expense da requisição. Exemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'
filters.datesFilters String 15 Não Tipo de data na qual os campos 'Initial Date' e 'Final Date' serão usados para fazer a consulta.
Exemplo: 'approvalDate', 'quotationDate', 'issueDate', 'selectionDate', 'tripInitialDate', 'tripEndDate', 'requestDate'
filters.initialDate String (Date Time) 24 Não Data inicial do filtro de datas, será a data inicial do tipo de data escolhido no filtro 'datesFilters'.
Obs: Passa a ser obrigatório caso escolhido um valor do campo 'datesFilters'.
Exemplo: 2019-09-18
filters.initialChangeDate String (Date Time) 24 Não Data/hora inicial da alteração da solicitação. Exemplo: 2019-09-18
filters.finalChangeDate String (Date Time) 24 Não Data/hora final da alteração da solicitação. Exemplo: 2019-09-18
filters.initialApprovationDate String (Date Time) 24 Não Data/hora inicial da aprovação da solicitação. Exemplo: 2019-09-18
filters.finalApprovationDate String (Date Time) 24 Não Data/hora final da aprovação da solicitação. Exemplo: 2019-09-18
filters.initialApprovationRefundDate String (Date Time) 24 Não Data/hora inicial da aprovação do reembolso da solicitação. Exemplo: 2019-09-18
filters.finalApprovationRefundDate String (Date Time) 24 Não Data/hora final da aprovação do reembolso da solicitação. Exemplo: 2019-09-18
filters.finalDate String (Date Time) 24 Não Data final do filtro de datas, será a data final do tipo de data escolhido no filtro 'datesFilters'.
Obs: Passa a ser obrigatório caso escolhido um valor do campo 'datesFilters'.
Exemplo: 2019-09-18
filters.requestNumber Number 20 Não Número da solicitação específica para ser recuperada.
filters.page String (Enum) 100 Não Página solicitada para a recuperação das informações das solicitações. Exemplo: 2
filters.products String (Enum) 15 Não Tipo de produto da solicitação. Exemplo: 'air', 'hotels', 'rental', 'road', 'advancedPayment', 'refund'

Resposta

[
  {
    "amountFlights": 0,
    "amountHotels": 0,
    "amountRentals": 0,
    "amountBus": 0,
    "amountServices": 0,
    "amountAdvancePayments": 0,
    "amountRefunds": 0,
    "amountFlightsNationalOnline": 0,
    "amountFlightsNationalOffline": 0,
    "amountFlightsInternationalOnline": 0,
    "amountFlightsInternationalOffline": 0,
    "amountHotelsNationalOnline": 0,
    "amountHotelsNationalOffline": 0,
    "amountHotelsInternationalOnline": 0,
    "amountHotelsInternationalOffline": 0,
    "amountRentalsNationalOnline": 0,
    "amountRentalsNationalOffline": 0,
    "amountRentalsInternationalOnline": 0,
    "amountRentalsInternationalOffline": 0,
    "amountBusNationalOnline": 0,
    "amountBusNationalOffline": 0,
    "amountBusInternationalOnline": 0,
    "amountBusInternationalOffline": 0,
    "requestId": "00000000-0000-0000-0000-000000000000",
    "requestNumber": 0,
    "tripStatus": "open",
    "expenseStatus": "awaitingIssue"
    "advancePaymentStatus": "finalized"
  }
]
Propriedade Tipo Tamanho Descrição
amountFlights Number (int) 100 Quantidade de voos da solicitação. Exemplo: 2
amountHotels Number (int) 100 Quantidade de hoteis da solicitação. Exemplo: 2
amountRentals Number (int) 100 Quantidade de locações da solicitação. Exemplo: 2
amountBus Number (int) 100 Quantidade de rodoviários da solicitação. Exemplo: 2
amountServices Number (int) 100 Quantidade de serviços da solicitação. Exemplo: 2
amountAdvancePayments Number (int) 100 Quantidade de pagamentos adiantadas da solicitação. Exemplo: 2
amountRefunds Number (int) 100 Quantidade de reembolsos da solicitação. Exemplo: 2
amountFlightsNationalOnline Number (int) 100 Quantidade de voos nacionais onlines solicitação. Exemplo: 2
amountFlightsNationalOffline Number (int) 100 Quantidade de voos nacionais offlines solicitação. Exemplo: 2
amountFlightsInternationalOnline Number (int) 100 Quantidade de voos internacionais onlines solicitação. Exemplo: 2
amountFlightsInternationalOffline Number (int) 100 Quantidade de voos internacionais offlines solicitação. Exemplo: 2
amountHotelsNationalOnline Number (int) 100 Quantidade de hotéis nacionais onlines solicitação. Exemplo: 2
amountHotelsNationalOffline Number (int) 100 Quantidade de hotéis nacionais offlines solicitação. Exemplo: 2
amountHotelsInternationalOnline Number (int) 100 Quantidade de hotéis internacionais onlines solicitação. Exemplo: 2
amountHotelsInternationalOffline Number (int) 100 Quantidade de hotéis internacionais offlines solicitação. Exemplo: 2
amountRentalsNationalOnline Number (int) 100 Quantidade de locações nacionais onlines solicitação. Exemplo: 2
amountRentalsNationalOffline Number (int) 100 Quantidade de locações nacionais offlines solicitação. Exemplo: 2
amountRentalsInternationalOnline Number (int) 100 Quantidade de locações internacionais onlines solicitação. Exemplo: 2
amountRentalsInternationalOffline Number (int) 100 Quantidade de locações internacionais offlines solicitação. Exemplo: 2
amountBusNationalOnline Number (int) 100 Quantidade de rodoviários nacionais onlines solicitação. Exemplo: 2
amountBusNationalOffline Number (int) 100 Quantidade de rodoviários nacionais offlines solicitação. Exemplo: 2
amountBusInternationalOnline Number (int) 100 Quantidade de rodoviários internacionais onlines solicitação. Exemplo: 2
amountBusInternationalOffline Number (int) 100 Quantidade de rodoviários internacionais offlines solicitação. Exemplo: 2
requestId Guid 36 ID de identificação da requisição retornada. Exemplo: 00000000-0000-0000-0000-000000000000
requestNumber Number (int) 100 Número da requisição retornada. Exemplo: 50
tripStatus String 32 Status da viagem da requisição. Exemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
expenseStatus String 20 Status de expense da requisição. Exemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'
advancePaymentStatus String 32 Status do adiantamento da requisição. Exemplo: 'saved', 'awaitingQuotation', 'awaitingSelection', 'awaitingApproval', 'awaitingPayment', 'finalized'

GET /requests/{requestId}

Requisição

requisição GET

Resposta

{
  "agency": "string",
  "agencyCode": "string",
  "selfTicket": "yes",
  "selfBook": "yes",
  "typeTrip": "both",
  "tripRefunded": "yes",
  "country": "string",
  "reasonTraveling": "string",
  "authorizationCode": "string",
  "tripInitialDate": "2020-02-26T23:50:22.496Z",
  "tripFinalDate": "2020-02-26T23:50:22.496Z",
  "expirationDate": "2020-02-26T23:50:22.496Z",
  "quotationDate": "2020-02-26T23:50:22.496Z",
  "emissionDate": "2020-02-26T23:50:22.496Z",
  "selectionDate": "2020-02-26T23:50:22.496Z",
  "requestDate": "2020-02-26T23:50:22.496Z",
  "approvalMeritDate": "2020-02-26T23:50:22.496Z",
  "approvalCostDate": "2020-02-26T23:50:22.496Z",
  "observation": "string",
  "conferenceRefundDate": "2020-02-26T23:50:22.496Z",
  "approvalRefundDate": "2020-02-26T23:50:22.496Z",
  "paymentRefundDate": "2020-02-26T23:50:22.496Z",
  "tripCancellationDate": "2020-02-26T23:50:22.496Z",
  "creditAdvancePaymentDate": "2020-02-26T23:50:22.496Z",
  "parentRequestId": "00000000-0000-0000-0000-000000000000",
  "parentRequestNumber": 0,
  "requestId": "00000000-0000-0000-0000-000000000000",
  "requestNumber": 0,
  "tripStatus": "open",
  "expenseStatus": "awaitingIssue"
}
Propriedade Tipo Tamanho Descrição
agency String 50 Nome da agência (razão) da solicitação. Exemplo: RWRD SC
agencyCode String 50 Código de integração da agência. Exemplo: rwrd-sc
selfTicket String 3 Campo que indica se a solicitação é um 'SelfTicket' ou não. Exemplo: Yes/No
selfBook String 3 Campo que indica se a solicitação é um 'SelfBook' ou não. Exemplo: Yes/No
typeTrip String (Enum) 14 Tipo de viagem que a soliciação está vinculada. Exemplo: 'both', 'international', 'domestic'
tripRefunded String 3 Campo que indica se a solicitação foi reembolsada. Exemplo: Yes/No
country String 255 Nome do País da solicitação. Exemplo: Brasil
reasonTraveling String 255 Descrição do motivo de viagem da solicitação. Exemplo: Missão
authorizationCode String 255 Código de autorização da solicitação. Exemplo: PEC 251735131839.6618.4280
tripInitialDate String (Date Time) 24 Data inicial da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
tripFinalDate String (Date Time) 24 Data final da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
expirationDate String (Date Time) 24 Data de expiração da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
quotationDate String (Date Time) 24 Data da cotação da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
emissionDate String (Date Time) 24 Data da emissão da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
selectionDate String (Date Time) 24 Data da seleção da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
requestDate String (Date Time) 24 Data da inserção da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
approvalMeritDate String (Date Time) 24 Data de aprovação do mérito da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
approvalCostDate String (Date Time) 24 Data de aprovação do custo da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
observation String 50 Observação da solicitação. Exemplo: A tarifa do hotel deve ser com desconto.
conferenceRefundDate String (Date Time) 24 Data de conferência do reembolso da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
approvalRefundDate String (Date Time) 24 Data de aprovação do reembolso da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
paymentRefundDate String (Date Time) 24 Data do pagamento do reembolso da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
tripCancellationDate String (Date Time) 24 Data de cancelamento da viagem da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
creditAdvancePaymentDate String (Date Time) 24 Data do adiantamento de crédito da solicitação. Exemplo: 2019-09-18T16:48:22.490Z
parentRequestId Guid 36 ID de identificação da solicitação pai. Exemplo: 00000000-0000-0000-0000-000000000000
parentRequestNumber Number (int) 100 Número da solicitação pai. Exemplo: 50
requestId Guid 36 ID de identificação da solicitação retornada. Exemplo: 00000000-0000-0000-0000-000000000000
requestNumber Number (int) 100 Número da solicitação retornada. Exemplo: 50
tripStatus String 32 Status da viagem da solicitação. Exemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
expenseStatus String 20 Status de expense da solicitação. Exemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'

POST /requests/concluderefund/{requestId}

Requisição

requisição POST /requests/concluderefund/{requestId}
Propriedade Tipo Tamanho Obrigatório Descrição
userId Guid 36 Sim ID da solicitação que possui o reembolso que deve ser concluído/finalizado. Exemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta POST /requests/concluderefund/{requestId}
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na conclusão/finalização do reembolso. Exemplo: True/False

GET /requests/roads/terminals

Requisição

requisição GET

Resposta

[
  {
    "terminalCity": "string"
  }
]
Propriedade Tipo Tamanho Descrição
terminalCity String 255 Nome do terminal localizado na cidade. Exemplo: JIQUIRICA (BA, BRASIL)

POST /requests

Requisição

{
  "tripStatus": "open",
  "typeTrip": "international",
  "reasonTravel": "string",
  "observation": "string",
  "authorizationCode": "string",
  "approvations": [
    {
      "login": "string",
      "email": "string",
      "fullName": "string"
    }
  ],
  "traveler": {
    "login": "string",
    "email": "string",
    "fullName": "string"
  },
  "requester": {
    "login": "string",
    "email": "string",
    "fullName": "string"
  },
  "allocations": [
    {
      "costCenterCode": "string",
      "costCenterDescription": "string",
      "companyName": "string",
      "percentage": 0,
      "levelsCostCenter": [
        {
          "level": 0,
          "company": "string",
          "code": "string",
          "acronym": "string",
          "description": "string"
        }
      ]
    }
  ],
  "requestFields": [
    {
      "field": "string",
      "content": "string"
    }
  ],
  "travelLegs": [
    {
      "date": "2020-03-25T13:23:35.611Z",
      "origin": "string",
      "destination": "string",
      "typeDate": "dawnConsideringArrival",
      "cabin": "string",
      "class": "string",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "advancePayments": [
    {
      "expense": "string",
      "coin": "string",
      "quantity": 0,
      "value": 0,
      "observation": "string"
    }
  ],
  "hotels": [
    {
      "checkin": "2020-03-25T13:23:35.611Z",
      "checkout": "2020-03-25T13:23:35.611Z",
      "hotel": "string",
      "city": "string",
      "cityId": 0,
      "typeApartament": "double",
      "bedType": "singleType",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "rentals": [
    {
      "vehicleCategory": "economic",
      "airConditioning": true,
      "driver": true,
      "carType": "manual",
      "provider": "string",
      "pickUp": "2020-03-25T13:23:35.611Z",
      "dropOff": "2020-03-25T13:23:35.611Z",
      "pickUpLocation": "string",
      "dropOffLocation": "string",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "roadLegs": [
    {
      "originCity": "string",
      "originTerminal": "string",
      "destinationCity": "string",
      "destinationTerminal": "string",
      "originCountryCode": 0,
      "destinationCountryCode": 0,
      "origin": "string",
      "destination": "string",
      "originCityCode": 0,
      "destinationCityCode": 0,
      "date": "2020-03-25T13:23:35.611Z",
      "schedule": "string",
      "period": "AnyTime",
      "typeWindowTime": "Undefined",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "services": [
    {
      "service": "string",
      "quantidade": 0,
      "date": "2020-03-25T13:23:35.611Z",
      "observation": "string",
      "requestFields": [
        {
          "field": "string",
          "content": "string"
        }
      ]
    }
  ]
}
Propriedade Tipo Tamanho Obrigatório Descrição
tripStatus String (Enum) 36 Sim Status da viagem da solicitação. Exemplo: 'open', 'awaitingQuotation'.
typeTrip String (Enum) 13 Sim Tipo de viagem da solicitação. Exemplo: 'both', 'international', 'domestic'
reasonTravel String 40 Sim Descrição do motivo de viagem registrado no cliente. Exemplo: Treinamento, Prestação, Reunião com o Cliente
observation String 255 Não Observação inserida pelo usuário no momento da solicitação de rodoviário. Exemplo: "Validar cotação para 2 pedidos offline"
autdorizationCode String 255 Não Código de autorização do cartão vinculada a despesa. Exemplo: 9573
traveler UserInfo (Object) 1 Não Objeto responsável por transportar as informações do viajante da solicitação
requester UserInfo (Object) 1 Não Objeto responsável por transportar as informações do solicitante da solicitação
allocations UserInfo (Object) 1 Sim Objeto responsável por transportar as informações das alocações da solicitação
requestFields RequestField (Object) 1 Não Objeto responsável por transportar as informações dos campos gerenciais da solicitação
travelLegs Leg (Object) 1 Não Objeto responsável por transportar as informações dos trechos aéreos
advancePayments AdvancePaymentsRQ (Object) 1 Não Objeto responsável por transportar as informações de adiantamento
hotels HotelRQ (Object) 1 Não Objeto responsável por transportas as informações de hotels
rentals RentalRQ (Object) 1 Não Objeto responsável por transportar as informações da locação da solicitação
roadLegs Leg (Object) 1 Não Objeto responsável por transportar as informações do trecho rodoviário da solicitação
services ServiceRQ (Object) 1 Não Objeto responsável por transportar as informações do serviço da solicitação
approvations Objeto responsável por transportar as informações dos aprovadores da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
login String 255 Sim Login do usuário aprovador da solicitação. Exemplo: aprovador.um
email String 255 Sim Email do usuário aprovador da solicitação. Exemplo: aprovador.um@argo.com
fullName String 255 Sim Nome completo do usuário aprovador da solicitação. Exemplo: Aprovador Principal
traveler Objeto responsável por transportar as informações do viajante da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
login String 3 Sim Login do usuário viajante da solicitação. Exemplo: viajante.um
email String 255 Sim Email do usuário viajante da solicitação. Exemplo: viajante.um@argo.com
fullName String 100 Sim Nome completo do usuário viajante da solicitação. Exemplo: Viajante Principal
requester Objeto responsável por transportar as informações do solicitante da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
login String 3 Sim Login do usuário solicitante da solicitação. Exemplo: viajante.um
email String 255 Sim Email do usuário solicitante da solicitação. Exemplo: viajante.um@argo.com
fullName String 100 Sim Nome completo do usuário solicitante da solicitação. Exemplo: Viajante Principal
allocations Objeto responsável por transportar as informações das alocações da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
costCenterCode String 30 Sim Código do centro de custo. Exemplo: 128031/26
costCenterDescription String 50 Sim Descrição do Centro de Custo. Exemplo: Serv. Sup. VP FCA(Nordeste)/Serv.Trecho-EEOEEN
companyName String 30 Não Nome da empresa vinculada ao Centro de Custo. Exemplo: Suporte e Supervisoria Volpiano
percentage Number (Double) 3 Sim Porcentagem de atribuição do débito ao Centro de Custo. Exemplo: 15.50
levelsCostCenter LevelCostCenterVM (Object) 1 Não Objeto responsável por transportar as informações dos níveis de centro de custo da alocação da solicitação
levelsCostCenter Objeto responsável por transportar as informações dos níveis de centro de custo da alocação da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
level Number (Integer) 100 Não Nível do centro de custo vinculado ao centro de custo. Exemplo: 1, 2
company String 255 Não Empresa vinculada ao centro de custo. Exemplo: Suporte e Supervisoria Volpiano - Filial
code String 30 Sim Código do centro de custo. Exemplo: 128031/26
acronym String 10 Não Sigla do Centro de Custo. Exemplo: CCVPFCA
description String 50 Sim Descrição do Centro de Custo. Exemplo: Serv. Sup. VP FCA(Nordeste)/Serv.Trecho-EEOEEN - Filial
requestFields Objeto responsável por transportar as informações doscampos gerenciais da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
field String 255 Não Identificador do campo gerencial. Exemplo: provisorio_argo_division
content String 255 Não Conteúdo inserido no campo gerencial. Exemplo: Provisorio
travelLegs Objeto responsável por transportar as informações dos trechos aéreos
Propriedade Tipo Tamanho Obrigatório Descrição
origin String 50 Sim Cidade de origem do trecho da viagem. Exemplo: Campinas
destination String 50 Sim Cidade de destino do trecho da viagem. Exemplo: São Paulo
date String (Date Time) 24 Não Data do trecho. Exemplo: 2019-02-05
schedule String 255 Não Horário do trecho. Exemplo: 06
period String (Enum) 12 Não Período do trecho. Exemplo: 'AnyTime', 'EarlyMorning', 'Morning', 'Afternoon', 'Evening', 'Defined'
typeWindowTime String (Enum) 9 Não Tipo da janela de tempo do trecho. Exemplo: 'Undefined', 'departure', 'arrival'
formPayment FormPayment (Object) 1 Não Objeto responsável por transportar as informações da forma de pagamento do trecho aéreo
advancePayments Objeto responsável por transportar as informações de adiantamento
Propriedade Tipo Tamanho Obrigatório Descrição
expense String 255 Não Nome da empresa vinculada ao Centro de Custo. Exemplo: Suporte e Supervisoria Volpiano
coin String 3 Não Tipo da moeda utilizada pelo apartamento. Exemplo: BRL
quantity Number 100 Não Quantidade de despesas do adiantamento. Exemplo: 2
value Number 100 Não Valor do adiantamento. Exemplo: 15,00
observation String 255 Não Observação do adiantamento. Exemplo: Pagamento de hotel com despesas pagas pela empresa para o período de festas local
hotels Objeto responsável por transportas as informações de hotels
Propriedade Tipo Tamanho Obrigatório Descrição
checkin String (DateTime) 24 Não Data de checkin do hotel. Exemplo: 2019-08-22T12:00:00
checkout String (DateTime) 24 Não Data de checkout do hotel. Exemplo: 2019-08-22T12:00:00
hotel String 50 Não Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
city String 50 Não Cidade onde se encontra o hotel. Exemplo: RIO DE JANEIRO / RJ
cityId Number 100   Id da cidade onde se encontra o hotel. Exemplo: 
typeApartament String 50 Não Tipo do apartamento reservado. Exemplo: Single
bedType String 50 Não Tipo da cama do apartamento reservado. Exemplo: Single
observation String 255 Não Observações a respeito do hotel alugado.
formPayment FormPayment (Object) 1 Não Objeto responsável por transportar as informações da forma de pagamento da hospedagem
rentals Objeto responsável por transportar as informações da locação da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
vehicleCategory String (Enum) 12 Não Categoria na qual o veículo pertence. Exemplo: 'economy', 'intermediate', 'superior', 'compact', 'special'
airConditioning string 5 Não Campo que indica se o veículo possui ou não ar-condicionado. Exemplo: true/false
driver string 3 Não Flag que indica que o veículo será contratado com motorista
carType String (Enum) 10 Não Tipo de direção do veículo. Exemplo: automatic/manual
provider String 100 Não Provedor de onde serão solicitadas as informações da locação. Exemplo: AMADEUSWS
pickUp String (DateTime) 24 Não Data de retirada do veículo. Exemplo: 2019-08-18T12:00:00
dropOff String (DateTime) 24 Não Data de devolução do veículo. Exemplo: 2019-08-22T12:00:00
pickUpLocation String 255 Não Local de retirada do veículo. Exemplo: São Paulo / SP, Brasil (SAO)
dropOffLocation String 255 Não Local de devolução do veículo. Exemplo: Rio de Janeiro / RJ, Brasil - Galeão (GIG)
observation String 255 Não Observações a respeito do veículo alugado. Exemplo: O veículo está com problema na porta inferior esquerda.
formPayment FormPayment (Object) 1 Não Objeto responsável por transportar as informações da forma de pagamento da locação
roadLegs Objeto responsável por transportar as informações do trecho rodoviário da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
originCity String 50 Sim Cidade de origem do trecho da viagem. Exemplo: Campinas
originTerminal String 50 Sim Terminal de origem do trecho da viagem. Exemplo:CAMPINAS (SP, BRASIL) / SP, Brasil (CPQ)
destinationCity String 50 Sim Cidade de destino do trecho da viagem. Exemplo: São Paulo
destinationTerminal String 50 Não Terminal de destino do trecho da viagem. Exemplo:SÃO PAULO - TIETE (SP, BRASIL) / SP, Brasil (SAO)
originCountryCode Number (Integer) 100 Não Código do país de origem do trecho. Exemplo: 29
destinationCountryCode Number (Integer) 100 Não Código do país de destino do trecho. Exemplo: 29
originCityCode Number (Integer) 100 Não Código da cidade de origem do trecho. Exemplo: 4831
destinationCityCode Number (Integer) 100 Não Código da cidade de destino do trecho. Exemplo: 5287
origin String 50 Não Cidade de origem do trecho da viagem. Exemplo: Campinas
destination String 50 Não Cidade de destino do trecho da viagem. Exemplo: São Paulo
date String (Date Time) 24 Não Data do trecho. Exemplo: 2019-02-05
schedule String 255 Não Horário do trecho. Exemplo: 06
period String (Enum) 12 Não Período do trecho. Exemplo: 'AnyTime', 'EarlyMorning', 'Morning', 'Afternoon', 'Evening', 'Defined'
typeWindowTime String (Enum) 9 Não Tipo da janela de tempo do trecho. Exemplo: 'Undefined', 'departure', 'arrival'
formPayment FormPayment (Object) 1 Não Objeto responsável por transportar as informações da forma de pagamento da solicitação
services Objeto responsável por transportar as informações do serviço da solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
service String 255 Não Nome do serviço. Exemplo: Compra de Bagagem
quantidade Number 50 Não Quantidade de serviços da solicitação. Exemplo: 1
date String 24 Não Data do serviço. Exemplo: 2020-01-08T15:00:00
observation String 255 Não Observação do serviço. Exemplo: Pedido de atendimento aeroporto
requestFields ManagementFieldRSVM (Object) 1 Não Objeto responsável por transportar as informações dos campos gerenciais
requestFields Objeto responsável por transportar as informações dos campos gerenciais
Propriedade Tipo Tamanho Obrigatório Descrição
content String 50 Não Conteúdo apresentado no campo. Exemplo: 08/01/2003
field String 50 Não Identificador do campo. Exemplo: sustentacao_ajweg_checkin3
formPayment Objeto responsável por transportar as informações da forma de pagamento do produto
Propriedade Tipo Tamanho Obrigatório Descrição
description String 255 Não Descrição da forma de pagamento da solicitação. Exemplo: Faturado
card Card (Object) 1 Não Objeto responsável por transportar as informações dos cartão utilizado pela solicitação
card Objeto responsável por transportar as informações dos cartão utilizado pela solicitação
Propriedade Tipo Tamanho Obrigatório Descrição
user String 255 Não Nome do usuário utilizador do cartão. Exemplo: Maurício
formPayment String 255 Não Tipo de Faturamento do Cartão. Exemplo: 
cardNumber String 255 Não Número do cartão. Exemplo: 3216-8394-9403-0604

Resposta

Propriedade Tipo Tamanho Descrição
nroSolic Number (int) 10 Número da solicitação gerada. Exemplo: 2

POST /requests/cancel/{requestId}

Requisição

{
  "product": "air",
  "cancelReason": "string"
}
Propriedade Tipo Tamanho Obrigatório Descrição
product String (Enum) 15 Sim Informação do produto que será cancelado. Exemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'all'
cancelReason String 255 Sim Descrição do motivo pelo qual a solicitação está sendo cancelada. Exemplo: Cancelada Por Administrador Sistema - Motivo Cancelamento: Cancelada pela política de cancelamento automático CANEXP

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha no cancelamento da solicitação. Exemplo: True/False

RequestsAgents

Através deste serviço é possível identificar as informações do consultor de viagem/atendente da solicitação aberta no Argo.

GET /requests/{requestId}/agents

Requisição

requisição GET

Resposta

{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "userId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "login": "string",
    "firstName": "string",
    "lastName": "string",
    "telephone": "string",
    "thirdParty": "yes",
    "groups": [
        "admin"
    ],
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 24 E-mail de contato do atendente da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 24 Login do atendente da solicitação. Exemplo: roberto.luiz
firstName String 3 Primeiro nome do atendente da solicitação Exemplo: Roberto
lastName Int 5 Último nome do atendente da solicitação. Exemplo: Luiz
telephone String 50 Telefone do atendente da solicitação. Exemplo: 995463154
thirdParty String 8 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
groups String 23 Grupo no qual o usuário está inserido. Exemplo: 'user', 'admin', 'manager', 'financial'

RequestsAllocations

Através desse método é possível recuperar a Alocação de Débito (Forma de pagamento) utilizada em uma determinada solicitação. Para recuperar essa informação é necessário ter o ID da Solicitação que deseja consultar.

GET /requests/{requestId}/allocations

Requisição

requisição GET

Resposta

[
    {
        "costCenterCode": "string",
        "costCenterDescription": "string",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "companyCode": "string",
        "companyReference": "string",
        "percentage": 0,
        "ledgerAccountCode": "string",
        "ledgerAccountDescription": "string",
        "projectCode": "string",
        "projectDescription": "string",
        "levelsCostCenters": [
            {
                "costCenterCode": "string",
                "costCenterDescription": "string",
                "level": 0,
                "companyName": "string"
            }
        ]
    }
]
Propriedade Tipo Tamanho Descrição
costCenterCode String 30 Código do Centro de Custo que a alocação de débito está relacionada. Exemplo: 001
costCenterDescription String 50 Descrição do Centro de Custo que a alocação de débito está relacionada. Exemplo: Desenvolvimento
companyId String (Guid) 36 Id da empresa que está relacionada a alocação de débito. Exemplo: 00000000-0000-0000-0000-000000000000
companyName String 30 Nome da empresa que está relacionada a alocação de débito. Exemplo: Argo
companyCode String 30 Código de integração da empresa que está relacionada a alocação de débito. Exemplo: 50043
companyReference String 30 Referência da empresa que está relacionada a alocação de débito. Exemplo: 0001/006433
percentage Integer 3 Porcentagem que foi vinculada a alocação de débito. Exemplo: 50
ledgerAccountCode String 20 Código da conta contábil relacionada a alocação de débito. Exemplo: 111
ledgerAccountDescription String 50 Descrição da conta contábil relacionada a alocação de débito. Exemplo: Conta contábil Argo
projectCode String 30 Código do projeto relacionada a alocação de débito. Exemplo: EB4008_VG_25B8750VGN_VN
projectDescription String 50 Descrição do projeto relacionado a alocação de débito. Exemplo: Atividades de Inovação
levelsCostCenters Níveis dos Centros de Custo vinculados a alocação de débito
Propriedade Tipo Tamanho Descrição
costCenterCode String 30 Código do centro de custo relacionado a alocação de débito. Exemplo: 002
costCenterDescription String 50 Descrição do centro de custo relacionado a alocação de débito. Exemplo: Centro de Custo Argo
level Integer 3 Nível do centro de custo relacionado a alocação de débito. Exemplo: 001
companyName String 30 Nome da empresa relacionada a alocação de débito. Exemplo: Argo Solutions

RequestsApprovals

Através desse método é possível recuperar os dados dos aprovadores de uma solicitação específica. Para isso, é necessário ter o ID da solicitação que deseja consultar. Além disso, por meio do PUT é possível aprovar/reprovar uma solicitação.

GET /requests/{requestId}/approvals

Requisição

requisição GET

Resposta

[
    {
        "approver": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "realApprover": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "approved": "yes",
        "approvalDate": "2020-03-06T14:32:24.607Z"
    }
]
approver Objeto contém as informações do usuário aprovador relacionado a solicitação
Propriedade Tipo Tamanho Descrição
clientId String(Guid) 36 Id do cliente no qual o aprovador está vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 Id do usuário aprovador. Exemplo: 00000000-0000-0000-0000-000000000000
email String 256 E-mail do usuário aprovador. Exemplo: pedro.silva@argo.com
login String 256 Login do usuário aprovador. Exemplo: pedro.silva
firstName String 20 Primeiro nome do usuário aprovador. Exemplo: Pedro
lastName String 20 Sobrenome do usuário aprovador. Exemplo: Silva
telephone String 30 Telefone do usuário aprovador. Exemplo: 5511998525545
fax String 30 Fax do usuário aprovador. Exemplo: 5511998525545
registration Strin 20 Matrícula do usuário aprovador. Exemplo: 464545
thirdParty String(Enum) 3 Indica se o usuário aprovador é “terceiro”. Exemplo: Yes/No
groups String(Enum) 10 Grupo que o usuário aprovador pertence. Exemplo: admin, financial, manager, user.
rg String 14 RG (documento nacional de identificação civil no Brasil) do usuário aprovador. Exemplo: 265487745
cpf String 12 CPF (cadastro de pessoa física no Brasil) do usuário aprovador. Exemplo: 36548425612
passport String 20 Passaporte do usuário aprovador. Exemplo: BR123456
employeeId String 20 Matrícula do usuário aprovador. Exemplo: 464545
fullName String 100 Nome completo do usuário aprovador. Exemplo: Pedro Silva
integrationCode String 50 Código que pode ser utilizado por outros sistemas no processo de integração. Exemplo: 001
department String 50 Departamento vinculado ao cadastro do usuário aprovador. Exemplo: Desenvolvimento
realApprover Objeto contém as informações do usuário que aprovou a solicitação
Propriedade Tipo Tamanho Descrição
clientId String(Guid) 36 Id do cliente no qual o aprovador está vinculado. Exemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 Id do usuário aprovador. Exemplo: 00000000-0000-0000-0000-000000000000
email String 256 E-mail do usuário aprovador. Exemplo: pedro.silva@argo.com
login String 256 Login do usuário aprovador. Exemplo: pedro.silva
firstName String 20 Primeiro nome do usuário aprovador. Exemplo: Pedro
lastName String 20 Sobrenome do usuário aprovador. Exemplo: Silva
telephone String 30 Telefone do usuário aprovador. Exemplo: 5511998525545
fax String 30 Fax do usuário aprovador. Exemplo: 5511998525545
registration String 20 Matrícula do usuário aprovador. Exemplo: 464545
thirdParty String(Enum) 3 Indica se o usuário aprovador é “terceiro”. Exemplo: Yes/No
groups String(Enum) 10 Grupo que o usuário aprovador pertence. Exemplo: admin, financial, manager, user.
rg String 14 RG (documento nacional de identificação civil no Brasil) do usuário aprovador. Exemplo: 265487745
cpf String 12 CPF (cadastro de pessoa física no Brasil) do usuário aprovador. Exemplo: 36548425612
passport String 20 Passaporte do usuário aprovador. Exemplo: BR123456
employeeId String 20 Matrícula do usuário aprovador. Exemplo: 464545
fullName String 100 Nome completo do usuário aprovador. Exemplo: Pedro Silva
integrationCode String 50 Código que pode ser utilizado por outros sistemas no processo de integração. Exemplo: 001
department String 50 Departamento vinculado ao cadastro do usuário aprovador. Exemplo: Desenvolvimento
approved String(Enum) 3 Indica se a solicitação está com o status aprovada. Exemplo: Yes
approvalDate String(Datetime) 24 Data que a solicitação foi aprovada. Exemplo: 2020-03-06T14:32:24.607Z

PUT /requests/{requestId}/approvals

Requisição

requisição PUT
Propriedade Tipo Tamanho Obrigatório Descrição
typeOfReprovation String(Enum) 7 Sim Tipo de produto a ser aprovado/reprovado. Exemplo: air, rental, hotels
action String(Enum) 10 Não Ação a ser tomada em relação a Solicitação. Exemplo: approve, disapprove
approver Objeto contém as informações do usuário aprovador
Propriedade Tipo Tamanho Obrigatório Descrição
numberList Number(Integer) 100 Não Número na lista de aprovadores. Exemplo: 1
representative String(Enum) 3 Não Se o aprovador é um delegado. Exemplo: Yes, No
allocation String(Enum) 3 Não Se o aprovador possui alocação. Exemplo: Yes, No
level String(Enum) 3 Não Se o aprovador possui nível. Exemplo: Yes, No
scope Number(Decimal) 100 Não O sistema Argo permite criar estruturas de aprovação por alçada de valores para os tipos de “sequential” e “single”. Essa propriedade permite definir a alçada cadastrada na estrutura
email String 256 Sim E-mail do usuário aprovador. Exemplo: argo@useargo.com
login String 256 Sim Login do usuário aprovador. Exemplo: argo.teste
fullName String 100 Não Nome completo do usuário aprovador. Exemplo: João Silva
reason String 200 Não Motivo de aprovação/reprovação. Exemplo: Valor acima do permitido

Resposta

resposta PUT
Propriedade Tipo Tamanho Descrição
Message String(Enum) 5 Mensagem de retorno da ação. Exemplo: True/False

RequestsFlightsQuotations

Através desse método é possível recuperar os dados de uma cotação aérea inserida em uma solicitação. Para obter esses dados é necessário informar o ID da OS.

Para mais informações sobre cotação aérea, consulte a Wiki.

GET

Requisição

requisição GET

Resposta

[
    {
        "webServiceId": "string",
        "locator": "string",
        "ticket": "string",
        "ticketDate": "2020-03-11T18:38:52.583Z",
        "coin": "string",
        "bacenCodeCoin": "string",
        "taxCoin": "string",
        "justificationLegs": [
            {
                "type": "string",
                "description": "string"
            }
        ],
        "bacenCodeCoinTaxCode": "string",
        "codeAgreementApplied": "string",
        "taxValue": 0,
        "taxIva": 0,
        "taxTua": 0,
        "otherTax": 0,
        "ticketValue": 0,
        "ticketValueMore": 0,
        "ticketValueLess": 0,
        "ticketExchange": 0,
        "valueTicketReference": 0,
        "exchangeTax": 0,
        "totalValue": 0,
        "approvedTotalValue": 0,
        "fullFare": 0,
        "departureDate": "2020-03-11T18:38:52.583Z",
        "reissue": {
            "reissueOriginalTicket": "string",
            "reissueNumberMcoCredit": "string",
            "reissueDateMcoCredit": "2020-03-11T18:38:52.583Z",
            "reissueValueMcoCredit": 0,
            "reissueNumberEmdFine": "string",
            "reissueDateEmdFine": "2020-03-11T18:38:52.583Z",
            "emdAuthorizationReissue": "string",
            "reissueAmountEmdFine": 0
        },
        "arrivalDate": "2020-03-11T18:38:52.583Z",
        "immediateIssue": true,
        "onlineIssue": true,
        "observation": "string",
        "id": "string",
        "quotationId": "00000000-0000-0000-0000-000000000000",
        "online": "yes",
        "formPayment": {
            "description": "string",
            "typePayment": "invoiced",
            "code": "string",
            "air": "yes",
            "hotels": "yes",
            "rental": "yes",
            "service": "yes",
            "bus": "yes",
            "restrictive": "yes",
            "alternativeUATP": "yes",
            "card": {
                "paymentName": "string",
                "name": "string",
                "cardNumber": "string",
                "flag": "string",
                "active": "yes",
                "providerId": "string",
                "webServiceId": "string"
            },
            "billingCode": "string",
            "billingDescription": "string"
            "cardAuthorization": "string"
        },
        "issuedOnline": "yes",
        "agentUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "issuerUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "airOffereds": [
            {
                "id": "string",
                "airline": "string",
                "numberFlight": "string",
                "date": "string",
                "hour": "string",
                "scales": 0,
                "connections": 0,
                "amount": "string",
                "totalAmount": 0,
                "grouped": "yes"
            }
        ],
        "airQuotedsLegs": [
            {
                "LegId": "00000000-0000-0000-0000-000000000000",
                "parentLegId": "00000000-0000-0000-0000-000000000000",
                "quantityScales": 0,
                "quantityConnections": 0,
                "departureDate": "2020-03-11T18:38:52.583Z",
                "arrivalDate": "2020-03-11T18:38:52.583Z",
                "departure": "string",
                "departureDescription": "string",
                "departureCity": "string",
                "departureCountry": "string",
                "arrival": "string",
                "arrivalDescription": "string",
                "arrivalCity": "string",
                "arrivalCountry": "string",
                "cabin": "string",
                "cabinClass": "string",
                "fareCode": "string",
                "marketingAirline": "string",
                "marketingAirlineDescription": "string",
                "operationAirline": "string",
                "operationAirlineDescription": "string",
                "departureTerminal": "string",
                "flightNumber": "string",
                "aircraft": "string",
                "seat": "string",
                "observation": "string",
                "locatorAirline": "string"
            }
        ],
        "feesLeg": [
            {
                "feeId": "00000000-0000-0000-0000-000000000000",
                "initialDate": "2020-03-11T18:38:52.583Z",
                "finalDate": "2020-03-11T18:38:52.583Z",
                "initialHour": "string",
                "finalHour": "string",
                "dayWeek": "monday",
                "name": "string",
                "description": "string",
                "typeTrip": "both",
                "action": "quotation",
                "online": "yes",
                "service": "air",
                "amount": 0,
                "percentage": 0,
                "ceilingPrice": 0,
                "inclusionDate": "2020-03-11T18:38:52.583Z"
            }
        ]
    }
]
Propriedade Tipo Tamanho Descrição
webServiceId String 50 Código do web service onde a cotação aérea foi consultada. Exemplo: GOL
locator String 10 Localizador da reserva. Exemplo: ZN3FYK
ticket String 20 Número do bilhete. Exemplo: XQL6MX
ticketDate String(DateTime) 24 Data de emissão bilhete. Exemplo: 2019-09-18T16:48:22.490Z
coin String 3 Moeda utilizada na cotação. Exemplo: BRL
bacenCodeCoin Number(int) 14 Código da moeda segundo a tabela Bacen, relacionada a cotação aérea. Exemplo: 790
taxCoin Number(double) 16 Taxa de câmbio da moeda relacionada a cotação aérea. Exemplo: BRL
justificationLegs Objeto responsável por retornar as justificativas da cotação aérea
Propriedade Tipo Tamanho Descrição
type String 255 Tipo da justificativa. Exemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descrição da justificativa. Exemplo: Voo escolhido está com valor acima do permitido.
Propriedade Tipo Tamanho Descrição
bacenCodeCoinTaxCode Number(int) 14 Código Bacen para taxa de câmbio da moeda. Exemplo: 790
codeAgreementApplied String 50 Código "Codeshare" da companhia aérea que comercializou o bilhete. Exemplo: JJ124
taxValue Number(double) 16 Valor da taxa do bilhete. Exemplo: 65.9
taxIva Number(decimal) 16 Somatório de taxas IVA do bilhete. Exemplo: 80.9
taxTua Number(decimal) 16 Somatório de taxas TUA do bilhete. Exemplo: 120.6
otherTax Number(decimal) 16 Somatório de outras taxas do bilhete. Exemplo: 37.1
ticketValue Number(double) 16 Valor do ticket/bilhete. Exemplo: 1460.97
ticketValueMore Number(double) 16 Valor acrescido ao valor do bilhete. Exemplo: 0
ticketValueLess Number(double) 16 Valor decrescido ao valor do bilhete. Exemplo: 0
ticketExchange Number(double) 16 Valor de câmbio do bilhete. Exemplo: 1
valueTicketReference Number(double) 16 Valor de referência do bilhete. Exemplo: 1718.1
exchangeTax Number(double) 16 Valor da taxa de câmbio. Exemplo: 1
totalValue Number(double) 16 valor total do bilhete. Exemplo: 1526.87
approvedTotalValue Number(double) 16 Valor total aprovado para cotação. Exemplo: 1525.87
fullFare Number(double) 16 Valor de tarifa cheia do voo relacionado a cotação. Exemplo: 4398
departureDate String(DateTime) 24 Data de partida do voo relacionado a cotação. Exemplo: 2020-09-18T16:48:22.490Z
reissue Objeto responsável por retornar as informações de reemissão do bilhete
Propriedade Tipo Tamanho Descrição
reissueOriginalTicket String 20 Número do ticket que foi reemitido. Exemplo: 9572388231627
reissueNumberMcoCredit String 20 Número do ticket reemitido com crédito MCO (Miscellaneous charges order). Exemplo: 9572388231929
reissueDateMcoCredit String(DateTime) 24 Data do ticket reemitido com o crédito MCO (Miscellaneous charges order). Exemplo: 2020-09-18T16:48:22.490Z
reissueValueMcoCredit Number(Decimal) 16 Valor do ticket reemitido com o crédito MCO (Miscellaneous charges order). Exemplo: 850.00
reissueNumberEmdFine String 20 Número do EMD (Electronic Miscellaneous Document) com o valor da multa da reemissão. Exemplo: EGSD/V6X/SC-PENF
reissueDateEmdFine String(DateTime) 24 Data do EMD (Electronic Miscellaneous Document) com o valor da multa da reemissão. Exemplo: 2020-09-18T16:48:22.490Z
emdAuthorizationReissue String 20 Código de autorização do EMD (Electronic Miscellaneous Document) da reemissão. Exemplo: 072189
reissueAmountEmdFine Number(Decimal) 16 Valor da multa EMD (Electronic Miscellaneous Document) da reemissão. Exemplo: 150.00
Propriedade Tipo Tamanho Descrição
arrivalDate String(DateTime) 24 Data de chegada do voo. Exemplo: 2020-09-18T16:48:22.490Z
immediateIssue Boolean 5 Propriedade indica se a emissão foi realizada de forma imediata. Exemplo: false
onlineIssue Boolean 5 Propriedade indica se a emissão foi On-Line. Exemplo: true
observation String 255 Observações referentes a cotação. Exemplo: Cotado com valor acima do previsto.
id Number(int) 50 ID de identificação do voo na cotação de aéreo. Exemplo: 1, 3, 5
quotationId Number(int) 50 Id de identificação das cotações. Se um trecho de aéreo possuir 7 cotações, é esta variável que será incrementada
online String 3 Indica se a reserva foi realizada através do módulo On-Line. Exemplo: yes/no
formPayment Objeto responsável por retornar as informações da forma de pagamento da solicitação
Propriedade Tipo Tamanho Descrição
description String 255 Descrição da forma de pagamento da solicitação. Exemplo: Faturado
typePayment String (Enum) 15 Tipos do pagamento utilizado na solicitação. Exemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integração da forma de pagamento. (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'TIPOFATURA1010'
Air String 3 Propriedade indica se a forma de pagamento pode ser utilizada para a aquisição de aéreo. Exemplo: yes/no
hotels String 3 Propriedade indica se a forma de pagamento pode ser utilizada para a aquisição de hospedagem. Exemplo: yes/no
rental String 3 Propriedade indica se a forma de pagamento pode ser utilizada para a aquisição de Locação. Exemplo: yes/no
service String 3 Propriedade indica se a forma de pagamento pode ser utilizada para a aquisição de Serviço. Exemplo: yes/no
bus String 3 Propriedade indica se a forma de pagamento pode ser utilizada para a aquisição de Rodoviário. Exemplo: yes/no
restrictive String 3 Propriedade indica se o faturamento é do tipo restritivo. Exemplo: yes/no
alternativeUATP String 3 Campo que indica se o faturamento é do tipo UATP. Exemplo: yes/no
card Objeto responsável por retornar as informações do cartão de crédito relacionado a forma de pagamento
Propriedade Tipo Tamanho Descrição
paymentName String 50 Nome da forma do pagamento do cartão. Exemplo: cartão de Crédito
name String 50 Nome do titular do cartão. Exemplo: Argo Cartão
cardNumber String 255 Número do cartão. Exemplo: 3216-8394-9403-0604
flag String 50 Indica qual a bandeira do cartão. Exemplo: Visa, Mastercard
active String 3 Campo indica se o cartão está ativo. Exemplo: yes/no
providerId String 50 Identificador do provedor do cartão. Exemplo: T0009015590A999118
webServiceId String 50 Identificador do WebService do cartão (Apenas para cartão virtual). Exemplo: B2BPAY, WEX, CONFERMA
Propriedade Tipo Tamanho Descrição
billingCode String 50 Código de faturamento da forma de pagamento. Exemplo: BV5
billingDescription String 50 Descrição do código de faturamento da forma de pagamento. Exemplo: FATURAMENTO TOTAL PARA A AGÊNCIA
cardAuthorization String 50 Número de autorização do cartão (quando for essa a opção de pagamento do trecho) inserido no momento da emissão do aéreo
issuedOnline String(Enum) 3 Flag que indica se a cotação foi emitida online. Exemplo: Yes, No
agentUser Objeto responsável por retornar as informações do usuário atendente
Propriedade Tipo Tamanho Descrição
clientId String(Guid) 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do atendente da OS. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do atendente da solicitação. Exemplo: roberto.luiz
firstName String 255 Primeiro nome do atendente da solicitação Exemplo: Roberto
lastName String 255 Último nome do atendente da solicitação. Exemplo: Luiz
telephone String 50 Telefone do atendente da solicitação. Exemplo: 9 95463154
fax String 50 Fax do atendente da solicitação. Exemplo: 9 95463154
registration String 255 Identificador de matrícula do usuário. Exemplo: 10377192
thirdParty String(Enum) 3 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
groups String(Enum) 10 Grupo no qual o usuário está inserido: Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
passport String 20 Número de passaporte do usuário. Exemplo: BR123456
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
department String 255 Departamento do usuário. Exemplo: Operacional
issuerUser Objeto responsável por retornar as informações do usuário emissor
Propriedade Tipo Tamanho Descrição
clientId String(Guid) 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do emissor da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do emissor da solicitação. Exemplo: roberto.luiz
firstName String 255 Primeiro nome do emissor da solicitação Exemplo: Roberto
lastName String 255 Último nome do emissor da solicitação. Exemplo: Luiz
telephone String 50 Telefone do emissor da solicitação. Exemplo: 9 95463154
fax String 50 Fax do emissor da solicitação. Exemplo: 9 95463154
registration String 255 Identificador de matrícula do usuário. Exemplo: 10377192
thirdParty String(Enum) 3 Flag que indica se o emissor é terceirizado ou não. Exemplo: yes/no
groups String(Enum) 10 Grupo no qual o usuário está inserido. Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
passport String 20 Número de passaporte do usuário. Exemplo: BR123456
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Emissor Principal
integrationCode String 255 Código de integração do usuário emissor (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
department String 255 Departamento do usuário. Exemplo: Operacional
airOffereds Objeto responsável por retornar as informações dos voos ofertados
Propriedade Tipo Tamanho Descrição
id String 5 ID do voo ofertado. Exemplo: 1, 3, 5
airline String 50 Companhia aérea da cotação. Exemplo: G3
numberFlight String 4 Número do voo da cotação. Exemplo: 1557
date String 40 Data do voo. Exemplo: 2020-09-18T16:48:22.490Z
hour String 20 Horário do voo. Exemplo: 07:05
scales String 4 Quantidade de escalas que o voo possui. Exemplo: 0
connections String 4 Quantidade de conexões que o voo possui. Exemplo: 0
amount String 100 Valor do bilhete. Exemplo: 1150.00
totalAmount Number 100 Valor total do bilhete. Exemplo: 1715.00
grouped String(Enum) 3 Flag que indica se o voo foi agrupado em um localizador. Exemplo: Yes, No
airQuotedsLegs Objeto responsável por retornar as informações dos trechos ofertados
Propriedade Tipo Tamanho Descrição
LegId String(Enum) 36 ID do trecho ofertado. Exemplo: 00000000-0000-0000-0000-000000000000
parentLegId String(Enum) 36 ID do trecho "Pai". Exemplo: 00000000-0000-0000-0000-000000000000
quantityScales Number(Int) 100 Quantidade de escalas do trecho. Exemplo: 2
quantityConnections Number(Int) 100 Quantidade de conexões do trecho. Exemplo: 1
departureDate String(DateTime) 24 Data de partida do trecho. Exemplo: 2020-09-18T16:48:22.490Z
arrivalDate String(DateTime) 24 Data de chegada do trecho. Exemplo: 2020-09-19T16:48:22.490Z
departure String 3 Sigla do aeroporto de origem. Exemplo: SAO, GIG
departureDescription String 50 Descrição da cidade de origem. Exemplo: São Paulo
departureCity String 50 Cidade de origem do trecho. Exemplo: São Paulo
departureCountry String 50 Pais de Origem do trecho. Exemplo: Brasil
arrival String 3 Sigla do aeroporto de destino. Exemplo: SAO, GIG
arrivalDescription String 50 Descrição do aeroporto de destino. Exemplo: Congonhas
arrivalCity String 50 Cidade do aeroporto destino. Exemplo: São Paulo
arrivalCountry String 50 Pais de destino do trecho. Exemplo: Brasil
cabin String 1 Classe de serviço, ou seja, a cabine que será utilizada. Exemplo: Y
cabinClass String 5 Classe tarifária do trecho. Exemplo: W
fareCode String 2000 Código que contém informações importantes sobre o voo. Exemplo: K100BG/OWNR/N§0~{0}31~X
marketingAirline String 3 SCompanhia aérea que comercializou o bilhete. Exemplo: JJ, G3
marketingAirlineDescription String 50 Descrição da companhia aérea que comercializou o bilhete. Exemplo: Latam, Passaredo, Azul
operationAirline String 3 Companhia aérea que opera o trecho. Exemplo: JJ, G3
operationAirlineDescription String 50 Descrição da companhia aérea operadora do trecho. Exemplo: Latam, Passaredo, Azul
departureTerminal String 100 Nome do terminal de origem. Exemplo: Congonhas
flightNumber String 5 Número do voo. Exemplo: 1890, 3557
aircraft String 30 Modelo da aeronave. Exemplo: E95
seat String 60 Número do assento na aeronave. Exemplo: 18D
observation String 200 Observações relevantes relacionadas ao trecho. Exemplo: Reunião de emergência
locatorAirline String 10 Localizador da companhia aérea. Exemplo: SZFOEV
feesLeg Objeto responsável por retornar as informações do fee dos trechos de cotação aérea
Propriedade Tipo Tamanho Descrição
feeId Int 50 ID de identificação do fee vinculado a solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Data inicial da solicitação. Exemplo: 2019-08-22
finalDate String (DateTime) 24 Data final da solicitação. Exemplo: 2019-08-22
initialHour String (DateTime) 24 Hora inicial da solicitação. Exemplo: 2019-08-22
finalHour String (DateTime) 24 Hora final da solicitação. Exemplo: 2019-08-22
dayWeek String 10 Dia da semana. Exemplo: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'
name String 50 Nome do fee. Exemplo: Experience Bundle
description String 1024 Descrição do Fee. Exemplo: Será cobrado R$15,00 para Emissão De Bundle de trechos Nacionais ou Internacionais, feita Online ou Offline. Para todas as solicitações (abertas a partir de 29/11/2019) nesse cliente . Caso o atendimento seja feito entre 00:00 e 23:59 .
typeTrip String (Enum) 13 Tipo de viagem que o 'fee' está vinculado. Exemplo: 'both', 'international', 'domestic'
action String 13 Tipo de ação tomada para cobrança do Fee. Exemplo: 'quotation', 'ticketing'
online String 3 Campo que informa se o fee está relacionado a uma transação online. Exemplo: yes/no
service String 7 Tipo de serviço que o fee contempla. Exemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Valor do Fee. Exemplo: 20
percentage Number 100 Porcentagem do Fee. Exemplo: 5
ceilingPrice Number 100 Valor teto do Fee. Exemplo: 35
inclusionDate String (DateTime) 24 Data de inclusão do Fee. Exemplo: 2020-03-11T19:29:50.873Z

RequestsFees

Através desse método é possível recuperar os Fees cobrados em uma determinada solicitação. Para realizar essa consulta é necessário que seja informado o ID da OS. Para mais informações sobre fee, consulte a Wiki.

GET /requests/{requestId}/fees

Requisição

requisição GET

Resposta

[
    {
        "feeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2020-03-10T21:33:17.204Z",
        "finalDate": "2020-03-10T21:33:17.204Z",
        "name": "string",
        "description": "string",
        "typeTrip": "both",
        "action": "quotation",
        "online": "yes",
        "service": "air",
        "amount": 0,
        "percentage": 0,
        "ceilingPrice": 0,
        "inclusionDate": "2020-03-10T21:33:17.204Z"
    }
]
Propriedade Tipo Tamanho Descrição
feeId Int 50 ID de identificação do fee vinculado a solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Data inicial da solicitação. Exemplo: 2019-08-22
finalDate String (DateTime) 24 Data final da solicitação. Exemplo: 2019-08-22
name String 50 Nome do fee. Exemplo: Experience Bundle
description String 1024 Descrição do Fee. Exemplo: Será cobrado R$15,00 para Emissão De Bundle de trechos Nacionais ou Internacionais, feita online ou Offline. Para todas as solicitações (abertas a partir de 29/11/2019) nesse cliente. Caso o atendimento seja feito entre 00:00 e 23:59.
typeTrip String (Enum) 13 Tipo de viagem que o 'fee' está vinculado. Exemplo: 'both', 'international', ´domestic'
action String 13 Tipo de ação tomada para o Fee. Exemplo: 'quotation', 'ticketing'
online String 3 Campo que informa se o fee é online. Exemplo: yes/no
service String 7 Tipo de serviço do fee. Exemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Valor do Fee. Exemplo: 20
percentage Number 100 Porcentagem do Fee. Exemplo: 5
ceilingPrice Number 100 Valor teto do Fee. Exemplo: 35
inclusionDate String (DateTime) 24 Data de inclusão do Fee. Exemplo:

RequestsFlightsRequesteds

Por meio desse método, é possível recuperar os dados da emissão de uma solicitação aérea. Para recuperar os detalhes é necessário informar o ID da OS.

GET /requests/{requestId}/flights/requesteds

Requisição

requisição GET

Resposta

[
    {
        "id": "string",
        "quotationId": "00000000-0000-0000-0000-000000000000",
        "date": "2020-03-05T16:51:01.221Z",
        "departure": "string",
        "departureDescription": "string",
        "arrival": "string",
        "arrivalDescription": "string",
        "online": "yes",
        "cabin": "string",
        "compartment": "string",
        "observation": "string"
    }
]
Propriedade Tipo Tamanho Descrição
id Number(Integer) 3 Código da busca aérea do trecho solicitado. Exemplo: 0
quotationId String(Guid) 36 Id da cotação relacionado ao trecho solicitado. Exemplo: 00000000-0000-0000-0000-000000000000
date String(DateTime) 24 Data do trecho solicitado. Exemplo: 2020-09-18T16:48:22.490Z
departure String 3 Sigla do aeroporto de origem. Exemplo: CGH, GIG
departureDescription String 50 Descrição da cidade de origem. Exemplo: São Paulo, Congonhas
arrival String 3 Sigla do aeroporto de destino. Exemplo: CGH, GIG
arrivalDescription String 50 Descrição da cidade de destino. Exemplo: São Paulo, Congonhas
online String 3 Indica se o trecho relacionado a solicitação foi escolhido via finder (on-line). Exemplo: Yes
cabin String 1 Classe de serviço (cabine reservada). Exemplo: Y
observation String 255 Observações relevantes relacionadas ao trecho. Exemplo: Reunião de emergência

RequestsFollowUps

Por meio desse método, é possível recuperar os dados de FollowUp de uma solicitação. Para recuperar os detalhes é necessário informar o ID da OS no requestId.

GET /requests/{requestId}/followups

Requisição

requisição GET

Resposta

[
  {
    "recipients": "string",
    "message": "string",
    "inclusionDate": "2021-01-12T19:05:55.719Z",
    "sentBy": "string"
  }
]
Propriedade Tipo Tamanho Descrição
recipients String 512 Endereços de e-mail de todos os destinatários para os quais foram enviados um e-mail de FollowUp. Exemplo: email1@teste.com;email2@teste
message String 512 Mensagem registrada no FollowUp. Exemplo: Aberta por Consultor em nome de Viajante
inclusionDate DateTime 23 Data/hora da inclusão do FollowUp. Exemplo: 2021-01-06T16:15:01.000
sentBy String 20 Nome do usuário responsável pela geração do FollowUp. Exemplo: argo

POST /requests/{requestId}/followups

Requisição

{
	"recipients": "usuario@teste.com",
	"copyRecipients": "copia@teste.com",
	"AllRecipients": true,
	"message": "Não é possível emitir a OS devido a um problema com a cotação.",
	"sentByEmail": true,
	"sentToAgency": true
}
Propriedade Tipo Tamanho Obrigatório Descrição
recipients String 512* Não Endereços de e-mail dos destinatários para os quais devem ser enviados a mensagem de FollowUp. Exemplo: email1@teste.com;email2@teste.com / * OBS: A soma do tamanho dos campos recipients, copyrecipients, e-mails da agência (sentToAgency) e demais e-mails (AllRecipients) não pode ser maior do que 512 caracteres
copyRecipients String 512* Não Endereços de e-mail dos destinatários em cópia para os quais devem ser enviados um FollowUp. Exemplo: email3@teste.com;email4@teste.com / * OBS: A soma do tamanho dos campos recipients, copyrecipients, e-mails da agência (sentToAgency) e demais e-mails (AllRecipients) não pode ser maior do que 512 caracteres
AllRecipients Boolean 5 Não Define se o endereço de e-mail de todos os envolvidos na OS deve ser adicionado aos destinatários, ao se enviar o e-mail de FollowUp. Exemplo: True/False / * OBS: A soma do tamanho dos campos recipients, copyrecipients, e-mails da agência (sentToAgency) e demais e-mails (AllRecipients) não pode ser maior do que 512 caracteres
message String(Guid) 512 Sim Mensagem a ser registrada no FollowUp. Exemplo: OS aberta por Consultor em nome de Viajante
sentByEmail Boolean 5 Não Define se FollowUp deve ser enviado por e-mail. Exemplo: True/False
sentToAgency Boolean 5 Não Define se os e-mails da Agência devem ser adicionados automaticamente na lista de destinatários, ao se enviar o e-mail de FollowUp. Exemplo: True/False / * OBS: A soma do tamanho dos campos recipients, copyrecipients, e-mails da agência (sentToAgency) e demais e-mails (AllRecipients) não pode ser maior do que 512 caracteres

Resposta

resposta POST
Propriedade Tipo Tamanho Descrição
Message Number (int?) - Quantidade de FollowUps registrados na OS. Exemplo: 5

RequestsHotelsApartmentDetails

Retorna as informa��es do apartamento do hotel da cota��o. Para realizar essa consulta � necess�rio informar o ID da OS.

GET /requests/{requestId}/hotels/apartmentdetails

Request

Request GET

Response

[
    {
        "hotelRequestedId": "int",
        "quotationId": "int",
        "apartmentName": "string",
        "apartmentType": "string",
        "apartmentId": 0,
        "checkin": "2020-03-11T19:29:50.871Z",
        "checkout": "2020-03-11T19:29:50.871Z",
        "expirationDate": "2020-03-11T19:29:50.871Z"
    }        
]
Propriedade Tipo Tamanho Descri��o
hotelRequestedId Int 50 ID de identifica��o do hotel na cota��o. Exemplo: 1, 3, 5
quotationId Int 50 ID de identifica��o da Cota��o Escolhida (apenas produto Hotels). Exemplo: 1, 3, 5
apartmentName String 3 Nome/Identifica��o do Quarto no Hotel. Example: Individual Luxo
apartmentType String 3 Tipo do apartamento reservado. Exemplo: Single
apartmentId Int 100 ID de identifica��o do apartamento retornado. Exemplo: 1, 3, 5
checkin String (DateTime) 24 Data de checkin do hotel. Exemplo: 2019-08-20T12:00:00
checkout String (DateTime) 24 Data de checkout do hotel. Exemplo: 2019-08-22T12:00:00
expirationDate String (DateTime) 24 Data limite para cancelamento sem penalidade. Exemplo: 2019-12-19T12:00:00.000

RequestsHotelsQuotations

Através desse método é possível obter todas as informações relacionadas a cotação de hospedagem vinculada a uma determinada solicitação. Para realizar essa consulta é necessário informar o ID da OS.

GET /requests/{requestId}/hotels/quotations

Requisição

requisição GET

Resposta

[
    {
        "id": "string",
        "quotationId": "string",
        "online": "yes",
    "hotel": "string",
        "city": "string",
        "state": "string",
        "localization": "string",
        "country": "string",
        "hotelData": {
            "hotelId": "00000000-0000-0000-0000-000000000000",
            "city": "string",
            "webServiceId": "string",
            "integrationCode": "string",
            "name": "string",
            "address": "string",
            "neighborHood": "string",
            "cep": "string",
            "telephone": "string",
            "email": "string",
            "webSite": "string",
            "latitude": "string",
            "longitude": "string",
            "iss": 0,
            "tourismTax": 0,
            "serviceTax": 0,
            "coffee": "yes",
            "amenities": "string",
            "stars": 0,
            "hotelApartament": {
                "hotelId": "00000000-0000-0000-0000-000000000000",
                "name": "string",
                "apartamentType": "string",
                "apartamentId": 0,
                "expiration": "string",
                "coin": "string",
                "dailyValue": 0
            }
        },
        "formPayment": {
            "description": "string",
            "typePayment": "invoiced",
            "code": "string",
            "air": "yes",
            "hotels": "yes",
            "rental": "yes",
            "service": "yes",
            "bus": "yes",
            "restrictive": "yes",
            "alternativeUATP": "yes",
            "card": {
                "paymentName": "string",
                "name": "string",
                "cardNumber": "string",
                "flag": "string",
                "active": "yes",
                "providerId": "string",
                "webServiceId": "string"
            },
            "billingCode": "string",
            "billingDescription": "string"
        },
        "justificationLegs": [
            {
                "type": "string",
                "description": "string"
            }
        ],
        "dailyQuantity": 0,
        "coin": "string",
        "bacenCodeCoin": "string",
        "dailyValue": 0,
        "totalValue": 0,
        "approvedTotalValue": 0,
        "webService": "string",
        "observation": "string",
        "voucher": "string",
        "voucherDate": "2020-03-11T19:29:50.871Z",
        "agentUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "issuerUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "userId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "firstName": "string",
            "lastName": "string",
            "telephone": "string",
            "fax": "string",
            "registration": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "passport": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "hostedOffer": [
            {
                "id": "string",
                "hotel": "string",
                "apartament": "double",
                "bed": "doubleType",
                "observation": "string",
                "value": "string",
                "totalValue": 0
            }
        ],
        "apartamentType": "double",
        "bedType": "doubleType",
        "dailyValuePlus": 0,
        "dailyValueLess": 0,
        "dailyPercentagePlus": 0,
        "dailyPercentageLess": 0,
        "totalPercentagePlus": 0,
        "totalPercentageLess": 0,
        "fees": [
            {
                "feeId": "00000000-0000-0000-0000-000000000000",
                "initialDate": "2020-03-11T19:29:50.872Z",
                "finalDate": "2020-03-11T19:29:50.872Z",
                "initialHour": "string",
                "finalHour": "string",
                "dayWeek": "monday",
                "name": "string",
                "description": "string",
                "typeTrip": "both",
                "action": "quotation",
                "online": "yes",
                "service": "air",
                "amount": 0,
                "percentage": 0,
                "ceilingPrice": 0,
                "inclusionDate": "2020-03-11T19:29:50.873Z"
            }
        ],
    }
]
Propriedade Tipo Tamanho Descrição
id Int 50 ID de identificação do hotel na cotação. Exemplo: 1, 3, 5
quotationId Int 50 ID de identificação da Cotação Escolhida (apenas produto Hotels). Exemplo: 1, 3, 5
online String 3 Campo que indica se o hotel foi reservado através do módulo. Exemplo: yes/no
dailyQuantity Number 100 Quantidade de diárias inseridas na cotação. Exemplo: 10
coin String 3 Moeda utilizada na cotação. Exemplo: BRL
bacenCodeCoin Number 5 Código da Moeda no Banco Central (Bacen) utilizada pelo hotel. Exemplo: 790
dailyValue Number 100 Valor da diária inserida na cotação. Exemplo: 45,00
totalValue Number 100 Valor total do hotel. Exemplo: 450,00
approvedTotalValue Number 100 Valor total aprovado. Exemplo: 450,00
webService String 255 Web Service utilizado na reserva. Exemplo: AMADEUSWS
observation String 255 Observação da cotação do hotel. Exemplo: EXECUTIVO TWIN BREAKFAST INCLUIDED
voucher String 255 Voucher do hotel. Exemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Data em que o Voucher foi confirmado. Exemplo: 2019-12-18T20:33:58.400
netCommissionedRateType String 12 Indica se a tarifa do apartamento é Net ou Comissionada. Exemplo: Net/Comissionada
apartamentType String (Enum) 50 Valor descrevendo qual o tipo do apartamento. Exemplo: 'induvidual', 'double', 'triple' ou 'quadruple'
bedType String (Enum) 10 Tipo da cama. Exemplo: 'singleType', 'doubleType' e 'twinType'
dailyValuePlus Number 100 Valor acrescido ao valor da diária do hotel. Exemplo: 10,00
dailyValueLess Number 100 Valor decrescido ao valor da diária do hotel. Exemplo: 10,00
dailyPercentagePlus Number 100 Porcentagem acrescida ao valor diária do hotel. Exemplo: 2,00
dailyPercentageLess Number 100 Porcentagem decrescida ao valor diária do hotel. Exemplo: 2,00
totalPercentagePlus Number 100 Porcentagem acrescida ao valor total. Exemplo: 5,00
totalPercentageLess Number 100 Porcentagem decrescida ao valor.Exemplo: 5,00
clientId Guid 36 ID de identificação do cliente. Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID do usuário a qual o cartão pertence. Exemplo: 00000000-0000-0000-0000-000000000000
email String 100 E-mail do usuário cadastrado. Exemplo: pedro@silva.com
login String 50 Login do usuário cadastrado. Exemplo: Argo2019
firstname String 20 Nome do usuário cadastrado. Exemplo: Pedro
lastName String 20 Sobrenome do usuário cadastrado. Exemplo: Silva
telephone String 30 Telefone do usuário. Exemplo: 5511998525545
fax String 30 Fax do usuário. Exemplo: 5511998525545
registration String 255 Identificador de matrícula do usuário. Exemplo: 10377192
thirdParty String 3 Flag indica se o usuário é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
passport String 20 Passaporte do usuário. Exemplo: BR123456
employeeId String 20 Matricula do usuário. Exemplo: 464545
fullname String 100 Nome completo do usuário que será cadastrado. Exemplo: Pedro Silva
integrationCode String 50 Código de integração do usuário. Exemplo: 454555
department String 50 Departamento vinculado ao cadastro do usuário. Exemplo: Desenvolvimento
hotelData Objeto responsável por retornar as informações dos hotéis da cotação
Propriedade Tipo Tamanho Descrição
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
city String 50 Nome da cidade de localização do hotel. Exemplo: Adamantina
webServiceId String 255 Identificador do Web Service que provê as informações do hotel. Exemplo: AMADEUS
integrationCode String 3 Código de integração do motivo de viagem (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'MOTIVO1010'
name String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
address String 50 Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
neighborHood String 50 Bairro de localização do Hotel. Exemplo: Meirelles
cep String 8 CEP de localização do Hotel. Exemplo: 14815000
telephone String 23 Telefone de contato do Hotel: Exemplo: +55 (16) 3343-2325
email String 50 E-mail de contato do Hotel. Exemplo: hotelsb2b@hotelsbtwob
webSite String 50 Site do hotel. Exemplo: http://www.hotelsbtwob.com/
latitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 255348752
longitude Number (Float?) 100 Coordenada geográfica de localização do Hotel. Exemplo: 485526208
iss Number (Decimal?) 100 Tarifa tributária do serviço prestado pelo Hotel. Exemplo: 5,00
tourismTax Number (Decimal?) 100 Taxa de turismo do hotel. Exemplo: 10,00
serviceTax Number (Decimal?) 100 Taxa de serviço do hotel. Exemplo: 5,00
coffee String 3 Informação de existência do serviço de café no Hotel.Exemplo yes/no
amenities String 255 Amenidades encontradas no Hotel. Exemplo: WIFI
stars Number (int) 100 Classificação do Hotel. Exemplo: 3
hotel String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
city String 50 Nome da cidade de localização do hotel. Exemplo: Adamantina
state String 2 Sigla do estado onde está localizado o hotel. Exemplo: SP
localization String 50 Endereço de localização do Hotel. Exemplo: Rua Frei Mansueto, 160
country String 50 Sigla do país onde está localizado o hotel. Exemplo: BR
hotelApartament Objeto responsável por retornar as informações do apartamento do hotel da cotação
Propriedade Tipo Tamanho Descrição
hotelId Guid 36 ID de identificação do hotel retornado. Exemplo: 00000000-0000-0000-0000-000000000000
name String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
apartamentType String (Enum) 50 Valor descrevendo qual o tipo do apartamento. Exemplo: Individual, Double, Triple ou Quadruple
apartamentId Number (int) 100 ID de identificação do apartamento retornado. Exemplo: 1, 3, 5
expiration String 50 Data da validade da tarifa do apartamento. Exemplo: 2019-09-18
coin String 3 Moeda relacionada a tarifa do apartamento. Exemplo: BRL
dailyValue Number (Double) 100 Valor da diária do apartamento. Exemplo: 45,00
formPayment Objeto responsável por retornar as informações da forma de pagamento da solicitação
Propriedade Tipo Tamanho Descrição
description String 255 Descrição da forma de pagamento da solicitação. Exemplo: Faturado
typePayment String (Enum) 15 Tipos de pagamento utilizado. Exemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integração da forma de pagamento. (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'TIPOFATURA1010'
air String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto aéreo.Exemplo: yes/no
hotels String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto hotel. Exemplo: yes/no
rental String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto locação. Exemplo: yes/no
service String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto Serviço. Exemplo: yes/no
bus String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto Rodoviário. Exemplo: yes/no
restrictive String 3 A propriedade indica se o faturamento é do tipo restritivo. Exemplo: yes/no
alternativeUATP String 3 Propriedade indica se o pagamento é UATP. Exemplo: yes/no
card Objeto responsável por retornar as informações do cartão utilizado na solicitação
Propriedade Tipo Tamanho Descrição
paymentName String 50 Nome da forma do pagamento do cartão. Exemplo: cartão de Crédito
name String 255 Nome do usuário que utilizou o cartão. Exemplo: Maurício
cardNumber String 255 Número do cartão. Exemplo: 3216-8394-9403-0604
flag String 50 Indica qual a bandeira do cartão. Exemplo: Visa, Mastercard
active String 3 Campo indica se o cartão está ativo. Exemplo: yes/no
providerId String 50 Identificador do provedor do cartão. Exemplo: T0009015590A999118
webServiceId String 50 Identificador do WebService do cartão (Apenas para cartão virtual). Exemplo: B2BPAY, WEX, CONFERMA
cardAuthorization String 50 Número de autorização do cartão (quando for essa a opção de pagamento do trecho) inserido no momento da emissão do aéreo
billingCode String 50 Código de faturamento da forma de pagamento. Exemplo: BV5
billingDescription String 50 Descrição do código de faturamento da forma de pagamento. Exemplo: FATURAMENTO TOTAL PARA A AGÊNCIA
justificationLegs Objeto responsável por retornar as justificativas da cotação de hotel
Propriedade Tipo Tamanho Descrição
type String 255 Tipo da justificativa. Exemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descrição da justificativa. Exemplo: Hotel não se enquadra no teto de diária do viajante.
agentUser Objeto responsável por retornar as informações do usuário atendente
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente. Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do atendente da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do solicitante da OS. Exemplo: roberto.luiz
firstName String 255 Primeiro nome do atendente da solicitação.Exemplo: Roberto
lastName String 255 Último nome do atendente da solicitação. Exemplo: Luiz
telephone String 50 Telefone do atendente da OS. Exemplo: 9 95463154
fax String 50 Fax do atendente da solicitação. Exemplo: 9 95463154
registration String 20 Matrícula do usuário atendente. Exemplo: 464545
thirdParty String 3 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido: Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
department String 255 Departamento do usuário. Exemplo: Jurídico
issuerUser Objeto responsável por retornar as informações do usuário emissor
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do emissor da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do emissor da solicitação. Exemplo: roberto.luiz
firstName String 255 Primeiro nome do emissor da solicitação. Exemplo: Roberto
lastName String 255 Último nome do emissor da solicitação. Exemplo: Luiz
telephone String 50 Telefone do emissor da solicitação. Exemplo: 9 95463154
fax String 50 Fax do emissor da solicitação. Exemplo: 9 95463154
registration String 20 Matrícula do emissor da solicitação. Exemplo: 464545
thirdParty String 3 Flag que indica se o emissor é terceiro ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido: Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
passport String 20 Passaporte do usuário. Exemplo: BR123456
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário emissor (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUEMISSOR1010'
department String 255 Departamento do usuário. Exemplo: Compras
hostedOffer Objeto responsável por retornar as informações da hospedagem ofertada
Propriedade Tipo Tamanho Descrição
id String 50 Identificador da hospedagem ofertada (combinação da hospedagemId e cotacaoId). Exemplo: 1_1, 0_1
hotel String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
apartament String (Enum) 50 Valor descrevendo qual o tipo do apartamento. Exemplo: 'induvidual', 'double', 'triple' ou 'quadruple'
bed String (Enum) 10 Tipo da cama da hospedagem ofertada. Exemplo: 'singleType', 'doubleType' e 'twinType'
observation String 255 Observação da hospedagem ofertada. Exemplo: EXECUTIVO TWIN BREAKFAST INCLUIDED
hotel String 50 Nome do Hotel. Exemplo: Comfort Hotel Fortaleza
value String 100 Valores cobrados pela hospedagem ofertada. Exemplo: 45,00 + 10,00
totalValue Number 100 Cálculo dos valores apresentados na propriedade 'value' (Valor diária + Taxas). Exemplo: 55,00
fees Objeto responsável por retornar as informações do fee da cotação hospedagem
Propriedade Tipo Tamanho Descrição
feeId Int 50 ID de identificação do fee vinculado a solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Data inicial da solicitação. Exemplo: 2019-08-22
finalDate String (DateTime) 24 Data final da solicitação. Exemplo: 2019-08-22
name String 50 Nome do fee. Exemplo: Experience Bundle
description String 1024 Descrição do Fee. Exemplo: Será cobrado R$15,00 para Emissão De Bundle de trechos Nacionais ou Internacionais, feita Online ou Offline. Para todas as solicitações (abertas a partir de 29/11/2019) nesse cliente . Caso o atendimento seja feito entre 00:00 e 23:59.
typeTrip String (Enum) 13 Tipo de viagem que o 'fee' está vinculado. Exemplo: 'both', 'international', 'domestic'
action String 13 Tipo de ação tomada para o Fee. Exemplo: 'quotation', 'ticketing'
online String 3 A propriedade informa se o fee é online. Exemplo: yes/no
service String 7 Tipo de serviço do fee. Exemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Valor do Fee. Exemplo: 20
percentage Number 100 Porcentagem do Fee. Exemplo: 5
ceilingPrice Number 100 Valor teto do Fee. Exemplo: 35
inclusionDate String (DateTime) 24 Data de inclusão do Fee. Exemplo: 2020-03-11T19:29:50.873Z

GET /requests/{requestId}/hotels/apartamentdetails

Retorna as informações do apartamento do hotel da cotação. Para realizar essa consulta é necessário informar o ID da OS.

Requisição

Request GET

Resposta

[
    {
        "hotelRequestedId": "int",
        "quotationId": "int",
        "apartamentName": "string",
        "apartamentType": "string",
        "apartamentId": 0,
        "checkin": "2020-03-11T19:29:50.871Z",
        "checkout": "2020-03-11T19:29:50.871Z",
        "expirationDate": "2020-03-11T19:29:50.871Z"
    }        
]
Propriedade Tipo Tamanho Descrição
hotelRequestedId Int 50 ID de identificação do hotel na cotação. Exemplo: 1, 3, 5
quotationId Int 50 ID de identificação da Cotação Escolhida (apenas produto Hotels). Exemplo: 1, 3, 5
apartamentName String 3 Nome/Identificação do Quarto no Hotel. Example: Individual Luxo
apartamentType String 3 Tipo do apartamento reservado. Exemplo: Single
apartamentId Int 100 ID de identificação do apartamento retornado. Exemplo: 1, 3, 5
checkin String (DateTime) 24 Data de checkin do hotel. Exemplo: 2019-08-20T12:00:00
checkout String (DateTime) 24 Data de checkout do hotel. Exemplo: 2019-08-22T12:00:00
expirationDate String (DateTime) 24 Data limite para cancelamento sem penalidade. Exemplo: 2019-12-19T12:00:00.000

RequestsHotelsRequesteds

Através desse método é possível recuperar os dados dos hotéis vinculados a uma determinada solicitação. Para obter essas informações, é necessário que na consulta seja informado o ID da OS que deseja pesquisar.

GET /requests/{requestId}/hotels/requesteds

Requisição

requisição GET

Resposta

[
    {
        "id": 0,
        "online": "yes",
        "checkin": "2020-03-10T21:33:17.250Z",
        "checkout": "2020-03-10T21:33:17.250Z",
        "city": "string",
        "apartamentType": "string",
        "bedType": "string",
        "observation": "string"
    }
]
Propriedade Tipo Tamanho Descrição
id Int 50 ID de identificação do hotel na solicitação. Exemplo: 1, 3, 5
online String 3 Campo que indica se o hotel foi reservado através do módulo On-Line.Exemplo: yes/no
checkin String (DateTime) 24 Data de checkin do hotel. Exemplo: 2019-08-22T12:00:00
checkout String (DateTime) 24 Data de checkout do hotel. Exemplo: 2019-08-22T12:00:00
city String 50 Cidade onde se encontra o hotel. Exemplo: RIO DE JANEIRO / RJ
apartamentType String 50 Tipo do apartamento reservado. Exemplo: Single
bedType String 50 Tipo da cama do apartamento reservado. Exemplo: Single
observation String 255 Observações a respeito do hotel alugado.Exemplo. Quarto duplo com ar

RequestsJustifications

Através desse método é possível recuperar as justificativas de viagem inseridas em uma solicitação. A inclusão da justificativa em uma OS pode ocorrer por diversos motivos, como por exemplo o não cumprimento das políticas de viagens. Para obter esse dado é necessário informar o ID da solicitação. Para mais informações consulte a Wiki.

GET requests/{requestId}/justifications

Requisição

requisição GET

Resposta

[
    {
        "type": "string",
        "description": "string"
    }
]
Propriedade Tipo Tamanho Descrição
type String 6 Tipo de Justificativa relacionada a solicitação. Exemplo: ESCAER, ESCHOS
description String 255 Descrição da justificativa relacionada a solicitação. Exemplo: Melhor tarifa no período.

requestsManagementFields

Através desse método é possível recuperar os campos gerenciais vinculados a uma determinada solicitação. Para obter essas informações é necessário informar o ID da solicitação.

GET /requests/{requestId}/managementfields

Requisição

requisição GET

Resposta

[
    {
        "managementFieldId": "string",
        "content": "string"
    }
]
Propriedade Tipo Tamanho Descrição
managementFieldId String 100 ID do campo gerencial relacionado a solicitação. Exemplo: Reserva_Ficticia_Argo
content String 8000 Conteúdo do campo gerencial relacionado a solicitação. Exemplo: E2989298929

POST /requests/{requestId}/managementfields

Requisição

requisição POST
Propriedade Tipo Tamanho Obrigatório Descrição
complement String 10 Sim Complemento do campo gerencial relacionado a solicitação. Exemplo: Argo_reserva
managementFieldId String 100 Sim ID do campo gerencial relacionado a solicitação. Exemplo: Reserva_Ficticia_Argo
content String 8000 Sim Conteúdo do campo gerencial relacionado a solicitação. Exemplo: E2989298929

Resposta

resposta POST /requests/{requestId}/managementfields
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na inserção do campo gerencial. Exemplo: True/False

PUT /requests/{requestId}/managementfields

Requisição

requisição PUT
Propriedade Tipo Tamanho Obrigatório Descrição
complement String 10 Sim Complemento do campo gerencial relacionado a solicitação. Exemplo: Argo_reserva
managementFieldId String 100 Sim ID do campo gerencial relacionado a solicitação. Exemplo: Reserva_Ficticia_Argo
content String 8000 Sim Conteúdo do campo gerencial relacionado a solicitação. Exemplo: E2989298929

Resposta

resposta PUT /requests/{requestId}/managementfields
Propriedade Tipo Tamanho Descrição
message String 5 Sucesso ou falha na alteração do campo gerencial. Exemplo: True/False

RequestsReasonsTravel

O motivo de viagem é uma informação obrigatório na abertura da OS. Através desse método é possível recuperá-lo. Lembrando que para obter essa informação é necessário informar o ID da solicitação. Para maiores informações sobre motivo de viagem, consulte a Wiki.

GET requests/{requestId}/reasonstravel

Requisição

requisição GET

Resposta

{
    "reasonTravelId": "00000000-0000-0000-0000-000000000000",
    "description": "string",
    "alert": "string",
    "initialDate": "2020-03-05T10:51:18.895Z",
    "finalDate": "2020-03-05T10:51:18.895Z",
    "legs": [
        "air"
    ],
    "requiresDescription": "yes",
    "requiresAuthorization": "yes",
    "quotationAvailable": "yes",
    "allowCompanions": "yes",
    "validateExpenseReport": "yes",
    "closingCard": "yes",
    "integrationCode": "string"
}
Propriedade Tipo Tamanho Descrição
reasonTravelId String(Guid) 36 Id do motivo de viagem vinculado a solicitação. Exemplo: 58791410-a137-4c50-b948-v090f2b474fv
description String 50 Descrição do motivo de viagem. Exemplo: Treinamento
alert String 2000 Mensagem de alerta quando o motivo de viagem é selecionado. Exemplo: Motivo de viagem não permite viagens internacionais
initialDate String(DateTime) 24 Data inicial do motivo de viagem. Exemplo: 2019-10-02T19:47:10.450Z
finalDate String(DateTime) 24 Data final do motivo de viagem. Exemplo: 2019-10-02T19:47:10.450Z
legs String(Enum) 15 Quais produtos o motivo de viagem está vinculado.Exemplo: Air, Rental, Refund
requiresDescription String(Enum) 3 Indica se descrição é obrigatória quando o motivo de viagem é selecionado. Exemplo: Yes/No
requiresAuthorization String(Enum) 3 Indica se a solicitação necessita de autorização quando selecionado o motivo de viagem. Exemplo: Yes/No
quotationAvailable String(Enum) 3 Indica se o motivo de viagem inserido na solicitação exige cotação.Exemplo: Yes/No
allowCompanions String(Enum) 3 Indica se o motivo de viagem selecionado na solicitação permite a inclusão de acompanhantes. Exemplo: Yes/No
validateExpenseReport String(Enum) 3 Indica se o motivo de viagem inserido na solicitação exige prestação de contas. Exemplo: Yes/No
closingCard String(Enum) 3 Indica se o motivo da viagem inserido na solicitação permite o fechamento de cartão. Exemplo: Yes/No
integrationCode String 30 Código de integração do motivo de viagem. Exemplo: 175

RequestsRentalsQuotations

Através desse método é possível obter todas as informações relacionadas a cotação de Locação vinculada a uma determinada solicitação. Para realizar essa consulta é necessário informar o ID da OS.

GET /requests/{requestId}/rentals/quotations

Requisição

requisição GET
[
 {
    "id": "String",
    "quotationId": "String",
    "carRental": "String",
    "carRentalIata": "String",
    "vehicle": "String",
    "pickUpLocation": "String",
    "dropOffLocation": "String",
    "pickUpAdress": "String",
    "dropOffAdress": "String",
    "airConditioning": "yes",
    "driver": "yes",
    "category": "economy",
    "gear": "automatic",
    "gps": "yes",
    "observation": "String",
    "integrationCode": "String",
    "country": "String",
    "webService": "String",
    "voucher": "String",
    "voucherDate": "2021-03-18T18:50:52.974Z",
    "dailyQuantity": 0,
    "coin": "String",
    "bacenCodeCoin": "String",
    "dailyValue": 0,
    "totalValue": 0,
    "approvedTotalValue": 0,
    "dailyValuePlus": 0,
    "dailyValueLess": 0,
    "dailyPercentagePlus": 0,
    "dailyPercentageLess": 0,
    "totalPercentagePlus": 0,
    "totalPercentageLess": 0,
    "additionalServicesValue": 0,
    "returnValue": 0,
    "safeValue": 0,
    "otherValue": 0,
    "agentUser": {
      "clientId": "00000000-0000-0000-0000-000000000000",
      "email": "String",
      "login": "String",
      "firstName": "String",
      "lastName": "String",
      "telephone": "String",
      "fax": "String",
      "registration": "String",
      "thirdParty": "yes",
      "groups": [
        "admin"
      ],
      "rg": "String",
      "cpf": "String",
      "passport": "String",
      "employeeId": "String",
      "fullName": "String",
      "integrationCode": "String",
      "department": "String"
    },
    "issuerUser": {
      "clientId": "00000000-0000-0000-0000-000000000000",
      "email": "String",
      "login": "String",
      "firstName": "String",
      "lastName": "String",
      "telephone": "String",
      "fax": "String",
      "registration": "String",
      "thirdParty": "yes",
      "groups": [
        "admin"
      ],
      "rg": "String",
      "cpf": "String",
      "passport": "String",
      "employeeId": "String",
      "fullName": "String",
      "integrationCode": "String",
      "department": "String"
    },
    "fees": [
      {
        "feeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-03-18T18:50:52.974Z",
        "finalDate": "2021-03-18T18:50:52.974Z",
        "initialHour": "String",
        "finalHour": "String",
        "dayWeek": "monday",
        "name": "String",
        "description": "String",
        "typeTrip": "both",
        "action": "quotation",
        "online": "yes",
        "service": "air",
        "amount": 0,
        "percentage": 0,
        "ceilingPrice": 0,
        "inclusionDate": "2021-03-18T18:50:52.974Z"
      }
    ],
    "justificationLegs": [
      {
        "type": "String",
        "description": "String"
      }
    ],
    "formPayment": {
      "description": "String",
      "typePayment": "invoiced",
      "code": "String",
      "air": "yes",
      "hotels": "yes",
      "rental": "yes",
      "service": "yes",
      "bus": "yes",
      "restrictive": "yes",
      "alternativeUATP": "yes",
      "card": {
        "paymentName": "String",
        "name": "String",
        "cardNumber": "String",
        "flag": "String",
        "active": "yes",
        "providerId": "String",
        "webServiceId": "String"
      },
      "billingCode": "String",
      "billingDescription": "String"
    },
    "rentalOffer": [
      {
        "id": "String",
        "airConditioning": "yes",
        "category": "economy",
        "driver": "yes",
        "totalValue": 0
      }
    ]
  }   
]
Propriedade Tipo Tamanho Descrição
id Int 2 ID de identificação do que foi Solicitado da locação de veículo. Exemplo: 1, 3, 5
quotationId Int 2 Id de identificação das cotações. Se um trecho de locação possuir 7 cotações, esta variável será incrementada
carRental String 10 Nome da locadora.
carRentalIata String 10 Código Iata da locadora.Exemplo: 7878
vehicle String 50 Veículo (Nome, marca). Detalhes do veículo.Exemplo. Ford Focus
pickUpLocation String 255 Local de retirada do veículo.Exemplo. São Paulo (Endereço)
dropOffLocation String 255 Local de devolução do veículo.Exemplo. São Paulo (Endereço)
pickUpAdress String 255 endereço de retirada do veículo.Exemplo. São Paulo
dropOffAdress String 255 endereço de devolução do veículo.Exemplo. São Paulo
airConditioning String 3 Campo que indica se o veículo possui ou não ar-condicionado. Exemplo: yes/no
driver String 3 Flag que indica se o veículo será contratado com motorista.Exemplo: Yes/No
category String (Enum) 30 Indica qual a categoria do veículo. Exemplo: Econômico, Superior, especial, etc.
gear String (Enum) 10 Indica qual o tipo de câmbio do veículo. Exemplo: Manual ou automático
gps String 3 Indica se o veículo será contratado com GPS.Exemplo: yes/No
country String 50 Sigla do país onde está localizado a locadora. Exemplo: BR
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
Observation String 255 Observação da cotação do veículo.Exemplo: Retirar às 12hrs.
coin String 3 Moeda utilizada na cotação. Exemplo: BRL
bacenCodeCoin Number 5 Código da Moeda no Banco Central (Bacen) utilizada pela locadora. Exemplo: 790
dailyQuantity Number 100 Quantidade de diárias inseridas na cotação. Exemplo: 10
dailyValue Number 100 Valor da diária inserida na cotação. Exemplo: 45,00
totalValue Number 100 Valor total da locação. Exemplo: 450,00
approvedTotalValue Number 100 Valor total aprovado. Exemplo: 450,00
dailyValuePlus Number 100 Valor acrescido ao valor da diária da locação. Exemplo: 10,00
dailyValueLess Number 100 Valor decrescido ao valor da diária da locação. Exemplo: 10,00
dailyPercentagePlus Number 100 Porcentagem acrescida ao valor diária da locação. Exemplo: 2,00
dailyPercentageLess Number 100 Porcentagem decrescida ao valor diária da locação. Exemplo: 2,00
totalPercentagePlus Number 100 Porcentagem acrescida ao valor total. Exemplo: 5,00
totalPercentageLess Number 100 Porcentagem decrescida ao valor.Exemplo: 5,00
returnValue Number 100 Valor de retorno
safeValue Number 100 Valor do seguro.
otherValue Number 100 Outros lançamentos de valores
voucher String 255 Voucher da locação. Exemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Data em que o Voucher foi confirmado. Exemplo: 2019-12-18T20:33:58.400
webService String 255 Web Service utilizado na reserva. Exemplo: AMADEUSWS
additionalServicesValue Number 100 Valores adicionais
justificationLegs Objeto responsável por retornar as justificativas da cotação de locação
Propriedade Tipo Tamanho Descrição
type String 255 Tipo da justificativa. Exemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descrição da justificativa. Exemplo: Locação não se enquadra no teto de diária do viajante.
agentUser Objeto responsável por retornar as informações do usuário atendente
Propriedade Tipo Tamanho Descrição
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
department String 255 Departamento do usuário. Exemplo: Jurídico
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
email String 50 E-mail de contato do atendente da solicitação.Exemplo: roberto.luiz@fdtps.br
login String 50 Login do solicitante da OS.Exemplo: roberto.luiz
telephone String 50 Telefone do atendente da solicitação. Exemplo: 9 95463154
cpf String 15 Número do CPF do usuário. Exemplo:665.854.965-63
rg String 15 Número do RG do usuário.Exemplo: 45.585.412-X
fax String 50 Fax do atendente da solicitação. Exemplo: 9 95463154
thirdParty String 3 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
groups String 10 Grupo no qual o usuário está inserido. Exemplo: 'user', 'admin', 'manager', 'financial'
issuerUser Objeto responsável por retornar as informações do usuário Emissor
Propriedade Tipo Tamanho Descrição
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
department String 255 Departamento do usuário. Exemplo: Jurídico
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
email String 50 E-mail de contato do atendente da solicitação.Exemplo: roberto.luiz@fdtps.br
login String 50 Login do solicitante da OS.Exemplo: roberto.luiz
telephone String 50 Telefone do atendente da solicitação. Exemplo: 9 95463154
cpf String 15 Número do CPF do usuário. Exemplo:665.854.965-63
rg String 15 Número do RG do usuário.Exemplo: 45.585.412-X
fax String 50 Fax do atendente da solicitação. Exemplo: 9 95463154
thirdParty String 3 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
groups String 10 Grupo no qual o usuário está inserido. Exemplo: 'user', 'admin', 'manager', 'financial'
fees Objeto exibe a estrutura do Fee vinculado à cotação de veículos
Propriedade Tipo Tamanho Descrição
feeId Guid 36 Id do Fee aplicado na solicitação.Exemplo: 00000000-0000-0000-0000-000000000000
initialDate String 24 Data inicial. Exemplo: 2019-08-22
finalDate String 24 Data final. Exemplo: 2019-08-22
name String 100 Nome do Fee aplicado nesta cotação de locação.Exemplo: Fee de cotação
description String 1024 Descrição completa do fee aplicadoExemplo: Valor de R$ 25,00 aplicado na cotação de locação de veículo
typeTrip String (Enum) 20 Propriedade indica qual tipo de viagem o Fee é aplicado.Exemplo: Domestic, International ou both
action String 20 Indica em qual momento o Fee é aplicado.Exemplo: Quotation ou Ticketing
online String 3 Campo que informa se o fee é online. Exemplo: yes/no
service String(Enum) 20 Indica qual produto o fee é aplicado. Exemplo: Rental, Hotels, service, etc
amount double 10 Valor do fee que será cobrado.Exemplo: 20,00
percentage double 10 Porcentagem do Fee. Exemplo: 5
ceilingProce double 10 Valor teto do Fee. Exemplo: 35
inclusionDate String 24 Data de inclusão do Fee. Exemplo: 2020-03-11T19:29:50.873Z
formPayment Objeto responsável por retornar as informações da forma de pagamento da solicitação
Propriedade Tipo Tamanho Descrição
description String 255 Descrição da forma de pagamento da solicitação. Exemplo: Faturado
typePayment String (Enum) 15 Tipos de pagamento utilizado. Exemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integração da forma de pagamento. (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'TIPOFATURA1010'
Air String 3 Propriedade indica se o pagamento pode ser utilizado para aéreo. Exemplo: yes/no
hotels String 3 Propriedade indica se o pagamento pode ser utilizado para hospedagem. Exemplo: yes/no
rental String 3 Propriedade indica se o pagamento pode ser utilizado para Locação. Exemplo: yes/no
service String 3 Propriedade indica se o pagamento pode ser utilizado para Serviço. Exemplo: yes/no
bus String 3 Propriedade indica se o pagamento pode ser utilizado para rodoviário.Exemplo: yes/no
restrictive String 3 Propriedade indica se o pagamento é restritivo. Exemplo: yes/no
alternativeUATP String 3 Propriedade indica se o pagamento é UATP. Exemplo: yes/no
billingCode String 50 Código de faturamento da forma de pagamento. Exemplo: BV5
billingDescription String 50 Descrição do código de faturamento da forma de pagamento. Exemplo: FATURAMENTO TOTAL PARA A AGÊNCIA
card Objeto responsável por retornar as informações do cartão utilizado pela solicitação
Propriedade Tipo Tamanho Descrição
paymentName String 50 Nome da forma do pagamento do cartão.Exemplo: Cartão de crédito
name String 50 Nome do usuário titular do cartão.Exemplo: Pedro Silva
cardNumber String 255 Número do cartão. Exemplo: 3216-8394-9403-0604
flag String 50 Indica qual a bandeira do cartão. Exemplo: Visa, Mastercard
active String 3 Campo que indica se o cartão está ativo. Exemplo: yes/no
providerId String 50 Identificador do provedor do cartão. Exemplo: T0009015590A999118
webServiceId String 50 Identificador do WebService do cartão (Apenas para cartão virtual). Exemplo: B2BPAY, WEX, CONFERMA
rentalOffer Objeto responsável por retornar locações ofertadas
Propriedade Tipo Tamanho Descrição
id String 50 Id da oferta de locação.
category String 20 Categoria da oferta. Enum (economy,intermediate,superior,compact,special)
totalValue double 10 Valor total da oferta.
airConditioning String 3 Campo que indica se o veículo possui ou não ar-condicionado. Exemplo: yes/no
driver String 3 Flag que indica se o veículo será contratado com motorista.Exemplo: Yes/No

RequestsRentalsRequesteds

Através desse método é possível recuperar as informações relacionadas as locações de veículo vinculadas a uma determinada solicitação. Para obter esses dados é necessário informar o ID da OS.

GET /requests/{requestId}/rentals/requesteds

Requisição

requisição GET

Resposta

[
    {
        "id": 0,
        "carRental": "string",
        "pickUpLocation": "string",
        "dropOffLocation": "string",
        "dropOffDate": "2020-03-10T21:33:17.277Z",
        "pickUpDate": "2020-03-10T21:33:17.277Z",
        "airConditioning": "yes",
        "driver": "yes",
        "category": "economy",
        "gear": "automatic",
        "observation": "string",
        "gps": "yes"
    }
]
Propriedade Tipo Tamanho Descrição
id Int 50 ID de identificação da locação na solicitação.Exemplo: 1, 3, 5
carRental String 50 Nome da locadora de onde foi feita a locação. Exemplo: ATESA
pickUpLocation String 255 Local de retirada do veículo. Exemplo: São Paulo / SP, Brasil (SAO)
dropOffLocation String 255 Local de devolução do veículo. Exemplo: Rio de Janeiro / RJ, Brasil - Galeão (GIG)
dropOffDate String (DateTime) 24 Data de devolução do veículo. Exemplo: 2019-08-22T12:00:00
pickUpDate String (DateTime) 24 Data de retirada do veículo. Exemplo: 2019-08-18T12:00:00
airConditioning String 3 Campo indica se o veículo possui ar condicionado. Exemplo: yes/no
driver String 3 Campo indica se o veículo possui motorista particular. Exemplo: yes/no
category String (Enum) 12 Categoria na qual o veículo pertence. Exemplo: 'economy', 'intermediate', 'superior', 'compact', 'special'
gear String (Enum) 10 Tipo de câmbio do veículo. Exemplo: automatic/manual
observation String 255 Observações a respeito do veículo alugado.Exemplo: Retirar a partir das 08h00.
gps String 3 Campo ndica se o veículo possui GPS. Exemplo: yes/no

RequestsRequesters

Através desse método é possível recuperar os dados de um solicitante de uma determinada OS. Para obter essas informações é necessário informar o ID da solicitação.

GET / requests/{requestId}/requesters

Requisição

requisição GET

Resposta

{
    "clientId": "00000000-0000-0000-0000-000000000000",
    "userId": "00000000-0000-0000-0000-000000000000",
    "email": "string",
    "login": "string",
    "firstName": "string",
    "lastName": "string",
    "telephone": "string",
    "fax": "string",
    "thirdParty": "yes",
    "groups": [
        "admin"
    ],
    "rg": "string",
    "cpf": "string",
}
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente.Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de identificação do usuário solicitante retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 24 E-mail de contato do solicitante da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 24 Login do solicitante da solicitação.Exemplo: roberto.luiz
firstName String 3 Primeiro nome do solicitante da solicitação Exemplo: Roberto
lastName Int 5 Último nome do solicitante da solicitação. Exemplo: Luiz
telephone String 50 Telefone do solicitante da solicitação.Exemplo: 9 95463154
fax String Fax do solicitante da solicitação. Exemplo: 9 95463154
thirdParty String 8 Flag que indica se o atendente é terceirizado ou não. Exemplo: yes/no
groups String 25 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String Número do RG do usuário. Exemplo: 45.585.412-X
cpf String Número do CPF do usuário. Exemplo: 665.854.965-63

RequestsRoadsQuotations

Através desse método é possível recuperar os dados que foram cotados em uma determinada solicitação de rodoviário.

Ao realizar essa requisição, serão retornados os dados que o consultor inseriu na solicitação (On-Line/Off-Line). No caso de uma cotação On-Line, os trechos com os menores valores serão registrados como cotações ofertadas.

Wiki

GET

Requisição

requisição GET

Resposta

[ 
    {
        "id": "2", 
        "quotationId": "1", 
        "online": "no", 
        "typeTrip": "domestic", 
        "agent": { 
            "clientId": "3f9a4a0c-9c7f-414d-8d15-a8502bb4f6cb", 
            "email": "rodrigo.lins@useargo.com", 
            "login": "rodrigo.lins@argo", 
            "thirdParty": "no", 
            "groups": [ 
                "admin" 
            ], 
            "fullName": "RODRIGO LINS" 
        }, 
        "emitter": { 
            "clientId": "3f9a4a0c-9c7f-414d-8d15-a8502bb4f6cb", 
            "email": "rodrigo.lins@useargo.com", 
            "login": "rodrigo.lins@argo", 
            "thirdParty": "no", 
            "groups": [ 
                "admin" 
            ], 
            "fullName": "RODRIGO LINS" 
        }, 
        "inclusionDate": "2020-03-23T09:12:00.587", 
        "changeDate": "2020-03-23T09:12:00.587", 
        "expirationDate": "2020-03-27T12:00:00", 
        "boarding": "2020-06-06T19:00:00", 
        "landing": "2020-06-06T23:00:00", 
        "originTerminal": "São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)", 
        "originCity": "São Paulo", 
        "destinationCity": "Catanduva", 
        "destinationTerminal": "CATANDUVA (SP, BRASIL) / SP, Brasil", 
        "marketingAirline": "Viação Commeta", 
        "formPayment": { 
            "description": "Cartao - tdos produtos", 
            "typePayment": "creditCard", 
            "air": "yes", 
            "hotels": "yes", 
            "rental": "yes", 
            "service": "yes", 
            "bus": "yes", 
            "restrictive": "no", 
            "alternativeUATP": "no", 
            "card": { 
                "cardNumber": "1111-1111-1111-1111", 
                "flag": "VI", 
                "active": "no" 
            } 
        }, 
        "feesLeg": [], 
        "coin": "BRL", 
        "bacenCodeCoin": "790", 
        "passageValuePlus": 0.0, 
        "passageValueLess": 0.0, 
        "percentagePassagePlus": 0.0, 
        "percentagePassageLess": 0.0, 
        "totalValue": 150.0, 
        "percentageTotalPlus": 0.0, 
        "percentageTotalLess": 0.0, 
        "observation": "" 
    } 
]
Propriedade Tipo Tamanho Descrição
id Int 50 ID de identificação do que foi Solicitado do Rodoviário. Exemplo: 1, 3, 5
quotationId Int 50 Id de identificação das cotações. Se um trecho de rodoviário possuir 7 cotações, é esta variável que será incrementada
online String 3 Campo que indica se o hotel foi reservado de forma online. Exemplo: yes/no
typeTrip String (enum) 15 Indica qual o tipo de viagem está sendo feita para este trecho. Ex: Domestic, International
agentUser Objeto responsável por retornar as informações do usuário atendente
Propriedadae Tipo Tamanho Descrição
email String 50 E-mail de contato do atendente da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do atendente da OS. Exemplo: roberto.luiz
telephone String 50 Telefone do atendente da solicitação.Exemplo: 9 95463154
fax String 50 Fax do atendente da solicitação. Exemplo: 9 95463154
thirdParty String 3 Flag indica se o atendente é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário atendente (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
department String 255 Departamento do usuário. Exemplo: Jurídico
groups String(Enum) 10 Grupo no qual o usuário está inserido: Exemplo: 'user', 'admin', 'manager', 'financial'

RequestsRoadsRequesteds

Através desse método é possível recuperar os dados da solicitação de rodoviário. Para obter essas informações é preciso informar o ID da OS.

Para mais informação referente a solicitação de rodoviário, consulte a Wiki.

GET

Requisição

requisição GET

Resposta

[ 
    { 
        "id": "1", 
        "date": "2019-05-05T00:00:00", 
        "inclusionDate": "2019-04-12T09:38:37.503", 
        "changeDate": "2019-04-12T09:38:37.503", 
        "originCity": "São Paulo", 
        "originTerminal": "São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)", 
        "destinationCity": "São José do Rio Preto", 
        "destinationTerminal": "São José do Rio Preto (SP, Brasil) / SP, Brasil (SJP)", 
        "finder": "no", 
        "typeTrip": "domestic", 
        "observation": "", 
        "dateFlag": "IS" 
    } 
]
Propriedade Tipo Tamanho Descrição
Id String 2 ID de identificação do que foi solicitado no rodoviário. Caso haja 2 solicitações de rodoviário, cada trecho conterá um código distinto.Exemplo: 1 e 2
Date String (Date Time) 24 Data de partida do trecho rodoviário.Exemplo: 2019-04-12T09:38:37.503
InclusionDate String (Date Time) 24 Data da solicitação do trecho rodoviário.Exemplo: 2019-04-12T09:38:37.503
ChangeDate String (Date Time) 24 Data de alteração do registro. Será a mesma data da inclusão, se o registro não foi alterado.Exemplo: 2019-04-12T09:38:37.503
originCity String (Number) 4 Cidade de origem que o viajante solicitou a viagem.Exemplo: São Paulo
originTerminal String 100 Descrição completa da origem. Cidade, estado e terminal rodoviário.Exemplo: São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)
destinationCity String (Number) 4 Cidade de destino.Exemplo: São José
destinationTerminal String 100 Descrição completa do destino: Cidade, estado e terminal rodoviário.Exemplo: São José do Rio Preto (SP, Brasil) / SP, Brasil (SJP
finder string 3 Flag indica se o trecho foi solicitado on-line. Ex yes/no
typeTrip String (enum) 15 Indica qual o tipo de viagemExemplo: Domestic, International
observation String 255 Observação da solicitação do trecho rodoviárioExemplo: Visita a fornecedor
dateFlag String 2 Indicativo de como o horário será considerado para o trecho. Exemplo: IS - indifferentConsideringDeparture; PC - dawnConsideringArrival

RequestsServicesQuotations

Através desse método é possível recuperar os dados da cotação do(s) serviço(s) vinculados a uma solicitação. Para obter esses dados é necessário informar o ID da solicitação. Para mais informações sobre cotação de serviço, consulte a Wiki.

GET /requests/{requestId}/services/quotations

Requisição

requisição GET

Resposta

[
    {
        "id": "string",
        "quotationId": "string",
        "service": "string",
        "serviceDate": "2020-03-19T11:54:19.958Z",
        "provider": "string",
        "totalValue": 0,
        "approvedTotalValue": 0,
        "observation": "string",
        "voucher": "string",
        "voucherDate": "2020-03-19T11:54:19.958Z",
        "formPaymentUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "telephone": "string",
            "fax": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "formPayment": {
            "description": "string",
            "typePayment": "invoiced",
            "code": "string",
            "air": "yes",
            "hotels": "yes",
            "rental": "yes",
            "service": "yes",
            "bus": "yes",
            "restrictive": "yes",
            "alternativeUATP": "yes",
            "card": {
                "paymentName": "string",
                "name": "string",
                "cardNumber": "string",
                "flag": "string",
                "active": "yes",
                "providerId": "string",
                "webServiceId": "string"
            },
            "billingCode": "string",
            "billingDescription": "string"
        },
        "schedulingUser": {
            "clientId": "00000000-0000-0000-0000-000000000000",
            "email": "string",
            "login": "string",
            "telephone": "string",
            "fax": "string",
            "thirdParty": "yes",
            "groups": [
                "admin"
            ],
            "rg": "string",
            "cpf": "string",
            "employeeId": "string",
            "fullName": "string",
            "integrationCode": "string",
            "department": "string"
        },
        "serviceFields": [
            {
                "field": "string",
                "content": "string"
            }
        ],
        "fees": [
            {
                "feeId": "00000000-0000-0000-0000-000000000000",
                "initialDate": "2020-03-19T11:54:19.958Z",
                "finalDate": "2020-03-19T11:54:19.958Z",
                "initialHour": "string",
                "finalHour": "string",
                "dayWeek": "monday",
                "name": "string",
                "description": "string",
                "typeTrip": "both",
                "action": "quotation",
                "online": "yes",
                "service": "air",
                "amount": 0,
                "percentage": 0,
                "ceilingPrice": 0,
                "inclusionDate": "2020-03-19T11:54:19.958Z"
            }
        ],
        "coin": "string",
        "servicesOffers": [
            {
                "id": "string",
                "service": "string",
                "totalValue": 0
            }
        ]
    }
]
Propriedade Tipo Tamanho Descrição
id Int 50 ID de identificação do serviço. Exemplo: 1, 3, 5
quotationId Int 2 Id de identificação das cotações.
service String 255 Nome do serviço inserido na cotação. Exemplo: TRANSFER
serviceDate String 24 Data do serviço. Exemplo: 2020-01-08T15:00:00
provider String 50 Provedor de onde vem as informações do serviço. Exemplo: ARGO, AMADEUSWS
coin String 3 Tipo da moeda utilizada na cotação. Exemplo: BRL
totalValue Number 100 Valor total do serviço. Exemplo: 450,00
approvedTotalValue Number 100 Valor total aprovado. Exemplo: 450,00
observation String 255 Observação da cotação do serviço. Exemplo: Pedido de atendimento aeroporto
voucher String 255 Valor do voucher do serviço. Exemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Data em que o Voucher foi confirmado. Exemplo: 2019-12-18T20:33:58.400
formPayment Objeto responsável por retornar as informações da forma de pagamento da solicitação
Propriedade Tipo Tamanho Descrição
description String 255 Descrição da forma de pagamento da solicitação. Exemplo: Faturado
typePayment String (Enum) 15 Tipos de pagamento utilizado. Exemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integração da forma de pagamento. (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'TIPOFATURA1010'
air String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto aéreo. Exemplo: yes/no
hotels String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto hospedagem.Exemplo: yes/no
rental String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto Locação. Exemplo: yes/no
service String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto Serviço. Exemplo: yes/no
bus String 3 A propriedade indica se a forma de pagamento pode ser utilizada para o produto Rodoviário. Exemplo: yes/no
restrictive String 3 Propriedade indica se o faturamento é do tipo restritivo. Exemplo: yes/no
alternativeUATP String 3 Propriedade indica se o faturamento é do tipo UATP. Exemplo: yes/no
billingCode String 50 Código de faturamento da forma de pagamento. Exemplo: BV5
billingDescription String 50 Descrição do código de faturamento da forma de pagamento. Exemplo: FATURAMENTO TOTAL PARA A AGÊNCIA
card Objeto responsável por retornar as informações do cartão utilizado na solicitação
Propriedade Tipo Tamanho Descrição
user String 255 Nome do usuário que utilizou o cartão.Exemplo: Maurício
formPayment String 255 Tipo de Faturamento do Cartão. Exemplo: Carão de crédito
cardNumber String 255 Número do cartão. Exemplo: 3216-8394-9403-0604
flag String 50 Indica qual a bandeira do cartão. Exemplo: Visa, Mastercard
active String 3 Campo indica se o cartão está ativo.Exemplo: yes/no
providerId String 50 Identificador do provedor do cartão. Exemplo: T0009015590A999118
webServiceId String 50 Identificador do WebService do cartão (Apenas para cartão virtual). Exemplo: B2BPAY, WEX, CONFERMA
formPaymentUser Objeto responsável por retornar as informações do usuário que utilizou a forma de pagamento
Propriedade Tipo Tamanha Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do usuário. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do usuário. Exemplo: roberto.luiz
telephone String 50 Telefone do usuário. Exemplo: 9 95463154
fax String 50 Fax do usuário. Exemplo: 9 95463154
thirdParty String 3 Flag indica se o usuário é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUARIO1010'
department String 255 Departamento do usuário. Exemplo: Jurídico
formPaymentUser Objeto responsável por retornar as informações do usuário que utilizou a forma de pagamento
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do usuário. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do usuário. Exemplo: roberto.luiz
telephone String 50 Telefone do usuário.Exemplo: 9 95463154
fax String 50 Fax do usuário. Exemplo: 9 95463154
thirdParty String 3 Flag que indica se o usuário é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUARIO1010'
department String 255 Departamento do usuário. Exemplo: Jurídico
schedulingUser Objeto responsável por retornar as informações do usuário que realizou o agendamento do serviço
Propriedade Tipo Tamanho Descrição
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 50 E-mail de contato do usuário. Exemplo: roberto.luiz@fdtps.br
login String 50 Login do usuário. Exemplo: roberto.luiz
telephone String 50 Telefone do usuário. Exemplo: 9 95463154
fax String 50 Fax do usuário. Exemplo: 9 95463154
thirdParty String 3 Flag que indica se o usuário é terceirizado ou não. Exemplo: yes/no
groups String 10 Grupo no qual o usuário está inserido.Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número do RG do usuário. Exemplo: 45.585.412-X
cpf String 15 Número do CPF do usuário. Exemplo: 665.854.965-63
employeeId String 255 Identificador de matrícula do usuário.Exemplo: 10377192
fullName String 255 Nome completo do usuário. Exemplo: Aprovador Principal
integrationCode String 255 Código de integração do usuário (Este código pode ser utilizado por outros sistemas no processo de integração).Exemplo: 'USUARIO1010'
department String 255 Departamento do usuário. Exemplo: Operacional
serviceFields Objeto responsável por retornar as informações dos campos gerenciais
Propriedade Tipo Tamanho Descrição
content String 50 Conteúdo apresentado no campo. Exemplo: 08/01/2003
field String 50 Identificador do campo. Exemplo: sustentacao_ajweg_checkin3
fees Objeto responsável por retornar as informações do fee da cotação do serviço
Propriedade Tipo Tamanho Descrição
feeId Int 50 ID de identificação do fee vinculado a solicitação. Exemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Data inicial da solicitação. Exemplo: 2019-08-22
finalDate String (DateTime) 24 Data final da solicitação. Exemplo: 2019-08-22
initialHour String (DateTime) 24 Hora inicial da solicitação. Exemplo: 2019-08-22
finalHour String (DateTime) 24 Hora final da solicitação. Exemplo: 2019-08-22
dayWeek String 10 Dia da semana da solicitação. Exemplo: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'
name String 50 Nome do fee. Exemplo: Experience Bundle
description String 1024 Descrição do Fee. Exemplo: Será cobrado R$15,00 para Emissão De Bundle de trechos Nacionais ou Internacionais, feita Online ou Offline. Para todas as solicitações (abertas a partir de 29/11/2019) nesse cliente . Caso o atendimento seja feito entre 00:00 e 23:59.
typeTrip String (Enum) 13 Tipo de viagem que o 'fee' está vinculado. Exemplo: 'both', 'international', 'domestic'
action String 13 Tipo de ação tomada para o Fee. Exemplo: 'quotation', 'ticketing'
online String 3 Campo que informa se o fee é online. Exemplo: yes/no
service String 7 Tipo de serviço do fee. Exemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Valor do Fee. Exemplo: 20
percentage Number 100 Porcentagem do Fee. Exemplo: 5
ceilingPrice Number 100 Valor teto do Fee. Exemplo: 35
inclusionDate String (DateTime) 24 Data de inclusão do Fee. Exemplo: 2020-03-11T19:29:50.873Z
servicesOffers Objeto responsável por retornar as informações do serviço ofertado
Propriedade Tipo Tamanho Descrição
service String 50 Nome do Serviço. Exemplo: Limpeza de janelas do apartamento
id String 50 Identificador do serviço ofertado (combinação da servicoId e cotacaoId). Exemplo: 1_1, 0_1
totalValue Number 100 Cálculo dos valores apresentados na propriedade 'value' (Valor diária + Taxas). Exemplo: 55,00

RequestsServicesRequested

Através desse método é possível recuperar informações das solicitações de serviço. Essa obter esses dados é necessário informar o ID da solicitação. Para mais informações referente a serviços, consulte a Wiki.

GET /requests/{requestId}/services/requested

Requisição

requisição GET

Resposta

[
    {
        "id": "string",
        "service": "string",
        "quantity": 0,
        "date": "2020-03-25T11:03:21.630Z",
        "observation": "string",
        "managementsFields": [
            {
                "field": "string",
                "content": "string"
            }
        ]
    }
]
Propriedade Tipo Tamanho Descrição
id Number 50 ID de identificação do serviço. Exemplo: 1, 3, 5
service String 255 Nome do serviço. Exemplo: Compra de Bagagem
quantity Number 50 Quantidade de serviços da solicitação. Exemplo: 1
date String 24 Data do serviço. Exemplo: 2020-01-08T15:00:00
observation String 255 Observação do serviço. Exemplo: Pedido de atendimento no aeroporto
managementsFields Objeto responsável por retornar as informações dos campos gerenciais
Propriedade Tipo Tamanho Descrição
content String 50 Conteúdo apresentado no campo.Exemplo: 08/01/2003
field String 50 Identificador do campo. Exemplo: sustentacao_ajweg_checkin3

RequestsTravelers

Através desse método é possível recuperar os dados relacionados aos viajantes vinculados a uma solicitação.

GET / requests/{requestId}/travelers

Requisição

requisição GET

Resposta

[
    {
        "typeUser": "string",
        "clientId": "00000000-0000-0000-0000-000000000000",
        "userId": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "login": "string",
        "firstName": "string",
        "lastName": "string",
        "telephone": "string",
        "fax": "string",
        "registration": "string",
        "thirdParty": "yes",
        "groups": [
            "admin"
        ],
        "rg": "string",
        "cpf": "string",
        "passport": "string",
        "employeeId": "string",
        "fullName": "string",
        "integrationCode": "string",
        "department": "string",
        "product" = "string",
        "id" = "int",
        "quotationId" = "int"
    }
]
Propriedade Tipo Tamanho Descrição
typeUser String (Enum) 9 Tipo de usuário na solicitação. Exemplo: Traveler/Companion
clientId Guid 36 ID de identificação do cliente retornado. Exemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de identificação do usuário retornado. Exemplo: 00000000-0000-0000-0000-000000000000
email String 24 E-mail de contato do viajante da solicitação. Exemplo: roberto.luiz@fdtps.br
login String 24 Login do viajante da solicitação. Exemplo: roberto.luiz
firstName String 50 Primeiro nome do viajante da solicitação. Exemplo: Roberto
lastName String 50 Último nome do viajante da solicitação. Exemplo: Luiz
telephone String 50 Telefone do viajante da solicitação. Exemplo: 9 95463154
fax String 50 Fax do viajante da solicitação. Exemplo: 9 95463154
registration String 20 Matrícula do usuário viajante. Exemplo: 464545
thirdParty String 3 Flag indica se o viajante é terceirizado ou não. Exemplo: yes/no
groups String 25 Grupo no qual o usuário está vinculado. Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 50 Número do RG do usuário. Exemplo: 00.000.000-0
cpf String 50 Número do CPF do usuário. Exemplo: 000.000.000-00
passport String 20 Passaporte do usuário. Exemplo: BR123456
fullName String 255 Nome completo do usuário. Exemplo: Roberto Oliveira Luiz
integrationCode String 255 Código de integração do usuário viajante (Este código pode ser utilizado por outros sistemas no processo de integração). Exemplo: 'USUATENDENTE1010'
employeeId String 255 Identificador de matrícula do usuário. Exemplo: 10377192
department String 255 Departamento do usuário. Exemplo: Jurídico
product String 255 Nome do produto relacionado. Exemplo: Hotels
id Int 50 ID de identificação do hotel na cotação. Exemplo: 1, 3, 5
quotationId Int 50 ID de identificação da Cotação Escolhida (apenas produto Hotels). Exemplo: 1, 3, 5
Português, Brasil