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:

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.

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:

• 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.

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

Body

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

{
    "username": "argo.argo",
    "password": "teste@",
    "reseller": "argo",
    "corp": "solutions",
    "grant_type": "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.

Tabela de Status das Solicitações

Adiantamento/Despesa

Status da Viagem

Tabela de Produtos

CancelledProduct

Através deste serviço, o usuário pode listar os produtos que foram cancelados em uma OS, através do ID da solicitação.

GET /cancelledProduct

Requisição

Resposta

[
  {
    "requestId": "00000000-0000-0000-0000-000000000000",
    "expense": "string",
    "status": "string",
    "webServiceId": "string",
    "locator": "string",
    "expirationDate": "2023-07-14T11:17:42.890Z",
    "paymentType": "string",
    "legDate": "string",
    "leg": "string",
    "totalValue": 0,
    "userCancellationName": "string",
    "cancellationDate": "2023-07-14T11:17:42.890Z"
  }
]

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

Resposta

[
  {
    "active": "yes",
    "description": "string",
    "accountingAccountId": "00000000-0000-0000-0000-000000000000"
  }
]

GET /accountingAccount/{accountingAccountId}

Requisição

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",
  ]
}

POST /accountingAccount/{accountingAccountId}

Requisição

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "active": "yes",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}

Resposta

PUT /accountingAccount/{accountingAccountId}

Requisição

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "active": "yes",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}

Resposta

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

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"
    }
]

GET /approvals/v2

Requisição

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"
	}
]

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",
        "forWhoDescription": "string",
        "typeApproval": "single",
        "approvers": [
            {
			    "numberList": 0,
                "representative": "yes",
                "allocation": "yes",
                "level": "yes",
                "scope": 0,
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "index": "0",
        "success": "yes"
    }
]

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",
        "forWhoDescription": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "numberList": 0,
                "representative": "yes",
                "allocation": "yes",
                "level": "yes",
                "scope": 0,
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "index": "0",
        "success": "yes"
    }
]

DELETE approvals/{approvalId}

Requisição

Resposta

GET /approvals/{approvalId}

Requisição

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

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"
    }
]

POST /companies

Requisição

{
    "companyName": "string",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}

Resposta

GET /companies/{companyId}

Requisição

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"
    }
]

PUT /companies/{companyId}

Requisição

{
    "companyName": "string",
    "active": "yes",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}

Resposta

ExpenseAdvancePayments

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

GET /expense/{requestId}/advancepayments

Requisição

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,
    "userId":"00000000-0000-0000-0000-000000000000",
    "requesterId":"00000000-0000-0000-0000-000000000000"
  }
]

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

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"
    }
]

ExpensePayments

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

POST /expense/payments (Obsoleto)

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"
    }
]

Resposta

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"
    }
]

Resposta

GET /expense/{requestId}/payments

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

Requisição

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"
    }
]

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"
  }
]

Resposta

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"
  }
]

Resposta

ExpenseMobility

Este serviço permite a inserção de uma despesa do tipo Mobilidade no expense.

POST /expense/mobility

Requisição

[
  {
    "userId": "00000000-0000-0000-0000-000000000000",
    "expenseDate": "2023-08-15T16:59:13.277Z",
    "currency": "string",
    "price": 0,
    "startAddress": "string",
    "endAddress": "string",
    "providerName": "string",
    "productName": "string",
    "motive": "string",
    "photoUrl": "string",
    "comments": "string"
  }
]

ExpenseRefunds

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

GET /expense/{requestId}/refunds

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"
    "costCenterCode": "string",
    "costCenterdescription": "string",
    "userId": "00000000-0000-0000-0000-000000000000",
    "requesterId": "00000000-0000-0000-0000-000000000000"
  }
]

ExpenseTypesPayments

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

GET /expense/typespayments

Requisição

Resposta

[
    {
        "typePaymentId": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "typePayment": "string",
        "userUpdateDescription": "string"
    }
]

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 /priceSummary/{requestId}

