Documentação API Company Copastur
A API da empresa Copastur possibilita a execução de operações de modificação, consulta, recuperação e inserção de dados relacionados a solicitações, centros de custo, faturamento, usuários, estruturas de aprovação e informações sobre adiantamentos/prestações de contas, entre outros. Além disso, a API permite a realização de ações como o pagamento de adiantamentos e/ou prestações de contas, a criação de requisições (OS) e a aprovação de solicitações, entre outras funcionalidades.
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 Utilizado para consulta de registros já existentes na aplicação. Por exemplo: Consultar solicitações (OS´s – Ordem de serviço).
POST Utilizado para submeter uma entidade a um recurso específico. Por exemplo: Inserção de usuários.
PUT Utilizado para atualização de um recurso específico já existente: Por exemplo: Atualização dos dados cadastrais de um usuário.
DELETE Utilizado para deletar um recurso já existente: Por exemplo: Finalizar uma estrutura de aprovação.
WebServices disponíveis
Método
Função
Endpoint
ApprovalFlowV
Método utilizado para realizar aprovações ou reprovações dos pedidos.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/ApprovalFlow
Produção: https://api.copastur.com.br/api-company/v2/api/ApprovalFlow
ApprovalV
Método utilizado para inativar, consultar e cadastrar estruturas de aprovações.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Approvals
Produção: https://api.copastur.com.br/api-company/v2/api/Approvals
BudgetV
Método utilizado para buscar, inserir ou atualizar orçamentos.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Budget
Produção: https://api.copastur.com.br/api-company/v2/api/Budget
CostCentersV
Método utilizado para inativar, consultar e cadastrar centro de custo.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/CostCenters
Produção: https://api.copastur.com.br/api-company/v2/api/CostCenters
OrderV
Método utilizado para listar solicitações, recuperar dados de uma solicitação, cadastrar follow-up e realizar pagamentos de expense.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Order
Produção: https://api.copastur.com.br/api-company/v2/api/Order
UsersV
Método utilizado para se autenticar no API Company Copastur.
Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Authentication/Authenticate
Produção: https://api.copastur.com.br/api-company/v2/api/Authentication/Authenticate
ApprovalFlowV
Método utilizado para realizar aprovações ou reprovações dos pedidos.
POST AcceptOrder - Metodo para aprovar um pedido.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/ApprovalFlow/AcceptOrder
Url Produção: https://api.copastur.com.br/api-company/v2/api/ApprovalFlow/AcceptOrder
Código
Campo
Formato
Função
{
"success": true,
"message": null,
"data": true
}
Order
String
Número do pedido.
LoginApprover
String
Login do aprovador.
POST DeclineOrder - Metodo para recusar um pedido.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/ApprovalFlow/DeclineOrder
Url Produção: https://api.copastur.com.br/api-company/v2/api/ApprovalFlow/DeclineOrder
Código
Campo
Formato
Função
{
"success": true,
"message": null,
"data": true
}
Order
String
Número do pedido.
LoginApprover
String
Login do aprovador.
Reason
String
Motivo da reprovação.
ApprovalV
Método utilizado para inativar, consultar e cadastrar estruturas de aprovações.
POST ApprovalV - Inserir estrutura de aprovação.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Approvals
Url Produção: https://api.copastur.com.br/api-company/v2/api/Approvals
Modelo Json
Campo
Formato
Função
{
"companyCode": "string",
"costCenterCode": "string",
"employeeLogin": "string",
"isAdvance": true,
"isConference": true,
"isInternational": true,
"isMerit": true,
"isNational": true,
"isPayment": true,
"isReimbursement": true,
"isSequential": true,
"isParalel": true,
"isUnique": true,
"isLevel": true,
"approvers": [
{
"isSecondLevel": true,
"limit": 0,
"order": 0,
"login": "string"
}
],
"forceIntegration": true
}
CompanyCode
String
Insira o nome da empresa, caso a aprovação seja por empresa de debito.
CostCenterCode
String
Insira o codigo do centro de custo, caso a aprovação seja por centro de custo.
EmployeeLogin
String
Insira o login do viajante, caso a aprovação seja por usuario.
isAdvance
String (Enum)
Insira True caso o fluxo seja para Adiantamento, caso não, envie como False.
isConference
String (Enum)
Insira True caso o fluxo seja para Conferência, caso não, envie como False.
isInternational
String (Enum)
Insira True caso o fluxo seja para Internacional, caso não, envie como False.
isMerit
String (Enum)
Insira True caso o fluxo seja para Merito, caso não, envie como False.
isNational
String (Enum)
Insira True caso o fluxo seja para Nacional, caso não, envie como False.
isPayment
String (Enum)
Insira True caso o fluxo seja para Fechamento de fatura, caso não, envie como False
isReimbursement
String (Enum)
Insira True caso o fluxo seja para Reembolso, caso não, envie como False
isSequential
String (Enum)
Insira True caso o fluxo de aprovação seja sequencial, caso não, envie como False.
isParalel
String (Enum)
Insira True caso o fluxo de aprovação seja Paralelo, caso não, envie como False.
isUnique
String (Enum)
Insira True caso o fluxo de aprovação seja Unica, caso não, envie como False.
isLevel
String (Enum)
Insira True caso o fluxo de aprovação seja por Nivel, caso não, envie como False.
isSecondLevel
String (Enum)
Insira True caso o fluxo seja para um aprovador de exceção, caso não, envie como False.
limit
Number (Decimal)
Insira o valor maximo que o aprovador poderá aprovar.
order
Number
Informe a ordem que este aprovador aparecerá no fluxo (Exemplo 1 - Primeiro aprovador, 2 - Segundo aprovador...).
login
String
Informe o login do aprovador.
forceIntegration
String (Enum)
True/False.
DELETE ApprovalV - Inativar uma estrutura de aprovação.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Approvals
Url Produção: https://api.copastur.com.br/api-company/v2/api/Approvals
Código (Não possui)
Campo
Formato
Função
EmployeeLogin
String
Informe o login do viajante, caso a aprovação seja por usuario.
CostCenterCode
String
Informe o codigo do centro de custo, caso a aprovação seja por centro de custo.
CompanyCode
String
Insira o nome da empresa, caso a aprovação seja por empresa de debito.
Logica da API
Permitido/ Não permitido
Combinação de Fluxos
Melhores Práticas
Permitido
Nacional + Internacional
Caso o aprovador seja o mesmo para o Nacional e internacional, é possível enviar em apenas uma chamada inserindo True nas tags "IsNational" e "IsInternational".
Permitido
Nacional + Internacional + Reembolso
Caso o aprovador seja o mesmo para o Nacional, Internacional e Reembolso é possível enviar em apenas uma chamada inserindo True nas tags "IsNational", "IsInternational" e "isReimbursement).
Permitido
Nacional + Reembolso
Caso o aprovador seja o mesmo para o Nacional e reembolso, é possível enviar em apenas uma chamada inserindo True nas tags "IsNational" e "isReimbursement".
Permitido
Internacional + Reembolso
Caso o aprovador seja o mesmo para o Internacional e reembolso, é possível enviar em apenas uma chamada inserindo True nas tags "IsInternational" e "isReimbursement".
Não permitido
Adiantamento + Outro fluxo
O Fluxo de adiantamento deve ser enviado em uma única chamada, pois não combina com os demais Fluxos.
Não permitido
Fechamento de Fatura + Outro fluxo
O Fluxo de Fechamento de Fatura deve ser enviado em uma única chamada, pois não combina com os demais Fluxos.
Não permitido
Conferencia + Outro fluxo
O Fluxo de Conferencia deve ser enviado em uma única chamada, pois não combina com os demais Fluxos.
BudgetV
Método utilizado para buscar, inserir ou atualizar um orçamento.
POST BudgetV - Inserir um orçamento no OBT.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Budget
Url Produção: https://api.copastur.com.br/api-company/v2/api/Budget
Modelo Json
Campo
Formato
Função
{
"companyCode": "string",
"ledgerAccountDescription": "string",
"costCenterCode": "string",
"budgetedValue": 0,
"observation": "string",
"date": "2024-11-11T14:23:22.139Z",
"order": "string"
}
CompanyCode
String
Insira o nome da empresa.
ledgerAccountDescription
String
Descrição da conta contábil.
CostCenterCode
String
Insira o código do centro de custo.
budgetedValue
Number (Decimal)
Valor a ser inserido no centro de custo.
observation
String
Observação registrada no histórico do orçamento.
date
String (Date Time)
Data do orçamento (Ex: 2024-11-11T14:23:22.139Z).
order
String
Numero do pedido de orçamento (Orçamento deve ser por data ou por pedido).
PUT BudgetV - Atualizar orçamento no OBT.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Budget
Url Produção: https://api.copastur.com.br/api-company/v2/api/Budget
Modelo Json
Campo
Formato
Função
{
"budgetId": "string",
"active": "string",
"observation": "string",
"adjustedObservation": "string",
"adjustedValue": 0
}
BudgetID
String
Insira o BudgetID fornecido no momento do cadastro.
Active
String (Enum)
Yes/No.
observation
String
Observação registrada no historico do orçamento.
adjustedObservation
String
Descrição/observação do ajuste do orçamento. O Orçamento pode ser ajustado para mais ou para menos.
adjustedValue
Number (Decimal)
Valor do ajuste orçamentário: Exemplo: +20.000 ou -20.000
GET BudgetV - Busca de dados de um Orçamento.
Modelo Json (Não possui)
Campo
Formato
Função
BudgetID
String
Insira o BudgetID fornecido no momento do cadastro.
CostCentersV
Método utilizado para buscar, inserir ou atualizar um centro de custo.
POST CostCentersV - Inserir ou atualizar um Centro de Custo.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/CostCenters
Url Produção: https://api.copastur.com.br/api-company/v2/api/CostCenters
Modelo Json:
Campo
Formato
Função
{
"code": "string",
"description": "string",
"companyCode": "string",
"parentCode": "string",
"initialDebitDate": "2024-11-11T17:21:13.104Z",
"finalDebitDate": "2024-11-11T17:21:13.104Z"
}
Code
String
Insira o código do centro de custo.
description
String
Descrição do centro de custo.
companyCode
String
Insira o nome da empresa.
parentCode
String
Codigo do centro de custo Pai.
initialDebitDate
String (Date Time)
Data inicial para utilização do centro de custo (Informação opcional).
finalDebitDate
String (Date Time)
Data final para utilização do centro de custo (Informação opcional).
DELETE CostCentersV - Inativar centro de custo.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/CostCenters
Url Produção: https://api.copastur.com.br/api-company/v2/api/CostCenters
Modelo Json (Não possui)
Campo
Formato
Função
Code
String
Insira o código do centro de custo.
CompanyCode
String
Insira a empresa atrelada ao centro de custo.
OrderV
Método utilizado para buscar, listar e realizar pagamentos (Expense) de solicitações.
GET GetOrderV2 - Retorna dados de uma solicitação.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Order/GetOrderV2
Url Produção: https://api.copastur.com.br/api-company/v2/api/Order/GetOrderV2?
Modelo Json
Campo
Formato
Formato
data": { "solicitationId": "string",
"orderNumber": "string",
"orderNumberRoot": "string",
"statusTravel": "string",
"statusExpense": "string",
"dateOrder": "2024-11-26T20:18:20.106Z",
"issuedDate": "2024-11-26T20:18:20.106Z",
"traveler": "string",
"remarks": "string",
"reason": "string",
"dateStartTravel": "2024-11-26T20:18:20.106Z",
"dateEndTravel": "2024-11-26T20:18:20.106Z",
"agency": "string",
"selfTicket": true,
"selfBook": true,
"dateQuotation": "2024-11-26T20:18:20.106Z",
"dateChoice": "2024-11-26T20:18:20.106Z",
"dateApprovalCost": "2024-11-26T20:18:20.106Z",
"dateExpiration": "2024-11-26T20:18:20.106Z",
"dateApprovedRefund": "2024-11-26T20:18:20.106Z",
"datePaidRefund": "2024-11-26T20:18:20.106Z",
"datePaidAdvance": "2024-11-26T20:18:20.106Z",
"atending": "string",
"atendingEmail": "string",
"issuer": "string",
"issuerEmail": "string",
"approver": "string",
"centerCostCode": "string",
"centerCostDescription": "string",
"urlClient": "string",
"typeTravel": "string",
"requester": "string",
"requesterEmail": "string",
"requesterLogin": "string",
"authorizationNumber": "string",
"dateCreated": "2024-11-26T20:18:20.106Z",
"miscellaneous": [
{
"departure": "string",
"arrival": "string",
"departureDate": "2024-11-26T20:18:20.106Z",
"arrivalDate": "2024-11-26T20:18:20.106Z",
"supplier": "string",
"totalFare": 0
}
],
"hotels": [
{
"hotelId": 0,
"name": "string",
"city": "string",
"checkinDate": "2024-11-26T20:18:20.106Z",
"checkoutDate": "2024-11-26T20:18:20.106Z",
"supplier": "string",
"voucher": "string",
"dateCancel": "2024-11-26T20:18:20.106Z",
"state": "string",
"address": "string",
"bedType": "string",
"roomType": "string",
"amountDialy": "string",
"currency": "string",
"billingType": "string",
"totalFare": 0,
"fare": 0,
"additionalFare": 0,
"discountFare": 0,
"tax": 0,
"dateCreated": "2024-11-26T20:18:20.106Z",
"category": "string",
"authorizationNumber": "string",
"guest": {
"id": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"login": "string",
"state": "string",
"registration": "string",
"email": "string",
"phone": "string",
"celularPhone": "string",
"position": "string",
"fax": "string",
"groups": [
"string"
],
"vip": "string",
"dateCreated": "string",
"travelerInfo": {
"sendHTMLEmail": "string",
"sendPDFFile": "string",
"showSeatMap": "string",
"smoker": "string",
"ticket": "string",
"bank": "string",
"branchNumber": "string",
"checkingAccount": "string",
"dashBoard": "string",
"aircraftPositions": [
"string"
],
"seat": "string",
"documents": [
{
"type": "string",
"description": "string",
"expirationDate": "2024-11-26T20:18:20.106Z"
}
],
"milesCards": "string",
"birthDate": "string",
"observation": "string",
"departureAirportIATA": "string",
"typeOfMeal": "string",
"office": "string",
"department": "string",
"companyName": "string",
"isCompanion": "string",
"nationality": "string",
"gender": "string",
"isThirdy": true,
"agency": "string",
"authorized": "string",
"language": "string",
"cep": "string",
"emergencyPhone": "string",
"address": "string",
"officeLevel": "string"
}
},
"paymentCondition": "string",
"dailyQuote": 0,
"formPayment": {
"description": "string",
"typePayment": "string",
"code": "string",
"air": "string",
"hotels": "string",
"rental": "string",
"service": "string",
"bus": "string",
"restrictive": "string",
"alternativeUATP": "string",
"card": {
"paymentName": "string",
"name": "string",
"cardNumber": "string",
"flag": "string",
"active": "string",
"providerId": "string",
"webServiceId": "string",
"cardId": "string",
"billingType": "string",
"userEmail": "string",
"userLogin": "string",
"securityCode": "string",
"dateValidity": "2024-11-26T20:18:20.106Z",
"virtualCard": true,
"community": "string",
"passport": "string",
"addressText": "string",
"addressCity": "string",
"addressState": "string",
"addressCountry": "string",
"addressPostalCode": "string",
"documentCpf": "string",
"dateInclusion": "2024-11-26T20:18:20.106Z",
"dateChange": "2024-11-26T20:18:20.106Z"
},
"billingCode": "string",
"billingDescription": "string",
"cardAuthorization": "string"
}
}
],
"cars": [
{
"carId": 0,
"departure": "string",
"arrival": "string",
"supplier": "string",
"totalFare": 0,
"dailyQuantity": 0,
"hasAirConditional": true,
"hasDriver": true,
"hasGPS": true,
"fare": 0,
"additionalFare": 0,
"discountFare": 0,
"tax": 0,
"cancelDate": "2024-11-26T20:18:20.106Z",
"category": "string",
"gearbox": "string",
"rentalAgency": "string",
"localCheckin": "string",
"localCheckout": "string",
"vehicle": "string",
"currency": "string",
"voucher": "string",
"checkoutDate": "2024-11-26T20:18:20.106Z",
"checkinDate": "2024-11-26T20:18:20.106Z",
"dateCreated": "2024-11-26T20:18:20.106Z",
"authorizationNumber": "string",
"paymentCondition": "string",
"dailyQuote": 0,
"formPayment": {
"description": "string",
"typePayment": "string",
"code": "string",
"air": "string",
"hotels": "string",
"rental": "string",
"service": "string",
"bus": "string",
"restrictive": "string",
"alternativeUATP": "string",
"card": {
"paymentName": "string",
"name": "string",
"cardNumber": "string",
"flag": "string",
"active": "string",
"providerId": "string",
"webServiceId": "string",
"cardId": "string",
"billingType": "string",
"userEmail": "string",
"userLogin": "string",
"securityCode": "string",
"dateValidity": "2024-11-26T20:18:20.106Z",
"virtualCard": true,
"community": "string",
"passport": "string",
"addressText": "string",
"addressCity": "string",
"addressState": "string",
"addressCountry": "string",
"addressPostalCode": "string",
"documentCpf": "string",
"dateInclusion": "2024-11-26T20:18:20.106Z",
"dateChange": "2024-11-26T20:18:20.106Z"
},
"billingCode": "string",
"billingDescription": "string",
"cardAuthorization": "string"
}
}
],
"airs": [
{
"airId": 0,
"departure": "string",
"arrival": "string",
"departureDate": "2024-11-26T20:18:20.106Z",
"arrivalDate": "2024-11-26T20:18:20.106Z",
"supplier": "string",
"totalFare": 0,
"fare": 0,
"additionalFare": 0,
"discountFare": 0,
"fullFare": 0,
"tax": 0,
"connections": 0,
"stops": 0,
"class": "string",
"cabin": "string",
"quotationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eticket": "string",
"ciaName": "string",
"flyNumber": "string",
"currency": "string",
"dateCreated": "2024-11-26T20:18:20.106Z",
"source": "string",
"iataDeparture": "string",
"iataArrival": "string",
"cityArrival": "string",
"countryArrival": "string",
"cityDeparture": "string",
"countryDeparture": "string",
"remarks": "string",
"baseFare": "string",
"pnr": "string",
"status": "string",
"id": "string",
"authorizationNumber": "string",
"justificationexcerpt": [
{
"tipo": "string",
"descricao": "string"
}
],
"paymentCondition": "string",
"dailyQuote": 0,
"formPayment": {
"description": "string",
"typePayment": "string",
"code": "string",
"air": "string",
"hotels": "string",
"rental": "string",
"service": "string",
"bus": "string",
"restrictive": "string",
"alternativeUATP": "string",
"card": {
"paymentName": "string",
"name": "string",
"cardNumber": "string",
"flag": "string",
"active": "string",
"providerId": "string",
"webServiceId": "string",
"cardId": "string",
"billingType": "string",
"userEmail": "string",
"userLogin": "string",
"securityCode": "string",
"dateValidity": "2024-11-26T20:18:20.106Z",
"virtualCard": true,
"community": "string",
"passport": "string",
"addressText": "string",
"addressCity": "string",
"addressState": "string",
"addressCountry": "string",
"addressPostalCode": "string",
"documentCpf": "string",
"dateInclusion": "2024-11-26T20:18:20.106Z",
"dateChange": "2024-11-26T20:18:20.106Z"
},
"billingCode": "string",
"billingDescription": "string",
"cardAuthorization": "string"
}
}
],
"travelers": [
{
"id": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"login": "string",
"state": "string",
"registration": "string",
"email": "string",
"phone": "string",
"celularPhone": "string",
"position": "string",
"fax": "string",
"groups": [
"string"
],
"vip": "string",
"dateCreated": "string",
"travelerInfo": {
"sendHTMLEmail": "string",
"sendPDFFile": "string",
"showSeatMap": "string",
"smoker": "string",
"ticket": "string",
"bank": "string",
"branchNumber": "string",
"checkingAccount": "string",
"dashBoard": "string",
"aircraftPositions": [
"string"
],
"seat": "string",
"documents": [
{
"type": "string",
"description": "string",
"expirationDate": "2024-11-26T20:18:20.106Z"
}
],
"milesCards": "string",
"birthDate": "string",
"observation": "string",
"departureAirportIATA": "string",
"typeOfMeal": "string",
"office": "string",
"department": "string",
"companyName": "string",
"isCompanion": "string",
"nationality": "string",
"gender": "string",
"isThirdy": true,
"agency": "string",
"authorized": "string",
"language": "string",
"cep": "string",
"emergencyPhone": "string",
"address": "string",
"officeLevel": "string"
}
}
],
"services": [
{
"startDate": "2024-11-26T20:18:20.106Z",
"endDate": "2024-11-26T20:18:20.106Z",
"expirationDate": "2024-11-26T20:18:20.106Z",
"remarks": "string",
"description": "string",
"typeService": "string",
"dateCreated": "2024-11-26T20:18:20.106Z",
"dateCanceled": "2024-11-26T20:18:20.106Z",
"quantity": 0,
"totalFare": 0,
"supplier": "string",
"voucher": "string",
"dateVoucher": "2024-11-26T20:18:20.106Z",
"fare": 0,
"tax": 0,
"issuedDate": "2024-11-26T20:18:20.106Z",
"authorizationNumber": "string",
"managementFields": [
{
"contentManagement": "string",
"fieldManagement": "string"
}
],
"paymentCondition": "string",
"dailyQuote": 0,
"formPayment": {
"description": "string",
"typePayment": "string",
"code": "string",
"air": "string",
"hotels": "string",
"rental": "string",
"service": "string",
"bus": "string",
"restrictive": "string",
"alternativeUATP": "string",
"card": {
"paymentName": "string",
"name": "string",
"cardNumber": "string",
"flag": "string",
"active": "string",
"providerId": "string",
"webServiceId": "string",
"cardId": "string",
"billingType": "string",
"userEmail": "string",
"userLogin": "string",
"securityCode": "string",
"dateValidity": "2024-11-26T20:18:20.106Z",
"virtualCard": true,
"community": "string",
"passport": "string",
"addressText": "string",
"addressCity": "string",
"addressState": "string",
"addressCountry": "string",
"addressPostalCode": "string",
"documentCpf": "string",
"dateInclusion": "2024-11-26T20:18:20.106Z",
"dateChange": "2024-11-26T20:18:20.106Z"
},
"billingCode": "string",
"billingDescription": "string",
"cardAuthorization": "string"
}
}
],
"approvers": [
{
"id": "string",
"registration": "string",
"email": "string",
"login": "string",
"fullName": "string",
"approvalDate": "string"
}
],
"transport": [
{
"seat": "string",
"cia": "string",
"departure": "string",
"terminalDeparture": "string",
"arrival": "string",
"terminalArrival": "string",
"remarks": "string",
"voucher": "string",
"exchange": "string",
"serviceType": "string",
"dateVoucher": "2024-11-26T20:18:20.106Z",
"dateIncluded": "2024-11-26T20:18:20.106Z",
"dateUpdated": "2024-11-26T20:18:20.106Z",
"dateDeparture": "2024-11-26T20:18:20.106Z",
"dateArrival": "2024-11-26T20:18:20.106Z",
"dateExpired": "2024-11-26T20:18:20.106Z",
"dateCanceled": "2024-11-26T20:18:20.106Z",
"totalFare": 0,
"fare": 0,
"additionalFare": 0,
"discountFare": 0,
"paymentCondition": "string",
"dailyQuote": 0,
"formPayment": {
"description": "string",
"typePayment": "string",
"code": "string",
"air": "string",
"hotels": "string",
"rental": "string",
"service": "string",
"bus": "string",
"restrictive": "string",
"alternativeUATP": "string",
"card": {
"paymentName": "string",
"name": "string",
"cardNumber": "string",
"flag": "string",
"active": "string",
"providerId": "string",
"webServiceId": "string",
"cardId": "string",
"billingType": "string",
"userEmail": "string",
"userLogin": "string",
"securityCode": "string",
"dateValidity": "2024-11-26T20:18:20.106Z",
"virtualCard": true,
"community": "string",
"passport": "string",
"addressText": "string",
"addressCity": "string",
"addressState": "string",
"addressCountry": "string",
"addressPostalCode": "string",
"documentCpf": "string",
"dateInclusion": "2024-11-26T20:18:20.106Z",
"dateChange": "2024-11-26T20:18:20.106Z"
},
"billingCode": "string",
"billingDescription": "string",
"cardAuthorization": "string"
}
}
],
"total": "string",
"traveljustification": [
{
"typeTravell": "string",
"descriptionTravel": "string"
}
],
"infgerencial": [
{
"contentManagement": "string",
"fieldManagement": "string"
}
],
"summary": [
{
"selected": 0,
"higher": 0,
"lower": 0,
"average": 0,
"product": "string",
"currency": "string"
}
],
"justificationexcerpt": [
{
"tipo": "string",
"descricao": "string"
}
],
"subCostCenters": [
{
"clientID": 0,
"costCenterID": 0,
"code": "string",
"description": "string",
"companyID": 0,
"companyCode": "string",
"parentCostCenterCode": "string",
"parentCostCenterID": 0,
"initialDebitDate": "2024-11-26T20:18:20.106Z",
"finalDebitDate": "2024-11-26T20:18:20.106Z",
"active": true
}
],
"costCenters": {
"clientID": 0,
"costCenterID": 0,
"code": "string",
"description": "string",
"companyID": 0,
"companyCode": "string",
"parentCostCenterCode": "string",
"parentCostCenterID": 0,
"initialDebitDate": "2024-11-26T20:18:20.106Z",
"finalDebitDate": "2024-11-26T20:18:20.106Z",
"active": true
},
"apportionment": [
{
"company": "string",
"companyID": "string",
"percent": 0,
"companyCode": "string",
"companyRef": "string",
"costCenter": {
"clientID": 0,
"costCenterID": 0,
"code": "string",
"description": "string",
"companyID": 0,
"companyCode": "string",
"parentCostCenterCode": "string",
"parentCostCenterID": 0,
"initialDebitDate": "2024-11-26T20:18:20.106Z",
"finalDebitDate": "2024-11-26T20:18:20.106Z",
"active": true
},
"subCostCenter": [
{
"clientID": 0,
"costCenterID": 0,
"code": "string",
"description": "string",
"companyID": 0,
"companyCode": "string",
"parentCostCenterCode": "string",
"parentCostCenterID": 0,
"initialDebitDate": "2024-11-26T20:18:20.106Z",
"finalDebitDate": "2024-11-26T20:18:20.106Z",
"active": true
}
],
"contaContabilCod": "string",
"contaContabilDesc": "string",
"projectCod": "string",
"projectDesc": "string",
"observation": "string"
}
],
"refunds": [
{
"price": 0,
"refundId": 0,
"expense": "string",
"account": "string",
"category": "string",
"currency": "string",
"currencyCode": "string",
"exchange": 0,
"quantity": 0,
"amount": 0,
"totalAmount": 0,
"taxAmount": 0,
"taxPercent": 0,
"referAmount": 0,
"referCurrency": "string",
"referExchange": 0,
"history": "string",
"isActive": true,
"isApproved": true,
"isRefund": true,
"isVerified": true,
"dateCreated": "2024-11-26T20:18:20.106Z",
"datePaid": "2024-11-26T20:18:20.106Z",
"dateModified": "2024-11-26T20:18:20.106Z",
"dateStart": "2024-11-26T20:18:20.106Z",
"dateEnd": "2024-11-26T20:18:20.106Z",
"bankAccount": "string",
"proofPayment": "string",
"invoicheImagemURL": "string",
"observation": "string",
"descriptiveExpense": "string",
"typePaymentName": "string"
}
],
"advances": [
{
"advancePaymentId": 0,
"coin": "string",
"bacenCode": "string",
"exchange": 0,
"typePaymentName": "string",
"departureCity": "string",
"arrivalCity": "string",
"departureCountry": "string",
"arrivalCountry": "string",
"reasonTravelling": "string",
"quantity": 0,
"expense": "string",
"currency": "string",
"currencyCode": "string",
"totalAmount": 0,
"price": 0,
"comments": "string",
"dateCreated": "2024-11-26T20:18:20.106Z",
"datePaid": "2024-11-26T20:18:20.106Z",
"dateModified": "2024-11-26T20:18:20.106Z",
"dateStart": "2024-11-26T20:18:20.106Z",
"dateEnd": "2024-11-26T20:18:20.106Z",
"cityOrigin": "string"
}
],
"companyId": "string",
"companyName": "string",
"dateCancel": "2024-11-26T20:18:20.106Z",
"expenseStatus": [
{
"status_code": "string",
"status_date": "string",
"status_name": "string"
}
],
"isCardExpenseClosing": true,
"isReissue": true,
"companyCode": "string",
"followUP": [
{
"recipients": "string",
"message": "string",
"inclusionDate": "2024-11-26T20:18:20.106Z",
"sentBy": "string"
}
],
"conferenceRefundDate": "2024-11-26T20:18:20.106Z"
}
}
solicitationId
String
ID da solicitação no OBT.
orderNumber
String
Numero da solicitação.
orderNumberRoot
Numero da solicitação Pai (Para casos onde a solicitação possui uma continuação ou foi duplicada).
statusTravel
String
Status da parte de travel da solicitação.
statusExpense
String
Status da parte de expense da solicitação.
dateOrder
String (Date Time)
Data da abertura da solicitação
issuedDate
String (Date Time)
Data da emissão da solicitação.
traveler
String
Viajante.
remarks
String
Observação.
reason
String
Motivo de viagem.
dateStartTravel
String (Date Time)
Data inicial da viagem.
dateEndTravel
String (Date Time)
Data final da viagem.
agency
String
Nome da agencia.
selfTicket
String
Solicitação offline.
selfBook
String
Solicitação Online.
dateQuotation
String (Date Time)
Data da cotação.
dateChoice
String (Date Time)
Data da escolha.
dateApprovalCost
String (Date Time)
Data da aprovação.
dateExpiration
String (Date Time)
Data de expiração.
dateApprovedRefund
String (Date Time)
Data de aprovação do reembolso.
datePaidRefund
String (Date Time)
Data do pagamento do reembolso.
datePaidAdvance
String (Date Time)
Data do pagamento do adiantamento.
atending
String
Nome do consultor.
atendingEmail
String
E-mail do consultor.
issue
String
Emissor.
issuerEmail
String
E-mail do emissor.
approver
String
Nome do aprovador.
centerCostCode
String
Codigo do centro de custo.
centerCostDescription
String
Nome do centro de custo.
urlClient
String
Url do cliente.
typeTravel
String
Tipo de solicitação (Nacional ou internacional)
requester
String
Nome do solicitante.
requesterEmail
String
E-mail do solicitante.
requesterLogin
String
Login do solicitante.
authorizationNumber
String
Numero da autorização (Campo Argo).
dateCreated
String (Date Time)
Data da criação.
miscellaneous
Array
Array
departure
String
Origem.
arrival
String
Destino.
departureDate
String (Date Time)
Data da ida.
arrivalDate
String (Date Time)
Data da volta.
supplier
totalFare
String
Valor total.
hotels
Array
Array
hotelId
String
ID do hotel.
name
String
Nome do hotel.
city
String
Nome da cidade.
checkinDate
String (Date Time)
Data da entrada no hotel.
checkoutDate
String (Date Time)
Data da saida no hotel.
supplier
voucher
String
Voucher do hotel.
dateCancel
String (Date Time)
Data limite para o cancelamento.
state
String
Estado do hotel.
address
String
Endereço do hotel.
bedType
String
Tipo de cama.
roomType
String
Tipo de apartamento (Single, double. triple...)
amountDialy
String
Numero de diarias.
currency
String
Sigla da moeda.
billingType
String
Forma de pagamento
totalFare
String
Valor total.
fare
String
Valor da diaria.
additionalFare
String
Valor adicional na tarifa.
discountFare
String
Valor de desconto na tarifa.
tax
String
Valor da taxa.
dateCreated
String (Date Time)
Data da criação da solicitação de hotel.
category
String
Categoria do hotel.
authorizationNumber
String
Numero da autorização do hotel.
guest
Array
Array
id
String
ID do viajante.
name
String
Nome do viajante.
firstName
String
Primeiro nome do viajante.
lastName
String
Ultimo sobrenome do viajante.
fullName
String
Nome completo do Viajante.
login
String
Login do viajante.
state
String
Estado de residencia do viajante.
registration
String
Numero da matricula.
email
String
E-mail do viajante.
phone
String
Numero do telefone do viajante.
celularPhone
String
Numero do telefone celular do viajante.
position
String
Cargo do viajante
fax
String
Numero do fax.
groups
Array
Array
vip
String
Viajante VIP.
dateCreated
String (Date Time)
Data de criação.
travelerInfo
String
Informações de viagem.
sendHTMLEmail
String (Enum)
Enviar o e-mail em formato HTML (True/False).
sendPDFFile
String (Enum)
Enviar o e-mail em formato PDF (True/False)
showSeatMap
String (Enum)
Utilizar o mapa de assentos (True/False)
smoker
String (Enum)
Passageiro fumante (True/False)
ticket
String
Numero do ticket.
bank
String
Banco registrado no perfil do viajante.
branchNumber
String
Numero
checkingAccount
String
Agencia.
dashBoard
aircraftPositions
Array
Array
seat
String
Assento escolhido.
documents
Array
Array
type
String
Tipo de documento
description
String
Descrição
expirationDate
String (Date Time)
Data de expiração do documento.
milesCards
String
Cartões de milhagem.
birthDate
String (Date Time)
Data de aniversario.
observation
String
Observação.
departureAirportIATA
String
Iata do aeroporto de partida.
typeOfMeal
String
Tipo de refeição
office
String
Escritorio.
department
String
Departamento.
companyName
String
Nome da empresa.
isCompanion
nationality
String
Nacionalidade.
gender
String
Genero.
isThirdy
String
Viajante terceiro (True/False).
agency
String
Agencia.
authorized
String
Autorização.
language
String
Idioma do perfil do viajante.
cep
Number (Decimal)
Cep do viajante.
emergencyPhone
Number (Decimal)
Numero de emergencia.
address
String
Endereço.
officeLevel
String
Nivel do funcionario.
paymentCondition
String
Tipo de pagamento.
dailyQuote
formPayment
Array
Array
description
String
Descrição da forma de pagamento.
typePayment
String
Tipo de pagamento.
code
String
Codigo da forma de pagamento
air
String (Enum)
Cartão de credito para Aereo (True/False).
hotels
String (Enum)
Cartão de credito para Hotel (True/False).
rental
String (Enum)
Cartão de credito para Locação de veiculo (True/False).
service
String (Enum)
Cartão de credito para Serviços (True/False).
bus
String (Enum)
Cartão de credito para Rodoviario (True/False).
restrictive
alternativeUATP
String (Enum)
Cartão de credito UATP
card
Array
Array
paymentName
String
Nome da forma de pagamento.
name
String
Nome do titular do cartão de credito.
cardNumber
Number (Decimal)
Numero do cartão de credito.
flag
String
Bandeira do cartão.
active
Number (Decimal)
Ativo ou Inativo.
providerId
String
ID do provedor do cartão.
webServiceId
String
ID da forma de pagamento
cardId
String
ID do cartão do credito.
billingType
userEmail
String
E-mail do viajante vinculado ao cartão.
userLogin
String
Login do viajante vinculado ao cartão.
securityCode
Number (Decimal)
Codigo de segurança do cartão.
dateValidity
String (Date Time)
Data de validade do cartão.
virtualCard
string (Enum)
Cartão virtual (True/False).
community
String
Nome da comunidade.
passport
String
Passaporte do viajante vinculado ao cartão.
addressText
String
Endereço do viajante vinculado ao cartão.
addressCity
String
Cidade do viajante vinculado ao cartão.
addressState
String
Estado do viajante vinculado ao cartão.
addressCountry
String
Pais do viajante vinculado ao cartão.
addressPostalCode
Number (Decimal)
Cep do viajante vinculado ao cartão.
documentCpf
Number (Decimal)
CPF do viajante vinculado ao cartão.
dateInclusion
String (Date Time)
Data de inclusão do cartão.
dateChange
String (Date Time)
Data de alteração do cartão.
billingCode
String
Codigo do faturamento.
billingDescription
String
Descrição do faturamento.
cardAuthorization
String
Codigo de autorização da transação.
cars
Array
Array
carId
Strind
ID da locação.
departure
String
Cidade do destino inicial.
arrival
String
Cidade do destino final.
supplier
String
Fornecedor.
totalFare
Number (Decimal)
Valor total.
dailyQuantity
Number (Decimal)
Numero de diarias.
hasAirConditional
string (Enum)
Veiculo com ar condicionado (True/False).
hasDriver
string (Enum)
Veiculo com motorista (True/False).
hasGPS
string (Enum)
Veiculo com GPS (True/False).
fare
Number (Decimal)
Tarifa.
additionalFare
Number (Decimal)
Tarifa adicional.
discountFare
Number (Decimal)
Desconto na tarifa.
tax
Number (Decimal)
Taxas.
cancelDate
String (Date Time)
Data limite para cancelamento.
category
String
Categoria do veiculo.
gearbox
String
Cambio do veiculo.
rentalAgency
String
Nome da locadora.
localCheckin
String (Date Time)
Data de check-in.
localCheckout
String (Date Time)
Data de Check-out.
vehicle
String
Veiculo.
currency
String
Tipo de moeda.
voucher
String
Voucher do veiculo.
checkoutDate
checkinDate
dateCreated
String (Date Time)
Data de criação.
authorizationNumber
String
Numero da autorização.
paymentCondition
String
Condições de pagamento.
dailyQuote
formPayment
description
String
Descrição da forma de pagamento.
typePayment
String
Tipo de pagamento.
code
String
Codigo da forma de pagamento.
air
string (Enum)
Cartão de credito para Aereo (True/False).
hotels
string (Enum)
Cartão de credito para Hotel (True/False).
rental
string (Enum)
Cartão de credito para Locação (True/False).
service
string (Enum)
Cartão de credito para Serviço (True/False).
bus
string (Enum)
Cartão de credito para Rodoviario (True/False).
restrictive
alternativeUATP
string (Enum)
Cartão de credito UATP(True/False).
card
paymentName
Nome da forma de pagamento.
name
Nome do titular da forma de pagamento.
cardNumber
Numero do cartão de credito.
flag
Bandeira do cartão.
active
string (Enum)
Ativo (True/False).
providerId
ID do provedor do cartão.
webServiceId
ID da forma de pagamento.
cardId
ID do cartão de credito.
billingType
userEmail
E-mail do viajante vinculado ao cartão de credito.
userLogin
Login do viajante vinculado ao cartão de credito.
securityCode
Codigo de segurança do cartão de credito.
dateValidity
Data de validade do cartão de credito.
virtualCard
string (Enum)
Cartão virtual (True/False).
community
passport
Passaporte do viajante vinculado ao cartão de credito.
addressText
Endereço do viajante vinculado ao cartão de credito.
addressCity
Cidade do viajante vinculado ao cartão de credito.
addressState
Estado do viajante vinculado ao cartão de credito.
addressCountry
Pais do viajante vinculado ao cartão de credito.
addressPostalCode
CEP do viajante vinculado ao cartão de credito.
documentCpf
CPF do viajante vinculado ao cartão de credito.
dateInclusion
Data da inclusão do cartão.
dateChange
Data da alteração do cartão.
billingCode
Codigo do faturamento.
billingDescription
Descrição do faturamento.
cardAuthorization
Numero de autorização do cartão.
airs
airId
departure
arrival
departureDate
arrivalDate
supplier
GET List - Retorna lista de pedidos.
Modelo Json
Campo
Formato
Função
{
"code": "string",
"description": "string",
"companyCode": "string",
"parentCode": "string",
"initialDebitDate": "2024-11-11T17:21:13.104Z",
"finalDebitDate": "2024-11-11T17:21:13.104Z"
}
request_date_start
String
Insira a data de inicio da pesquisa (Formato yyyy-MM-dd).
request_date_end
String
Insira a data final da pesquisa (Formato yyyy-MM-dd).
request_status
String
Status da viagem da solicitação. Exemplo: 'open' (Em aberto), 'requested' (Solicitado), 'awaitingPermissionAuthorization' (Aguardando mérito),'awaitingQuotation'(Aguardando cotação), 'awaitingDefinitionOfReserve' (Aguardando definição de reserva),'reserving'(Reservando), 'awaitingBudget'(Aguardando orçamento), 'awaitingSelection'(Aguardando seleção), 'waitingDefinitionApprover'(Aguardando definição do aprovador),'awaitingApprovalOfCost'(Aguardando aprovação de custo), 'awaitingIssue'(Aguardando emissão), 'issued' (Emitido), 'canceled' (Cancelado), 'expired' (Expirado), 'rejected' (Rejeitado), 'finalized' (Finalizado) .
expense_status
String
Status de expense da requisição. Exemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'.
date_type
String (Date Time)
Filtro para busca da solicitação: 'approvalDate', 'quotationDate', 'issueDate', 'selectionDate', 'tripInitialDate', 'tripEndDate', 'requestDate',ApprovationRefundDate.
advancePaymentStatus
String (Date Time)
Status de pagamento: Exemplo: 'awaitingApproval', 'awaitingPayment', 'finalized'.
UserV
POST UserV - Inserir ou atualizar um Funcionario.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Users
Url Produção: https://api.copastur.com.br/api-company/v2/api/Users
Modelo Json
Campo
Formato
Função
{
"login": "string",
"fullName": "string",
"firstName": "string",
"lastName": "string",
"gender": "string",
"costCenterCode": "string",
"companyCode": "string",
"companyName": "string",
"registration": "string",
"address": "string",
"zipCode": "string",
"state": "string",
"city": "string",
"birthDate": "2024-12-04T18:45:20.281Z",
"cpf": "string",
"rg": "string",
"email": "string",
"department": "string",
"position": "string",
"level": "string",
"mobilePhone": "string",
"phone": "string",
"isApproverAdvance": true,
"isMasterInternational": true,
"isMasterNational": true,
"isRefundMaster": true,
"isRequester": true,
"isRequesterMaster": true,
"isThirdParty": true,
"isVip": true,
"active": true,
"nationality": "string",
"language": "string",
"group": "string",
"integrationCode": "string"
}
login
String
Login do viajante no Argo.
fullName
String
Nome completo do funcionario.
firstName
String
Primeiro nome do funcionario.
lastName
String
Ultimo nome do funcionario.
gender
String
Gênero do funcionario. (Masculino = M Feminino = F ou deixar em branco)
costCenterCode
String
Centro de custo do funcionario.
companyCode
String
Empresa de debito do funcionario.
companyName
String
Empresa de debito do funcionario.
registration
String
Matricula do funcionario.
address
String
Endereço do funcionario.
zipCode
String
CEP do funcionario.
state
String
Estado do funcionario.
city
String
Cidade do funcionario.
birthDate
String
Data de nascimento do funcionario.
cpf
String
CPF do funcionario.
rg
Number
RG do funcionario.
email
Number
E-mail do funcionario.
department
String
Departamento do funcionario.
position
String
Cargo do funcionario.
level
String
Nivel do funcionario.
mobilePhone
String
Telefone celular do funcionario.
phone
String
Telefone fixo do funcionario.
isApproverAdvance
String (Enum)
Flag para master adiantamento.
isMasterInternational
String (Enum)
Flag para master internacional.
isMasterNational
String (Enum)
Flag para master nacional.
isRefundMaster
String (Enum)
Flag para master reembolso.
isRequester
String (Enum)
Flag para solicitante.
isRequesterMaster
String (Enum)
Flag para solicitante master.
isThirdParty
String (Enum)
Flag para viajante terceiro.
isVip
String (Enum)
Flag para viajante VIP.
active
String (Enum)
Status do funcionario.
nationality
String
Nacionalidade do funcionario.
language
String
Idioma do funcionario.
group
String
Grupo de permissão do funcionario.
integrationCode
String
Codigo de integração do funcionario.
DELETE UserV - Inativar funcionario.
Url Homologação: https://stag-api.copastur.com.br/api-company/v2/api/Users
Url Produção: https://api.copastur.com.br/api-company/v2/api/Users
Modelo Json (Não possui)
Campo
Formato
Função
login
String
Login do funcionario.