Requisição

Resposta

[
    {
        "selected": 350.00,
        "higher": 600.00,
        "lower": 200.00,
        "average": 400.00,
        "product": "air",
        "currency": "BRL"
      }
]

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 /costcenters

Requisição

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"
  }
]

GET /costcenters/{costCenterId}

Requisição

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"
  }

POST /costcenters

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"
  }
]

Resposta

[
    {
        "id": "343c6d7d-4496-49b8-9ec0-90846e684091",
        "index": "0",
        "success": "yes"
    }
]

PATCH /costcenters

Requisição

[
    {
        "costCenterId": "82c56fe0-2816-4871-8368-583020383dbf",
        "active": "yes",
        "flagProject": "yes",
        "code": "002",
        "acronym": "002",
        "description": "CCUsto Argo 002"
    }
]

Resposta

[
    {
        "id": "82c56fe0-2816-4871-8368-583020383dbf",
        "index": "0",
        "success": "yes"
    }
]

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 /creditcards

Requisição

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"
      },
]

POST /creditcards

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"
}

Resposta

GET /creditcards/{cardId}

Requisição

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"
    }

PUT /creditcards/{cardId}

Requisição

Resposta

DELETE /creditCards/{cardId}

Requisição

Resposta

ConfigsExpenseManagementFields

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

GET /expensemanagementsfields

Requisição

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"
  }
]

POST /expensemanagementsfields

Requisição

{
  "description": "string",
  "fieldId": "string",
  "expensesIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "type": "string",
  "order": 0,
  "regularExpression": "string",
  "integrationCode": "string",
  "required": "yes",
  "utilization": "string"
}

Resposta

GET /expensemanagementsfields/{expenseManagementfieldId}

Requisição

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"
  }
]

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",
  "utilization": "string"
}

Resposta

GET /expensemanagementsfields/{expenseManagementfieldId}/values

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

Requisição

Resposta

[
  {
    "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "value": "string",
    "order": 0,
    "code": "string"
  }
]

POST /expensemanagementsfields/{expenseManagementfieldId}/values

Requisição

  {
    "value": "string",
    "order": 0,
    "code": "string"
  }

Resposta

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

Requisição

Resposta

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

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

Requisição

Resposta

{
  "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
  "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
  "value": "string",
  "order": 0,
  "code": "string"
}

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

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"
    }
]

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"
}

Resposta

GET /expenses/{expenseId}

Requisição

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"
    }
]

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"
}

Resposta

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 /formspayments

Requisição

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"
    }
]

GET /formspayments/{formPaymentId}

Requisição

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"
    }

POST /formspayments

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"
}

Resposta

PUT /formspayments/{formPaymentId}

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"
}

Resposta

DELETE /formspayments/{formPaymentId}

Requisição

Resposta

GET /formspayments/{formPaymentId}/codesformspayments

Requisição

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"
  }
]

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

Requisição

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"
  }
]

POST /formspayments/{formPaymentId}/codesformspayments

Requisição

Resposta

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

Requisição

Resposta

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

Requisição

Resposta

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

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"
}

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"
}

Resposta

{
    "id": "00000000-0000-0000-0000-000000000000",
    "success": "yes",
    "message": "string"
}

GET /users

Requisição

Resposta

[
    {
      "changeDate": "2021-01-12T10:32:14.160Z",
      "userId": "00000000-0000-0000-0000-000000000000",
      "login": "string",
      "fullName": "string"
    }
]

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"
    }
]

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]

GET /users/{userId}/requesters

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

Requisição

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"
    }
]

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"
    }
]

Resposta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]

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",
    }
]

Resposta

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

Requisição

Resposta

GET /users/{userId}/representatives

Recupera os delegados vinculados ao usuário

Requisição

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"
    }
  ]

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"
    }
]

Resposta

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"
    }
]

Resposta

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

Requisição

Resposta

PUT /users/{userId}/sendEmailPassword

Requisição

Resposta

[
      {
        "message": "string"
      }
]