¿Qué es la API de Argo?

La API de Argo permite el uso de servicios de alteración, listado, recuperación e inserción de datos, como solicitudes, centros de costos, cierre de tarjeta, usuarios, estructuras de aprobación, anticipo / rendición de cuentas, etc. Además de permitir la ejecución de acciones como pago de anticipo y / o reembolso, creación de solicitudes (OS), aprobación de solicitudes, etc.

¿Quién puede usarlo?

Las agencias de viajes o corporaciones que tienen acceso "Admin" a la aplicación Argo y desean administrar sus datos e información de una manera práctica, segura y automatizada.

Descripción general - API de Argo

Esta documentación tiene como objetivo guiar a los desarrolladores sobre cómo integrarse con la API de Argo, presentando las características y métodos que se utilizarán con ejemplos, facilitando la comprensión y el uso de los servicios.

El conocimiento intermedio del lenguaje de programación web (HTTP / HTTPS) y la manipulación de archivos web son suficientes para la integración con la solución API ARGO.

En esta documentación es posible encontrar las indicaciones y operaciones principales disponibles en la API de Argo.

Características de la API

La API de Argo está relacionada con los productos puestos a disposición por Argo Solutions (Travel and Expense), desarrollados en RestFul (estándar de tecnología utilizado en el mercado), pudiendo integrarse utilizando los lenguajes de programación más variables:

  • Net
  • Java
  • PHP
  • Ruby
  • Python

Arquitectura

La integración se lleva a cabo a través de servicios disponibles como servicios web, con operaciones y transacciones realizadas utilizando los métodos GET, POST, PUT, DELETE o PATCH.

GET Se utiliza para consultar los registros existentes en la aplicación: Ejemplo: Solicitudes de consulta (OS - Orden de servicio).

POST Se utiliza para enviar una entidad a un recurso específico. Ejemplo: inserción de usuarios.

PUT Se usa para actualizar un recurso existente específico: Ejemplo: Actualizar los datos de registro de un usuario.

DELETE Se usa para eliminar un recurso existente: Ejemplo: Finalizar una estructura de aprobación.

PATCH Se utiliza para actualizar por lotes los recursos existentes. Ejemplo: actualización de centros de costos.

Herramientas de integración

Postman es un API Rest Client que facilita a los desarrolladores la creación, el intercambio, la prueba y la documentación de las API, lo que permite a los usuarios crear y guardar solicitudes HTTP simples y complejas, así como leer sus respuestas.

Entendiendo la aplicación

Para poder utilizar los métodos y recursos disponibles en nuestra API, es importante comprender los conceptos de la aplicación, en el siguiente enlace es posible encontrar las principales funcionalidades y reglas comerciales de Argo:
Argo Wiki

Resumen de características y operaciones

Para facilitar la comprensión de la aplicación, tenemos a continuación un glosario con los términos principales relacionados con los productos de viajes y gastos:

Servicio Descripción
ConfigsAccountingAccount Gestión de cuentas contables.
ConfigsApprovals Registro / actualización de estructuras de aprobación. Saiba mais
ConfigsBudgets Registro / actualización de presupuestos
ConfigsCities Recupera la lista de ciudades registradas en la base de datos
ConfigsClients Registro / actualización de clientes Saiba mais
ConfigsCommunities Registro / actualización de comunidades
ConfigsCompanies Registro / actualización de empresas Saiba mais
ConfigsCostCenters Registro / actualización de los Centros de Costos
ConfigsCreditCards Recupera la lista de tarjetas registradas
ConfigsExpenses Registro / actualización de gastos
ConfigsFormsPayments CRegistro / actualización de las formas de pago utilizados por la corporación.
ConfigsHotels Registro / actualización del directorio hotelero de agencias / corporaciones
ConfigsJustifications Registro / actualización de justificación de elección
ConfigsLevels Recupera la lista de niveles de usuario
ConfigsManagementFields Registro / actualización de campos de gerenciales
ConfigsProjects Registro / actualización de proyectos
ConfigsReasonsTravel Registro / actualización de "motivos de viaje" utilizados en el cliente
ConfigsUsers Registrar / actualizar usuarios
ConfigsUsersProfile Registro / actualización de perfil del usuario
ExpenseAdvancePayments Enumera las solicitudes que contienen anticipo
ExpenseBlockedRequests Enumera las solicitudes bloqueadas y las solicitudes pendientes de bloqueo.
ExpensePayments Le permite pagar solicitudes de anticipo / rendición de cuentas
ExpenseRefunds Enumera las solicitudes que contienen rendición de cuentas / reembolso
ExpenseTypesPayments Enumera las formas de pago registradas para anticipo / reembolso / devolución
PriceSummary Enumera los resumen de los valores del producto para partes de una solicitud.
Requests Recupera el resumen de solicitudes
RequestsAgents Recupera los datos del asistente / consultor de la solicitud
RequestsAllocations Recupera los datos de asignación de la deuda de la solicitud
RequestsApprovals Recupera los datos del aprobador de la solicitud (GET) y permite la aprobación / rechazo de una solicitud (PUT)
RequestsFees Recupera los datos de la Fee de solicitud
RequestsFlightsQuotations Recupera los datos de la cotización aérea de la solicitud.
RequestsFlightsRequesteds Recupera los datos de la emisión aérea de la solicitud
RequestsHotelsQuotations Recupera los datos de cotización de hospedaje de la solicitud
RequestsHotelsRequesteds Recupera los datos de emisión de hospedaje de la solicitud
RequestsManagementFields Recupera los campos gerenciales de la solicitud
RequestsReasonsTravel Recupera el motivo de viaje ingresado en la solicitud
RequestsRentalsQuotations Recupera los datos de la cotización de alquiler de auto de la solicitud.
RequestsRentalsRequesteds Recupera los datos de emisión de alquiler de auto de la solicitud.
RequestsRequesters Recupera los datos del solicitante de la solicitud
RequestsRoadsQuotations Recupera los datos de cotización de autobús de la solicitud
RequestsRoadsRequesteds Recupera los datos de emisión de autobús de la solicitud
RequestsServicesQuotations Recupera los datos de cotización para el servicio de solicitud
RequestsServicesRequests Recupera los datos de emisión de servicio de la solicitud
RequestsTravelers Recupera los datos del viajero de la solicitud

Ocurrencias

La siguiente es una lista de los principales códigos y descripciones que se pueden presentar al devolver los servicios solicitados, lo que facilita la comprensión y los posibles ajustes para el correcto funcionamiento de la solicitud.

Código Error Descripción
200 OK Éxito.
400 Bad Request La solicitud tiene parámetro(s) no válido(s).
401 Unauthorized El token de acceso no fue informado o no tiene acceso a las APIs.
404 Not Found No se encontró el recurso informado en la solicitud.
413 Request is to Large La solicitud excede el límite permitido para su perfil de token de acceso.
422 Unprocessable Entity La solicitud tiene errores comerciales.
429 Too Many Requests Se ha excedido el límite de solicitudes por tiempo.
500 Internal Server Error Error inesperado, algo está inaccesible en la API.

Primeros pasos para usar la API de Argo

1. Crea tu cuenta

Acceda al portal y cree su cuenta.

2. Crea tu aplicación

Después de crear su cuenta, cree su aplicación:

cree su aplicación
  • El campo "nombre" debe representar al titular de la licencia que utilizará la APP.
    • Si el titular de la licencia es "Agencia 1", el campo debe completarse como "AGENCIA1-HML"
    • Si la APP es de acceso exclusivo a una corporación, el campo debe ser llenado como "AGENCIA1-NOMBRE-DE-LA-CORPORACION-HML"
  • El campo "descripción" se puede completar a discreción del creador del APP.
  • Para completar el campo "Link para su Aplicación" utilice "https://api-hml.useargo.com/argo/v2/".
Nota: La APP creada directamente por el usuario se dirige automáticamente al plan de Homologación.
En el momento en que la APP apruebe el plan de Producción, el acrónimo "HML" se cambiará a "PRD".
Alinee con su ejecutivo de cuenta para conocer los planes de acceso a los entornos de homologación y producción.

3. Hacer la codificación para la base 64

Acceda a su aplicación y codifique el "Client ID/Client Secret" para la base 64.

Client ID e Client Secret

Nota: Al hacer la codificación para la base 64, elimine los "espacios" y "/", agregue ":"
Ejemplo:

De:

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

Para:

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

4. Creando el token para la autenticación

Para la creación de access-token primero necesita saber cuál es el plan de contrato de su APP.

  • Si se trata de un plan de Homologación, debe realizar una solicitud POST a la URL https://api-hml.useargo.com/oauth/access-token/
  • Si se trata de un plan de Producción, debe realizar una solicitud POST a la URLhttps://api.useargo.com/oauth/access-token/
Nota: alinee con su ejecutivo de cuenta para averiguar en qué plan se encuentra su aplicación.

La requisición realizada debe enviar la siguiente información:

Headers

  • Content-Type: application/json
  • Authorization: Encode base 64
Headers
Propiedad Tipo Requerido Descripción
Content-Type String Si Incluir Value: application/json
Content-Type Si Incluya la codificación Base 64 en la Autorización. Ejemplo: Basec KTliMCNiNDvtYjQjZC0bMxOThlNjYtMTVuAYY2M2YzYjAzOjQwOWQyNjU1KTY3YzktMzE3ZS04YzMwLTJlOGU5ZBAxYzA5ZC==

Body

La solicitud del body debe completarse de acuerdo con los detalles a continuación:

{
	"username": "argo.argo",
	"password": "teste@",
	"reseller": "argo",
	"corp": "solutions",
	"grant_type": "password"
}
Propiedad Requerido Descripción
Username Si Inicio de sesión de usuario utilizado para ingresar al sistema Argo
password Si Contraseña de usuario utilizada para ingresar al sistema Argo
reseller Si URL de agencia de viajes.
Ejemplo: www.argoit.com.br/URLdaAGÊNCIA
corp Si URL del cliente (corporación) servida por la agencia de viajes. Ejemplo: www.argo.com.br/URLdaAGÊNCIA/URLdaCORPORAÇÃO
grant_type Si Rellene con “password”

Después de este procedimiento, el token se generará para su uso en la autenticación API.
Este token tendrá una validez de 60 minutos y se puede utilizar para todas las solicitudes dentro de ese período.

5. Usa la API

A través del token generado de acuerdo con el paso 4, es posible consumir los métodos API de Argo, para esto, siga los procedimientos a continuación:

  • Vaya a la sección Detalles de funciones y operaciones y seleccione el método que desea utilizar.
  • Pase la información en el encabezado:
    • access_token: generado en el método de autenticación
    • client_id: como se mencionó anteriormente, es posible encontrarlo en Herramientas de desarrollo -> Mis aplicaciones -> ID de cliente
  • Para todos los servicios disponibles está el encabezado a continuación:

5.1 URLs de acceso

Para realizar solicitudes, es necesario utilizar la URL correcta de acuerdo con su plan de APP.

Homologación: https://api-hml.useargo.com/argo/v2/{metodo-elegido}

Ejemplo:

Si desea consultar a los usuarios que se encuentran en un entorno de aprobación, la URL de consulta será la siguiente: https://api-hml.useargo.com/argo/v2/users

Producción: https://api.useargo.com/argo/v2/{metodo-elegido}

Ejemplo:

Si desea consultar a los usuarios que se encuentran en un entorno de producción, la url de consulta será la siguiente: https://api.useargo.com/argo/v2/users

Nota: El "método elegido" se puede encontrar en Detalles de funciones y operaciones

Propiedad Tipo Tamaño Requerido Descripción
reseller String 20 No URL de agencia de viajes. Ejemplo: www.argoit.com.br/URLdaAGÊNCIA
client_id Guid 36 Si Identificación generada al crear la aplicación. (Vea el segundo paso para usar la API de Argo)
access_token String 36 Si Token generado a través de la API de autenticación. Ejemplo: 5b035b1c-9acc-3c22-b40a-f2d3c9bb0d54
corp String 20 No URL del cliente (corporación) que pertenece a la agencia de viajes. Ejemplo: www.argo.com.br/URLdeAGÊNCIA/URLdeCORPORACION
login String 50 No Inicio de sesión de usuario utilizado para ingresar al sistema Argo
password String 12 No Contraseña de usuario utilizada para ingresar al sistema Argo

Tabla de Estatus de las Solicitudes

Anticipo / Gastos

Estatus utilizado en la API Estatus
awaitingIssue Aguardando emisión (cuando está asociado con un viaje / anticipo)
awaitingLaunch Aguardando lista
awaitingConfirmation Aguardando confirmación
awaitingApproval Aguardando de autorización
awaitingPayment Aguardando pago
finalized Concluida

Estatus del Viaje

Estatus utilizado en la API Estatus
open Abierto
requested Solicitado
awaitingPermissionAuthorization Aguardando autorización de mérito
awaitingQuotation Aguardando cotización
awaitingDefinitionOfReserve Aguardando definición de reserva
reserving Reservando
awaitingBudget Aguardando presupuesto
awaitingSelection Aguardando elección
waitingDefinitionApprover Aguardando definición de aprobador
awaitingApprovalOfCost Aguardando autorización de costo
awaitingIssue Aguardando emisión
issued Emitido (liberado para facturación)
canceled Cancelado
expired Expirado
rejected Rechazado

Tabla de productos

Producto Descripción
air Aéreo
hotel Hospedaje
rental Alquiler de autos
service Servicios adicionales
road Autobuses
advancedPayment Anticipo
refound Rendición de cuentas / reembolso

Detalles de caracteristicas y operaciones

ConfigsAccountingAccount

A travess de este servicio el cliente puede obtener toda la informaión relacionada a las cuentas contables registradas en su ambiente. Por medio de este servicio es posible tambiesn la administración (crear, actualizar e inactivar) de las cuentas contables registradas.

GET /accountingAccount

Request

Request GET
Propiedad Tipo Tamaño Descripción
filters.active String 3 Propiedad que indica si la cuenta contable está activa. Ejemplo: Yes/No
filters.companyId Guid 36 ID de Identificación de la empresa de la cuenta contable. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.description String 50 Descripción de la cuenta contable. Ejemplo: Cuenta contable de asuntos internos
filters.integrationCode String 3 Código de integración de la cuenta contable (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'ACC1010'
filters.typeTrip String 13 Tipo de viaje de la cuenta contable. Ejemplo: 'both', 'international', 'domestic'

Response

[
  {
    "active": "yes",
    "description": "string",
    "accountingAccountId": "00000000-0000-0000-0000-000000000000"
  }
]
Propiedad Tipo Tamaño Descripción
accountingAccountId Guid 36 ID de Identificación de la cuenta contable. Ejemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descripción de la cuenta contable. Ejemplo: Cuenta contable de asuntos internos
active String 3 Propiedad que indica si la cuenta contable está activa. Ejemplo: Yes/No

GET /accountingAccount/accountingAccountId

Request

Request GET

Response

{
  "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",
  ]
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID de Identificación del cliente de la Cuenta Contable. Ejemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descripción de la Cuenta Contable. Ejemplo: Cuenta Contable de Asuntos internos
integrationCode String 3 Código de integración de la cuenta contable (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'ACC1010'
typeTrip String 13 Tipo da viaje de la Cuenta Contable. Ejemplo: 'both', 'international', 'domestic'
companyId Guid 36 ID de identificación de la empresa de la Cuenta Contable. Ejemplo: 00000000-0000-0000-0000-000000000000
active String 3 Propiedad que indica si la Cuenta Contable está activa. Ejemplo: Yes/No
requestsProject String 3 Propiedad que indica si la Cuenta Contable obliga proyecto. Ejemplo: Yes/No
expenseType String 15 Tipo de gasto que la Cuenta Contable es vinculada. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

POST /accountingAccount

Request

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}
Propiedad Tipo Tamaño Obligatorio Descripción
description String 50 Si Descripción da Cuenta Contable. Ejemplo: Cuenta Contable da Corregedoria
integrationCode String 20 Si Código de integración da conta contable (Este código pode ser utilizado por otros sistemas no proceso de integración). Ejemplo: 'ACC1010'
typeTrip String 13 No Tipo da viaje da Cuenta Contable. Ejemplo: 'both', 'international', 'domestic'
companyId Guid 36 No ID de identificación da empresa da Cuenta Contable. Ejemplo: 00000000-0000-0000-0000-000000000000
requestsProject String 3 No Propiedad que indica se a Cuenta Contable obliga proyecto. Ejemplo: Yes/No
expenseType String 15 No Tipo de gasto que a Cuenta Contable es vinculada. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

Response

resposta POST
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de la acción. Ejemplo: True/False

PUT /accountingAccount

Request

{
  "description": "string",
  "integrationCode": "string",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "typeTrip": "both, international, domestic",
  "requestsProject": "yes",
  "expenseType": [
	"air",
	"hotels",
	"rental",
	"service",
	"road",
	"fee",
    "expense"
  ]
}
Propiedad Tipo Tamaño Obligatorio Descripción
description String 50 Si Descripción de la Cuenta Contable. Ejemplo: Cuenta Contable de Asuntos internos
integrationCode String 20 Si Código de integración de la cuenta contable (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'ACC1010'
typeTrip String 13 No Tipo da viaje de la Cuenta Contable. Ejemplo: 'both', 'international', 'domestic'
companyId Guid 36 No ID de identificación de la empresa de la Cuenta Contable. Ejemplo: 00000000-0000-0000-0000-000000000000
requestsProject String 3 No Propiedad que indica si la Cuenta Contable obliga proyecto. Ejemplo: Yes/No
expenseType String 15 No Tipo de gasto que la Cuenta Contable es vinculada. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'fee', 'expense'

Response

resposta PUT
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

ConfigsApprovals

Através del registro de estructura de aprobación, es posible configurar y definir el flujo de aprobación de solicitudes.

1º Para quien:

La estructura se puede hacer para todo el cliente, en este caso mantenga los campos mencionados a continuación en blanco.

  • EMPRESA - Establece si el flujo será exclusivo para la empresa informada, debe estar registrada previamente en el sistema.
  • CENTRO DE COSTO - Establece si el flujo será exclusivo para el centro de costos informado, debe estar registrado previamente en el sistema.
  • COMUNIDAD - Establece si el flujo será exclusivo para la comunidad, debe estar registrada previamente en el sistema.
  • USUARIO - Establece si el flujo será exclusivo para el usuario informado, debe estar registrada previamente en el sistema.
  • CUENTA CONTABLE - Establece si el flujo será exclusivo para la cuenta contable informada, debe estar registrada previamente en el sistema.
  • PROYECTO - Establece si el flujo será exclusivo para el proyecto informado, debe estar previamente registrado en el sistema.

2º Qué:

Establece lo que se aprobará en la solicitud: Tipo de viaje (nacional o internacional) Control de fondos (Confirmación, anticipo o reembolso).

3º Como: Determina cómo será la estructura de aprobación, siguiendo los criterios.:

  • Única - Sólo un aprobador de la lista para autorizar.
  • Secuencial - Los correos electrónicos se enviarán desde el primero al último aprobador registrado de forma secuencial. Todos los aprobadores de la lista deben aprobar.
  • Paralela - Se enviarán correos electrónicos al mismo tiempo a todos los aprobadores registrados. Todos los aprobadores de la lista deben aprobar.
  • Nivel - Solo un aprobador de la lista será elegido para aprobar y debe ser de un nivel más alto que el viajero.

Ejecutar los métodos GET, POST, PUT, GET ou DELETE de una estructura de aprobación.

PPara obtener más información, visite Argo Wiki.

GET /approvals (Obsoleto)

Este método está obsoleto y será removido en el futuro. Puede utilizar el método "GET /approvals/v2"

Request

Request GET
Propiedad Tipo Tamaño Obligatorio Descripción
filters.actives String (Boolean) 5 No Status de la estructura de aprobación (activa/inactiva) Ejemplo: true/false

Respuesta

[
    {
        "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"
    }
]
Propiedad Tipo Tamaño Descripción
approvalId Guid 36 ID relacionado al registro de la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000
active String 3 Status de la estructura de aprobación (activo/inactivo). Ejemplo: Yes/no
forWhoDescription String 255 Login de usuario para quien es destinada la estructura de aprobación.
structurePer String (Enum) 17 “Para quien” (ver introducción del servicio). Ejemplo: client, company, costCenter, user, accountingAccount, project, community
project string 50 Proyecto al que la estructura de aprobación está relacionada. Ejemplo: Proyecto travel.
companyName String 50 Descripción de la empresa al que la estructura de aprobación está relacionada. Ejemplo: Argo
costCenterCode String 30 Código del centro de costo al que la estructura de aprobación está relacionada. Ejemplo: 001
costCenterDescription String 50 Descripción del centro de costo al que la estructura de aprobación está relacionada. Ejemplo: Desarrollo
reasonTravel String 50 Motivo del viaje al que la estructura de aprobación está relacionada. Ejemplo: Reunión con cliente.
accountingAccount String 50 Cuenta Contable al que la estructura de aprobación está relacionada. Ejemplo: Alimentación
community String 50 Comunidad al que la estructura de aprobación está relacionada. Ejemplo: Equipo técnico
typeApproval String (Enum) 10 “Como” (Ver introducción del servicio). Ejemplo: parallel, sequential, single
approvers ApproverVM 1 Objeto responsable de transportar la información de aprobación de la estructura de aprobación
approvers Arreglo responsable por enviar la información de los aprobadores de la estructura de aprobación.
Propiedad Tipo Tamaño Descripción
login String 255 Login del usuario aprobador. Ejemplo: aprobador.uno
email String 255 Email del usuario aprobador. Ejemplo: aprobador.uno@argo.com
fullName String 255 Nombre completo del usuario. Ejemplo: Aprobador Principal

GET /approvals/v2

Solicitud

solicitud GET
Propiedad Tipo Tamaño Obligatorio Descripción
filters.status String (Boolean) 5 No Status de la estructura de aprobación (activa/inactiva) Ejemplo: true/false
filters.companyId Guid 36 No El Argo permite vincular una estructura de aprobación a una determinada empresa. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” de la empresa vinculada. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.costCenterId Guid 36 No El Argo permite vincular una estructura de aprobación a un determinado centro de costo. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” del centro de costo vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.userId Guid 36 No El Argo permite vincular una estructura de aprobación a un determinado usuario. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” del usuario vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.projectId Guid 36 No El Argo permite vincular una estructura de aprobación a un determinado proyecto. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” del proyecto vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.accountingAccountId Guid 36 No El Argo permite vincular una estructura de aprobación a una determinada cuenta contable. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” de la cuenta contable vinculada. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.communityId Guid 36 No El Argo permite vincular una estructura de aprobación a una determinada comunidad. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” de la comunidad vinculada. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.reasonTravelId Guid 36 No El Argo permite vincular una estructura de aprobación a un determinado motivo de viaje. Esa propiedad permite filtrar la estructura de aprobación utilizando el “ID” del motivo de viaje vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.approverId Guid 36 No A través de esa propiedad es posible encontrar la estructura de aprobación de acuerdo a un determinado usuario aprobador. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.approval String (Enum) 10 No “Como” (Ver la infroamción del servicio). Posibilita consultar estructuras de un determinado tipo de aprobación. Ejemplo: parallel, sequential, single
filters.typeApproval String (Enum) 15 No “El qué” (Ver la información del servicio). Permite consultar estructuras con las características de la aprobación. Ejemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
filters.page Number 100 No Esta propiedad le permite cargar más solicitudes (u Órdenes de Servicio OSs) por página si se excede el número estándar de 3000, por lo que una vez que se supera este número en el filtro, se incrementará un nuevo grupo de 3000 solicitudes por página disponibles para ser cargado, agregándose sucesivamente nuevos conjuntos de 3000 solicitudes conforme se incrementan, para poder ser filtradas y cargadas en distintas páginas. Por ejemplo: si necesitamos acceder al registro 3090, usamos el número dos en el filtro. O bien, si necesitamos acceder al registro 7000, usaremos el filtro tres.

Respuesta

[
	{
		"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"
            },
        ]
	}
]
Propiedad Tipo Tamaño Descripción
approvalId Guid 36 ID relacionado al registro de la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000
forWhoDescription String 255 Login de usuario para quién es destinada la estructura de aprobación.
structurePer String (Enum) 17 “Para qué” (ver la introducción del servicio). Ejemplo: client, company, costCenter, user, accountingAccount, project, community
project string 50 Proyecto al que la estructura de aprobación está relacionada. Ejemplo: Proyecto Travel
companyName String 50 Descripción de la empresa al que la estructura de aprobación está relacionada. Ejemplo: Argo
costCenterCode String 30 Código del centro de costo al que la estructura de aprobación está relacionada. Ejemplo: 001
costCenterDescription String 50 Descripción del centro de costo al que la estructura de aprobación está relacionada. Ejemplo: Desarrollo
reasonTravel String 50 Motivo de viaje al que la estructura de aprobación está relacionada. Ejemplo: Reunión con cliente
accountingAccount String 50 Cuenta Contable al que la estructura de aprobación está relacionada. Ejemplo: Viáticos
community String 50 Comunidad al que la estructura de aprobación está relacionada. Ejemplo: Equipo Técnico
typeApproval String (Enum) 10 “Cómo” (Ver introducción del servicio). Ejemplo: parallel, sequential, single
active String 3 Status de la estructura de aprobación (activo/inactivo). Ejemplo: Yes/no
approvers ApproverVM 1 Objeto responsable de transportar la información de aprobación de la estructura de aprobación
approvers Objeto responsable de transportar la información de aprobación de la estructura de aprobación
Propiedad Tipo Tamaño Descripción
login String 255 Inicio de sesión de usuario aprobador. Ejemplo: aprover.um
email String 255 Correo electrónico del usuario aprobador. Ejemplo: aprovador.um@argo.com
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal

POST /approvals

Solicitud

[
    {
        "companyName": "string",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "costCenterCode": "string",
        "costCenterDescription": "string",
        "community": "string",
        "userLogin": "string",
        "userEmail": "string",
        "accountingAccount": "string",
        "project": "string",
        "reasonTravel": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]
Propiedad Tipo Tamaño Requerido Descripción
companyName String 50 No Descripción de la empresa a la que se relacionará la estructura de aprobación. Ejemplo: Argo
costCenterId String (Guid) 36 No ID del centro de coste con el que se relacionará la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterCode String 30 No Código de centro de costo en el que se relacionará la estructura de aprobación. Ejemplo: ABHA87
costCenterDescription String 50 No Descripción del Centro de costos en el que se relacionará la estructura de aprobación. Ejemplo: Desarrollo
community String 50 No Comunidad en la que se relacionará la estructura de aprobación. Ejemplo: equipo técnico
userLogin String 50 No Login del usuario en el que se relacionará la estructura de aprobación. Ejemplo: argo.solutions
userEmail String 100 No Correo electrónico del usuario en el que se relacionará la estructura de aprobación. Ejemplo: useargo@argo.com
accountingAccount String 50 No Cuenta contable en la que se relacionará la estructura de aprobación. Ejemplo: Departamento de Desarrollo
project String 50 No Proyecto en el que se relacionará la estructura de aprobación. Ejemplo: Proyecto Travel
reasonTravel String 50 No Motivo del viaje en el que se relacionará la estructura de aprobación Ejemplo: reunión con el cliente
typeApproval String (Enum) 10 Si "Cómo" (ver introducción del servicio). Ejemplo: paralela, secuencial, única
approvers ApproverVM 1 No Objeto responsable de transportar la información de aprobación de la estructura de aprobación
scopes Number 100 No Argo permite la creación de estructuras de aprobación por rango de valores para los tipos de "secuencial" y "único". Esta propiedad permite definir el alcance registrado en la estructura
secondLevel String (Enum) 3 No Usuario aprobador de segundo nivel. Ejemplo: (Yes/No)
secondLevelMaster String (Enum) 3 No Usuario aprobador maestro de segundo nivel. Ejemplo: Yes/No
approvals String (Enum) 15 No "Qué" (consulte la introducción del servicio). Ejemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
approvers Datos del aprobador de la estructura
Propiedad Tipo Tamaño Requerido Descripción
email String 50 Si Correo electrónico del usuario aprobador. Ejemplo: argo@useargo.com
login String 50 Si Login del usuario aprobador. Ejemplo: argo.teste
fullName String 50 Si Nombre completo del usuario aprobador. Ejemplo: João Silva

Respuesta

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"index": "0",
		"success": "yes"
	}
]
Propiedad Tipo Tamaño Descripción
id Guid 36 Identificación de registro realizada. Ejemplo: 00000000-0000-0000-0000-000000000000
index String 5 Posición en la lista insertada de aprobaciones. Ejemplo: Index 1
success String (Enum) 3 Transacción exitosa o fallida. Ejemplo: Yes o No

PUT /approvals

Solicitud

[
    {
        "approvalId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "costCenterCode": "string",
        "costCenterDescription": "string",
        "community": "string",
        "userLogin": "string",
        "userEmail": "string",
        "accountingAccount": "string",
        "project": "string",
        "reasonTravel": "string",
        "typeApproval": "single",
        "approvers": [
            {
                "email": "string",
                "login": "string",
                "fullName": "string"
            }
        ],
        "scopes": [
            0
        ],
        "secondLevel": [
          true
        ],
        "secondLevelMaster": [
          true
        ],
        "approvals": [
            "domestic"
        ]
    }
]
Propiedad Tipo Tamaño Requerido Descripción
approvalId Guid 36 Si ID relacionada con el registro de la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 No Descripción de la empresa enn la que está relacionada la estructura de aprobación. Ejemplo: Argo
costCenterId String(Guid) 36 No ID del centro de coste con el que se relacionará la estructura de aprobación. Exemplo: 00000000-0000-0000-0000-000000000000
costCenterCode String 30 No Código del centro de costos en el que está relacionada la estructura de aprobación. Ejemplo: ABHA87
costCenterDescription String 50 No Descripción del Centro de costos en el que está relacionada la estructura de aprobación. Ejemplo: desarrollo
community String 50 No Comunidad en la que está relacionada la estructura de aprobación. Ejemplo: equipo técnico
userLogin String 50 No Login de usuario en el que está relacionada la estructura de aprobación. Ejemplo: argo.solutions
userEmail String 100 No Correo electrónico del usuario en el que está relacionada la estructura de aprobación. Ejemplo: useargo@argo.com
accountingAccount String 50 No Cuenta contable en la que está relacionada la estructura de aprobación. Ejemplo: Departamento de Desarrollo
project String 50 No Proyecto en la que está relacionada la estructura de aprobación. Ejemplo: Proyecto Travel
reasonTravel String 50 No Motivo del viaje en el que está relacionada la estructura de aprobación. Ejemplo: reunión con el cliente
typeApproval String (Enum) 10 No "Cómo" (ver introducción del servicio). Ejemplo: paralela, secuencial, única
approvers String 50 No Usuario que aprobará la estructura. Ejemplo: João Silva
scopes Number 100 No El Argo permite la creación de estructuras de aprobación por rango de valores para los tipos de “secuencial” y “única”. Esta propiedad permite definir el valor máximo registrado en la estructura
secondLevel String (Enum) 3 No Usuario aprobador de segundo nivel. Ejemplo: (Yes/No)
secondLevelMaster String (Enum) 3 No Usuario aprobador maestro de segundo nivel. Ejemplo: Yes/No
approvals String (Enum) 15 No "Qué" (consulte la introducción del servicio). Ejemplo: refund, international, domestic, conference, merit, closingCard, advancedPayment, additional, payment
approvers Estructura de los datos del aprobador
Propiedad Tipo Tamaño Requerido Descripción
email String 50 Si Correo electrónico del usuario que aprueba. Ejemplo: argo@useargo.com
login String 50 Si Inicio de sesión de usuario aprobador. Ejemplo: argo.teste
fullName String 50 No Nombre completo del usuario que aprueba. Ejemplo: João Silva

Respuesta

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"index": "0",
		"success": "yes"
	}
]
Propiedad Tipo Tamaño Formato
id Guid 36 Registro de ID completado. Ejemplo: 00000000-0000-0000-0000-000000000000
index String 5 Posición en la lista insertada de aprobaciones. Ejemplo: Index 1
success String (Enum) 3 Transacción exitosa o fallida. Ejemplo: Yes ou No

DELETE approvals/{approvalId}

Solicitud

solicitud DELETE
Propiedad Tipo Tamaño Requerido Descripción
approvalId Guid 36 Si ID relacionada con el registro de la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 50 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

GET /approvals/{approvalId}

Solicitud

solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
approvalId Guid 36 Sim ID relacionado con el registro de la estructura de aprobación. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
	{
		"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

El sistema Argo permite a los clientes vincular a las empresas, lo que permite relacionar configuraciones tales como (políticas, centro de costos, cuentas contables, usuarios, etc.) a las respectivas empresas (subunidades). La gestión / mantenimiento de estas empresas se puede realizar a través de la API de acuerdo con los detalles de los métodos a continuación.

GET /companies

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
filters.active String (Enum) 3 No Filtro: Estatus de registro de la empresa (activo / inactivo). Ejemplo: Yes/No
filters.companyName String 50 No Filtro - Nombre de la empresa
filters.flagProject String (Enum) 3 No Filtro: Define si la empresa debe estar vinculada a un proyecto
filters.integrationCode String 50 No Filtro: código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
filters.iata String 20 No Filtro - Código de la Asociación Internacional de Transporte Aéreo
filters.star String 50 No Filtro: datos de registro de clientes en globalizadores (GDS)
filters.referenceCode String 30 No Filtro: código de referencia de la empresa registrada

Respuesta

[
    {
        "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"
    }
]
Propiedad Tipo Tamaño Descripción
companyId Guid 36 ID de la empresa consultada. Ejemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Nombre de la empresa
active String (Enum) 3 Estatus de registro de la empresa (activo / inactivo). Ejemplo: Yes/No
inclusionDate String (Date Time 2 Fecha / hora de inclusión / creación de la empresa. Ejemplo: 2019-09-18T16:48:22.490Z
flagProject String (Enum) 3 Define si la empresa debe estar vinculada a un proyecto
integrationCode String 50 Código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
iata String 20 Código de la Asociación Internacional de Transporte Aéreo
star String 50 Datos de registro de clientes en globalizadores (GDS)
referenceCode String 30 Código de referencia de la empresa registrada

POST /companies

Solicitud

{
    "companyName": "string",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
companyName String 50 Si Nombre de la empresa
flagProject String (Enum) 3 No Define si la empresa debe estar vinculada a un proyecto. Ejemplo: Yes/No
integrationCode String 50 No Código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
iata String 20 No Código de la Asociación Internacional de Transporte Aéreo
star String 50 No Datos de registro de clientes en globalizadores (GDS)
referenceCode String 30 No Código de referencia de la empresa registrada

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
companyId String 50 ID de la empresa registrada. Ejemplo: 00000000-0000-0000-0000-000000000000

GET /companies/{companyId}

Solicitud

requisição GET
Propiedad Tipo Tamaño Requerido Descripción
companyId Guid 36 Si ID de la empresa registrada. Ejemplo: 00000000-0000-0000-0000-000000000000

Resposta

[
    {
        "companyId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "active": "yes",
        "inclusionDate": "2020-10-29T10:32:26.367Z",
        "flagProject": "yes",
        "integrationCode": "string",
        "iata": "string",
        "star": "string",
        "referenceCode": "string"
    }
]
Propiedad Tipo Tamaño Descripción
companyId Guid 36 ID de la empresa registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Nombre de la empresa
active String (Enum) 3 Estatus de registro de la empresa (activo / inactivo). Ejemplo: Yes/No
inclusionDate String (Date Time 2 Fecha / hora de inclusión / creación de la empresa. Ejemplo: 2019-09-18T16:48:22.490Z
flagProject String (Enum) 3 Define si la empresa debe estar vinculada a un proyecto
integrationCode String 50 Código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
iata String 20 Código de la Asociación Internacional de Transporte Aéreo
star String 50 Datos de registro de clientes en globalizadores (GDS)
referenceCode String 30 Código de referencia de la empresa registrada

PUT /companies/{companyId}

Solicitud

{
    "companyName": "string",
    "active": "yes",
    "flagProject": "yes",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "referenceCode": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
companyId Guid 36 Si ID de la empresa que desea actualizar. Ejemplo: 00000000-0000-0000-0000-000000000000
companyName String 50 Si Nombre de la empresa
active String (Enum) 3 No Indica el estado de la empresa (Activo / Inactivo). Ejemplo: Yes/No
flagProject String (Enum) 3 No Indica si la empresa debe estar vinculada a un proyecto. Ejemplo: Yes/No
integrationCode String 50 No Código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
iata String 20 No Código de la Asociación Internacional de Transporte Aéreo. Ejemplo: 957
star String 50 No Datos de registro de clientes en globalizadores (GDS). Ejemplo: 89289
referenceCode String 30 No Código de referencia de la empresa registrada. Ejemplo: 892k11

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
companyName String 50 Nombre de la empresa
flagProject String 3 Indica si la empresa debe estar vinculada a un proyecto. Ejemplo: Yes/No
integrationCode String 50 Código de integración de la empresa. Usualmente se utiliza para integrarse con otras aplicaciones. Ejemplo: Argo1673
iata String 50 Código de la Asociación Internacional de Transporte Aéreo. Ejemplo: 957
star String 50 Datos de registro de clientes en globalizadores (GDS). Ejemplo: 89289
referenceCode String 50 Código de referencia de la empresa registrada. Ejemplo: 892k11

ExpenseAdvancePayments

Este servicio le permite listar las solicitudes que contienen al menos una solicitud de anticipo.
Argo Wiki

GET

Solicitud

Solicitud GET

Respuesta

[
  {
    "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
  }
]
Propiedad Tipo Tamaño Descripción
bacenCode String 50 Código de país del banco central. Ejemplo: 1058
initialDate String (DataTime) 24 Es posible incluir en la solicitud de anticipo y/o rendición de cuentas, el período del viaje, siendo las propiedades "initialDate" y "finalDate" las fechas del mismo. Ejemplo: 2019-10-02T19:47:10.450Z
finalDate String (DataTime) 24 Es posible incluir en la solicitud de anticipo y/o rendición de cuentas el período del viaje, siendo las propiedades "initialDate" y "finalDate" las fechas del mismo. Ejemplo: 2019-10-02T19:47:10.450Z
expenseName String 50 Nombre del gasto relacionado con el pedido de anticipo. Ejemplo: Taxi
reasonTravelling String 50 Motivo de la solicitud de anticipo. Ejemplo: reunión con el cliente
coin String 3 Moneda solicitada en el anticipo. Ejemplo: BRL
exchange Number 14 Tipo de cambio utilizado en la solicitud en caso de solicitudes de anticipo en monedas distintas a la utilizada en el cliente. Ejemplo: 4.891,00
typePaymentName String 50 Descripción de "Pago preferencial" (forma de pago) solicitado por el usuario al solicitar el anticipo. Ejemplo: depósito bancario
integrationCodeCompany String 50 Código de integración de la empresa seleccionada en la solicitud de anticipo. Ejemplo: 18982
companyName String 50 Nombre de la empresa seleccionada en la solicitud de anticipo. Ejemplo: Argo
typePaymentId Guid 36 ID de "Pago preferido" (forma de pago) solicitada por el usuario en el pedido de anticipo
departureCity A través de la configuración en la aplicación, es posible agregar los campos "Ciudad de origen" y "Ciudad de destino" a la solicitud de anticipo. Una vez que estos campos se completan en la apertura del OS, las ciudades se mostrarán cuando registre la solicitud. Ejemplo: São Paulo
arrivalCity A través de la configuración en la aplicación, es posible agregar los campos "Ciudad de origen" y "Ciudad de destino" a la solicitud de anticipo. Una vez que estos campos se completan en la apertura del OS, las ciudades se mostrarán cuando registre la solicitud. Ejemplo: Salvador
departureCountry A través de la configuración en la aplicación, es posible agregar los campos "País de origen" y "País de destino" a la solicitud anticipada. Una vez que estos campos se completan en la apertura del OS, los países se mostrarán cuando registre la solicitud. Ejemplo: Brasil
arrivalCountry A través de la configuración en la aplicación, es posible agregar los campos "País de origen" y "País de destino" a la solicitud anticipada. Una vez que estos campos se completan en la apertura del OS, los países se mostrarán cuando registre la solicitud. Ejemplo: Argentina
quantity Number 5 Cantidad de anticipo(s) solicitado(s). Ejemplo: 1
price Number 14 Valor unitario del anticipo solicitado. Ejemplo: 100.0000
amount Number 14 Importe total de los anticipos solicitados. Ejemplo: 100.000000
observation String 255 Observación ingresada por el usuario al momento de solicitar el anticipo. Ejemplo: visita externa del cliente
inclusionDate String (DataTime) 24 Fecha / hora de la solicitud de anticipo. Ejemplo: 2019-10-02T19:47:10.450Z
paymentDate String (DataTime) 23 Fecha / hora del pago del anticipo. Ejemplo: 2019-10-02T19:47:10.450Z
ledgerAccount String 36 Descripción de la cuenta para la solicitud. Ejemplo: pagos API
ledgerAccountId Guid 36 ID de cuenta de la cuenta de solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
codeLedgerAccount String 36 Código de cuenta de la cuenta de solicitud. Ejemplo: 235ARGO12
advancePaymentId Number 10 Identificación de anticipo en la solicitud. Ejemplo 1

ExpenseBlockedRequests

Este servicio le permite enlistar todas las solicitudes de rendición de cuentas. Antes de enlistarlas, verifica si la solicitud debe ser bloqueada dependiendo del valor determinado por la agencia para el cliente en la política BLOPRE. Si se excede el valor determinado, la solicitud es bloqueada y enlistada; de lo contrario, la solicitud es enlistada informando la fecha prevista para el bloqueo.
Argo Wiki

GET /expense/blockedrequests

Requisição

requisição GET

Resposta

[
    {
    "RequestNumber": 0,
    "RequestId": "00000000-0000-0000-0000-000000000000",
    "ManualBlock": "string",
    "Name": "string",
    "Blocked": true,
    "Message": "string",
    "FinalDate": "2021-03-17T15:11:31.732Z",
    "FinalDateAdvance": "string",
    "BlockForecastDate": "string",
    "BlockedBy": "string",
    "BlockedDate": "string",
    "UnblockedDate": "string"
    }
]
Propiedad Tipo Tamaño Descripción
RequestNumber Number (int) 100 Número de solicitud devuelto. Ejemplo: 50
RequestId Guid 36 ID de identificación de la solicitud devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
ManualBlock String 3 Indica si la solicitud fue bloqueada manualmente
Name String 50 Nombre del gasto relacionado a la solicitud de anticipo. Ejemplo: Alimentación
Blocked String (boolean) 4 Informa si la solicitud está bloqueada. Ejemplo: True/False
Message String (boolean) 4 Mensaje de información sobre bloqueo/desbloqueo. Ejemplo: True/False
FinalDate String (Date-Time) 24 Fecha final de la solicitud. Ejemplo: 2019-08-22
FinalDateAdvance String (Date-Time) 24 Fecha final de la solicitud formateada. Ejemplo: 08/22/2019
BlockForecastDate String (Date-Time) 24 Fecha prevista para el bloqueo de la solicitud. Ejemplo: 08/22/2019
BlockedBy String 50 Usuario responsable de bloquear la solicitud
BlockedDate Guid 36 Fecha en que la solicitud fue bloqueada. Ejemplo: 2019-08-22
UnblockedDate String (Date-Time) 24 Fecha en que la solicitud fue desbloqueada. Ejemplo: 2019-08-22

ExpensePayments

Este servicio le permite pagar un anticipo o rendición de cuentas/reembolso

POST

Este método se descontinuará en el futuro, hay una nueva implementación en el método POST /expense/payments/v2

Solicitud

[
	{
		"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"
	}
]
Propiedad Tipo Tamaño Requerido Descripción
typePayment String (Enum) 15 Si Determina lo que se paga en la solicitud: all = Todos, advancedPayment = Anticipo, refund = Rendición de cuentas/ reembolso, devolución. Ejemplo: advancedPayment
amount Number 14 Si Importe total pagado del anticipo. Ejemplo: 100.000000
coin String 3 Si Moneda utilizada para pagar el anticipo. Ejemplo: BRL
typePaymentId Guid 36 Si ID del "Método de pago" utilizado para pagar el anticipo. Ejemplo: 00000000-0000-0000-0000-000000000000
requestId Guid 36 Si ID de la solicitud que desea pagar. Ejemplo: 00000000-0000-0000-0000-000000000000
paymentDate String (DataTime) 24 Si Fecha de pago del anticipo. Ejemplo: 2019-10-02T19:47:10.450Z
observation String 255 No Observación insertada al pagar el anticipo. Ejemplo: el depósito se realizará en 02 días

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

POST /expense/payments/v2

Solicitud

[
	{
        "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"
	}
]
Propiedad Tipo Tamaño Requerido Descripción
advancePaymentId Number (int) 10 Si ID de anticipo en la solicitud. Propiedad obligatoria si el tipo de pago es 'advancePayment'. Ejemplo: 1
refundId Number (int) 10 Si ID de reembolso/devolución en la solicitud. Propiedad obligatoria si el tipo de pago es 'refund'. Ejemplo: 1
typePayment String (Enum) 15 Si Determina lo que se paga en la solicitud: all = Todos, advancedPayment = Anticipo, refund = Rendición de cuentas/ reembolso, devolución. Ejemplo: advancedPayment
amount Number 14 Si Importe total pagado del anticipo. Ejemplo: 100.000000
coin String 3 Si Moneda utilizada para pagar el anticipo. Ejemplo: BRL
typePaymentId Guid 36 Si ID del "Método de pago" utilizado para pagar el anticipo. Ejemplo: 00000000-0000-0000-0000-000000000000
requestId Guid 36 Si ID de la solicitud que desea pagar. Ejemplo: 00000000-0000-0000-0000-000000000000
paymentDate String (DataTime) 24 Si Fecha de pago del anticipo. Ejemplo: 2019-10-02T19:47:10.450Z
observation String 255 No Observación insertada al pagar el anticipo. Ejemplo: el depósito se realizará en 02 días

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

GET

Recupera la forma de pago, información ingresada en el pago del anticipo / rendición de cuentas

Solicitud

Solicitud GET

Respuesta

[
	{
		"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"
	}
]
Propiedad Tipo Tamaño Descripción
requestPaymentId Guid 36 ID de pago utilizada en el OS, ejemplo: 00000000-0000-0000-0000-000000000000
typePayment String (Enum) 15 Tipo de gasto que se pagó: all, advancedPayment, refund, dropOff. Ejemplo: advancedPayment
requireId Guid 36 ID de solicitud consultada. Ejemplo: 54b8dbf0-ebe6-e911-943d-90b11c25f05b
amount Number 14 Importe total pagado. Ejemplo: 100.0000
coin String 3 Moneda utilizada para el pago. Ejemplo: BRL
paymentDescription String 50 Descripción de la forma de pago utilizado en la solicitud. Ejemplo: Depósito bancario
paymentDate String (Date-Time) 24 Fecha en que se programó el pago. Ejemplo: 2018-11-02
inclusionDate String (Date-Time) 24 Fecha / hora de inclusión de la programación del pago. Ejemplo: 2018-11-02T21:36:00
observation String 255 Observación insertada en el momento del pago. Ejemplo: pago exitoso

ExpenseCards

Este servicio permite la inserción de una lista de tarjetas de gastos para los usuarios, así como la inserción de una lista de facturas de gastos para las tarjetas de gastos.

POST /expense/invoicecards

El límite por solicitud es un máximo de 100 gastos.

Solicitud

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Requerido Descripción
cardNumber String 50 Si Número de tarjeta en la que se realizó el gasto. Ejemplo: 5261400319746371
owner String 155 No Nombre del titular de la tarjeta. Ejemplo: Virgilio Dante
description String 100 Si Descripción del gasto en la factura. Ejemplo: BOA COMPRA STORE
authorizationCode String 20 Si Código de Seguridad de la Tarjeta. Ejemplo: 897
currency String 3 Si Moneda utilizada para gastos. Ejemplo: MXN
value Number (Decimal) 10 Si Monto del gasto. Ejemplo: 150.00
transactionDate DateTime 24 Si Fecha de la transacción de gastos. Ejemplo: 2020-02-10T15:40:01.022Z
billingDate DateTime 24 No Fecha de cierre de la factura de gastos. Ejemplo: 2020-02-10T15:40:01.022Z
companyId Guid 36 No ID de la compañía. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

respuesta POST /expense/invoicecards
Propiedad Tipo Tamaño Descripción
transactionId Guid 36 ID de transacción generado en la base de datos. Ejemplo: 00000000-0000-0000-0000-000000000000

POST /expense/usercards

El límite por solicitud es un máximo de 100 tarjetas.

Solicitud

[
  {
    "userId": "00000000-0000-0000-0000-000000000000",
    "cardNumber": "string",
    "flag": "string",
    "refundable": "yes"
  }
]
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si ID de usuario al que pertenece la tarjeta. Ejemplo: 00000000-0000-0000-0000-000000000000
cardNumber String 50 Si Número de tarjeta de usuario. Ejemplo: 5261400319746371
flag String 50 Si Banner de tarjeta. Ejemplo: VI
refundable String (Enum) 3 Si Si los gastos incurridos en esta tarjeta son reembolsables. Ejemplo: Yes/No

Respuesta

respuesta POST /expense/usercards
Propiedad Tipo Tamaño Descripción
Mensaje String 155 User cards successfully inserted

ExpenseRefunds

Este servicio le permite listar las solicitudes que contienen al menos una rendición de cuentas / reembolso.

GET /expense/{requestId}/refunds

Solicitud GET

Respuesta

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Descripción
expenseCard Object (ExpenseCardVM) 1 Objeto responsable de transferir información incluída en la factura de la tarjeta corporativa
closingExpenseCard Object (ExpenseCardVM) 1 Objeto responsable de transferir información de tarjetas confirmadas como “cierre de tarjeta” en gastos
companyName String 50 Nombre de la empresa seleccionada en la rendición de cuentas. Ejemplo: Argo
typePaymentName String 50 Descripción del "pago preferencial" solicitado por el usuario con respecto al pago de la rendición de cuentas. Ejemplo: depósito bancario
integrationCodeCompany String 50 Código de integración de la empresa seleccionada en la solicitud de rendición de cuentas. Ejemplo: 18982
expenseCategory String 100 Descripción de la categoría de gasto. Ejemplo: comida
expenseTypePayment String (Enum) 16 Tipo de pago de gastos. Ejemplo: 'advancedPayment', 'dropOff', 'refund'
exchange Number 14 Tipo de cambio utilizado en la solicitud en caso de rendición de cuentas en monedas distintas a la utilizada en el cliente. Ejemplo: 4.891,00
expenseName String 50 Nombre del gasto ingresado en la rendición de cuentas. Ejemplo: Taxi
amount Number 14 Importe total de los gastos solicitados. Ejemplo: 100.000000
amountPrice Number 100 Importe total del gasto (sin IVA). Ejemplo: 200
descriptiveExpense String 255 Descripción del gasto. Ejemplo: ‘Almuerzo con proveedor’
coin String 3 Moneda solicitada en la rendición de cuentas. Ejemplo: BRL
active String (Enum) 3 Informa si el gasto registrado está activo o inactivo. Ejemplo: Yes/No
bacenCode String 50 Código de país del banco central. Ejemplo: 1058
proven String (Enum) 3 Permite identificar si el gasto se registró como comprobado. Ejemplo: Yes/No
refunded String (Enum) 3 Permite identificar si el gasto se registró como "reembolsable". Ejemplo: Yes/No
approved String (Enum) 3 Permite identificar si se aprobó el gasto. Ejemplo: Yes/No
vouchers String 100 Lista los enlaces para descargar las imágenes / recibos relacionados con los gastos. Ejemplo: argo.imagem.html
changeDate String (DataTime) 24 Fecha del último cambio de gasto. Ejemplo: 2019-10-02T19:47:10.450Z
inclusionDate String (DataTime) 24 Fecha de inclusión de la rendición de cuentas. Ejemplo: 2019-10-02T19:47:10.450Z
paymentDate String (DataTime) 24 Fecha de pago de la rendición de cuentas / reembolso. Ejemplo: 2019-10-02T19:47:10.450Z
initialExpenseDate String (DataTime) 24 Es posible incluir en la solicitud de anticipo y/o rendición de cuentas el período del viaje, siendo las propiedades "initialExpenseDate" y "finalExpenseDate" las fechas relacionadas con el período. Ejemplo: 2019-10-02T19:47:10.450Z
finalExpenseDate String (DataTime) 24 Es posible incluir en la solicitud de anticipo y/o rendición de cuentas el período del viaje, siendo las propiedades "initialExpenseDate" y "finalExpenseDate" las fechas relacionadas con el período. Ejemplo: 2019-10-02T19:47:10.450Z
ledgerAccount String 100 Descripción de la cuenta para la solicitud. Ejemplo: pagos API
ledgerAccountId Guid 36 ID de cuenta de la cuenta de solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
codeLedgerAccount String 100 Código de cuenta de la cuenta de solicitud. Ejemplo: 235ARGO12
refundId Number 10 Identificación de reembolso en la solicitud. Ejemplo 1
valueIVA Number 10 Propiedad referente al valor del IVA insertado en la devolución. Ejemplo: 100
percentualIVA Number 3 Propiedad referente al Porcentaje de IVA ingresado en la devolución. Ejemplo: 15
totalValue Number 10 Importe total de la devolución con aplicación del valor / porcentaje de IVA. Ejemplo: 85
observation String 255 Comentario agregado al editar el gasto de la tarjeta en la rendición de cuentas. Ejemplo: 'comida de negocios con el proveedor'
uuid Guid 36 Identificador único de la factura de tipo CFDI. (Información disponible sólo para clientes con una firma BTC). Ejemplo: 00000000-0000-0000-0000-000000000000
expenseCard Expense permite al usuario rendir cuentas de la información en el estado de cuenta de la tarjeta corporativa
Propiedad Tipo Tamaño Descripción
cardNumber Int 16 Número de tarjeta vinculado a gastos. Ejemplo: 4569-7654-9876-1678
autorizationCode Int 4 Código de autorización de tarjeta vinculado a gastos. Ejemplo: 9573
invoiceDate String (Date-Time) 10 Fecha de cierre del estado de cuenta de la tarjeta vinculada al gasto. Ejemplo: 10-10-2020
closingExpenseCard Expense permite en el momento de la rendición de cuentas contabilizar el gasto como "cierre de tarjeta"
Propiedad Tipo Tamaño Descripción
cardNumber Int 16 Número de tarjeta vinculado a gastos. Ejemplo: 4569-7654-9876-1678
autorizationCode Int 4 Código de autorización de tarjeta vinculado a gastos. Ejemplo: 9573
invoiceDate String (Date-Time) 10 Fecha de cierre del estado de cuenta de la tarjeta vinculada al gasto. Ejemplo: 10-10-2020

ExpenseTypesPayments

Este servicio le permite listar las formas de pago registradas para anticipo / reembolso / devolución.
Argo Wiki

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"typePaymentId": "bfd2223d-3ff6-4021-8116-46ce6bd824ce",
		"name": "Cash01",
		"typePayment": "advancedPayment";
		"userUpdateDescription": "MURILLO SIQUEIRA"
	}
]
Propiedad Tipo Tamaño Descripción
typePaymentId Guid 36 ID de la forma de pago registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
name String 50 Descripción de la forma de pago
typePayment String (Enum) 15 Tipo(s) de gasto(s) cubiertos por la forma de pago: all, advancedPayment, refund, dropOff. Ejemplo: advancedPayment
companyId Guid 36 ID de empresa a la que está vinculada la forma de pago. Ejemplo: Argo
companyName String 50 Descripción de la empresa con la que está relacionada la forma de pago. Ejemplo: Argo
userUpdateDescription String 50 Nombre del último usuario que realizó el cambio en el método de pago registrado. Ejemplo: João Silva

PriceSummary

Ese servicio permite listar los valores Mayor, Menor, Medio y escojido de los productos de los tramos de una determinada solicitud
Los valores son presentados en la misma moneda de la solicitud y tiene un indicador 'currency' espcificando cúal es el tipo retornado. Obs: Los valores retornados son referentes a la tarifa del producto (ticket, tarifa diaria, pasaje y valor del servicio) sin el valor de las tasas.

GET

Request

Request GET

Response

[
    {
        "selected": 350.00,
        "higher": 600.00,
        "lower": 200.00,
        "average": 400.00,
        "product": "air",
        "currency": "BRL"
      }
]
Propiedad Tipo Tamaño Descripción
selected Number 50 Valor del producto seleccionado en el tramo de la solicitud
higher Number 50 Mayor valor de los productos cotizados para el tramo de la solicitud
lower Number 50 Menor valor de los productos cotizados para el tramo de la solicitud
average Number 50 Media entre los valores Mayor y menor valor de los productos cotizados para el tramo de la solicitud/td>
product String 10 Descripción del producto del trecho. Ejemplo: 'air', 'hotels', 'rental', 'service' e 'road'
currency String 3 Tipo da moneda del producto de la solicitud. Ejemplo: BRL, COP, USD

ConfigsCostCenters

Cada nuevo cliente/corporativo registrado en el sistema Argo (Travel y Expense) debe tener al menos un centro de costos registrado, de lo contrario, no se permitirá crear solicitudes. Es posible que diferentes configuraciones estén vinculadas a un centro de costos, como políticas de viaje, control de presupuesto, etc. Debido a la importancia de estos datos, Argo hace posible a través de la API administrar la lista de Centros de Costos del cliente.
Argo Wiki

GET

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
filters.active String (Enum) 3 No Filtro: estatus de registro del centro de costos (activo / inactivo). Ejemplo: Yes/No
filters.code String 30 No Filtro: código de integración del centro de costos. Ejemplo: 001
filters.acronym String 10 No Filtro: sigla del centro de costos. Ejemplo: 7829
filters.parentCostCenterId Guid 36 No Filtro: el sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad le permite filtrar el Centro de costos utilizando la "ID" del "padre". Ejemplo: 00000000-0000-0000-0000-000000000000
filters.companyId Guid 36 No Filtro: el sistema Argo le permite vincular un Centro de costos a una empresa específica. Esta propiedad le permite filtrar el Centro de costos utilizando la "ID" de la empresa vinculada. Ejemplo: 00000000-0000-0000-0000-000000000000
Page Int 100 No Propiedad utilizada para localizar centros de costos. Ejemplo: 1

Respuesta

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Descripción
costCenterId Guid 36 ID de registro del centro de costos. Ejemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 ID de la empresa vinculada al Centro de costos devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Estatus del centro de costos (activo / inactivo). Ejemplo: Yes/No
flagProject String (Enum) 3 Indica si el Centro de costos debe estar vinculado a un proyecto. Ejemplo: Yes/No
parentCostCenterId Guid 36 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad permite identificar el "padre" del centro de costos devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (DataTime 24 Fecha en que se registró el Centro de costos. Ejemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
parentCostCenterDescription String 50 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad le permite identificar la descripción del Centro de costos devuelto. Ejemplo: compras
parentCostCenterCode String 30 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad le permite identificar el código del Centro de costos devuelto. Ejemplo: 92898
parentCostCenterAcronym String 10 Sigla del centro de costos. Ejemplo: 7829
companyName String 50 El sistema Argo le permite vincular un centro de costos a una empresa específica. Esta propiedad permite identificar la empresa vinculada al Centro de costos devuelto. Ejemplo: Argo
code String 30 Código de centro de costo. Ejemplo: 001
acronym String 10 Acrónimo de centro de coste. Ejemplo: 7829
description String 50 Descripción del centro de costos registrado. Ejemplo: Centro de entrenamiento

GET /costcenters/{costCenterId}

Solicitud

Solicitud GET /costcenters/{costCenterId}

Respuesta

{
    "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"
  }
Propiedad Tipo Tamaño Descripción
costCenterId Guid 36 ID de registro del centro de costos. Ejemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 ID de la empresa vinculada al Centro de costos devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Estatus del centro de costos (activo / inactivo). Ejemplo: Yes/No
flagProject String (Enum) 3 Indica si el Centro de costos debe estar vinculado a un proyecto. Ejemplo: Yes/No
parentCostCenterId Guid 36 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad permite identificar el "padre" del centro de costos devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (DataTime 24 Fecha en que se registró el Centro de costos. Ejemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
parentCostCenterDescription String 50 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad le permite identificar la descripción del Centro de costos devuelto. Ejemplo: compras
parentCostCenterCode String 30 El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad le permite identificar el código del Centro de costos devuelto. Ejemplo: 92898
parentCostCenterAcronym String 10 Sigla del centro de costos. Ejemplo: 7829
companyName String 50 El sistema Argo le permite vincular un centro de costos a una empresa específica. Esta propiedad permite identificar la empresa vinculada al Centro de costos devuelto. Ejemplo: Argo
code String 30 Código de centro de costo. Ejemplo: 001
acronym String 10 Acrónimo de centro de coste. Ejemplo: 7829
description String 50 Descripción del centro de costos registrado. Ejemplo: Centro de entrenamiento

POST

Solicitud

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Requerido Descripción
companyId Guid 36 No ID de la empresa vinculada al Centro de costos. Ejemplo: 00000000-0000-0000-0000-000000000000
flagProject String (Enum) 3 No Indica si el Centro de costos debe estar vinculado a un proyecto. Ejemplo: Yes/No
parentCostCenterId Guid 36 No El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad permite informar al "Padre" del Centro de Costos. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 No Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 No Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
code String 30 Si Código de centro de costos. Ejemplo: 001
acronym String 10 No Sigla del centro de costos. Ejemplo: 7829
description String 50 Si Descripción del centro de costos. Ejemplo: Centro de entrenamiento

Respuesta

[
	{
		"id": "343c6d7d-4496-49b8-9ec0-90846e684091",
		"index": "0",
		"success": "yes"
	}
]
Propiedad Tipo Tamaño Descripción
costCenterId Guid 36 ID del centro de costos registrado. Ejemplo: 00000000-0000-0000-0000-000000000000

PATCH

Solicitud

[
	{
		"costCenterId": "82c56fe0-2816-4871-8368-583020383dbf",
		"active": "yes",
		"flagProject": "yes",
		"code": "002",
		"acronym": "002",
		"description": "CCUsto Argo 002"
	}
]
Propiedad Tipo Tamaño Requerido Descripción
costCenterId Guid 36 ID del centro de costos. Ejemplo: 00000000-0000-0000-0000-000000000000
Active String (Enum) 3 Si Estatus del centro de costos (activo / inactivo). Ejemplo: Yes/No
companyId Guid 36 No ID de la empresa vinculada al Centro de costos. Ejemplo: 00000000-0000-0000-0000-000000000000
flagProject String (Enum) 3 No Indica si el Centro de costos debe estar vinculado a un proyecto Ejemplo: Yes/No
parentCostCenterId Guid 36 No El sistema Argo le permite crear la relación Centro de costos (padre - hijo). Esta propiedad permite informar al "Padre" del Centro de Costos. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDebitDate String (DataTime) 24 No Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
finalDebitDate String (DataTime 24 No Es posible determinar un período para el cual puede haber una asignación del débito en el Centro de costos. Podrán ser creadas solicitudes que estén dentro del período definido a través de las propiedades initialDebitDate y inclusionDate. Ejemplo: 2019-09-18T16:48:22.490Z
code String 30 Si Código del centro de costos. Ejemplo: 001
acronym String 10 No Sigla del centro de costos. Ejemplo: 7829
description String 50 Si Descripción del centro de costos. Ejemplo: Centro de entrenamiento

Respuesta

[
	{
		"id": "82c56fe0-2816-4871-8368-583020383dbf",
		"index": "0",
		"success": "yes"
	}
]
Propiedad Tipo Tamaño Descripción
costCenterId Guid 36 ID del centro de costos registrado. Ejemplo: 00000000-0000-0000-0000-000000000000

ConfigsCreditCards

El sistema Argo permite al cliente, generalmente agencias de viaje, realizar el registro de tarjetas de créditos de sus clientes. Los items Obligatorios son "flags", "actives" y "login". "Flags" quiere decir el tipo de tarjeta (AMEX, VISA, MASTERCARD, etc.), "Actives" si esta tarjeta está activa o inactiva en el sistema argo y "Login" es el nombre de usuario que ocupa para ingresar al sistema.

GET

Request

Request GET
Propiedad Tipo Tamaño Obligatorio Descripción
filters.initialDate DateTime 24 No Fecha en que la tarjeta fue creada en la base de datos. Ejemplo: 2020-02-10T15:40:01.022Z
filters.finalDate DateTime 24 No Fecha en que la tarjeta fue inactivada en la base de datos. Ejemplo: 2020-02-10T15:40:01.022Z
filters.flag String (Enum) 15 No Tipo de tarjeta. Ejemplo: 'visa', 'mastercard', 'dinersClub', 'americanExpress', 'hipercard', 'UATP', 'ELO'
filters.actives String 3 No Si la tarjeta registrada en la base de datos está activa o No. Ejemplo: Si, No
filters.login String 256 No Login del usuario con el que la tarjeta está relacionada. Ejemplo: argo.solutions

Response

[
    {
        "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"
      },
]
Propiedad Tipo Tamaño Descripción
cardId String(Guid) 36 ID de la tarjeta registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Fecha/hora de inclusión/creación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Fecha/hora de la última modificación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
flag String 15 Tipo de tarjeta. Ejemplo: Mastercard, Visa
typePayment String 100 Forma de pago registrada en la tarjeta. Ejemplo: Creditcard
cardNumber String 50 Número do tarjeta registrada. Ejemplo: 4569-7654-9876-1678
active String(Enum) 3 Indica si la tarjeta está activa o inactiva. Ejemplo: Yes/No

POST

Request

{
  "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"
}
Propiedad Tipo Tamaño Obligatorio Descripción
typePayment String 100 Si Forma de pago registrada en la tarjeta. Ejemplo: Crditcard
community String 50 No Comunidad a la que la estructura de aprobación está relacionada. Ejemplo: Equipo técnico
userEmail String 512 No E-mail del usuario al que la tarjeta está relacionada. Ejemplo: useargo@argo.com
userLogin String 256 No Login del usuario al que la tarjeta está relacionada. Ejemplo: argo.solutions
requester String 3 No Indica si el usuario “solicitante” podrá ver esta tarjeta al momento de solicitar viaje para otros usuarios. Ejemplo: Yes/No
flag String (Enum) 15 No Tipo de tarjeta. Ejemplo: 'visa', 'mastercard', 'dinersClub', 'americanExpress', 'hipercard', 'UATP', 'ELO'
cardNumber String 50 Si Número de tarjeta registrada. Ejemplo: 4569-7654-9876-1678
securityCode String 4 No Código de seguridad de la tarjeta registrada. Ejemplo: 658
expirationDate DateTime 24 Si Fecha de expiración de la tarjeta registrada. Ejemplo: 2019-09-18
holder String 50 Si Nombre de la persona a la que está impresa la tarjeta. Ejemplo: Lorenzo M. Magallanes
holderCpf String 12 No Cpf del titular de la tarjeta (exlusivo Brasil). Ejemplo: 123.321.231-23
holderPassport String 15 No Numero de pasaporte del titular de la tarjeta (exlusivo Brasil). Ejemplo: BR123456
address String 50 No Dirección del titular de la tarjeta registrada. Ejemplo: calle Figueroa Barros 145
neighborHood String 30 No Colonia del titular de la tarjeta registrada. Ejemplo: Villa de las naranjas
city String 30 No Ciudad del titular de la tarjeta registrada. Ejemplo: Sao Paulo
acronymState String 2 No Acrónimo/Sigla del estado del titular de la tarjeta registrada. Ejemplo: SP
countryCode String 3 No Código del pais del titular de la tarjeta registrada. Ejemplo: 55
CP String 11 No Código Postal del titular de la tarjeta registrada. Ejemplo: 89456
active String (Enum) 3 Si Indica si la tarjeta está activa o inactiva. Ejemplo: Yes/No
virtual String (Enum) 3 Si Indica si es tarjeta virtual o No. Ejemplo: Yes/No

Response

Response POST
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error en la creación de una tarjeta. Ejemplo: True/False

GET /creditcards/{cardId}

Request

Request GET by ID
Propiedad Tipo Tamaño Obligatorio Descripción
cardId Guid 36 Si ID de la tarjeta que el Usuario desea consultar los detalles. Ejemplo: 00000000-0000-0000-0000-000000000000

Response

{
        "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"
    }
Propiedad Tipo Tamaño Descripción
cardId String(Guid) 36 ID de la tarjeta registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Fecha/hora de inclusión/creación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Fecha/hora de la última modificación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 ID del usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
user String 256 Usuario de la tarjeta registrada. Ejemplo: Pedro
flag String 15 Tipo de tarjeta. Ejemplo: Mastercard, Visa
typePayment String 100 Forma de pago registrada en la tarjeta. Ejemplo: Creditcard
community String 50 Comunidad a la que la estructura de aprobación está relacionada. Ejemplo: Equipo técnico
userEmail String 512 E-mail del Usuario al que la tarjeta está relacionada. Ejemplo: useargo@argo.com
userLogin String 256 Login del Usuario al que la tarjeta está relacionada. Ejemplo: argo.solutions
requester String 3 Indica si el usuario “solicitante” podrá ver esta tarjeta al momento de solicitar viaje para otros usuarios. Ejemplo: Yes/No
cardNumber String 50 Número de la tarjeta registrada. Ejemplo: 4569-7654-9876-1678
securityCode String 4 Código de seguridad de la tarjeta registrada. Ejemplo: 658
expirationDate DateTime 24 Fecha de expiración de la tarjeta registrada. Ejemplo: 2019-09-18
holder String 50 Nombre de la persona a la que está impresa la tarjeta. Ejemplo: Lorenzo M. Magallanes
holderCpf String 12 Cpf del titular de la tarjeta (exlusivo Brasil). Ejemplo: 123.321.231-23
holderPassport String 15 Numero de pasaporte del titular de la tarjeta (exlusivo Brasil). Ejemplo: BR123456
address String 50 Dirección del titular de la tarjeta registrada. Ejemplo: calle Figueroa Barros 145
neighborHood String 30 Colonia del titular de la tarjeta registrada. Ejemplo: Villa de las naranjas
city String 30 Ciudad del titular de la tarjeta registrada. Ejemplo: Sao Paulo
acronymState String 2 Acrónimo/Sigla del estado del titular de la tarjeta registrada. Ejemplo: SP
countryCode String 3 Código del pais del titular de la tarjeta registrada. Ejemplo: 55
cep String 11 Código postal del titular de la tarjeta registrada. Ejemplo: 89456
active String(Enum) 3 Indica si la tarjeta está activa ou inactiva. Ejemplo: Yes/No
virtual String(Enum) 3 Indica si es tarjeta virtual o No. Ejemplo: Yes/No

PUT /creditcards/{cardId}

Request

Request PUT
Propiedad Tipo Tamaño Obligatorio Descripción
cardId Guid 36 Si ID de la tarjeta que el Usuario desea modificar. Ejemplo: 00000000-0000-0000-0000-000000000000
Propiedad Tipo Tamaño Obligatorio Descripción
typePayment String 100 Si Forma de pago registrada en la tarjeta. Ejemplo: Creditcard
community String 50 No Comunidad a la que la estructura de aprobación está relacionada. Ejemplo: Equipo Técnico
userEmail String 512 No E-mail del Usuario al que la tarjeta está relacionada. Ejemplo: useargo@argo.com
userLogin String 256 No Login del Usuario al que la tarjeta está relacionada. Ejemplo: argo.solutions
requester String 3 No Indica si el usuario “solicitante” podrá ver esta tarjeta al momento de solicitar viaje para otros usuarios. Ejemplo: Yes/No
flag String 15 No Tipo de tarjeta. Ejemplo: Mastercard, Visa
cardNumber String 50 Si Número de la tarjeta registrada. Ejemplo: 4569-7654-9876-1678
securityCode String 4 No Código de seguridad de la tarjeta registrada. Ejemplo: 658
expirationDate DateTime 24 Si Fecha de expiración de la tarjeta registrada. Ejemplo: 2019-09-18
holder String 50 Si Nombre de la persona a la que está impresa la tarjeta. Ejemplo: Lorenzo M. Magallanes
holderCpf String 12 No Cpf del titular de la tarjeta (exlusivo Brasil). Ejemplo: 123.321.231-23
holderPassport String 15 No Numero de pasaporte del titular de la tarjeta (exlusivo Brasil). Ejemplo: BR123456
address String 50 No Dirección del titular de la tarjeta registrada. Ejemplo: calle Figueroa Barros 145
neighborHood String 30 No Colonia del titular de la tarjeta registrada. Ejemplo: Villa de las naranjas
city String 30 No Ciudad del titular de la tarjeta registrada. Ejemplo: Sao Paulo
acronymState String 2 No Acrónimo/Sigla del estado del titular de la tarjeta registrada. Ejemplo: SP
countryCode String 3 No Código del pais del titular de la tarjeta registrada. Ejemplo: 55
cep String 11 No Código postal del titular de la tarjeta registrada. Ejemplo: 89456
active String(Enum) 3 Si Indica si la tarjeta está activa o inactiva. Ejemplo: Yes/No
virtual String(Enum) 3 Si Indica si es tarjeta virtual o No. Ejemplo: Yes/No

Response

Response PUT
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error en la atualización de una tarjeta. Ejemplo: True/False

DELETE /creditCards/{cardId}

Request

Request DELETE
Propiedad Tipo Tamaño Obligatorio Descripción
cardId Guid 36 Si ID de la tarjeta que el Usuario desea borrar. Ejemplo: 00000000-0000-0000-0000-000000000000

Response

Response DELETE
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error en el borrado de una tarjeta. Ejemplo: True/False

ConfigsExpenseManagementFields

Este módulo es responsable de gestionar los campos de gestión de gastos.

GET /expensemanagementsfields

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Obligatorio Descripción
filters.list String (Enum) 3 No Filtrar campos de administración con o sin valores (los valores están vinculados a campos de autocompletar). Ejemplo: Yes/No
filters.type String 12 No Filtrar por tipo de campo de gestión. Ejemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time
filters.fieldId String 100 No Filtro referente al identificador del campo gerencial. Ejemplo: sustentacao_29396_Hora_3despesas, sustentacao_29396_autocomplete_1despesa
filters.description String 255 No Filtro referido a la descripción dada al campo de gestión. Ejemplo: vencimiento de la factura
filters.active String 3 No Filtro referente al estado del campo de gestión (Activo / Inactivo). Ejemplo: yes/no
filters.expenseId Guid 36 No Filtro relacionado con el identificador de gasto vinculado al campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.expenseManagementFieldId Guid 36 No Filtro referente al identificador del campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.order Number (Int) 100 No Filtro referido al orden del campo gerencial. Ejemplo: 1, 2, 3
filters.integrationCode String 255 No Filtro referente al código de integración del campo de gestión. Ejemplo: CMP-GER-001
filters.initialChangeDate String (Date Time) 24 No Filtro que hace referencia a la fecha inicial de cambio. Ejemplo: 2019-09-18T16:48:22.490Z
filters.finalChangeDate String (Date Time) 24 No Filtro referido a la fecha final de cambio. Ejemplo: 2019-09-18T16:48:22.490Z
filters.initialFinalizationDate String (Date Time) 24 No Filtro que hace referencia a la fecha de finalización inicial. Ejemplo: 2019-09-18T16:48:22.490Z
filters.finalFinalizationDate String (Date Time) 24 No Filtro referente a la fecha final de finalización. Ejemplo: 2019-09-18T16:48:22.490Z
filters.initialInclusionDate String (Date Time) 24 No Filtro referente a la fecha inicial de inclusión. Ejemplo: 2019-09-18T16:48:22.490Z
filters.finalInclusionDate String (Date Time) 24 No Filtro referente a la fecha de inclusión final. Ejemplo: 2019-09-18T16:48:22.490Z
filters.regularExpression String 255 No Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
filters.required String 3 No Filtro referente al campo de gestión obligatorio. Ejemplo: yes/no
filters.changedUserId Guid 36 No Filtro relacionado con el identificador del usuario que cambió el campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
    {
    "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"
    }
]
Propiedad Tipo Tamaño Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de cliente al que está vinculado el campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
fieldId String 255 Identificador de campo gerencial. Ejemplo: sustentacao_29396_Hora_3despesas
description String 255 Descripción dada al campo gerencial. Ejemplo: vencimiento de la factura
type String 12 Tipo de campo gerencial. Ejemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
regularExpression String 255 Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
active String (Enum) 3 Indica si el campo de gestión está activo o inactivo. Ejemplo: Yes/No
order Number (Int) 100 Orden del campo empresarial. Ejemplo: 1, 2, 3
integrationCode String 255 Código de integración del campo de gestión. Ejemplo: CMP-GER-001
expenseId Guid 36 Identificación de gastos vinculada al campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de registro del campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio en el campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date Time) 24 Fecha / hora de finalización del campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
required String 3 Campo que hace referencia al campo de gestión obligatorio. Ejemplo: yes/no

POST /expensemanagementsfields

Solicitud

{
    "description": "string",
    "fieldId": "string",
    "expensesIds": [
    "00000000-0000-0000-0000-000000000000"
    ],
    "type": "string",
    "order": 0,
    "regularExpression": "string",
    "integrationCode": "string",
    "required": "yes"
}
Propiedad Tipo Tamaño Obligatorio Descripción
description String 255 Descripción dada al campo gerencial. Ejemplo: vencimiento de la factura
fieldId String 255 Identificador de campo gerencial. Ejemplo: sustentacao_29396_Hora_3despesas
expensesIds Array (Guid) 1 Relación de gastos que estarán vinculados al ámbito de la gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 12 Tipo de campo gerencial. Ejemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
order Number (Int) 100 Orden del campo empresarial. Ejemplo: 1, 2, 3
regularExpression String 255 No Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
integrationCode String 255 No Código de integración del campo de gestión. Ejemplo: CMP-GER-001
required String 3 No Campo que hace referencia al campo de gestión obligatorio. Exemplo: yes/no

Respuesta

respuesta POST
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

GET /expensemanagementsfields/{expenseManagementfieldId}

Solicitud

solicitud GET
Propiedad Tipo Tamaño Obligatorio Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
    {
    "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"
    }
]
Propiedad Tipo Tamaño Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de cliente al que está vinculado el campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
fieldId String 255 Identificador de campo gerencial. Ejemplo: sustentacao_29396_Hora_3despesas
description String 255 Descripción dada al campo gerencial. Ejemplo: Vencimento da Fatura
type String 12 Tipo de campo gerencial. Ejemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
regularExpression String 255 Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
active String (Enum) 3 Indica si el campo de gestión está activo o inactivo. Ejemplo: Yes/No
order Number (Int) 100 Orden del campo empresarial. Ejemplo: 1, 2, 3
integrationCode String 255 Código de integración del campo de gestión. Ejemplo: CMP-GER-001
expenseId Guid 36 Identificación de gastos vinculada al campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de registro del campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio en el campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date Time) 24 Fecha / hora de finalización del campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
required String 3 Campo que hace referencia al campo de gestión obligatorio. Ejemplo: yes/no

PUT /expensemanagementsfields/{expenseManagementfieldId}

Solicitud

{
    "description": "string",
    "fieldId": "string",
    "expensesIds": [
    "00000000-0000-0000-0000-000000000000"
    ],
    "type": "string",
    "order": 0,
    "regularExpression": "string",
    "integrationCode": "string",
    "required": "yes"
}
Propiedad Tipo Tamaño Obligatorio Descripción
description String 255 Descripción dada al campo gerencial. Ejemplo: vencimiento de la factura
fieldId String 255 Identificador de campo gerencial. Ejemplo: sustentacao_29396_Hora_3despesas
expensesIds Array (Guid) 1 Relación de gastos que estarán vinculados al ámbito de la gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 12 Tipo de campo gerencial. Ejemplo: AutoComplete, Bit, DateTime, Decimal, Int, String, Time, RadioButton
order Number (Int) 100 Orden del campo empresarial. Ejemplo: 1, 2, 3
regularExpression String 255 No Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
integrationCode String 255 No Código de integración del campo de gestión. Ejemplo: CMP-GER-001
required String 3 No Campo que hace referencia al campo de gestión obligatorio. Ejemplo: yes/no

Respuesta

respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en el cambio de campo de la gestión. Ejemplo: True/False

GET /expensemanagementsfields/{expenseManagementfieldId}/values

Los valores están vinculados solo en los campos de gestión de tipo "AutoComplete"

Solicitud

solicitud GET
Propiedad Tipo Tamaño Obligatorio Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
    {
    "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "value": "string",
    "order": 0,
    "code": "string"
    }
]
Propiedad Tipo Tamaño Descripción
expenseManagementFieldValueId Guid 36 ID de valor vinculado al campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
value String 50 Descripción del valor vinculado al campo de gestión. Ejemplo: 1, 2, 3
order Number (Int) 100 Orden del campo empresarial. Ejemplo: 1, 2, 3
code String 50 Código de valor vinculado al campo de gestión. Ejemplo: Cod-01, 2

POST /expensemanagementsfields/{expenseManagementfieldId}/values

Solicitud

    {
    "value": "string",
    "order": 0,
    "code": "string"
    }
Propiedad Tipo Tamaño Obligatorio Descripción
value String 50 Descripción del valor vinculado al campo de gestión. Ejemplo: 1, 2, 3
order Number (Int) 100 No Orden del campo empresarial. Ejemplo: 1, 2, 3
code String 50 No Código de valor vinculado al campo de gestión. Ejemplo: Cod-01, 2

Respuesta

respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en el cambio de campo de la gestión. Ejemplo: True/False

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

Solicitud

solicitud DELETE
Propiedad Tipo Tamaño Obligatorio Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldValueId Guid 36 ID de valor vinculado al campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o no al eliminar una tarjeta. Ejemplo: True/False

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

Los valores están vinculados solo en los campos de gestión de tipo "AutoComplete"

Solicitud

solicitud GET
Propiedad Tipo Tamaño Obligatorio Descripción
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldValueId Guid 36 ID de valor vinculado al campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

{
    "expenseManagementFieldValueId": "00000000-0000-0000-0000-000000000000",
    "expenseManagementFieldId": "00000000-0000-0000-0000-000000000000",
    "value": "string",
    "order": 0,
    "code": "string"
}
Propiedad Tipo Tamaño Descripción
expenseManagementFieldValueId Guid 36 ID de valor vinculado al campo de gestión. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseManagementFieldId Guid 36 ID de campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
value String 50 Descripción del valor vinculado al campo de gestión. Ejemplo: 1, 2, 3
order Number (Int) 100 Orden del campo empresarial. Ejemplo:: 1, 2, 3
code String 50 Código de valor vinculado al campo de gestión. Ejemplo: Cod-01, 2

ConfigsExpenses

El módulo de Expense es una solución que permite a las corporaciones controlar sus gastos. A través del módulo, los usuarios pueden informar su rendición de cuentas y los involucrados supervisan todo el flujo (aprobadores, financieros, etc.). Usando los métodos a continuación, es posible mantener la gestión de gastos de acuerdo a las necesidades.
Argo Wiki

GET /expenses

Solicitud

Solicitud GET

Respuesta

[
    {
        "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"
    }
]
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID del gasto registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha / hora del registro del gasto. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date-Time) 24 Fecha / hora del último cambio en el registro del gasto. Ejemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID de la empresa a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 ID de la cuenta contable a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica si el gasto registrado está activo o inactivo. Ejemplo: Yes/No
name String 50 Descripción del gasto. Ejemplo: Alimentación
type String (Enum) 15 Tipo de gasto registrado: advancedPayment = anticipo; refund = reembolso; invoiceClosing = cierre de tarjeta. Exemplo: refund
day Int 3 Cantidad máxima de gasto permitido por día. Ejemplo: 2
air Int 3 Cantidad máxima de gasto permitido, de acuerdo con la cantidad de tramos de servicio aéreo en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) por vía aérea, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) por vía aérea, el usuario puede solicitar hasta (6) gastos.
hotel Int 3 Cantidad máxima de gasto permitida, de acuerdo a la cantidad de alojamiento en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) alojamiento, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) alojamiento, el usuario puede solicitar hasta (6) gastos
rental Int 3 Cantidad máxima de gasto permitida, de acuerdo con la cantidad de alquiler de auto en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) automóvil, el usuario puede solicitar hasta (3) gastos. Si se solicitan (2) automóviles, el usuario puede solicitar hasta (6) gastos
request Int 3 Cantidad máxima de gastos por solicitud. Ejemplo: 2
typeTrip String (Enum) 13 Tipo de viaje al que está vinculado el gasto (both, international, domestic). Ejemplo: domestic
groupDay Int 3 A través de esta propiedad, es posible limitar la cantidad de un tipo específico de gasto que se puede pedir en una OS. Ejemplo: Configurado (2) para gastos de taxi. Al abrir una solicitud, el usuario puede seleccionar un máximo de (2) Taxi.
groupRequest Int 3 A través de esta propiedad, es posible limitar la cantidad de gastos que se pueden pedir en una OS. Ejemplo: configurado (2). La solicitud (anticipo o rendición de cuentas) puede tener un máximo de dos gastos
plusLess String (Enum) 3 Propiedad para identificar si el gasto tiene más o no en relación al monto ya definido en el aire, hotel, propiedades de alquiler. "Sí" para "+" y "no" para "-". Ejemplo: yes/no
plusLessValue Int 3 Cantidad más o menos en relación con la cantidad definida en las propiedades air, hotel, rental. Ejemplo: 2
plusLessUtilization String (Enum) 11 Específico para qué "producto" la cantidad para más o menos será válida en relación con la configuración definida en la propiedad “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Ejemplo: totalAir
individualQuantity String (Enum) 3 Cuando el gasto se configura con esta propiedad, significa que el usuario no puede contabilizar dos gastos al mismo tiempo (Ejemplo: Taxi), sino que incluye una línea de gastos para cada artículo. Ejemplo: Yes/No
tax Number (Decimal) 100 Importe fiscal del gasto. Ejemplo: 115.00
category String (Enum) 16 Define la categoría del gasto registrado. (food, hotels, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Ejemplo: food
kilometerValue Int 6 A través de esta propiedad es posible definir el valor de la categoría de gastos "trayecto" (por km). Ejemplo: 1.50
requiredVoucher String (Enum) 3 Obliga incluir un archivo/comprobante cuando se selecciona el gasto. Ejemplo: Yes
requiredCFDI String (Enum) 3 Obliga incluir un archivo de tipo XML/CFDI al agregar el gasto (Exclusivo para México). Ejemplo: No
refundable String (Enum) 3 Define si el gasto se presentará al usuario siempre con el estándar "reembolsable". Ejemplo: Yes/No
proven String (Enum) 3 Define si el gasto se presentará al usuario siempre con el estándar "comprobado". Ejemplo: Yes/No
costCenterId Guid 36 ID del centro de coste al que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 ID del nivel al que está vinculado el gasto (Ejemplo: Junta). Cuando un gasto está vinculado a un nivel, se presentará solo a los usuarios con los niveles definidos. Ejemplo: 00000000-0000-0000-0000-000000000000

POST /expenses

Solicitud

{
        "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"
      }
Propiedad Tipo Tamaño Requerido Descripción
companyId Guid 36 No ID de la empresa a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 No ID de cuenta contable a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Indica si el gasto registrado está activo o inactivo. Ejemplo: Yes/No
name String 50 Si Descripción del gasto. Ejemplo: Alimentación
type String (Enum) 15 No Tipo de gasto registrado: advancedPayment = anticipo refund - reembolso invoiceClosing - cierre de tarjeta. Ejemplo: refund
day Int 3 No Cantidad máxima de gasto permitida por día. Ejemplo: 2
air Int 3 No Cantidad máxima de gasto permitido, de acuerdo con la cantidad de tramos de servicio aéreo en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) por vía aérea, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) por vía aérea, el usuario puede solicitar hasta (6) gastos.
hotel Int 3 No Cantidad máxima de gasto permitida, de acuerdo a la cantidad de alojamiento en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) alojamiento, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) alojamiento, el usuario puede solicitar hasta (6) gastos
rental Int 3 No Cantidad máxima de gasto permitida, de acuerdo con la cantidad de alquiler de auto en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) automóvil, el usuario puede solicitar hasta (3) gastos. Si se solicitan (2) automóviles, el usuario puede solicitar hasta (6) gastos
request Int 3 No Cantidad máxima de gastos por solicitud. Ejemplo: 2
typeTrip String (Enum) 13 No Tipo de viaje al que está vinculado el gasto (both, international, domestic). Ejemplo: domestic
groupDay Int 3 No A través de esta propiedad, es posible limitar la cantidad de un tipo específico de gasto que se puede pedir en una OS. Ejemplo: configurado (2) para el gasto de taxi. Al abrir una solicitud, el usuario puede seleccionar un máximo de (2) Taxi.
groupRequest Int 3 No A través de esta propiedad, es posible limitar la cantidad de gastos que se pueden pedir en una OS. Ejemplo: configurado (2). La solicitud (anticipo o rendición de cuentas) puede tener un máximo de dos gastos
plusLess String (Enum) 3 No Propiedad para identificar si el gasto tiene más o no en relación al monto ya definido en el aire, hotel, propiedades de alquiler. "Sí" para "+" y "no" para "-". Ejemplo: yes/no
plusLessValue Int 3 No Cantidad más o menos en relación a la cantidad definida en las propiedades aire, hotel, alquiler de auto. Ejemplo: 2
plusLessUtilization String (Enum) 11 No Específico para qué "producto" la cantidad para más o menos será válida en relación con la configuración definida en la propiedad “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Ejemplo: totalAir
individualQuantity String (Enum) 3 No Cuando el gasto se configura con esta propiedad, significa que el usuario no puede contabilizar dos gastos al mismo tiempo (Ejemplo: Taxi), sino que incluye una línea de gastos para cada artículo. Ejemplo: Yes/No
tax Number (Decimal) 100 No Importe fiscal del gasto. Ejemplo: 115.00
category String (Enum) 16 No Define la categoría de gastos registrados. (food, hotel, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Ejemplo: food
kilometerValue Int 6 No A través de esta propiedad es posible definir el valor de la categoría de gastos "Trayecto". Ejemplo: 1.50
requiredVoucher String (Enum) 3 No Obliga incluir un archivo/comprobante cuando se selecciona el gasto. Ejemplo: Yes
requiredCFDI String (Enum) 3 No Obliga incluir un archivo de tipo XML/CFDI al agregar el gasto (Exclusivo para México). Ejemplo: No
refundable String (Enum) 3 No Define si el gasto se presentará al usuario siempre con el estándar "reembolsable". Ejemplo: Yes/No
costCenterId Guid 36 No ID del centro de coste al que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
proven String (Enum) 3 No Define si el gasto se presentará al usuario siempre con el estándar "comprobado". Ejemplo: Yes/No
leveld Guid 36 No ID del nivel al que está vinculado el gasto (Ejemplo: Junta). Cuando un gasto está vinculado a un nivel, se presentará solo a los usuarios con los niveles definidos. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
ID Guid 36 ID del gasto registrado. Ejemplo: 00000000-0000-0000-0000-000000000000

GET /expenses/{expenseId}

Solicitud

requisição GET

Resposta

[
    {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "expenseId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-10-30T10:26:04.483Z",
        "changeDate": "2020-10-30T10:26:04.483Z",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "accountingAccountId": "00000000-0000-0000-0000-000000000000",
        "active": "yes",
        "name": "string",
        "type": "advancedPayment",
        "day": 0,
        "air": 0,
        "hotel": 0,
        "rental": 0,
        "request": 0,
        "typeTrip": "both",
        "groupDay": 0,
        "groupRequest": 0,
        "plusLess": "yes",
        "plusLessValue": 0,
        "plusLessUtilization": "totalDay",
        "individualQuantity": "yes",
        "tax": 0,
        "category": "food",
        "kilometerValue": 0,
        "requiredVoucher": "yes",
        "requiredCFDI": "yes",
        "refundable": "yes",
        "proven": "yes",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "leveld": "00000000-0000-0000-0000-000000000000"
    }
]
Propiedad Tipo Tamaño Descripción
expenseId Guid 36 Si Identificación de gastos. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID del cliente a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID del gasto registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha / hora del registro del gasto. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date-Time) 24 Fecha / hora del último cambio en el registro del gasto. Ejemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID de la empresa a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 ID de la cuenta contable a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica si el gasto registrado está activo o inactivo. Ejemplo: Yes/No
name String 50 Descripción del gasto. Ejemplo: Alimentación
type String (Enum) 15 Tipo de gasto registrado: advancedPayment = anticipo; refund = reembolso; invoiceClosing = cierre de tarjeta. Exemplo: refund
day Int 3 Cantidad máxima de gasto permitido por día. Ejemplo: 2
air Int 3 Cantidad máxima de gasto permitido, de acuerdo con la cantidad de tramos de servicio aéreo en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) por vía aérea, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) por vía aérea, el usuario puede solicitar hasta (6) gastos.
hotel Int 3 Cantidad máxima de gasto permitida, de acuerdo a la cantidad de alojamiento en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) alojamiento, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) alojamiento, el usuario puede solicitar hasta (6) gastos
rental Int 3 Cantidad máxima de gasto permitida, de acuerdo con la cantidad de alquiler de auto en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) automóvil, el usuario puede solicitar hasta (3) gastos. Si se solicitan (2) automóviles, el usuario puede solicitar hasta (6) gastos
request Int 3 Cantidad máxima de gastos por solicitud. Ejemplo: 2
typeTrip String (Enum) 13 Tipo de viaje al que está vinculado el gasto (both, international, domestic). Ejemplo: domestic
groupDay Int 3 A través de esta propiedad, es posible limitar la cantidad de un tipo específico de gasto que se puede pedir en una OS. Ejemplo: Configurado (2) para gastos de taxi. Al abrir una solicitud, el usuario puede seleccionar un máximo de (2) Taxi.
groupRequest Int 3 A través de esta propiedad, es posible limitar la cantidad de gastos que se pueden pedir en una OS. Ejemplo: configurado (2). La solicitud (anticipo o rendición de cuentas) puede tener un máximo de dos gastos
plusLess String (Enum) 3 Propiedad para identificar si el gasto tiene más o no en relación al monto ya definido en el aire, hotel, propiedades de alquiler. "Sí" para "+" y "no" para "-". Ejemplo: yes/no
plusLessValue Int 3 Cantidad más o menos en relación con la cantidad definida en las propiedades air, hotel, rental. Ejemplo: 2
plusLessUtilization String (Enum) 11 Específico para qué "producto" la cantidad para más o menos será válida en relación con la configuración definida en la propiedad “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Ejemplo: totalAir
individualQuantity String (Enum) 3 Cuando el gasto se configura con esta propiedad, significa que el usuario no puede contabilizar dos gastos al mismo tiempo (Ejemplo: Taxi), sino que incluye una línea de gastos para cada artículo. Ejemplo: Yes/No
tax Number (Decimal) 100 Importe fiscal del gasto. Ejemplo: 115.00
category String (Enum) 16 Define la categoría del gasto registrado. (food, hotels, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Ejemplo: food
kilometerValue Int 6 A través de esta propiedad es posible definir el valor de la categoría de gastos "trayecto" (por km). Ejemplo: 1.50
requiredVoucher String (Enum) 3 Obliga incluir un archivo/comprobante cuando se selecciona el gasto. Ejemplo: Yes
requiredCFDI String (Enum) 3 Obliga incluir un archivo de tipo XML/CFDI al agregar el gasto (Exclusivo para México). Ejemplo: No
refundable String (Enum) 3 Define si el gasto se presentará al usuario siempre con el estándar "reembolsable". Ejemplo: Yes/No
proven String (Enum) 3 Define si el gasto se presentará al usuario siempre con el estándar "comprobado". Ejemplo: Yes/No
costCenterId Guid 36 ID del centro de coste al que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 ID del nivel al que está vinculado el gasto (Ejemplo: Junta). Cuando un gasto está vinculado a un nivel, se presentará solo a los usuarios con los niveles definidos. Ejemplo: 00000000-0000-0000-0000-000000000000

PUT /expenses/{expenseId}

Solicitud

{
        "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"
      }
Propiedad Tipo Tamaño Requerido Descripción
expenseId Guid 36 Si Identificación de gastos. Ejemplo: 00000000-0000-0000-0000-000000000000
companyId Guid 36 No ID de la empresa a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
accountingAccountId Guid 36 No ID de la cuenta contable a la que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Indica si el gasto registrado está activo o inactivo. Ejemplo: Yes/No
name String 50 Si Descripción del gasto. Ejemplo: Alimentación
type String (Enum) 15 No Tipo de gasto registrado: advancedPayment = anticipo refund - reembolso invoiceClosing - cierre de tarjeta. Ejemplo: refund
day Int 3 No Cantidad máxima de gasto permitido por día. Ejemplo: 2
air Int 3 No Cantidad máxima de gasto permitido de acuerdo con la cantidad de aéreo en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) por vía aérea, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) por vía aérea, el usuario puede solicitar hasta (6) gastos
hotel Int 3 No Cantidad máxima de gasto permitida, de acuerdo a la cantidad de alojamiento en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) alojamiento, el usuario puede solicitar hasta (3) gastos. Si se solicita (2) alojamiento, el usuario puede solicitar hasta (6) gastos
rental Int 3 No Cantidad máxima de gasto permitida, de acuerdo con la cantidad de alquiler de auto en la solicitud. Ejemplo: Registrada la cantidad (3). Si se solicita (1) automóvil, el usuario puede solicitar hasta (3) gastos. Si se solicitan (2) automóviles, el usuario puede solicitar hasta (6) gastos
request Int 3 No Cantidad máxima de gastos por solicitud. Ejemplo: 2
typeTrip String (Enum) 13 No Tipo de viaje al que está vinculado el gasto (both, international, domestic). Ejemplo: domestic
groupDay Int 3 No A través de esta propiedad, es posible limitar la cantidad de un tipo específico de gasto que se puede pedir en una OS. Ejemplo: configurado (2) para el gasto de taxi. Al abrir una solicitud, el usuario puede seleccionar un máximo de (2) Taxi.
groupRequest Int 3 No A través de esta propiedad, es posible limitar la cantidad de gastos que se pueden pedir en una OS. Ejemplo: configurado (2). La solicitud (anticipo o rendición de cuentas) puede tener un máximo de dos gastos
plusLess String (Enum) 3 No Propiedad para identificar si el gasto tiene más o no en relación al monto ya definido en el aire, hotel, propiedades de alquiler. "Sí" para "+" y "no" para "-". Ejemplo: yes/no
plusLessValue Int 3 No Cantidad más o menos en relación a la cantidad definida en las propiedades aire, hotel, alquiler de auto. Ejemplo: 2
plusLessUtilization String (Enum) 11 No Específico para qué "producto" la cantidad para más o menos será válida en relación con la configuración definida en la propiedad “plusLessValue” (totalDay, totalAir, totalHotels, totalRental). Ejemplo: totalAir
individualQuantity String (Enum) 3 No Cuando el gasto se configura con esta propiedad, significa que el usuario no puede contabilizar dos gastos al mismo tiempo (Ejemplo: Taxi), sino que incluye una línea de gastos para cada artículo. Ejemplo: Yes/No
tax Number (Decimal) 100 No Importe fiscal del gasto. Ejemplo: 115.00
category String (Enum) 16 No Define la categoría de gastos registrados. (food, hotel, transport, route, others, taxi, laundry, toll, taxes, personalExpenses, air, trip). Ejemplo: food
kilometerValue Int 6 No A través de esta propiedad es posible definir el valor de la categoría de gastos "Trayecto". Ejemplo: 1.50
requiredVoucher String (Enum) 3 No Obliga incluir un archivo/comprobante cuando se selecciona el gasto. Ejemplo: Yes
requiredCFDI String (Enum) 3 No Obliga incluir un archivo de tipo XML/CFDI al agregar el gasto (Exclusivo para México). Ejemplo: No
refundable String (Enum) 3 No Define si el gasto se presentará al usuario siempre con el estándar "reembolsable". Ejemplo: Yes/No
proven String (Enum) 3 No Define si el gasto se presentará al usuario siempre con el estándar "comprobado". Ejemplo: Yes/No
costCenterId Guid 36 No ID del centro de coste al que está vinculado el gasto. Ejemplo: 00000000-0000-0000-0000-000000000000
leveld Guid 36 No ID del nivel al que está vinculado el gasto (Ejemplo: Junta). Cuando un gasto está vinculado a un nivel, se presentará solo a los usuarios con los niveles definidos. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de respuesta a la acción. Ejemplo: True/False

ConfigsFormsPayments

Una de las configuraciones mandatorias en Argo es el registro de formas de pago (Ejemplo: Tarjeta de crédito, crédito, etc.). Sin esta personalización, los usuarios no pueden crear solicitudes (Aéreo, Hospedaje, Alquiler de Auto, etc.). Por lo tanto, Argo proporciona a través de su API la posibilidad de registrar y administrar las Formas de pago utilizadas en los clientes.
Argo Wiki

GET

Solicitud

Solicitud GET

Respuesta

[
      {
        "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"
      }
]
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID de cliente al que está vinculado a la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha / hora de creación de la forma de pago. Ejemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date-Time) 24 Fecha / hora de finalización / cancelación de la forma de pago. Ejemplo: 2019-09-18T16:48:22.490Z
typePaymentId Guid 24 ID de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
billed String (Enum) 3 Indica que la forma de pago registrado es "Facturado". Ejemplo: Yes/No
name String 100 Descripción de la forma de pago. Ejemplo: facturado
utilization String (Enum) 14 A través de la política de FATUTI (Argo Wiki) es posible segmentar los tipos de facturación. A través de esta propiedad es posible definir el uso: requestOnline = Formas de pago utilizada para solicitudes On-Line, requestOffline = Formas de pago utilizada para solicitudes Off-Line, issueOnline = Forma de pago utilizada para emisiones online, issueOffline = Forma de pago utilizado para emisiones Off-Line. Exemplo: issueOffline
active String (Enum) 3 Indica si la forma de pago está activo o inactivo. Ejemplo: Yes/No
service String (Enum) 3 Indica para qué producto se utilizará la forma de pago (air, hotels, rental, service, bus). Ejemplo: Air
thirdParty String (Enum) 3 Indica si la forma de pago se puede utilizar para invitados o terceros. Ejemplo: Yes/No
reserve String (Enum) 3 Esta opción se verificará cuando el método de pago se utilice solo para garantizar el No-show de las reservas de alojamiento. Ejemplo: Yes/No
government String (Enum) 3 Indica que la forma de pago es "Agencia gubernamental". Ejemplo: Yes/No
direct String (Enum) 3 Indica que la forma de pago es "Directa". Ejemplo: Yes/No
manual String (Enum) 3 Indica si forma de pago se registró debido a la política CADCAR (Argo Wiki). Ejemplo: Yes/No
integrationCode String 8 Código de integración de la forma de pago. Ejemplo: 87383
changedUser Guid 36 ID de usuario que finalizó / cambió el registro de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Tipo de viaje para el que se puede utilizar la forma de pago (both, international, domestic). Ejemplo: domestic
collaborator String (Enum) 3 Indica que la forma de pago solo se puede utilizar cuando el viaje es para usuarios registrados. Ejemplo: Yes/No
agencyId Guid 36 ID de agencia vinculada al método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Indica si el método de pago es restrictivo. Ejemplo: Yes/No
cnpj String 14 Registro Nacional de Entidades Legales (CNPJ) de la empresa que utiliza la forma de pago. Ejemplo: 09096135000100
alternativeUATP String (Enum) 3 UATP es una tarjeta utilizada para pagar emisiones específicos de la aerolínea, y es posible registrar una forma alternativa de pago, en caso de que emisión con UATP no se realice con éxito. Ejemplo: Yes/No
Conferma String (Enum) 3 Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Cumple). Ejemplo: Yes/No
agency String (Enum) 3 Determina que la forma de pago será visible solo para los usuarios de la agencia de viajes. Ejemplo: Yes/No
wex String (Enum) 3 Indica si la forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Wex). Ejemplo: Yes/No
agencyTypePaymentId Guid 36 ID del tipo de facturación de la agencia. Ejemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (B2B P@y). Ejemplo: Yes/No
companyId Guid 36 ID de empresa a la que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID del centro de costo al que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Indica que la forma de pago es "Tarjeta de crédito". Ejemplo: Yes/No
userCard String (Enum) 3 Determina que la tarjeta es por usuario. Ejemplo: Yes

GET /formspayments/{formPaymentId}

Solicitud

Solicitud GET /formspayments/{formPaymentId}
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

{
        "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"
      }
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID de cliente al que está vinculado a la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha / hora de creación de la forma de pago. Ejemplo: 2019-09-18T16:48:22.490Z
finalizationDate String (Date-Time) 24 Fecha / hora de finalización / cancelación de la forma de pago. Ejemplo: 2019-09-18T16:48:22.490Z
typePaymentId Guid 24 ID de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
billed String (Enum) 3 Indica que la forma de pago registrado es "Facturado". Ejemplo: Yes/No
name String 100 Descripción de la forma de pago. Ejemplo: facturado
utilization String (Enum) 14 A través de la política de FATUTI (Argo Wiki) es posible segmentar los tipos de facturación. A través de esta propiedad es posible definir el uso: requestOnline = Formas de pago utilizada para solicitudes On-Line, requestOffline = Formas de pago utilizada para solicitudes Off-Line, issueOnline = Forma de pago utilizada para emisiones online, issueOffline = Forma de pago utilizado para emisiones Off-Line. Exemplo: issueOffline
active String (Enum) 3 Indica si la forma de pago está activo o inactivo. Ejemplo: Yes/No
service String (Enum) 3 Indica para qué producto se utilizará la forma de pago (air, hotels, rental, service, bus). Ejemplo: Air
thirdParty String (Enum) 3 Indica si la forma de pago se puede utilizar para invitados o terceros. Ejemplo: Yes/No
reserve String (Enum) 3 Esta opción se verificará cuando el método de pago se utilice solo para garantizar el No-show de las reservas de alojamiento. Ejemplo: Yes/No
government String (Enum) 3 Indica que la forma de pago es "Agencia gubernamental". Ejemplo: Yes/No
direct String (Enum) 3 Indica que la forma de pago es "Directa". Ejemplo: Yes/No
manual String (Enum) 3 Indica si forma de pago se registró debido a la política CADCAR (Argo Wiki). Ejemplo: Yes/No
integrationCode String 8 Código de integración de la forma de pago. Ejemplo: 87383
changedUser Guid 36 ID de usuario que finalizó / cambió el registro de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 Tipo de viaje para el que se puede utilizar la forma de pago (both, international, domestic). Ejemplo: domestic
collaborator String (Enum) 3 Indica que la forma de pago solo se puede utilizar cuando el viaje es para usuarios registrados. Ejemplo: Yes/No
agencyId Guid 36 ID de agencia vinculada al método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 Indica si el método de pago es restrictivo. Ejemplo: Yes/No
cnpj String 14 Registro Nacional de Entidades Legales (CNPJ) de la empresa que utiliza la forma de pago. Ejemplo: 09096135000100
alternativeUATP String (Enum) 3 UATP es una tarjeta utilizada para pagar emisiones específicos de la aerolínea, y es posible registrar una forma alternativa de pago, en caso de que emisión con UATP no se realice con éxito. Ejemplo: Yes/No
Conferma String (Enum) 3 Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Cumple). Ejemplo: Yes/No
agency String (Enum) 3 Determina que la forma de pago será visible solo para los usuarios de la agencia de viajes. Ejemplo: Yes/No
wex String (Enum) 3 Indica si la forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Wex). Ejemplo: Yes/No
agencyTypePaymentId Guid 36 ID del tipo de facturación de la agencia. Ejemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (B2B P@y). Ejemplo: Yes/No
companyId Guid 36 ID de empresa a la que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID del centro de costo al que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 Indica que la forma de pago es "Tarjeta de crédito". Ejemplo: Yes/No
userCard String (Enum) 3 Determina que la tarjeta es por usuario. Ejemplo: Yes

POST

Solicitud

{
  "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"
}
Propiedad Tipo Tamaño Requerido Descripción
name String 100 Si Descripción de la forma de pago. Ejemplo: facturado
utilization String (Enum) 14 No A través de la política de FATUTI (Argo Wiki) es posible segmentar los tipos de facturación. A través de esta propiedad es posible definir el uso: requestOnline = Formas de pago utilizada para solicitudes On-Line, requestOffline = Formas de pago utilizada para solicitudes Off-Line, issueOnline = Forma de pago utilizada para emisiones online, issueOffline = Forma de pago utilizado para emisiones Off-Line. Exemplo: issueOffline
active String (Enum) 3 No Indica si la forma de pago está activo o inactivo. Ejemplo: Yes/No
service String (Enum) 3 Si Indica para qué producto se utilizará la forma de pago (air, hotels, rental, service, bus). Ejemplo: Air
thirdParty String (Enum) 3 No Indica si la forma de pago se puede utilizar para invitados o terceros. Ejemplo: Yes/No
reserve String (Enum) 3 No Esta opción se verificará cuando el método de pago se utilice solo para garantizar el No-show de las reservas de alojamiento. Ejemplo: Yes/No
government String (Enum) 3 No Indica que la forma de pago es "Agencia gubernamental". Ejemplo: Yes/No
direct String (Enum) 3 No Indica que la forma de pago es "Directa". Ejemplo: Yes/No
manual String (Enum) 3 No Indica si forma de pago se registró debido a la política CADCAR (Argo Wiki). Ejemplo: Yes/No
integrationCode String 8 No Código de integración de la forma de pago. Ejemplo: 873837
changedUser Guid 36 No ID de usuario que finalizó / cambió el registro de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 No Tipo de viaje para el que se puede utilizar la forma de pago (both, international, domestic). Ejemplo: domestic
collaborator String (Enum) 3 No Indica que la forma de pago solo se puede utilizar cuando el viaje es para usuarios registrados. Ejemplo: Yes/No
agencyId Guid 36 No ID de agencia vinculada al método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 No Indica si el método de pago es restrictivo. Ejemplo: Yes/No
cnpj String 14 No Registro Nacional de Entidades Legales (CNPJ) de la empresa que utiliza la forma de pago. Ejemplo: 09096135000100
alternativeUATP String (Enum) 3 No UATP es una tarjeta utilizada para pagar emisiones específicos de la aerolínea, y es posible registrar una forma alternativa de pago, en caso de que emisión con UATP no se realice con éxito. Ejemplo: Yes/No
Conferma String (Enum) 3 No Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Cumple). Ejemplo: Yes/No
agency String (Enum) 3 No Determina que la forma de pago será visible solo para los usuarios de la agencia de viajes. Ejemplo: Yes/No
wex String (Enum) 3 No Indica si la forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Wex). Ejemplo: Yes/No
agencyTypePaymentId Guid 36 No ID del tipo de facturación de la agencia. Ejemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 No Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (B2B P@y). Ejemplo: Yes/No
companyId Guid 36 No ID de empresa a la que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 No ID del centro de costo al que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 No Indica que la forma de pago es "Tarjeta de crédito". Ejemplo: Yes/No
userCard String (Enum) 3 No Determina que la tarjeta es por usuario. Ejemplo: Yes/No

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
id Guid 36 ID del registro realizado. Ejemplo: 00000000-0000-0000-0000-000000000000

PUT

Solicitud

{
  "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"
}
Propiedad Tipo Tamaño Requerido Descripción
name String 100 Si Descripción de la forma de pago. Ejemplo: facturado
utilization String (Enum) 14 No A través de la política de FATUTI (Argo Wiki) es posible segmentar los tipos de facturación. A través de esta propiedad es posible definir el uso: requestOnline = Formas de pago utilizada para solicitudes On-Line, requestOffline = Formas de pago utilizada para solicitudes Off-Line, issueOnline = Forma de pago utilizada para emisiones online, issueOffline = Forma de pago utilizado para emisiones Off-Line. Exemplo: issueOffline
active String (Enum) 3 No Indica si la forma de pago está activo o inactivo. Ejemplo: Yes/No
service String (Enum) 3 Si Indica para qué producto se utilizará la forma de pago (air, hotels, rental, service, bus). Ejemplo: Air
thirdParty String (Enum) 3 No Indica si la forma de pago se puede utilizar para invitados o terceros. Ejemplo: Yes/No
reserve String (Enum) 3 No Esta opción se verificará cuando el método de pago se utilice solo para garantizar el No-show de las reservas de alojamiento. Ejemplo: Yes/No
government String (Enum) 3 No Indica que la forma de pago es "Agencia gubernamental". Ejemplo: Yes/No
direct String (Enum) 3 No Indica que la forma de pago es "Directa". Ejemplo: Yes/No
manual String (Enum) 3 No Indica si forma de pago se registró debido a la política CADCAR (Argo Wiki). Ejemplo: Yes/No
integrationCode String 8 No Código de integración de la forma de pago. Ejemplo: 873837
changedUser Guid 36 No ID de usuario que finalizó / cambió el registro de la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typeTrip String (Enum) 13 No Tipo de viaje para el que se puede utilizar la forma de pago (both, international, domestic). Ejemplo: domestic
collaborator String (Enum) 3 No Indica que la forma de pago solo se puede utilizar cuando el viaje es para usuarios registrados. Ejemplo: Yes/No
agencyId Guid 36 No ID de agencia vinculada al método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
restrictive String (Enum) 3 No Indica si el método de pago es restrictivo. Ejemplo: Yes/No
cnpj String 14 No Registro Nacional de Entidades Legales (CNPJ) de la empresa que utiliza la forma de pago. Ejemplo: 09096135000100
alternativeUATP String (Enum) 3 No UATP es una tarjeta utilizada para pagar emisiones específicos de la aerolínea, y es posible registrar una forma alternativa de pago, en caso de que emisión con UATP no se realice con éxito. Ejemplo: Yes/No
Conferma String (Enum) 3 No Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Cumple). Ejemplo: Yes/No
agency String (Enum) 3 No Determina que la forma de pago será visible solo para los usuarios de la agencia de viajes. Ejemplo: Yes/No
wex String (Enum) 3 No Indica si la forma de pago está relacionado con la plataforma de generación de tarjeta virtual (Wex). Ejemplo: Yes/No
agencyTypePaymentId Guid 36 No ID del tipo de facturación de la agencia. Ejemplo: 00000000-0000-0000-0000-000000000000
b2bPay String (Enum) 3 No Indica si forma de pago está relacionado con la plataforma de generación de tarjeta virtual (B2B P@y). Ejemplo: Yes/No
companyId Guid 36 No ID de empresa a la que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 No ID del centro de costo al que está vinculada la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
card String (Enum) 3 No Indica que la forma de pago es "Tarjeta de crédito". Ejemplo: Yes/No
userCard String (Enum) 3 No Determina que la tarjeta es por usuario. Ejemplo: Yes/No

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o fracaso en la actualización de la forma de pago. Ejemplo: True/False

DELETE

Solicitud

Solicitud DELETE
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o fracaso en la actualización de la forma de pago. Ejemplo: True/False

GET /formspayments/{formPaymentId}/codesformspayments

Solicitud

requisição GET /formspayments/{formPaymentId}/codesformspayments
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Descripción
typePaymentCodeId Guid 36 ID del código del método de pago que está vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de cliente al que está vinculado el método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typePaymentId Guid 24 ID de método de pago devuelto en la consulta. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica si la forma de pago está activa o inactiva. Ejemplo: Yes/No
inclusionUser Guid 36 ID del usuario que creó la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha/hora de creación del método de pago. Ejemplo: 2019-09-18T16:48:22.490Z
changeUser Guid 36 ID de usuario que finalizó/cambió la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
changeDate Guid 36 Fecha/hora en que se finalizó/cambió el método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
webServiceId String 10 Identificador del WebService da forma de pagamento. Ejemplo: MOVIDA, TREND, AMADEUSWS
description String 100 Descripción de la forma de pago. Ejemplo: pago directo
paymentCode String 20 Código de método de pago. Ejemplo: 2B55Argo

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

Solicitud

requisição GET /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Si ID del código del método de pago que está vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
  {
    "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"
  }
]
Propiedad Tipo Tamaño Descripción
typePaymentCodeId Guid 36 ID del código del método de pago que está vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de cliente al que está vinculado el método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
typePaymentId Guid 24 ID de método de pago devuelto en la consulta. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica si la forma de pago está activa o inactiva. Ejemplo: Yes/No
inclusionUser Guid 36 ID del usuario que creó la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date-Time) 24 Fecha/hora de creación del método de pago. Ejemplo: 2019-09-18T16:48:22.490Z
changeUser Guid 36 ID de usuario que finalizó/cambió la forma de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
changeDate Guid 36 Fecha/hora en que se finalizó/cambió el método de pago. Ejemplo: 00000000-0000-0000-0000-000000000000
webServiceId String 10 Identificador del WebService da forma de pagamento. Ejemplo: MOVIDA, TREND, AMADEUSWS
description String 100 Descripción de la forma de pago. Ejemplo: pago directo
paymentCode String 20 Código de método de pago. Ejemplo: 2B55Argo

POST /formspayments/{formPaymentId}/codesformspayments

Solicitud

requisição POST /formspayments/{formPaymentId}/codesformspayments
Propiedad Tipo Tamaño Requerido Descripción
webServiceId String 10 Si Identificador del WebService da forma de pagamento. Ejemplo: MOVIDA, TREND, AMADEUSWS
description String 100 No Descripción de la forma de pago. Ejemplo: pago directo
paymentCode String 20 No Código de método de pago. Ejemplo: 2B55Argo

Respuesta

resposta POST
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o fracaso en el registro del método de pago. Ejemplo: True/False

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

Solicitud

requisição PUT /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Si ID del código del método de pago que está vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000
Propiedad Tipo Tamaño Requerido Descripción
webServiceId String 10 Si Identificador del WebService da forma de pagamento. Ejemplo: MOVIDA, TREND, AMADEUSWS
description String 100 No Descripción de la forma de pago. Ejemplo: pago directo
paymentCode String 20 No Código de método de pago. Ejemplo: 2B55Argo

Respuesta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o fracaso en el cambio de forma de pago. Ejemplo: True/False

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

Solicitud

requisição DELETE /formspayments/{formPaymentId}/codesformspayments/{codeTypePaymentId}
Propiedad Tipo Tamaño Requerido Descripción
formPaymentId Guid 36 Si ID del tipo de facturación. Ejemplo: 00000000-0000-0000-0000-000000000000
codeTypePaymentId Guid 36 Si ID del código del método de pago que está vinculado. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

resposta DELETE
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error al eliminar el método de pago. Ejemplo: True/False

ConfigsUsers

El servicio permite el registro de usuarios del cliente, así como las parametrizaciones que definen las características de los usuarios como (solicitante, viajero, etc).
Argo Wiki

GET /users/{userId}

Recupera detalles del usuario

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si ID de usuario a consultar para más detalles. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

{
    "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"
}
Propiedad Tipo Tamaño Descripción
active String (Enum) 3 Indica si el usuario está activo o inactivo. Ejemplo: Yes/No
userId Guid 36 ID de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
requester String (Enum) 3 Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios. Ejemplo: Yes/No
levelId Guid 36 ID de nivel vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
levelDescription String 50 Descripción del nivel vinculado al usuario. Ejemplo: presidente
employeeId String 20 Número de empleado del usuario Ejemplo: 464545
integrationCode String 50 Código de integración del usuario. Ejemplo: 454555
changeDate String (DateTime) 24 Fecha del último cambio en el registro del usuario. Ejemplo: 2019-09-18T16:48:22.490Z
companyId Guid 36 ID de empresa vinculada al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID del centro de costo vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
serviceCenterId Guid 36 ID relacionado con puesto de atención al que está vinculado el usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
supplierId Guid 36 ID de proveedor vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
communityId Guid 36 ID de comunidad vinculada al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
thirdParty String (Enum) 3 Indica si el usuario es un "tercero". Ejemplo: Yes/No
vip String (Enum) 3 Indica si el usuario es un viajero VIP. Ejemplo: Yes/No
masterNational String(Enum) 3 Indica si el usuario es un viajero master nacional (no se necesitarán aprobar solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterInternational String (Enum) 3 Indica si el usuario es un viajero master internacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
clientName String 50 Nombre del cliente / corporación en la que se ingresa el usuario. Ejemplo: Argo Solutions
agencyName String 50 Nombre de la agencia de viajes en la que se ingresa el usuario. Ejemplo: Argo
serviceCenterDescription String 100 Descripción del puesto de atención al que está vinculado el usuario. Ejemplo: estación de servicio A
supplierName String 50 Descripción del proveedor vinculado al usuario. Ejemplo: Argo
companyName String 50 Nombre de la empresa vinculada al usuario. Ejemplo: Argo
costCenterDescription String 50 Descripción del centro de costo vinculado al usuario. Ejemplo: Ccusto de prueba
costCenterCode String 30 Código del centro de costos vinculado al usuario. Ejemplo: 001
communityName String 50 Nombre de la comunidad vinculada al usuario. Ejemplo: desarrollo
language String (Enum) 12 Idioma del usuario: portugueseBR = Portugués (Brasil), portuguesePT = Portugués (Portugal), english, spanish = español (España), mexico = español (México). Ejemplo: portugueseBR
peopleDeficiency String (Enum) 3 Indica si el usuario es una persona discapacitada. Ejemplo: Yes/No
requesterMaster String (Enum) 3 Indica que el usuario es un solicitante master. Los usuarios con esta función pueden solicitar viajes para otros pasajeros sin aprobación. Ejemplo: Yes/No
masterAdvancePayment String (Enum) 3 Indica que el usuario es un solicitante master. Los usuarios con esta característica pueden solicitar anticipos sin necesidad de aprobación. Ejemplo: Yes/No
masterRefund String (Enum) 3 Indica que el usuario es un usuario master de reembolso. Los usuarios con esta función pueden hacer prestación de cuentas/ reembolso sin la necesidad de aprobación. Ejemplo: Yes/No
master String (Enum) 3 Indica que o usuário é um solicitante master. Usuários com essa característica podem criar uma solicitação sem a necessidade de aprovação. Ejemplo:Yes/No
star String 50 Star está relacionado con el perfil de usuario de GDS Sabre. Ejemplo: SILVA/1234567
telephone String 30 Teléfono del usuario Ejemplo: 5511998525545
fax String 30 Fax de usuario. Ejemplo: 5511998525545
office String 50 Puesto vinculado al registro de usuario: Ejemplo: Analista de negocios
department String 50 Departamento vinculado al registro de usuarios. Ejemplo: desarrollo
local String 50 Dirección del usuario Ejemplo: Alameda Santos, 1978
city String 50 Ciudad donde reside el usuario. Ejemplo: São Paulo
state String 2 Estado dónde reside el usuario. Ejemplo: SP
zipCode String 11 Código postal donde reside el usuario. Ejemplo: 36544875421
bank String 20 Banco del usuario. Ejemplo: Itaú
bankBranch String 30 Sucursal bancaria del usuario. Ejemplo: 5434
bankAccount String 30 Cuenta bancaria de usuario: ejemplo: 36555454
secretaryId Guid 36 ID de secretaria vinculada al registro del usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
secretaryFullName String 100 Nombre completo de la secretaria vinculada al usuario. Ejemplo: Maria Silva
secretaryEmail String 256 Correo electrónico de la secretaria vinculado al usuario. Ejemplo: maria@silva.com
groups String (Enum) 9 Grupo al que pertenece el usuario: admin, financial, manager, user (Argo Wiki). Ejemplo: user
email String 100 Correo electrónico del usuario registrado. Ejemplo: pedro@silva.com
login String 50 Inicio de sesión de usuario registrado. Ejemplo: Argo2019
firstName Strting 20 Nombre de usuario registrado. Ejemplo: Pedro
lastName String 20 Apellidos del usuario registrado. Ejemplo: Silva
fullName String 50 Nombre completo del usuario registrado. Ejemplo: Pedro Silva

PUT /users/{userId}

Solicitud

{
    "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"
}
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si ID de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
groups String (Enum) 9 Si Grupo al que pertenece el usuario: administrador, financiero, gerente, usuario. Argo Wiki. Ejemplo: user
fax String 30 No Fax de usuario. Ejemplo: 5511998525545
office String 50 No Puesto del usuario Ejemplo: analista de negocios
requester String (Enum) 3 No Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios). Ejemplo: Yes/No
vip String (Enum) 3 No Indica si el usuario es un viajero VIP. Ejemplo: Yes/No
masterNational String(Enum) 3 No Indica si el usuario es un viajero master nacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterInternational String (Enum) 3 No Indica si el usuario es un viajero master internacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterAdvancePayment String (Enum) 3 No Indica que el usuario es un usuario master de anticipo. Los usuarios con esta característica pueden solicitar anticipos sin necesidad de aprobación. Ejemplo: Yes/No
masterRefund String (Enum) 3 No Indica que el usuario es un master de rendición de cuentas. Los usuarios con esta función pueden hacer prestación de cuentas / reembolso sin la necesidad de aprobación. Ejemplo: Yes/No
requesterMaster String (Enum) 3 No Indica que el usuario es un solicitante master. Los usuarios con esta función pueden solicitar viajes para otros pasajeros sin aprobación. Ejemplo: Yes/No
thirdParty String (Enum) 3 No Indica si el usuario es un "tercero". Ejemplo: Yes/No
levelDescription String 50 No Descripción del nivel vinculado al usuario. Ejemplo: presidente
employeeId String 20 No Número de empleado del usuario Ejemplo: 56565
integrationCode String 50 No Código de integración del usuario. Ejemplo: 454555
companyName String 50 No Nombre de la empresa vinculada al usuario. Ejemplo: Argo
costCenterDescription String 50 No Descripción del centro de costo vinculado al usuario. Ejemplo: Ccosto de prueba
costCenterCode String 30 No Código del centro de costo vinculado al usuario. Ejemplo: 001
telephone String 30 No Teléfono del usuario Ejemplo: 5511998525545
department String 50 No Departamento vinculado al registro de usuarios. Ejemplo: desarrollo
local String 50 No Dirección del usuario Ejemplo: Alameda Santos, 1978
city String 50 No Ciudad donde reside el usuario. Ejemplo: São Paulo
star String 50 No Star está relacionado con el perfil de usuario de GDS Sabre. Ejemplo: SILVA/1234567
state String 2 No Estado donde reside el usuario. Ejemplo: SP
active String (Enum) 3 No Indica si el usuario está activo o inactivo. Ejemplo: Yes/No
zipCode String 11 No Código postal donde reside el usuario. Ejemplo: 36544875421
secretaryEmail String 256 No Correo electrónico de la secretaria vinculado al usuario. Ejemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 No Objeto responsable de transportar la información de la empresa del usuario
levelsCostCenter Object (LevelCostCenterVM) 1 No Objeto responsable de llevar la información del centro de costos vinculada al usuario
communityId Guid 36 No ID de comunidad vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 256 Si Dirección de correo electrónico del usuario a registrar. Ejemplo: pedro@silva.com
login String 256 Si Inicio de sesión del usuario a registrarse. Ejemplo: Argo2019
password String 256 Si Contraseña del usuario a registrar. Ejemplo: Argo2019@
firstName Strting 20 Si Nombre del usuario a registrar. Ejemplo: Pedro
lastName String 20 Si Apellido del usuario a registrar. Ejemplo: Silva
fullName String 100 Si Nombre completo del usuario a registrar. Ejemplo: Pedro Silva
userCompanies Empresa vinculada al usuario
Propiedad Tipo Tamaño Requerido Descripción
companyName String 50 No Descripción de la empresa vinculada al usuario. Ejemplo: Argo
referenceCode String 50 No Código de empresa vinculado al usuario. Ejemplo: 4545
levelsCostCenter Niveles de centros de coste vinculados al usuario
Propiedad Tipo Tamaño Requerido Descripción
level Int 3 No Nível do Centro de Custo vinculado ao usuário:. Exemplo: 1
company String 50 No Nombre de la empresa a la que está vinculado el Centro de costes. Ejemplo: Argo
code String 30 Si Código de centro de coste. Ejemplo: 5654
acronym String 10 No Acrónimo de Cost Center. Ejemplo: AIO52
description String 50 Si Descripción del centro de costos. Ejemplo: Comercial

Respuesta

{
    "id": "00000000-0000-0000-0000-000000000000",
    "success": "yes",
    "message": "string"
}
Propiedad Tipo Tamaño Descripción
id Guid 36 ID de usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Sí = éxito, No = Fracaso. Ejemplo: Yes
message String 500 Mensaje que se muestra cuando hay un error en la actualización del usuario

GET /users

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
filters.actives String (Boolean) 5 No Filtro referente al estado del usuario (Activo / Inactivo). Ejemplo: True/False
filters.login string 50 No Filtro referente al login del usuario.

Respuesta

[
    {
      "changeDate": "2021-01-12T10:32:14.160Z",
      "userId": "00000000-0000-0000-0000-000000000000",
      "login": "string",
      "fullName": "string"
    }
]
Propiedad Tipo Tamaño Descripción
changeDate String (DateTime) 24 Fecha del último cambio en el registro del usuario. Ejemplo: 2019-09-18T16:48:22.490Z
userId Guid 36 ID de usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
login String 50 Inicio de sesión de usuario registrado. Ejemplo: Argo2019
fullName String 50 Nombre completo del usuario registrado. Ejemplo: Pedro Silva

POST /users

Solicitud

[
	{
		"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"
	}
]
Propiedad Tipo Tamaño Requerido Descripción
groups String (Enum) 9 Si Grupo al que pertenece el usuario: admin, financial, manager, user Argo Wiki .Ejemplo: user
fax String 30 No Fax de usuario. Ejemplo: 5511998525545
office String 50 No Puesto del usuario Ejemplo: analista de negocios
requester String (Enum) 3 No Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios. Ejemplo: Yes/No
vip String (Enum) 3 No Indica si el usuario es un viajero VIP. Ejemplo: Yes/No
masterNational String(Enum) 3 No Indica si el usuario es un viajero master nacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterInternational String (Enum) 3 No Indica si el usuario es un viajero master internacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterAdvancePayment String (Enum) 3 No Indica que el usuario es un usuario master de anticipo. Los usuarios con esta característica pueden solicitar anticipos sin necesidad de aprobación. Ejemplo: Yes/No
masterRefund String (Enum) 3 No Indica que el usuario es un master de rendición de cuentas. Los usuarios con esta función pueden hacer prestación de cuentas / reembolso sin la necesidad de aprobación. Ejemplo: Yes/No
requesterMaster String (Enum) 3 No Indica que el usuario es un solicitante master. Los usuarios con esta función pueden solicitar viajes para otros pasajeros sin aprobación. Ejemplo: Yes/No
thirdParty String (Enum) 3 No Indica si el usuario es un "tercero". Ejemplo: Yes/No
levelDescription String 50 No Descripción del nivel vinculado al usuario. Ejemplo: presidente
employeeId String 20 No Número de empleado del usuario Ejemplo: 56565
integrationCode String 50 No Código de integración del usuario. Ejemplo: 454555
companyName String 50 No Nombre de la empresa vinculada al usuario. Ejemplo: Argo
costCenterDescription String 50 No Descripción del centro de costo vinculado al usuario. Ejemplo: Ccosto de prueba
costCenterCode String 30 No Código del centro de costo vinculado al usuario. Ejemplo: 001
telephone String 30 No Teléfono del usuario Ejemplo: 5511998525545
department String 50 No Departamento vinculado al registro de usuarios. Ejemplo: desarrollo
local String 50 No Dirección del usuario Ejemplo: Alameda Santos, 1978
city String 50 No Ciudad donde reside el usuario. Ejemplo: São Paulo
star String 50 No Star está relacionado con el perfil de usuario de GDS Sabre. Ejemplo: SILVA/1234567
state String 2 No Estado donde reside el usuario. Ejemplo: SP
active String (Enum) 3 No Indica si el usuario está activo o inactivo. Ejemplo: Yes/No
zipCode String 11 No Código postal donde reside el usuario. Ejemplo: 36544875421
secretaryEmail String 256 No Correo electrónico de la secretaria vinculado al usuario. Ejemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 No Objeto responsable de transportar la información de la empresa del usuario
levelsCostCenter Object (LevelCostCenterVM) 1 No Objeto responsable de llevar la información del centro de costos vinculada al usuario
communityId Guid 36 No ID de comunidad vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 256 Si Dirección de correo electrónico del usuario a registrar. Ejemplo: pedro@silva.com
login String 256 Si Inicio de sesión del usuario a registrarse. Ejemplo: Argo2019
password String 256 Si Contraseña del usuario a registrar. Ejemplo: Argo2019@
firstName Strting 20 Si Nombre del usuario a registrar. Ejemplo: Pedro
lastName String 20 Si Apellido del usuario a registrar. Ejemplo: Silva
fullName String 100 Si Nombre completo del usuario a registrar. Ejemplo: Pedro Silva
userCompanies Empresa vinculada al usuario
Propiedad Tipo Tamaño Requerido Descripción
companyName String 50 No Descripción de la empresa vinculada al usuario. Ejemplo: Argo
referenceCode String 50 No Código de empresa vinculado al usuario. Ejemplo: 4545
levelsCostCenter Niveles de centros de coste vinculados al usuario
Propiedad Tipo Tamaño Requerido Descripción
level Int 3 No Nível do Centro de Custo vinculado ao usuário:. Exemplo: 1
company String 50 No Nombre de la empresa a la que está vinculado el Centro de costes. Ejemplo: Argo
code String 30 Si Código de centro de coste. Ejemplo: 5654
acronym String 10 No Acrónimo de Cost Center. Ejemplo: AIO52
description String 50 Si Descripción del centro de costos. Ejemplo: Comercial

Respuesta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]
Propiedad Tipo Tamaños Descripción
id Guid 36 ID de usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Yes = exito, No = Fracaso. Ejemplo: Yes
index String Posición de la lista. Ejemplo: 1
message String 500 Mensaje que se muestra cuando hay un error en la actualización del usuario

GET /users/{userId}/requesters

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

Solicitud

Solicitud GET

Respuesta

[
    {
        "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"
    }
]
Propiedad Tipo Tamaños Descripción
userId Guid 36 ID de usuario itinerante. Ejemplo: 00000000-0000-0000-0000-000000000000
userFullName String 50 Nombre completo del usuario viajero. Ejemplo: Pedro Silva
requesterId Guid 36 Solicitando identificación de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
requesterFullName String 100 Nombre completo del usuario solicitante. Ejemplo: Marcos Ribeiro
inclusionDate String (DateTime) 24 Fecha de inclusión del enlace entre el usuario solicitante y el usuario viajero. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Fecha de finalización del enlace entre el usuario solicitante y el usuario viajero. Ejemplo: 2019-09-18T16:48:22.490Z

PATCH /users (Obsoleto)

Este método está obsoleto y se eliminará en el futuro. Utilice el método "PUT /users/{userId}"

Solicitud

[
    {
        "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"
    }
]
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si ID de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
groups String (Enum) 9 Si Grupo al que pertenece el usuario: administrador, financiero, gerente, usuario. Argo Wiki. Ejemplo: user
fax String 30 No Fax de usuario. Ejemplo: 5511998525545
office String 50 No Puesto del usuario Ejemplo: analista de negocios
requester String (Enum) 3 No Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios). Ejemplo: Yes/No
vip String (Enum) 3 No Indica si el usuario es un viajero VIP. Ejemplo: Yes/No
masterNational String(Enum) 3 No Indica si el usuario es un viajero master nacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterInternational String (Enum) 3 No Indica si el usuario es un viajero master internacional (no se aprobarán solicitudes nacionales abiertas para este tipo de usuario). Ejemplo: Yes/No
masterAdvancePayment String (Enum) 3 No Indica que el usuario es un usuario master de anticipo. Los usuarios con esta característica pueden solicitar anticipos sin necesidad de aprobación. Ejemplo: Yes/No
masterRefund String (Enum) 3 No Indica que el usuario es un master de rendición de cuentas. Los usuarios con esta función pueden hacer prestación de cuentas / reembolso sin la necesidad de aprobación. Ejemplo: Yes/No
requesterMaster String (Enum) 3 No Indica que el usuario es un solicitante master. Los usuarios con esta función pueden solicitar viajes para otros pasajeros sin aprobación. Ejemplo: Yes/No
thirdParty String (Enum) 3 No Indica si el usuario es un "tercero". Ejemplo: Yes/No
levelDescription String 50 No Descripción del nivel vinculado al usuario. Ejemplo: presidente
employeeId String 20 No Número de empleado del usuario Ejemplo: 56565
integrationCode String 50 No Código de integración del usuario. Ejemplo: 454555
companyName String 50 No Nombre de la empresa vinculada al usuario. Ejemplo: Argo
costCenterDescription String 50 No Descripción del centro de costo vinculado al usuario. Ejemplo: Ccosto de prueba
costCenterCode String 30 No Código del centro de costo vinculado al usuario. Ejemplo: 001
telephone String 30 No Teléfono del usuario Ejemplo: 5511998525545
department String 50 No Departamento vinculado al registro de usuarios. Ejemplo: desarrollo
local String 50 No Dirección del usuario Ejemplo: Alameda Santos, 1978
city String 50 No Ciudad donde reside el usuario. Ejemplo: São Paulo
star String 50 No Star está relacionado con el perfil de usuario de GDS Sabre. Ejemplo: SILVA/1234567
state String 2 No Estado donde reside el usuario. Ejemplo: SP
active String (Enum) 3 No Indica si el usuario está activo o inactivo. Ejemplo: Yes/No
zipCode String 11 No Código postal donde reside el usuario. Ejemplo: 36544875421
secretaryEmail String 256 No Correo electrónico de la secretaria vinculado al usuario. Ejemplo: maria@silva.com
userCompanies Object (UserCompanyVM) 1 No Objeto responsable de transportar la información de la empresa del usuario
levelsCostCenter Object (LevelCostCenterVM) 1 No Objeto responsable de llevar la información del centro de costos vinculada al usuario
communityId Guid 36 No ID de comunidad vinculado al usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 256 Si Dirección de correo electrónico del usuario a registrar. Ejemplo: pedro@silva.com
login String 256 Si Inicio de sesión del usuario a registrarse. Ejemplo: Argo2019
password String 256 Si Contraseña del usuario a registrar. Ejemplo: Argo2019@
firstName Strting 20 Si Nombre del usuario a registrar. Ejemplo: Pedro
lastName String 20 Si Apellido del usuario a registrar. Ejemplo: Silva
fullName String 100 Si Nombre completo del usuario a registrar. Ejemplo: Pedro Silva
userCompanies Empresa vinculada al usuario
Propiedad Tipo Tamaño Requerido Descripción
companyName String 50 No Descripción de la empresa vinculada al usuario. Ejemplo: Argo
referenceCode String 50 No Código de empresa vinculado al usuario. Ejemplo: 4545
levelsCostCenter Niveles de centros de coste vinculados al usuario
Propiedad Tipo Tamaño Requerido Descripción
level Int 3 No Nível do Centro de Custo vinculado ao usuário:. Exemplo: 1
company String 50 No Nombre de la empresa a la que está vinculado el Centro de costes. Ejemplo: Argo
code String 30 Si Código de centro de coste. Ejemplo: 5654
acronym String 10 No Acrónimo de Cost Center. Ejemplo: AIO52
description String 50 Si Descripción del centro de costos. Ejemplo: Comercial

Respuesta

[
    {
        "id": "00000000-0000-0000-0000-000000000000",
        "success": "yes",
        "index": 0,
        "message": "string"
      }
]
Propiedad Tipo Tamaño Descripción
id Guid 36 ID de usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
success String (Enum) 3 Yes = éxito, No = Fracaso. Ejemplo: Yes
index String (Enum) 3 Posición del elemento en la matriz. Ejemplo: 1, 2, 3
message String 500 Mensaje que se muestra cuando hay un error en la actualización del usuario

PUT /users/{userId}/requesters

Este método es útil para los clientes que tienen habilitada la política "LISSOL" en su entorno.

Solicitud

[
    {
        "requesterId": "00000000-0000-0000-0000-000000000000",
        "requesterFullName": "string",
    }
]
Propiedad Tipo Tamaño Requerido Descripción
requesterId Guid 36 Si Solicitando ID relacionada con el usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
requesterFullName String 100 Si Nombre completo del usuario solicitante. Ejemplo: Marcos Ribeiro

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
Message String 5 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

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

Solicitud

Solicitud DELETE
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si Identificación relacionada con el usuario viajero. Ejemplo: 00000000-0000-0000-0000-000000000000
requesterId Guid 36 Si Solicitando ID relacionada con el usuario. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
Message String 5 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

GET /users/{userId}/representatives

Recupera delegados vinculados al usuario

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si Identificación de usuario a consultar con los delegados. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

[
    {
      "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"
    }
  ]
Propiedad Tipo Tamaño Descripción
whoReceivesEmail String (Enum) 28 Tipo de usuario que recibirá el correo electrónico de solicitud. Ejemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
fullName String 50 Nombre completo del delegado. Ejemplo: Cléber Machado
representativeId Guid 36 ID de usuario delegado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Fecha de inclusión del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 Fecha de finalización del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z
active String (Enum) 3 Indica si el delegado está activo o inactivo. Ejemplo: Yes/No

POST /users/{userId}/representatives

Solicitud

[
    {
        "whoReceivesEmail": "authorizerAndRepresentatives",
        "representativeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-01-14T10:21:17.687Z",
        "finalDate": "2021-01-14T10:21:17.687Z"
    }
]
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si Identificación relacionada con el usuario viajero. Ejemplo: 00000000-0000-0000-0000-000000000000
whoReceivesEmail String (Enum) 28 Si Tipo de usuario que recibirá el correo electrónico de solicitud. Ejemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
representativeId Guid 36 Si ID de usuario delegado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Si Fecha de inclusión del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 No Fecha de finalización del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
Message String 5 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

PUT /users/{userId}/representatives

Solicitud

[
    {
        "whoReceivesEmail": "authorizerAndRepresentatives",
        "representativeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-01-14T10:21:17.687Z",
        "finalDate": "2021-01-14T10:21:17.687Z"
    }
]
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si Identificación relacionada con el usuario viajero. Ejemplo: 00000000-0000-0000-0000-000000000000
whoReceivesEmail String (Enum) 28 Si Tipo de usuario que recibirá el correo electrónico de solicitud. Ejemplo: 'authorizerAndRepresentatives', 'onlyRepresentatives' ou 'onlyAuthorizer'
representativeId Guid 36 Si ID de usuario delegado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (DateTime) 24 Si Fecha de inclusión del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (DateTime) 24 No Fecha de finalización del enlace entre el usuario y el delegado. Ejemplo: 2019-09-18T16:48:22.490Z

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
Message String 5 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

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

Solicitud

Solicitud DELETE
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si ID relacionada con el usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
representativeId Guid 36 Si Identificación relacionada con el delegado. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
Message String 5 Éxito o fracaso en el uso del servicio. Ejemplo: True/False

ConfigsUsersProfile

El servicio le permite registrar datos de perfil para cada usuario, por ejemplo:

  • Datos bancarios
  • Tarjetas de millaje
  • Pasaporte
  • Visa
  • Fecha de nacimiento
  • RG/CPF

GET /users/{userId}/profile

Solicitud

solicitud GET

Respuesta

{
    "fullName": "string",
    "rg": "string",
    "cpf": "string",
    "birthDate": "2021-01-06T10:50:11.849Z",
    "observation": "string",
    "cellPhone": "string",
    "cellPhoneDDI": 0,
    "sendHTMLEmail": "yes",
    "sendPDFFile": "yes",
    "showMap": "yes",
    "smoker": "yes",
    "dashBoard": "yes",
    "aircraftPositions": [ "front" ],
    "seat": "window",
    "departureAirportIATA": "string",
    "typeOfMeal": "string",
    "gender": "male"
}
Propiedad Tipo Tamaño Descripción
fullName String 50 Nombre completo del usuario que aprueba. Ejemplo: João Silva
rg String 14 RG (documento nacional de identificación civil en Brasil) del usuario que canceló el SO. Ejemplo: 265487745
cpf String 14 CPF (registro de personas en Brasil) del usuario que cancela el SO. Ejemplo: 36548425612
birthDate String (Date-Time) 10 Fecha de nacimiento del viajero. Ejemplo: 2019-11-19T17:55:32.002Z
observation String 255 Nota insertada en el perfil del usuario. Ejemplo: usuario con restricciones dietéticas
cellPhone Int 11 Teléfono de usuario. Ejemplo:236548856
cellPhoneDDI Int 4 Marcación directa internacional (DDI) relacionada con el teléfono del usuario. Ejemplo:55
sendHTMLEmail String (Enum) 3 Define el formato HTML para enviar correos electrónicos. Ejemplo:Yes/No
sendPDFFile String (Enum) 3 Define el formato HTML para enviar correos electrónicos. Ejemplo: Yes/No
showMap String (Enum) 3 Determina si el usuario tendrá acceso al mapa de acento. Ejemplo: Yes/No
smoker String (Enum) 3 Define si el usuario es fumador. Ejemplo: Yes/No
dashBoard String 3 Información que define si el usuario usa el menú del Tablero en el sistema. Ejemplo: Yes/No
aircraftPositions String (Enum) 6 Preferencia del usuario en el posicionamiento de la aeronave. Ejemplo: front, middle ou back
seat String (Enum) Preferencia de asiento del usuario. Ejemplo: window ou aisle
departureAirportIATA String 50 Aeropuerto de origen utilizado con frecuencia por el usuario. Ejemplo: Congonhas
typeOfMeal String 50 Tipo de comida preferido por el usuario. Ejemplo: Massa
gender String 6 Género declarado en el perfil del usuario. Ejemplo: 'male' ou 'female'

PUT /users/{userId}/profile

Requisição

{
    "rg": "string",
    "cpf": "string",
    "birthDate": "2021-01-06T10:50:11.856Z",
    "observation": "string",
    "cellPhone": "string",
    "cellPhoneDDI": 0,
    "sendHTMLEmail": "yes",
    "sendPDFFile": "yes",
    "showMap": "yes",
    "smoker": "yes",
    "dashBoard": "yes",
    "aircraftPositions": ["front", "middle", "back"],
    "seat": "window",
    "typeOfMeal": "string",
    "gender": "male"
    "departureAirportIATA": "string",
}
Propiedad Tipo Tamaño Requerido Descripción
rg String 14 No RG (documento nacional de identificación civil en Brasil) del usuario que canceló el SO. Ejemplo: 265487745
cpf String 12 No CPF (registro de personas en Brasil) del usuario que cancela el SO. Ejemplo: 36548425612
birthDate String (Date-Time) 10 No Fecha de nacimiento del viajero. Ejemplo: 2019-11-19T17:55:32.002Z
observation String 255 No Nota insertada en el perfil del usuario. Ejemplo: Usuário com restrições alimentares
cellPhone Int 30 No Teléfono de usuario. Ejemplo: 236548856
cellPhoneDDI Int 4 No Marcación directa internacional (DDI) relacionada con el teléfono del usuario. Ejemplo: 55
sendHTMLEmail String (Enum) 3 No Define el formato HTML para enviar correos electrónicos. Ejemplo: Yes/No
sendPDFFile String (Enum) 3 No Define el formato HTML para enviar correos electrónicos. Ejemplo: Yes/No
showMap String (Enum) 3 No Determina si el usuario tendrá acceso al mapa de acento. Ejemplo: Yes/No
smoker String (Enum) 3 No Define si el usuario es fumador. Ejemplo: Yes/No
dashBoard String 3 No Información que define si el usuario usa el menú del Tablero en el sistema. Ejemplo: Yes/No
aircraftPositions String (Enum) 6 No Preferencia del usuario en el posicionamiento de la aeronave. Ejemplo: front, middle ou back
seat String (Enum) No Preferencia de asiento del usuario. Ejemplo: window ou aisle
typeOfMeal String 50 No Tipo de comida preferido por el usuario. Ejemplo: Massa
gender String 6 No Género declarado en el perfil del usuario. Ejemplo: 'male' ou 'female'
departureAirportIATA String 50 No Aeropuerto de origen utilizado con frecuencia por el usuario. Ejemplo: Congonhas

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Informa se a atualização foi realizada com sucesso. Exemplo: True/False

GET /users/{userId}/profile/frequentFlyers

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "number": "string",
  "marketingAirline": "string"
}
Propiedad Tipo Tamaño Descripción
sequence Number 1 Número secuencial de millas. Ejemplo: 1, 2, 3, 4, 5 o 6
number String 20 Cantidad de millas disponibles. Ejemplo: 265487745
marketingAirline String 3 Acrónimo de la aerolínea CIA donde se vinculan las millas. Ejemplo: JJ, AD, AA

PUT /users/{userId}/profile/frequentFlyers

Requisição

[{
  "sequence": 0,
  "number": "string",
  "marketingAirline": "string"
}]
Propiedad Tipo Tamaño Requerido Descripción
sequence Number 1 No Número secuencial de millas. Ejemplo: 1, 2, 3, 4, 5 o 6
number String 20 Si Cantidad de millas disponibles. Ejemplo: 15000
marketingAirline String 3 Si Acrónimo de la aerolínea CIA donde se vinculan las millas. Ejemplo: JJ, AD, AA

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

GET /users/{userId}/profile/passports

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "passport": "string",
  "validity": "2021-01-06T10:50:11.867Z",
  "country": "string"
}
Propiedad Tipo Tamaño Descripción
sequence Number 1 Número secuencial de pasaportes. Ejemplo: 1, 2
passport String 30 Número de pasaporte. Ejemplo: BR123456
validity String (DateTime) 24 Fecha de expiración del pasaporte. Ejemplo: 2026-01-06T10:50:11.867Z
country String 100 País de origen del pasaporte. Ejemplo: Brasil

PUT /users/{userId}/profile/passports

Requisição

[{
  "sequence": 0,
  "passport": "string",
  "validity": "2021-01-06T10:50:11.867Z",
  "country": "string"
}]
Propiedad Tipo Tamaño Requerido Descripción
sequence Number 1 No Número secuencial de pasaportes. Ejemplo: 1, 2
passport String 30 Si Número de pasaporte. Ejemplo: BR123456
validity String (DateTime) 24 Si Fecha de expiración del pasaporte. Ejemplo: 2026-01-06T10:50:11.867Z
country String 2 Si Acrónimo del país de origen del pasaporte. Ejemplo: BR

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

GET /users/{userId}/profile/visas

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "visa": "string",
  "validity": "2021-01-06T10:50:11.875Z",
  "country": "string",
  "type": "tourism"
}
Propiedad Tipo Tamaño Descripción
sequence Number 1 Número secuencial de visas. Ejemplo: 1, 2, 3
visa String 30 Costo de la visa. Ejemplo: 60444378
validity String (DateTime) 24 Fecha de vencimiento de la visa. Ejemplo: 2026-01-06T10:50:11.867Z
country String 100 País de origen de la visa. Ejemplo: Brasil
type String (Enum) 8 Tipo de visa. Ejemplo: 'tourism', 'business'

PUT /users/{userId}/profile/visas

Requisição

[{
  "sequence": 0,
  "visa": "string",
  "validity": "2021-01-06T10:50:11.875Z",
  "country": "string",
  "type": "tourism"
}]
Propiedad Tipo Tamaño Requerido Descripción
sequence Number 1 No Número secuencial de visas. Ejemplo: 1, 2, 3
visa String 30 Si Valor do visto. Exemplo: 60444378
validity String (DateTime) 24 Si Fecha de vencimiento de la visa. Ejemplo: 2026-01-06T10:50:11.867Z
country String 2 Si Acrónimo del país de origen de la visa. Ejemplo: BR
type String (Enum) 8 Si Tipo de visa. Ejemplo: 'tourism', 'business'

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

GET /users/{userId}/profile/vaccines

Requisição

requisição GET

Resposta

{
  "sequence": 0,
  "vaccine": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}
Propiedad Tipo Tamaño Descripción
sequence Number 1 Número secuencial de vacuna. Ejemplo: 1, 2, 3
vaccine String 30 Nombre de la vacuna. Ejemplo: Coronavac
validity String (DateTime) 24 Fecha de caducidad de la vacuna. Ejemplo: 2026-01-06T10:50:11.867Z

PUT /users/{userId}/profile/vaccines

Requisição

[{
  "sequence": 0,
  "vaccine": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}]
Propiedad Tipo Tamaño Requerido Descripción
sequence Number 1 No Número secuencial de vacuna. Ejemplo: 1, 2, 3
vaccine String 30 Si Nombre de la vacuna. Ejemplo: Coronavac
validity String (DateTime) 24 Si Fecha de caducidad de la vacuna. Ejemplo: 2026-01-06T10:50:11.867Z

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

GET /users/{userId}/profile/creditcards

Requisição

requisição GET

Resposta

[{
  "cardNumber": "string",
  "holderName": "string",
  "validity": "2021-01-06T10:50:11.875Z",
}]
Propiedad Tipo Tamaño Descripción
cardNumber string 20 Número de tarjeta vinculado al perfil del usuario. Ejemplo: 0000-XXXX-XXXX-0000
holderName String 255 Nombre del titular de la tarjeta. Ejemplo: CLÉBER SOARES S. OLIVEIRA
validity String (DateTime) 24 Fecha de vencimiento de la tarjeta. Ejemplo: 2026-01-06T10:50:11.867Z

GET /users/{userId}/profile/expensecards

Requisição

requisição GET

Resposta

[{
    "cardId": "00000000-0000-0000-0000-000000000000",
    "cardNumber": "string",
    "inclusionDate": "2020-02-10T15:40:01.022Z",
    "flagCard": "string"
}]
Propiedad Tipo Tamaño Descripción
cardId String(Guid) 36 Identificación de tarjeta registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
cardNumber string 20 Número de tarjeta vinculado al perfil del usuario. Ejemplo: 0000-XXXX-XXXX-0000
inclusionDate DateTime 24 Fecha / hora de inclusión / creación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
flag String 15 Banner de tarjeta. Ejemplo: Master card, Visa

PUT /users/{userId}/profile/vaccines

Requisição

{
    "cardNumber": "string",
    "flagCard": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
cardNumber string 20 Si Número de tarjeta vinculado al perfil del usuario. Ejemplo: 0000-XXXX-XXXX-0000
flag String 15 Si Banner de tarjeta. Ejemplo: Master card, Visa

Resposta

resposta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la actualización se realizó correctamente. Ejemplo: True/False

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

Requisição

requisição DELETE
Propiedad Tipo Tamaño Requerido Descripción
expenseCardId Guid 36 Si Identificación de la tarjeta a eliminar. Ejemplo: 00000000-0000-0000-0000-000000000000

Resposta

resposta DELETE
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o no al eliminar una tarjeta. Ejemplo: True/False

ConfigsCommunities

Las comunidades le permiten organizar grupos de usuarios comerciales que necesitan ver y / o interactuar en las solicitudes de los demás. Consulte el Wiki para obtener más detalles y personalizaciones de la comunidad.
Argo Wiki

GET

Solicitud

Solicitud GET

Respuesta

[
    {
        "communityId": "802720fe-c657-47d4-9e8d-76145001da38",
        "changeDate": "2019-09-19T17:20:43.837",
        "inclusionDate": "2019-09-19T17:20:43.837",
        "clienteId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "type": "close",
        "name": "Comunidade B",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "active": "yes"
    }
]
Propiedad Tipo Tamaño Descripción
communityId Guid 36 ID de la comunidad registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
changeDate String (Date-Time) 24 Fecha / hora del último cambio en el registro de la comunidad. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date-Time) 24 Fecha / hora de registro comunitario. Ejemplo: ejemplo: 2019-09-18T16:48:22.490Z
clienteId Guid 36 ID de cliente con el que está registrada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Si el usuario pertenece a una comunidad abierta, verá e interactuará con las solicitudes de los solicitantes que pertenecen a la misma comunidad. Si el usuario pertenece a una comunidad cerrada, no podrá ver ni interactuar con las solicitudes de los solicitantes en esa comunidad. Si el usuario se relaciona con una comunidad (S) abierta o cerrada, verá las solicitudes de los viajeros en esa (s) comunidad (es) pero solo verá, sin interacción. Ejemplo: open/close
name String 50 Nombre de la comunidad Ejemplo: comunidad operativa
companyId Guid 36 ID de la empresa a la que está vinculada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Identifica si la comunidad está activa o inactiva. Ejemplo: Yes/No

GET /communities/{communityId}

Solicitud

Solicitud GET /communities/{communityId}

Respuesta

[
    {
        "communityId": "802720fe-c657-47d4-9e8d-76145001da38",
        "changeDate": "2019-09-19T17:20:43.837",
        "inclusionDate": "2019-09-19T17:20:43.837",
        "clienteId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
        "type": "close",
        "name": "Comunidade B",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "active": "yes"
    }
]
Propiedad Tipo Tamaño Descripción
communityId Guid 36 ID de la comunidad registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
changeDate String (Date-Time) 24 Fecha / hora del último cambio en el registro de la comunidad. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date-Time) 24 Fecha / hora de registro comunitario. Ejemplo: ejemplo: 2019-09-18T16:48:22.490Z
clienteId Guid 36 ID de cliente con el que está registrada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Si el usuario pertenece a una comunidad abierta, verá e interactuará con las solicitudes de los solicitantes que pertenecen a la misma comunidad. Si el usuario pertenece a una comunidad cerrada, no podrá ver ni interactuar con las solicitudes de los solicitantes en esa comunidad. Si el usuario se relaciona con una comunidad (S) abierta o cerrada, verá las solicitudes de los viajeros en esa (s) comunidad (es) pero solo verá, sin interacción. Ejemplo: open/close
name String 50 Nombre de la comunidad Ejemplo: comunidad operativa
companyId Guid 36 ID de la empresa a la que está vinculada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Identifica si la comunidad está activa o inactiva. Ejemplo: Yes/No

POST

Solicitud

{
    "type": "open",
    "name": "Comunidade API ARGO",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes"
}
Propiedad Tipo Tamaño Requerido Descripción
type String (Enum) 5 Si Si el usuario pertenece a una comunidad abierta, verá e interactuará con las solicitudes de los solicitantes que pertenecen a la misma comunidad. Si el usuario pertenece a una comunidad cerrada, no podrá ver ni interactuar con las solicitudes de los solicitantes en esa comunidad. Si el usuario se relaciona con una comunidad (S) abierta o cerrada, verá las solicitudes de los viajeros en esa (s) comunidad (es) pero solo verá, sin interacción. Ejemplo: open/close
name String 50 Si Nombre de la comunidad Ejemplo: comunidad operativa
companyId Guid 36 No ID de empresa a la que está vinculada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Identifica si la comunidad está activa o inactiva. Ejemplo: Yes/No

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
message String 5 Informa si la comunidad se ha registrado con éxito. Ejemplo: True/False

PUT

Solicitud

{
    "communityId": "00000000-0000-0000-0000-000000000000",
    "type": "open",
    "name": "Comunidade API ARGO",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "active": "yes"
}
Propiedad Tipo Tamaño Requerido Descripción
communityId Guid 36 Si ID de comunidad registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
type String (Enum) 5 Si Si el usuario pertenece a una comunidad abierta, verá e interactuará con las solicitudes de los solicitantes que pertenecen a la misma comunidad. Si el usuario pertenece a una comunidad cerrada, no podrá ver ni interactuar con las solicitudes de los solicitantes en esa comunidad. Si el usuario se relaciona con una comunidad (S) abierta o cerrada, verá las solicitudes de los viajeros en esa (s) comunidad (es) pero solo verá, sin interacción. Ejemplo: open/close
name String 50 Si Nombre de la comunidad Ejemplo: comunidad operativa
companyId Guid 36 No ID de empresa a la que está vinculada la comunidad. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Identifica si la comunidad está activa o inactiva. Ejemplo: Yes/No

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la comunidad se ha modificado correctamente. Ejemplo: True/False

DELETE

Solicitud

Solicitud DELETE
Propiedad Tipo Tamaño Requerido Descripción
communityId Guid 36 Si ID de comunidad registrada. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la comunidad se ha inactivado correctamente. Ejemplo: True/False

ConfigsProjects

Las corporaciones pueden llevar a cabo una serie de controles, vinculando solicitudes a proyectos, como control de presupuesto, política de viajes, etc. A través de la API de Argo es posible mantener los registros del proyecto siempre actualizados. Más informaciones.

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"projectId": "e23c742b-8b3a-480e-9cad-bd9a1b33f1ac",
		"clientId": "ebab7b76-44c7-426f-97ea-22c1cc71ee65",
		"inclusionDate": "2019-11-07T17:26:25.333",
		"changeDate": "2019-11-07T17:26:25.333",
		"code": "001",
		"name": "Projeto API ARGO",
		"acronym": "ABC",
		"initialDate": "2019-11-07T00:00:00",
		"finalDate": "2019-11-30T00:00:00",
		"companyId": "a00bed32-9f2d-4748-9b0b-6c761c348ecf",
		"active": "yes"
	}
]
Propiedad Tipo Tamaño Descripción
projectId Guid 36 ID del proyecto registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID de cliente al que está vinculado el proyecto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Indica si el proyecto está activo o inactivo. Ejemplo: Yes/No
inclusionDate String (Data-Time) 24 Fecha / hora de inclusión / creación del cliente. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Data-Time) 24 Fecha / hora del último cambio del cliente. Ejemplo: 2019-09-18T16:48:22.490Z
code String 30 Código relacionado con el proyecto, utilizado en algunas situaciones para la integración con sistemas de terceros.
name String 50 Nombre del proyecto. Ejemplo: proyecto API Argo
acronym String 10 Acrónimo de centro de coste. Ejemplo: 7829
initialDate String (Data-Time) 24 Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-30T00:00:00
companyId Guid 36 ID de la empresa vinculada al proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 El sistema Argo le permite crear la lista de Proyectos (Padre - Hijo). Esta propiedad permite identificar al "Padre" del Proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000

POST

Solicitud

{
	"code": "002",
	"name": "Projeto Argo",
	"acronym": "XYZ",
	"initialDate": "2019-11-07T20:37:57.461Z",
	"finalDate": "2019-11-07T20:37:57.461Z",
	"active": "yes"
}
Propiedad Tipo Tamaño Requerido Descripción
code String 30 Si Código relacionado con el proyecto, utilizado en algunas situaciones para la integración con sistemas de terceros.
name String 50 Si Nombre del proyecto. Ejemplo: proyecto API Argo
acronym String 10 No Acrónimo de centro de coste. Ejemplo: 7829
initialDate String (Data-Time) 24 No Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 No Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-30T00:00:00
companyId Guid 36 No ID de la empresa vinculada al proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 No El sistema Argo le permite crear la lista de Proyectos (Padre - Hijo). Esta propiedad permite identificar al "Padre" del Proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Indica si el proyecto está activo o inactivo. Ejemplo: Yes/No

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
ID Guis 36 ID del proyecto registrado. Ejemplo: 00000000-0000-0000-0000-000000000000

PUT

Solicitud

{
	"code": "003",
	"name": "Projeto Argo",
	"acronym": "XYZ",
	"initialDate": "2019-11-07T20:37:57.461Z",
	"finalDate": "2020-11-07T20:37:57.461Z",
	"active": "yes"
}
Propiedad Tipo Tamaño Requerido Descripción
projectId Guid 36 Si ID del proyecto que desea cambiar. Ejemplo: 00000000-0000-0000-0000-000000000000
code String 30 Si Código relacionado con el proyecto, utilizado en algunas situaciones para la integración con sistemas de terceros.
name String 50 Si Nombre del proyecto. Ejemplo: proyecto API Argo
acronym String 10 No Acrónimo de centro de coste. Ejemplo: 7829
initialDate String (Data-Time) 24 No Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-07T00:00:00
finalDate String (Data-Time) 24 No Es posible determinar un período en el que se le puede asignar una deuda al Proyecto. Solo las solicitudes que están dentro del período definido se pueden abrir a través de las propiedades initialDate y finalDate. Ejemplo: 2019-11-30T00:00:00
companyId Guid 36 No ID de la empresa vinculada al proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
projectParentId Guid 36 No El sistema Argo le permite crear la lista de Proyectos (Padre - Hijo). Esta propiedad permite identificar al "Padre" del Proyecto devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 No Indica si el proyecto está activo o inactivo. Ejemplo: Yes/No

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Indica si la comunidad se ha actualizado correctamente. Ejemplo: True/False

ConfigsBudgets

A través del sistema Argo es posible llevar a cabo un control de presupuesto mensual o por solicitud. El presupuesto siempre debe estar vinculado a un centro de costos y una cuenta de contable.

Además del registro, es posible realizar el ajuste del presupuesto (más o menos), según sea necesario. Consulte el Wiki para obtener más detalles del presupuesto.

GET /budgets

Solicitud

requisição GET
Propiedad Tipo Tamaño Requerido Descripción
filters.active String (Enum) 3 No Filtre el estado del presupuesto (activo / inactivo). Ejemplo: Yes/No.
filters.costCenterId Guid 36 No Filtro referente al código del centro de coste vinculado al presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.ledgerAccountId Guid 36 No Filtro referido al código de cuenta vinculado al presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.date String (Date Time) 24 No Filtra por el período en el que funcionará el presupuesto. Se considerará mes y año.
filters.companyId Guid 36 No Filtro referente al estado del campo de gestión (Activo / Inactivo). Ejemplo: yes/no
filters.observation String 255 No Filtro relacionado con la observación del Presupuesto registrado. Ejemplo: Presupuesto disponible
filters.order String 30 No Filtro referente a la Solicitud de Presupuesto. Un presupuesto debe ser por período o por solicitud
filters.budgetedValue Number (Decimal) 100 No Filtro referente al importe del presupuesto creado. Ejemplo: 50.00

Respuesta

[ 
	{ 
		"budgetId": "00000000-0000-0000-0000-000000000000", 
		"active": "yes", 
		"ledgerAccountDescription": "string", 
		"costCenterDescription": "string", 
		"costCenterCode": "string", 
		"companyName": "string", 
		"inclusionDate": "2020-02-10T14:45:59.709Z", 
		"changeDate": "2020-02-10T14:45:59.709Z", 
		"finalDate": "2020-02-10T14:45:59.709Z", 
		"changeUser": "string", 
		"finalUser": "string", 
		"budgetedValue": 0, 
		"adjustedValue": 0, 
		"companyId": "00000000-0000-0000-0000-000000000000", 
		"ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
		"costCenterId": "00000000-0000-0000-0000-000000000000", 
		"observation": "string", 
		"date": "2020-02-10T14:45:59.709Z", 
		"order": "string" 
	} 
]
Propiedad Tipo Tamaño Descripción
budgetId Guid 36 ID del presupuesto consultado. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Estado de registro del presupuesto (activo / inactivo). Ejemplo: Yes/No
ledgerAccountDescription String 50 Descripción de la cuenta contable. Ejemplo: materiales
costCenterDescription String 50 Descripción del centro de costo vinculado al presupuesto. Ejemplo: desarrollo
costCenterCode String 30 Código del Centro de Costo. Exemplo: 001
companyName String 30 Nombre de la empresa. Ejemplo: Argo Solutions
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / creación del presupuesto. Ejemplo: 2020-02-10T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora de cambio de presupuesto. Ejemplo: 2020-02-10T09:48:22.490Z
finalUser String 100 Usuario que finalizó la estructura del presupuesto. Ejemplo: “João Tamboré”
budgetedValue Number 14 Presupuesto creado. Ejemplo: 50.000
adjustedValue Number 14 Presupuesto ajustado. Puede ser positivo o negativo. Ejemplo: -10.000
companyId Guid 36 ID de la empresa vinculada al Presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
ledgerAccountId Guid 36 ID de la cuenta contable vinculada al presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID del centro de costo vinculado al presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
observation String 255 Observación del presupuesto registrado. Ejemplo: presupuesto disponible
date String (Date Time) 24 Período cuando el presupuesto funcionará. Mes y año serán considerados.
order String 30 Solicitud de presupuesto. Un presupuesto debe ser por período o por solicitud

POST /budgets

Solicitud

{ 
	"companyId": "00000000-0000-0000-0000-000000000000", 
	"ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
	"costCenterId": "00000000-0000-0000-0000-000000000000", 
	"budgetedValue": 0, 
	"observation": "string", 
	"date": "2020-02-10T13:00:03.551Z", 
	"order": "string" 
}
Propiedad Tipo Tamaño Requerido Descripción
companyId Guid 36 No ID de la empresa Ejemplo: 09109
ledgerAccountId Guid /td> 36 Si ID de cuenta de contable Ejemplo 2929
costCenterId Guid 36 Si ID del centro de costos. Ejemplo: 001
budgetedValue Number 14 Si Cantidad disponible del presupuesto que se está creando. Ejemplo 1.000
observation String 255 No Observación del presupuesto. Aquí encontrará más detalles del presupuesto. Ejemplo: presupuesto disponible para...
date String (dateTime) 24 No Período de presupuesto efectivo. Un presupuesto debe ser por Período o por Solicitud
order String 30 No Solicitud de presupuesto. Un presupuesto debe ser por Período o por Solicitud

Respuesta

Propiedad Tipo Tamaño Descripción
Id Guid 36 ID del registro realizada. Ejemplo: 00000000-0000-0000-0000-000000000000

GET /budgets/{budgetId}

Solicitud

requisição GET
Propiedad Tipo Tamaño Requerido Descripción
BudGetID Guid 36 Si ID del presupuesto que desea ver los detalles. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

{ 
	"budgetId": "00000000-0000-0000-0000-000000000000", 
    "active": "yes", 
    "ledgerAccountDescription": "string", 
    "costCenterDescription": "string", 
    "costCenterCode": "string", 
    "companyName": "string", 
    "inclusionDate": "2020-02-08T14:37:53.19", 
    "changeDate": "2020-02-08T14:37:53.19", 
    "finalUser": "string", 
    "budgetedValue": 0, 
    "adjustedValue": 0, 
    "companyId": "00000000-0000-0000-0000-000000000000", 
    "ledgerAccountId": "00000000-0000-0000-0000-000000000000", 
    "costCenterId": "00000000-0000-0000-0000-000000000000", 
    "observation": "string", 
    "date": "2020-03-01T00:00:00",
    "balance": 0,
    "budgetAdjusted": [
        {
            "sequence": 0,
            "adjustedValue": 0,
            "changeUser": "string",
            "inclusionDate": "2020-10-29T10:32:26.302Z",
            "observation": "string"
        }
    ]
}
Propiedad Tipo Tamaño Descripción
budgetId Guid 36 ID del presupuesto consultado. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Estado de registro del presupuesto (activo / inactivo). Ejemplo: Yes/No
ledgerAccountDescription String 50 Descripción de la cuenta contable vinculada al presupuesto. Ejemplo: material
costCenterDescription String 50 Descripción del centro de costo vinculado al presupuesto. Ejemplo: desarrollo
costCenterCode String 30 Código del centro de costos vinculado al presupuesto. Ejemplo: 001
companyName String 30 Nombre de la empresa vinculada al presupuesto Ejemplo: Argo Solutions
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / creación del presupuesto. Ejemplo: 2020-02-10T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora de cambio de presupuesto. Ejemplo: 2020-02-10T09:48:22.490Z
finalUser String 100 Usuario que finalizó la estructura del presupuesto. Ejemplo: João Tamboré
budgetedValue Number 14 Cantidad de presupuesto registrada. Ejemplo: 50.000
adjustedValue Number 14 Presupuesto ajustado. Puede ser positivo o negativo. Ejemplo: -10.000
companyId Guid 36 ID de la empresa vinculado al Presupuesto. Ejemplo: 00000000-0000-0000-0000-000000000000
ledgerAccountId Guid 36 ID de la cuenta contable. Ejemplo: 00000000-0000-0000-0000-000000000000
costCenterId Guid 36 ID del centro de costo. Ejemplo: 00000000-0000-0000-0000-000000000000
observation String 255 Observación del Presupuesto creado. Ejemplo: prueba
date String (Date Time) 24 Período en que el presupuesto será válido. Se considerará mes y año. Ejemplo: 01/2020
balance Number (Decimal) 100 Importe del saldo presupuestario actual. Ejemplo: 150.00 ou -150.00
budgetAdjusted BudgetAdjustedRSVM (Object) 1 Historial de ajuste presupuestario
budgetAdjusted Objeto responsable de llevar la información presupuestaria histórica
Propiedad Tipo Tamaño Descripción
sequence Number (Int) 100 Identificador de ajuste realizado. Ejemplo: 1, 2, 3
adjustedValue Number (Decimal) 100 Valor ajustado. Ejemplo: 150.00 ou -150.00
changeUser String 255 Nombre completo del usuario que realizó el ajuste. Ejemplo: Jorge Machado
inclusionDate String (DateTime) 24 Fecha de inclusión del ajuste. Ejemplo: 2018-12-12T17:25:00.980
observation String 255 Observación del ajuste realizado al presupuesto. Ejemplo: monto aumentado para la corrección de tarifas

PUT

Solicitud

{ 
	"active": "yes", 
	"observation": "string", 
	"adjustedObservation": "string", 
	"adjustedValue": 0 
}
Propiedad Tipo Tamaño Requerido Descripción
active String (Enum) 3 Si Estado de registro del presupuesto (activo / inactivo). Ejemplo: Yes/No
observation String 255 No Observación del presupuesto que se cambiará. Ejemplo: presupuesto de prueba
adjustedObservation String 255 Si Descripción / observación del ajuste presupuestario. El presupuesto se puede ajustar más o menos. Ejemplo: ajuste para marzo
adjustedValue Number (Decimal) 14 Si Importe de ajuste presupuestario: ejemplo: +10.000

Respuesta

Propiedad Tipo Tamaño Descripción
Mensagem string 4 Éxito o fracaso en la actualización del método de pago. Ejemplo: True/False

ConfigsCards

El sistema Argo permite que se administren las tarjetas de la corporación a través de la API, manteniendo el método de pago siempre actualizado para que puedan usarse en las solicitudes de viaje. Para obtener más información sobre la configuración de la tarjeta de crédito, consulte elWiki.

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"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"
	}
]
Propiedad Tipo Tamaño Descripción
cardId String(Guid) 36 ID de la tarjeta registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 Fecha / hora de inclusión / creación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 Fecha / hora del último cambio de tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 ID del usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
user String 20 Usuario de la tarjeta registrado en el sistema. Ejemplo: Pedro
flag String 15 Banner de tarjeta Ejemplo: Master card, Visa
typePayment String 100 Tipo de pago vinculado a la tarjeta. Ejemplo: facturado
community String 50 Comunidad vinculada a la tarjeta. Ejemplo: equipo técnico
userEmail String 512 Correo electrónico del usuario con el que está relacionada la tarjeta. Ejemplo: useargo@argo.com
userLogin String 256 Inicio de sesión del usuario con el que está relacionada la tarjeta. Ejemplo: argo.solutions
requester String 3 Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios. Ejemplo: Yes/No
cardNumber String 50 Número de tarjeta registrada. Ejemplo: 4569-7654-9876-1678
securityCode String 4 Código de seguridad de la tarjeta registrada. Ejemplo: 658
expirationDate DateTime 24 Fecha de vencimiento de la tarjeta registrada. Ejemplo: 2019-09-18
holder String 50 Nombre que está impreso en la tarjeta. Ejemplo: Lorenzo M. Magalhães
holderCpf String 12 CPF que está impreso en la tarjeta. Ejemplo...: 123.321.231-23
holderPassport String 15 Número de pasaporte del titular de la tarjeta. Ejemplo: BR123456
address String 50 Domicilio registrado del titular de la tarjeta. Ejemplo: Rua figueiroa barros 145
neighborHood String 30 Barrio del titular de la tarjeta registrada. Ejemplo: Vila das laranjeiras
city String 30 Ciudad del titular de la tarjeta registrada. Ejemplo: São Paulo
acronymState String 2 Acrónimo del estado del titular de la tarjeta registrado en el sistema. Ejemplo: SP
countryCode String 3 Código de país del titular de la tarjeta registrado en el sistema. Ejemplo: 55
cep String 11 CEP del titular de la tarjeta registrado en el sistema. Ejemplo: 89456-818
active String(Enum) 3 Indica si la tarjeta está activa o inactiva. Ejemplo: Yes/No
virtual String(Enum) 3 Indica si la tarjeta es virtual. Ejemplo: Yes/No

POST

Solicitud

Solicitud POST
Propiedad Tipo Tamaño Requerido Descripción
cardId String(Guid) 36 No ID de la tarjeta registrada. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate DateTime 24 No Fecha / hora de inclusión / creación de la tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate DateTime 24 No Fecha / hora del último cambio de tarjeta. Ejemplo: 2019-09-18T16:48:22.490Z
userId String(Guid) 36 No ID de usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
user String 20 No Usuario de la tarjeta registrado en el sistema. Ejemplo: Pedro
flag String 15 No Banner de tarjeta Ejemplo: Master card, Visa
typePayment String 100 Si Tipo de pago registrado en la tarjeta. Ejemplo: facturado
community String 50 No Comunidad con la que está relacionada la estructura de aprobación. Ejemplo: equipo técnico
userEmail String 512 No Correo electrónico del usuario con el que está relacionada la tarjeta. Ejemplo: useargo@argo.com
userLogin String 256 No Inicio de sesión del usuario con el que está relacionada la tarjeta. Ejemplo: argo.solutions
requester String 3 No Indica si el usuario es un "solicitante" (que puede solicitar viajes para otros usuarios). Ejemplo: Yes/No
cardNumber String 50 Si Número de tarjeta registrada. Ejemplo: 4569-7654-9876-1678
securityCode String 3 Si Código de seguridad de la tarjeta registrada. Ejemplo: 658
expirationDate DateTime 24 Si Fecha de vencimiento de la tarjeta registrada. Ejemplo: 2019-09-18
holder String 50 Si Nombre que está impreso en la tarjeta. Ejemplo: Lorenzo M. Magalhães
holderCpf String 12 No CPF (Registro de contribuyente individual) del titular de la tarjeta. Ejemplo: 123.321.231-23
holderPassport String 15 No Número de pasaporte del titular de la tarjeta. Ejemplo: BR123456
address String 50 No Domicilio registrado del titular de la tarjeta. Ejemplo: Rua figueiroa barros 145
neighborHood String 30 No Barrio registrado del titular de la tarjeta. Ejemplo: Vila das laranjeiras
city String 30 No Ciudad del titular de la tarjeta registrada. Ejemplo: São Paulo
acronymState String 2 No Acrónimo del estado del titular de la tarjeta registrado en el sistema. Ejemplo: SP
countryCode String 3 No Código de país del titular de la tarjeta registrado en el sistema. Ejemplo: 55
cep String 11 No CEP del titular de la tarjeta registrado en el sistema. Ejemplo: 89456-818
active String(Enum) 3 Si Indica si la tarjeta está activa o inactiva. Ejemplo: Yes/No
virtual String(Enum) 3 Si Indica si la tarjeta es virtual. Ejemplo: Yes/No

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

ConfigsManagementFields

A través de este método, es posible obtener toda la información relacionada con los campos gerenciales de su base de datos, además de permitir la administración (exclusión, inserción y alteración) de los campos gerenciales encontrados en los respectivos clientes.

GET /managementsfields

Solicitud

Solicitud GET

Respuesta

[
	{
        "clientId": "string",
        "expenseId": "string",
        "fieldId": "string",
        "caracterQuantity": 0,
        "finalizationDate": "string",
        "inclusionDate": "string",
        "integrationCode": "string",
        "lenght" :0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "utilization": "string",
        "visibility": "string",
	}
]
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID de gasto vinculado al campo de registro. Ejemplo: 00000000-0000-0000-0000-000000000000
fieldId String 100 ID del campo gerencial. Ejemplo: sustentacion_rdg_ser_cot_auto
caracterQuantity Number (int) 100 Número de caracteres en el campo. Ejemplo: 60
finalizationDate String 3 Fecha/hora de finalización del valor del campo de gestión. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Fecha/hora de inclusión/creación del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
integrationCode String 15 Código de integración del campo de gestión (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: '12345'
length Number (int?) 100 Tamaño del campo (puede ser nulo). Ejemplo: nulo, 30
name String 255 Nombre del campo gerencial. Ejemplo: Servicio/Cotización (Actualización - Campo de tipo de Autocompletar)
order Number (int?) 100 Orden de valor. Ejemplo: 0
product String (Enum) 7 Tipo de producto utilizado en el ámbito de la gestión. Ejemplo: 'aéreo', 'hoteles', 'alquiler', 'servicio', 'carretera', 'todos'
regularExpression String 255 Expresión regular del ámbito empresarial. Ejemplo: ^([0-7]{1,9})$
required String (Enum) 3 Información obligatoria del ámbito de la gestión. Ejemplo: Yes/No
serviceId Guid 36 ID de identificación del tipo de servicio. Ejemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Claves de servicio en el campo gerencial Ejemplo: 'checkin', 'departure' y 'arrival'
type String (Enum) 12 Tipo de campo gerencial. Ejemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viaje al que está vinculada la solicitud. Ejemplo: 'ambos', 'internacional', 'nacional'
utilization String (Enum) 21 Tipo de uso del campo gerencial. Ejemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
visibility String (Enum) 3 Información de visibilidad de campo gerencial. Ejemplo: Yes/No

POST /managementsfields

Solicitud

{
	"fieldId": "string",
	"typeTrip": "both",
	"caracterQuantity": 0,
	"serviceId": "00000000-0000-0000-0000-000000000000",
	"serviceKey": "checkin",
	"integrationCode": "string",
	"name": "string",
	"utilization": "expenseAdvancePayment",
	"type": "text",
	"required": "yes",
	"regularExpression": "string",
	"order": 0,
	"product": "air",
	"visibility": "yes",
	"expenseId": "00000000-0000-0000-0000-000000000000",
	"lenght": 0,
	"sequential": true
}
Propiedad Tipo Tamaño Requerido Descripción
fieldId String 100 Si ID del campo gerencial. Ejemplo: sustentacion_rdg_ser_cot_auto
typeTrip Number (int) 100 No Tipo de viaje al que está vinculado el campo gerencial. Ejemplo: 'both', 'international', 'domestic'
caracterQuantity Number (int) 100 No Número de caracteres que se permitirán al completar el campo. Ejemplo: 60
integrationCode String 15 Código de integración del campo de gestión (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: '12345'
serviceId Guid 36 No ID del tipo de servicio. Ejemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 No Claves de servicio en el campo gerencial. Ejemplo: 'checkin', 'departure' y 'arrival'
integrationCode String 15 No Código de integración del campo gerencial (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: '12345'
name String 255 Si Nombre del campo gerencial. Ejemplo: Servicio / Presupuesto (Actualización - campo Tipo AutoComplete)
utilization String (Enum) 21 Si Tipo de uso del campo gerencial. Ejemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
type String (Enum) 12 Si Tipo de campo gerencial. Ejemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
required String (Enum) 3 No Información obligatoria del campo gerencial. Ejemplo: Yes/No
regularExpression String 255 No Expresión regular del campo gerencial. Ejemplo: ^([0-7]{1,9})$
order Number (int) 100 Si Orden del campo gerencial. Ejemplo: 63
product String (Enum) 7 No Tipo de producto utilizado en el campo gerencial. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
visibility String (Enum) 3 No Información de visibilidad de campo gerencial. Exemplo: Yes/No
expenseId Guid 36 No ID de gastos donde está vinculado el campo gerencial. Ejemplo: 00000000-0000-0000-0000-000000000000
length Number (int?) 100 No Tamaño del campo (puede ser nulo). Ejemplo: null, 30
sequential Boolean 5 No Valor relacionado con los campos de tipo 'autocompletar'. Informa si los registros devueltos en el autocompletado serán secuenciales o no, de acuerdo con el "orden" de cada uno. Ejemplo: True/False

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en la inserción del campo de gestión. Ejemplo: True/False

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

Solicitud

Solicitud GET

Respuesta

{
	"finalizationDate": "2020-02-17T18:28:31.228Z",
	"inclusionDate": "2020-02-17T18:28:31.228Z",
	"fieldId": "string",
	"value": "string",
	"order": 0,
	"code": "string"
}
Propiedad Tipo Tamaño Descripción
finalizationDate String 3 Fecha / hora de finalización del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / creación del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
fieldId String 100 ID del campo gerencial. Ejemplo: sustentacion_rdg_ser_cot_auto
value String 50 Valor de campo gerencial. Ejemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 Orden de valor. Ejemplo: 0
code String 50 Código de valor. Ejemplo: SC-0500-ML02-01-07

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

DELETE
DELETE
Propiedad Tipo Tamaño Descripción
message String 5 esxito o fracaso al eliminar el valor del campo gerencial. Ejemplo: True/False

GET /managementsfields/{managementsFieldId}/values

Request

Request GET

Response

[
	{
		"finalizationDate": "2020-02-17T20:54:33.871Z",
		"inclusionDate": "2020-02-17T20:54:33.871Z",
		"fieldId": "string",
		"value": "string",
		"order": 0,
		"code": "string"
	}
]
Propiedad Tipo Tamaño Descripción
finalizationDate String 3 Fecha / hora de finalización del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / creación del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
fieldId String 100 ID del campo gerencial. Ejemplo: sustentacion_rdg_ser_cot_auto
value String 50 Valor de campo gerencial. Ejemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 Orden de valor. Ejemplo: 0
code String 50 Código de valor Ejemplo: SC-0500-ML02-01-07

POST /managementsfields/{managementsFieldId}/values

Request

{
	"value": "string",
	"order": 0,
	"code": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
value String 50 Si Valor de campo gerencial. Ejemplo: 03641 - AASA - CONSOL ELIM - AE
order Number (int?) 100 No Orden de valor. Ejemplo: 0
code String 50 No Código de valor Ejemplo: SC-0500-ML02-01-07

Response

Response POST
Propiedad Tipo Tamaño Descripción
message String 5 esxito o fracaso al insertar el valor del campo gerencial. Ejemplo: True/False

DELETE /managementsfields/{managementsFieldId}

Request

Request DELETE

Response

resposta DELETE

GET /managementsfields/{managementsFieldId}

Request

Request GET

Response

[
    {
        "clientId": "string",
        "expenseId": "string",
        "fieldId": "string",
        "caracterQuantity": 0,
        "finalizationDate": "string",
        "inclusionDate": "string",
        "integrationCode": "string",
        "lenght" :0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "utilization": "string",
        "visibility": "string",
    }
]
Propiedad Tipo Tamaño Descripción
clientId String 36 ID de identificación del cliente donde está registrado el campo. Ejemplo: 00000000-0000-0000-0000-000000000000
expenseId Guid 36 ID del gasto vinculado al campo registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
fieldId String 100 ID de identificación del campo gerencial. Ejemplo: demo_rdg_ser_cot_auto
caracterQuantity Number (int) 100 Cantidad de caracteres del campo. Ejemplo: 60
finalizationDate String 24 Fecha/hora de finalización del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
inclusionDate String (Date Time) 24 Fecha/hora de inclusión/creación del valor del campo gerencial. Ejemplo: 2019-09-18T16:48:22.490Z
integrationCode String 15 Código de integración del campo gerencial (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: '12345'
length Number (int?) 100 Tamaño del campo (pudiendo ser nulo). Ejemplo: null, 30
name String 255 Nombre del campo gerencial. Ejemplo: servicio/Cotización (Actualización - Campo Tipo AutoComplete)
order Number (int?) 100 Orden del valor. Ejemplo: 0
product String (Enum) 7 Tipo de producto de utilización del campo gerencial. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
regularExpression String 255 Expresión regular del campo gerencial. Ejemplo: ^([0-7]{1,9})$
required String (Enum) 3 Información de obligatoriedad del campo gerencial. Ejemplo: Yes/No
serviceId Guid 36 ID de identificación del tipo de servicio. Ejemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Llaves de servicio de actuación del campo gerencial Ejemplo: 'checkin', 'departure' e 'arrival'
type String (Enum) 12 Tipo de campo gerencial. Ejemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viaje al que la solicitud está vinculada. Ejemplo: 'both', 'international', 'domestic'
utilization String (Enum) 21 Tipo de utilización del campo gerencial. Ejemplo: 'expenseAdvancePayment', 'backoffice', 'emission', 'politic', 'serviceQuotation', 'serviceRequest', 'request', 'refund'
visibility String (Enum) 3 Información de visibilidad del campo gerencial. Ejemplo: Yes/No

PUT /managementsfields/{managementsFieldId}

Request

[
    {
        "expenseId": "string",
        "caracterQuantity": 0,
        "integrationCode": "string",
        "lenght": 0,
        "name": "string",
        "order": "string",
        "product": "string",
        "regularExpression": "string",
        "required": "string",
        "serviceId": "string",
        "serviceKey": "string",
        "type": "string",
        "typeTrip": "string",
        "visibility": "string",
        "sequential": "string",
    }
]
Propiedad Tipo Tamaño Descripción
expenseId Guid 36 ID del gasto vinculado al campo registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
caracterQuantity Number (int) 100 Cantidad de caracteres del campo. Ejemplo: 60
integrationCode String 15 Código de integración del campo gerencial (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: '12345'
length Number (int?) 100 Tamaño del campo (pudiendo ser nulo). Ejemplo: null, 30
name String 255 Nombre del campo gerencial. Ejemplo: servicio/Cotización (Actualización - Campo Tipo AutoComplete)
order Number (int?) 100 Orden del valor. Ejemplo: 0
product String (Enum) 7 Tipo de producto de utilización del campo gerencial. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'all'
regularExpression String 255 Expresión regular del campo gerencial. Ejemplo: ^([0-7]{1,9})$
required String (Enum) 3 Información de obligatoriedad del campo gerencial. Ejemplo: Yes/No
serviceId Guid 36 ID de identificación del tipo de servicio. Ejemplo: 00000000-0000-0000-0000-000000000000
serviceKey String (Enum) 9 Llaves de servicio de actuación del campo gerencial Ejemplo: 'checkin', 'departure' e 'arrival'
type String (Enum) 12 Tipo de campo gerencial. Ejemplo: 'text', 'number', 'value', 'date', 'hour', 'yesNo', 'autoComplete'
typeTrip String (Enum) 14 Tipo de viaje al que la solicitud está vinculada. Ejemplo: 'both', 'international', 'domestic'
visibility String (Enum) 3 Información de visibilidad del campo gerencial. Ejemplo: Yes/No
sequential Boolean 5 No Valor relacionado al campo de tipo 'autocomplete'. El informa si los registros retornados en autocomplete serán secuenciales o No, de acuerdo con el 'orden' de cada uno. Ejemplo: True/False

Response

resposta PUT
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de la acción. Ejemplo: True/False

ConfigsCities

Este método permite enumerar las ciudades registradas en el sistema.

GET

Solicitud

Solicitud GET
Propiedad Tipo Tamaño Requerido Descripción
countryName String 40 Si Nombre del pais. Ejemplo: Brasil
cityName String 50 Si Nombre de la ciudad Ejemplo: São Paulo

Respuesta

[
	{
		"countryId": 0,
		"cityId": 0,
		"cityName": "string",
		"stateAcronym": "string",
		"stateName": "string",
		"countryAcronym": "string",
		"countryName": "string"
	}
]
Propiedad Tipo Tamaño Descripción
countryId Number(Integer) 36 Identificación del país de la ciudad. Ejemplo: 55
cityId Number(Integer) 36 Identificación de la ciudad. Ejemplo: 16
cityName String 50 Nombre de la ciudad Ejemplo: Osasco
stateAcronym String 2 Acrónimo del estado que se refiere a la ciudad. Ejemplo: SP
stateName String 50 Nombre del estado donde se encuentra la ciudad. Ejemplo: São Paulo
countryAcronym String 2 Acrónimo del país que se refiere a la ciudad. Ejemplo: BR
countryName String 40 Nombre del país para la ciudad. Ejemplo: Brasil

ConfigsClients

El sistema Argo permite registrar a sus clientes, así como sus datos de registro. La URL será la dirección donde el cliente accederá al sistema, esta información vendrá inmediatamente después de la URL de la agencia.

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

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"clientId": "396605df-728e-4303-be3e-272ae4fe96d7",
		"active": "yes",
		"inclusionDate": "2019-02-25T00:41:46.613",
		"changeDate": "2019-02-25T00:41:46.613",
		"corporateName": "Yvonne Jacobs",
		"tradeName": "Yvonne Jacobs",
		"country": "BR",
		"language": "portugueseBR",
		"url": "11840"
	}
]
Propiedad Tipo Tamaño Requerido Descripción
filters.active String (Enum) 3 No Estado del registro de los clientes que desea consultar (Activo / Inactivo). Ejemplo: Yes/No
filters.corporateName String 50 No Filtro - Descripción del nombre de la corporación. Ejemplo: Argo Solutions
filters.tradeName String 50 No Filtro: nombre comercial de la corporación. Ejemplo: Argo
filters.country String 2 No Filtro: país donde la empresa tiene su sede. Ejemplo: BR (Brasil)
filters.expense String (Enum) 3 No Filtro: corporaciones que usan el módulo Expense. Exemplo: Yes/No
filters.url String 20 No Filtro: URL de la corporación utilizada para el acceso del usuario. Ejemplo: https://www.argoit.com.br/ URLagencia / URLcliente
filters.integrationCode String 50 No Filtro: código que pueden utilizar otros sistemas en el proceso de integración.: 001
filters.iata String 50 No Filtro - Código de la Asociación Internacional de Transporte Aéreo. Ejemplo: BWN
filters.stars String 50 No Filtro: datos de registro del cliente en globalizadores (GDS).: PortView
filters.email String 50 No Filtro: correo electrónico corporativo principal. Ejemplo: useargo@argo.com
filters.currency String 3 No Filtro - Moneda de la corporación. Ejemplo: BRL

POST

Solicitud

{
    "corporateName": "string",
    "tradeName": "string",
    "country": "string",
    "clientType": "callCenter",
    "language": "portugueseBR",
    "url": "string",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "companyRegister": "string",
    "email": "string",
    "currency": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
corporateName String 50 Si Descripción del nombre de la corporación. Ejemplo: Argo Solutions
tradeName String 50 Si Nombre de la corporación. Ejemplo: Argo
Country String 2 No País sede de la empresa. Ejemplo: BR (Brasil)
ClientType String 10 Si El tipo de cliente a registrar. Ejemplo: callCenter o Expense
language String (Enum) 12 Si Idioma del cliente Ejemplo: portugueseBR, portuguesePT, english, spanish, mexico
url String 20 Si URL del cliente (corporación) servida por la agencia de viajes. Ejemplo: www.argo.com.br/URLdeAGENCIA/URLdeCORPORACION
integrationCode String 50 No Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
iata String 50 No Ejemplo de código de la Asociación de transporte aéreo internacional: 8292
star String 50 No Datos de registro de clientes globales (GDS). Ejemplo: 78374ks
companyRegister String 14 No Registro Nacional de Entidades Legales (CNPJ) del cliente. Ejemplo: 09096135000100
email String 50 No Correo electrónico principal corporativo. Ejemplo: useargo@argo.com
currency String 3 No Moneda de la corporación. Ejemplo: BRL

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
clientId String 36 ID del cliente registrado. Ejemplo: 00000000-0000-0000-0000-000000000000

GET clients/{clientId}

GET
{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"active": "yes",
	"inclusionDate": "2020-02-12T14:48:05.741Z",
	"changeDate": "2020-02-12T14:48:05.741Z",
	"corporateName": "string",
	"tradeName": "string",
	"country": "string",
	"clientType": "callCenter",
	"language": "portugueseBR",
	"url": "string",
	"integrationCode": "string",
	"iata": "string",
	"star": "string",
	"companyRegister": "string",
	"email": "string",
	"currency": "string"
}
Propiedad Tipo Tamaño Descripción
clientId String 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
active String (Enum) 3 Estatus del registro del cliente (activo / inactivo). Ejemplo: Yes/No
inclusionDate Date Time 24 Fecha / hora de inclusión / creación del cliente. Ejemplo: 2019-10-02T19:47:10.450Z
changeDate Date Time 24 Fecha / del último cambio del cliente. Ejemplo: 2019-10-02T19:47:10.450Z
corporateName String 50 Razón Social del cliente. Ejemplo: Argo Solutions
tradeName String 50 Nombre comercial del cliente. Ejemplo: Argo
country String 2 País donde el cliente tiene su sede. Ejemplo: BR (Brasil)
clientType String 10 Tipo de cliente a registrar. Ejemplo: callCenter o Expense
language String (Enum) 12 Idioma del cliente Ejemplo: portugueseBR, portuguesePT, english, spanish, mexico
url String 20 URL del cliente utilizada para el acceso del usuario. Ejemplo: www.argo.com.br/URLdeAGENCIA/URLdeCORPORACION
integrationCode String 50 Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
iata String 50 Código de la Asociación Internacional de Transporte Aéreo. Ejemplo: 7273
star String 50 Datos de registro de clientes en globalizadores (GDS). Ejemplo: 7878js
companyRegister String 14 Registro Nacional de Entidades Legales (CNPJ) del cliente. Ejemplo: 09096135000100
email String 50 Principal correo electrónico principal del cliente. Ejemplo: useargo@argo.com
currency String 3 Moneda del cliente. Ejemplo: BRL

PUT clients/{clientId}

Solicitud

{
    "active": "string",
    "corporateName": "string",
    "tradeName": "string",
    "country": "string",
    "clientType": "callCenter",
    "language": "portugueseBR",
    "integrationCode": "string",
    "iata": "string",
    "star": "string",
    "companyRegister": "string",
    "email": "string",
    "currency": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
active String (Enum) 3 Si Estado del cliente (Activo / Inactivo). Ejemplo: yes/no
corporateName String 50 Si Razón Social del cliente. Ejemplo: Argo Solutions
tradeName String 50 Si Nombre comercial del cliente. Ejemplo: Argo
country String 2 No País donde el cliente tiene su sede. Ejemplo: BR (Brasil)
clientType String (Enum) 10 No Tipo de ambiente. Ejemplo: callCenter o Expense
language String (Enum) 12 Si Idioma del cliente Ejemplo: portugueseBR, portuguesePT, english, spanish, mexico
integrationCode String 50 No Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
iata String 50 No Código de la Asociación Internacional de Transporte Aéreo. Ejemplo: 7878
star String 50 No Datos de registro de clientes en globalizadores (GDS). Ejemplo: 7832732js
companyRegister String 14 No Registro Nacional de Entidades Legales (CNPJ) del cliente. Ejemplo: 09096135000100
email String 50 No Correo electrónico principal del cliente. Ejemplo: useargo@argo.com
currency String 3 No Moneda del cliente. Ejemplo: BRL

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
Message String (Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

ConfigsHotels

A través de este servicio, se puede obtener toda la información relacionada con los hoteles registrados, así como datos relacionados con los apartamentos de estos hoteles.

A través de este método también es posible gestionar (excluir, insertar y cambiar) los hoteles y apartamentos en el entorno.

GET /hotels

Solicitud

Solicitud GET

Respuesta

[
	{
		"clientId": "00000000-0000-0000-0000-000000000000",
		"hotelId": "00000000-0000-0000-0000-000000000000",
		"inclusionDate": "2020-02-06T19:27:06.987Z",
		"changeDate": "2020-02-06T19:27:06.987Z",
		"active": "yes",
		"cityId": 0,
		"name": "string",
		"address": "string",
		"neighborHood": "string",
		"cep": "string",
		"telephone": "string",
		"email": "string",
		"site": "string",
		"latitude": 0,
		"longitude": 0,
		"iss": 0,
		"tourismTax": 0,
		"serviceTax": 0,
		"coffee": "yes",
		"amenities": "string",
		"stars": 0,
		"cnpj": "string",
		"image": "string"
	}
]
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
hotelId Guid 36 ID del hotel registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / creación del hotel. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio. Ejemplo: 2019-09-18T16:48:22.490Z
active String 3 Estado del hotel (activo / inactivo). Ejemplo: Yes/No
cityId Int 5 ID de identificación de la ciudad donde se encuentra el hotel. Ejemplo: 44363
name String 50 Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
address String 50 Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
neighborHood String 50 Barrio del hotel. Ejemplo: Meirelles
cep String 8 Código postal de la ubicación del hotel. Ejemplo: 14815000
telefone String 23 Teléfono de contacto del hotel: ejemplo: +55 (16) 3343-2325
email String 50 Correo electrónico de contacto del hotel. Ejemplo: hotelsb2b@hotelsbtwob
site String 50 Sitio web del hotel. Ejemplo: http://www.hotelsbtwob.com/
latitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 255348752
longitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 485526208
iss Number (Decimal?) 100 Tasa obligatoria por el servicio prestado por el Hotel. Ejemplo: 5,00
tourismTax Number (Decimal?) 100 Tasa turística del hotel. Ejemplo: 10,00
serviceTax Number (Decimal?) 100 Cargo por servicio de hotel. Ejemplo: 5,00
coffee String 3 Información sobre la existencia del servicio de desayuno en el Hotel. Ejemplo: yes/no
amenities String 255 Servicios encontrados en el Hotel. Ejemplo: WIFI
stars Number (int) 100 Valoración del hotel. Ejemplo: 3
cnpj String 18 Registro Nacional de Entidades Legales, CNPJ del Hotel. Ejemplo: 07849999000197
Image String 100 Imagen del hotel. Ejemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

POST /hotels

Solicitud

{
	"active": "yes",
	"cityId": 0,
	"name": "string",
	"address": "string",
	"neighborHood": "string",
	"cep": "string",
	"telephone": "string",
	"email": "string",
	"site": "string",
	"latitude": 0,
	"longitude": 0,
	"iss": 0,
	"tourismTax": 0,
	"serviceTax": 0,
	"coffee": "yes",
	"amenities": "string",
	"stars": 0,
	"cnpj": "string",
	"image": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
active String (Enum) 3 Si Estado del hotel (activo / inactivo). Ejemplo: Yes/no
cityId Number(Int) 5 Si ID de la ciudad donde se encuentra el hotel. Ejemplo: 44363
name String 50 Si Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
address String 50 No Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
neighborHood String 50 No Barrio del hotel. Ejemplo: Meirelles
cep String 8 No Código postal de la ubicación del hotel. Ejemplo: 14815000
telephone String 23 No Teléfono de contacto del hotel. Ejemplo: +55 (16) 3343-2325
email String 50 No Correo electrónico de contacto del hotel. Ejemplo: hotelsb2b@hotelsbtwob
site String 50 No SSitio web del hotel. Ejemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 No Coordenadas geográficas de la ubicación del hotel. Ejemplo: 255348752
longitude Number (Float?) 100 No Coordenadas geográficas de la ubicación del hotel. Ejemplo: 485526208
iss Number (Decimal?) 100 No Tasa obligatoria por el servicio prestado por el Hotel. Ejemplo: 5,00
tourismTax Number (Decimal?) 100 No Tasa turística del hotel. Ejemplo: 10,00
serviceTax Number (Decimal?) 100 No Cargo por servicio de hotel. Ejemplo: 5,00
coffee String 3 No Información sobre la existencia del servicio de desayuno en el Hotel. Ejemplo: yes/no
amenities String 255 No Servicios encontrados en el Hotel. Ejemplo: WIFI
stars Number (int) 100 No Valoración del hotel. Ejemplo: 3
cnpj String 18 No CNPJ del Hotel. Ejemplo: 07849999000197
image String 100 No Imagen del hotel. Ejemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error al crear el hotel. Ejemplo: True/False

GET /hotels/{hotelId}

Solicitud

Solicitud GET

Respuesta

{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"hotelId": "00000000-0000-0000-0000-000000000000",
	"inclusionDate": "2020-02-07T19:59:19.778Z",
	"changeDate": "2020-02-07T19:59:19.778Z",
	"active": "yes",
	"cityId": 0,
	"name": "string",
	"address": "string",
	"neighborHood": "string",
	"cep": "string",
	"telephone": "string",
	"email": "string",
	"site": "string",
	"latitude": 0,
	"longitude": 0,
	"iss": 0,
	"tourismTax": 0,
	"serviceTax": 0,
	"coffee": "yes",
	"amenities": "string",
	"stars": 0,
	"cnpj": "string",
	"image": "string"
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
hotelId Guid 36 ID del hotel registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de creación / del hotel. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio / del hotel. Ejemplo: 2019-09-18T16:48:22.490Z
active String 3 Estatus del hotel (activo / inactivo). Ejemplo: Yes/No
cityId Int 5 ID de la ciudad donde se encuentra el hotel. Ejemplo: 44363
name String 50 Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
address String 50 Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
neighborHood String 50 Barrio del hotel. Ejemplo: Meirelles
cep String 8 Código postal de la ubicación del hotel. Ejemplo: 14815000
telefone String 23 Teléfono de contacto del hotel: ejemplo: +55 (16) 3343-2325
email String 50 Correo electrónico de contacto del hotel. Ejemplo: hotelsb2b@hotelsbtwob
site String 50 Sitio web del hotel. Ejemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 255348752
longitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 485526208
iss Number (Decimal?) 100 Tasa obligatoria por el servicio prestado por el Hotel. Ejemplo: 5,00
tourismTax Number (Decimal?) 100 Tasa turística del hotel. Ejemplo: 10,00
serviceTax Number (Decimal?) 100 Cargo por servicio de hotel. Ejemplo: 5,00
coffee String 3 Información sobre la existencia del servicio de desayuno en el Hotel. Ejemplo: yes/no
amenities String 255 Servicios encontrados en el Hotel. Ejemplo: WIFI
stars Number (int) 100 Valoración del hotel. Ejemplo: 3
cnpj String 18 Registro Nacional de Entidades Legales, CNPJ del Hotel. Ejemplo: 07849999000197
Image String 100 Imagen del hotel. Ejemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

PUT /hotels/{hotelId}

Solicitud

{
	"active": "yes",
	"cityId": 0,
	"name": "string",
	"address": "string",
	"neighborHood": "string",
	"cep": "string",
	"telephone": "string",
	"email": "string",
	"site": "string",
	"latitude": 0,
	"longitude": 0,
	"iss": 0,
	"tourismTax": 0,
	"serviceTax": 0,
	"coffee": "yes",
	"amenities": "string",
	"stars": 0,
	"cnpj": "string",
	"image": "string"
}
Propiedad Tipo Tamaño Requerido Descripción
active String (Enum) 3 Si Estado del hotel (activo / inactivo). Ejemplo: Yes/no
cityId Number(Int) 5 Si ID de la ciudad donde se encuentra el hotel. Ejemplo: 44363
name String 50 Si Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
address String 50 No Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
neighborHood String 50 No Barrio del hotel. Ejemplo: Meirelles
cep String 8 No Código postal de la ubicación del hotel. Ejemplo: 14815000
telephone String 23 No Teléfono de contacto del hotel. Ejemplo: +55 (16) 3343-2325
email String 50 No Correo electrónico de contacto del hotel. Ejemplo: hotelsb2b@hotelsbtwob
site String 50 No SSitio web del hotel. Ejemplo: http://www.hotelsbtwob.com
latitude Number (Float?) 100 No Coordenadas geográficas de la ubicación del hotel. Ejemplo: 255348752
longitude Number (Float?) 100 No Coordenadas geográficas de la ubicación del hotel. Ejemplo: 485526208
iss Number (Decimal?) 100 No Tasa obligatoria por el servicio prestado por el Hotel. Ejemplo: 5,00
tourismTax Number (Decimal?) 100 No Tasa turística del hotel. Ejemplo: 10,00
serviceTax Number (Decimal?) 100 No Cargo por servicio de hotel. Ejemplo: 5,00
coffee String 3 No Información sobre la existencia del servicio de desayuno en el Hotel. Ejemplo: yes/no
amenities String 255 No Servicios encontrados en el Hotel. Ejemplo: WIFI
stars Number (int) 100 No Valoración del hotel. Ejemplo: 3
cnpj String 18 No CNPJ del Hotel. Ejemplo: 07849999000197
image String 100 No Imagen del hotel. Ejemplo: http://www.ahstatic.com/photos/9438_ho_02_p_1024x768.jpg

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error en la actualización del hotel. Ejemplo: True/False

DELETE /hotes/{hotelId}

Solicitud

Solicitud DELETE

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error en la actualización del hotel. Ejemplo: True/False

GET /hotels/{hotelId}/apartaments

Solicitud

Solicitud GET

Respuesta

[
	{
		"apartamentId": 0,
		"clientId": "00000000-0000-0000-0000-000000000000",
		"inclusionDate": "2020-02-10T12:37:08.356Z",
		"changeDate": "2020-02-10T12:37:08.356Z",
		"inativationDate": "2020-02-10T12:37:08.356Z",
		"HotelId": "00000000-0000-0000-0000-000000000000",
		"typeApartament": "string",
		"name": "string",
		"coin": "string",
		"dailyValue": 0,
		"agencyRates": "yes",
		"netCommissionedRate": "commissioned",
		"justification": "string"
	}
]
Propiedad Tipo Tamaño Descripción
apartamentId Number (int) 100 ID del departamento encontrado. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID del cliente encontrado. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de inclusión / del apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio / en el apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
inativationDate String (Date Time) 24 Fecha / hora de inactivación / del apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
hotelId Guid 36 ID del hotel devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo de apartamento. Ejemplo: Individual, Double, Triple o Quadruple
name String 50 Nombre del departamento. Ejemplo: standard
coin String 3 Moneda registrada con la tarifa de la habitación. Ejemplo: BRL
dailyValue Number (Double) 100 Tarifa diaria del apartamento. Ejemplo: 45,00
agencyRates String 3 Indica si la tarifa se presentará solo al usuario de la agencia de viajes. Ejemplo: yes/no
netCommissionedRate String 12 Indica si la tarifa de la habitación es Net o Comisionada. Ejemplo: Net/Comissionada
Justification String 255 Justificación cuando hay un cambio en la tarifa del hotel.

POST /hotels/{hotelId}/apartaments

Solicitud

{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"typeApartament": "string",
	"name": "string",
	"coin": "string",
	"dailyValue": 0,
	"agencyRates": "yes",
	"netCommissionedRate": "commissioned"
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo de apartamento. Ejemplo: Individual, Double, Triple ou Quadruple
name String 50 Nombre del apartamento. Ejemplo: standard
coin String 3 Moneda relacionada con la tarifa de la habitación. Ejemplo: BRL
dailyValue Number (Double) 100 Tarifa diaria del apartamento. Ejemplo: 45,00
agencyRates String 3 Indicar si la tarifa se presentará solo al usuario de la agencia de viajes. Ejemplo: yes/no
netCommissionedRate String 12 Indicar si la tarifa de la habitación es Net o Comisionada. Ejemplo: Net/Comissionada

Respuesta

Respuesta POST
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error al incluir el apartamento. Ejemplo: True/False

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

Solicitud

Solicitud GET

Respuesta

{
	"apartamentId": 0,
	"clientId": "00000000-0000-0000-0000-000000000000",
	"inclusionDate": "2020-02-10T12:37:08.356Z",
	"changeDate": "2020-02-10T12:37:08.356Z",
	"inativationDate": "2020-02-10T12:37:08.356Z",
	"HotelId": "00000000-0000-0000-0000-000000000000",
	"typeApartament": "string",
	"name": "string",
	"coin": "string",
	"dailyValue": 0,
	"agencyRates": "yes",
	"netCommissionedRate": "commissioned",
	"justification": "string"
}
Propiedad Tipo Tamaño Descripción
apartamentId Number (int) 100 ID del departamento devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
inclusionDate String (Date Time) 24 Fecha / hora de creación / del apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
changeDate String (Date Time) 24 Fecha / hora del último cambio / en el apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
inativationDate String (Date Time) 24 Fecha / hora de inactivación del apartamento. Ejemplo: 2019-09-18T16:48:22.490Z
hotelId Guid 36 ID del hotel devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo de apartamento Ejemplo: Double, Triple o Quadruple
name String 50 Nombre del apartamento. Ejemplo: standard
coin String 3 Moneda registrada en la tarifa del hotel. Ejemplo: BRL
dailyValue Number (Double) 100 Tarifa diaria del apartamento. Ejemplo: 45,00
agencyRates String 3 Indica si la tarifa se presentará solo al usuario de la agencia de viajes. Ejemplo: yes/no
netCommissionedRate String 12 Indica si la tarifa de la habitación es Net o Comisionada. Ejemplo: Net
Justification String 255 Justificación cuando hay un cambio en la tarifa del hotel.

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

Solicitud

{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"typeApartament": "string",
	"name": "string",
	"coin": "string",
	"dailyValue": 0,
	"agencyRates": "yes",
	"netCommissionedRate": "commissioned"
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
typeApartament String (Enum) 50 Tipo de apartamento. Ejemplo: Individual, Double, Triple ou Quadruple
name String 50 Nombre del apartamento. Ejemplo: standard
coin String 3 Moneda relacionada con la tarifa de la habitación. Ejemplo: BRL
dailyValue Number (Double) 100 Tarifa diaria del apartamento. Ejemplo: 45,00
agencyRates String 3 Indica si la tarifa se presentará solo al usuario de la agencia de viajes. Ejemplo: yes/no
netCommissionedRate String 12 Indica si la tarifa de la habitación es Net o Comisionada. Ejemplo: Net/Comissionada

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error en la actualización del apartamento. Ejemplo: True/False

DELETE /hotels/{hotelId}/apartaments

Solicitud

Solicitud DELETE

Respuesta

Respuesta DELETE
Propiedad Tipo Tamaño Descripción
message String 4 Resultado Exitoso o Error al eliminar el apartamento. Ejemplo: True/False

ConfigsJustifications

El sistema Argo permite a sus clientes, generalmente agencias de viajes, por medio del método ConfigsJustifications, realizar el registro de justificaciones, así como la administración de ellas, como búsqueda y actualización.

GET

Request

request GET
Propiedad Tipo Tamaño Obligatorio Descripción
description String 100 No Filtro relacionado a las descripciones registradas en las justificaciones. Ejemplo: Rechazo por precio elevado.
active String(Enum) 3 No Filtro relacionado a los status de las justificaciones, en caso de que la misma está activa o No. Ejemplo: Yes, No.
integrationCode String 30 No Filtro relacionado a los códigos de integración de las justificaciones. Ejemplo: ST002A

Response

[
{
     "justificationId": "00000000-0000-0000-0000-000000000000",
     "description": "string",
     "active": "yes"
}
]
Propiedad Tipo Tamaño Descripción
justificationId String(Guid) 36 ID de la justificación. Ejemplo: 00000000-0000-0000-0000-000000000000
description String 100 Descripción de la justificación. Ejemplo: Rechazo por precio elevado
active String(Enum) 3 Status de la justificación, en caso si ella está activa o No. Ejemplo: yes, No

POST

Request

Request POST
    {
        "typeId": "String",
        "description": "String",
        "requireDescription": "String",
        "helpDescription": "String",
        "active": "String",
        "integrationCode": "String"
    }
Propiedad Tipo Tamaño Obligatorio Descripción
typeId String 6 Si Tipo de la justificación. Ejemplo: Para Ejemplo ver la tabla de tipos de justificaciones.
description String 100 Si Descripción de la justificación. Ejemplo: Rechazo por precio elevado.
requireDescription String(Enum) 3 Si Si la justificación obliga una descripción. Ejemplo: Yes, No
helpDescription String 255 No En caso que seaa Obligatorio el llenado de la descripción, un texto de ayuda puede ser ingresado para ayudar a llenar la descripción.Ejemplo: Debe informar el motivo de la justificación.
active String(Enum) 3 Si Status de la justificación, en caso si ella está activa o no. Ejemplo: yes, No
integrationCode String 30 No Código de integración de la justificación (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: justificacion19

Response

response POST
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error en la creación de una justificación. Ejemplo: True/False

GET /justifications/{justificationId}

Request

request GET /justifications/{justificationId}
Propiedad Tipo Tamaño Obligatorio Descripción
justificationId Guid 36 Si ID de la justificación que el usuario desea consultar los detalles. Ejemplo: 00000000-0000-0000-0000-000000000000

Response

    {
        "justificationId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000",
        "typeId": "string",
        "typeDescription": "string",
        "description": "string",
        "requireDescription": "yes",
        "helpDescription": "string",
        "initialDate": "2020-04-06T10:40:24.695Z",
        "active": "yes",
        "integrationCode": "string"
    }
Propiedad Tipo Tamaño Descripción
justificationId String(Guid) 36 ID de la justificación. Ejemplo: 00000000-0000-0000-0000-000000000000
clientId String(Guid) 36 ID del cliente relacionado a la justificación. Ejemplo: 00000000-0000-0000-0000-000000000000
typeId String 6 Tipo de justificación. Ejemplo: Para Ejemplos ver la tabla de tipos de justificaciones.
typeDescription String 30 Descripción del tipo de justificación. Ejemplo: Para Ejemplos ver la tabla de tipos de justificaciones.
description String 100 Descripción de la justificación. Ejemplo: Rechazo por precio elevado.
requireDescription String(Enum) 3 Si la justificación obliga una descripción. Ejemplo: Yes, No
helpDescription String 255 Caso sea obligatorio el llenado de la descripción, un texto de ayuda puede ser ingresado para ayudar a llenar la descripción.Ejemplo: Debe informar el motivo de la justificación.
initialDate String(DateTime) 26 Fecha en que la justificación fue registrada. Ejemplo: 2020-04-06T10:36:14.586Z
active String(Enum) 3 Status de la justificación, en caso si ella está activa o no. Ejemplo: yes, No
integrationCode String 30 Código de integración de la justificación (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: justificacion

PUT /justifications/{justificationId}

Request

request GET
Propiedad Tipo Tamaño Obligatorio Descripción
justificationId Guid 36 Si ID de la justificación que el usuario desea consultar los detalles. Ejemplo: 00000000-0000-0000-0000-000000000000
typeId String 6 Si Tipo de la justificación. Ejemplo: Para Ejemplos ver la tabla de tipos de justificaciones.
description String 100 Si Descripción de la justificación. Ejemplo: Rechazo por precio elevado.
requireDescription String(Enum) 3 Si Indica si la justificación obliga una descripción. Ejemplo: Yes, No
helpDescription String 255 No Caso sea obligatorio el llenado de la descripción, un texto de ayuda puede ser ingresado para ayudar a llenar la descripción.Ejemplo: Debe informar el motivo de la justificación.
active String(Enum) 3 Si Status de la justificación, en caso si ella está activa o no.Ejemplo: yes, No
integrationCode String 30 No Código de integración de la justificación (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: justificacion

Response

response PUT
Propiedad Tipo Tamaño Descripción
message String 4 Éxito o error en la modificación de la justificación. Ejemplo: True/False

ConfigsLevels

El sistema Argo permite a los usuarios asignar niveles (Ejemplo: Ejecutivo, operativo, etc.). Mediante este método es posible recuperar los niveles registrados en el cliente.

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"levelId": "00000000-0000-0000-0000-000000000000",
		"order": 0,
		"name": "String"
	}
]
Propiedad Tipo Tamaño Descripción
levelId String (Guid) 36 ID del registro de nivel de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
order Integer 3 Número relacionado con el orden de los usuarios, en el caso de una jerarquía. Ejemplo: 1
name String 50 Nombre de usuario relacionado con el nivel obtenido. Ejemplo: Pedro Cardoso

ConfigsReasonsTravel

A través de este servicio, es posible obtener toda la información relacionada con los motivos del viaje. A través de este servicio también es posible gestionar (insertar y cambiar) los motivos de viaje registrados en el cliente.

Para obtener más información sobre los motivos de viaje, consulte el Wiki.

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"reasonTravelId": "00000000-0000-0000-0000-000000000000",
		"description": "string",
		"alert": "string",
		"initialDate": "2020-02-18T14:39:42.355Z",
		"finalDate": "2020-02-18T14:39:42.355Z",
		"legs": [
			"air"
		],
		"requiresDescription": "yes",
		"requiresAuthorization": "yes",
		"quotationAvailable": "yes",
		"allowCompanions": "yes",
		"validateExpenseReport": "yes",
		"closingCard": "yes",
		"integrationCode": "string"
	}
]
Propiedad Tipo Tamaño Descripción
reasonTravelId Guid 36 ID del motivo del viaje. Ejemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descripción del motivo del viaje. Ejemplo: viaje de patrocinador
alert String 2000 Algunas razones de viaje tienen alertas para dar información interna cuando son elegidas. Ejemplo: "Conozco la Política global para viajes corporativos internacionales y entiendo eso en su [...] ubicación si es necesario.

Estoy consciente ##Aceptar##"
initialDate String (Date Time) 24 Fecha / hora de inclusión / creación del motivo del viaje. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (Date Time) 24 Fecha / hora de finalización / del motivo del viaje. Ejemplo: 2019-09-18T16:48:22.490Z
legs String 100 Campo que representa productos relacionados con el motivo del viaje. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 36 Información de descripción obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
requiresAuthorization String (Enum) 3 Información de autorización / aprobación obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa si el motivo del viaje tiene cuota. Ejemplo: Yes/No
allowCompanions String (Enum) 3 Información de permiso de acompañamiento cuando se utiliza el motivo del viaje. Ejemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa si se validará el motivo del viaje en Expense. Ejemplo: Yes/No
closingCard String (Enum) 3 Campo que le informa si el motivo del viaje solo se presentará al cierre de la tarjeta. Ejemplo: Yes/No
integrationCode String 3 Código de integración de motivo de viaje (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'MOTIVO1010'

POST /reasonstravel

Solicitud

{
	"description": "string",
	"alert": "string",
	"legs": [
		"air"
	],
	"requiresDescription": "yes",
	"requiresAuthorization": "yes",
	"quotationAvailable": "yes",
	"allowCompanions": "yes",
	"validateExpenseReport": "yes",
	"closingCard": "yes",
	"integrationCode": "string"
}
Propiedad Tipo Tamaño Obligatorio Descripción
description String 50 Si Descripción del motivo del viaje. Ejemplo: viaje de patrocinador
alert String 2000 No Algunas razones de viaje tienen alertas para dar información interna a quienes la usarán. Ejemplo: "Conozco la Política global para viajes corporativos internacionales y entiendo eso en su [...] ubicación si es necesario.

Estoy consciente ##Aceptar##"
legs String 100 Si Campo que representa productos vinculados al motivo del viaje. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 No Información de descripción obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
requiresAuthorization String (Enum) 3 No Información de autorización obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
quotationAvailable String (Enum) 3 No Campo que informa si el motivo del viaje tiene cuota. Ejemplo: Yes/No
allowCompanions String (Enum) 3 No Información de permiso de acompañamiento cuando se utiliza el motivo del viaje. Ejemplo: Yes/No
validateExpenseReport String (Enum) 3 No Campo que informa si se validará el motivo del viaje para Expense. Ejemplo: Yes/No
closingCard String (Enum) 3 No Campo que le informa si el motivo del viaje solo se presentará al cierre de la tarjeta. Ejemplo: Yes/No
integrationCode String 3 No Código de integración de motivo de viaje (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'MOTIVO1010'

Respuesta

Propiedad Tipo Tamaño Descripción
reasonTravelId Guid 36 ID del motivo del viaje. Ejemplo: 00000000-0000-0000-0000-000000000000

GET /reasonstravel/{reasonTravelId}

Solicitud

Solicitud GET

Respuesta

{
	"reasonTravelId": "00000000-0000-0000-0000-000000000000",
	"description": "string",
	"alert": "string",
	"initialDate": "2020-02-18T19:37:36.697Z",
	"finalDate": "2020-02-18T19:37:36.697Z",
	"legs": [
		"air"
	],
	"requiresDescription": "yes",
	"requiresAuthorization": "yes",
	"quotationAvailable": "yes",
	"allowCompanions": "yes",
	"validateExpenseReport": "yes",
	"closingCard": "yes",
	"integrationCode": "string"
}
Propiedad Tipo Tamaño Descripción
reasonTravelId Guid 36 ID del motivo del viaje. Ejemplo: 00000000-0000-0000-0000-000000000000
description String 50 Descripción del motivo del viaje. Ejemplo: viaje de patrocinador
alert String 2000 Algunos motivos de viaje tienen alertas de información interna para aquellos que lo usarán. Ejemplo: "Conozco la Política global para viajes corporativos internacionales y entiendo eso en su [...] ubicación si es necesario.

Estoy consciente ##Aceptar##"
initialDate String (Date Time) 24 Fecha / hora de inclusión / creación del motivo del viaje. Ejemplo: 2019-09-18T16:48:22.490Z
finalDate String (Date Time) 24 Fecha / hora de finalización / del motivo del viaje. Ejemplo: 2019-09-18T16:48:22.490Z
legs String 100 Campo que representa productos vinculados al motivo del viaje. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 Información de descripción obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
requiresAuthorization String (Enum) 3 Información de autorización obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa si el motivo del viaje tiene cuota. Ejemplo: Yes/No
allowCompanions String (Enum) 3 Información de permiso de acompañamiento cuando se utiliza el motivo del viaje. Ejemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa si se validará el motivo del viaje para Expense. Ejemplo: Yes/No
closingCard String (Enum) 3 Campo que le informa si el motivo del viaje se presentará solo al cierre de la tarjeta. Ejemplo: Yes/No
integrationCode String 3 Código de integración de motivo de viaje (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'MOTIVO1010'

PUT /reasonstravel/{reasonTravelId}

Solicitud

{
	"description": "string",
	"alert": "string",
	"legs": [
		"air"
	],
	"requiresDescription": "yes",
	"requiresAuthorization": "yes",
	"quotationAvailable": "yes",
	"allowCompanions": "yes",
	"validateExpenseReport": "yes",
	"closingCard": "yes",
	"integrationCode": "string"
}
Propiedad Tipo Tamaño Descripción
description String 50 Descripción del motivo del viaje. Ejemplo: viaje de patrocinador
alert String 2000 Algunos motivos de viaje tienen alertas de información interna para aquellos que lo usarán. Ejemplo: "Conozco la Política global para viajes corporativos internacionales y entiendo eso en su [...] ubicación si es necesario.

Estoy consciente ##Aceptar##"
legs String 100 El campo que representa los productos permite el uso del motivo del viaje. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'closingCard'
requiresDescription String (Enum) 3 Información de descripción obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
requiresAuthorization String (Enum) 3 Información de autorización obligatoria para utilizar el motivo del viaje. Ejemplo: Yes/No
quotationAvailable String (Enum) 3 Campo que informa si el motivo del viaje tiene cuota. Ejemplo: Yes/No
allowCompanions String (Enum) 3 Información de permiso de acompañamiento cuando se utiliza el motivo del viaje. Ejemplo: Yes/No
validateExpenseReport String (Enum) 3 Campo que informa si se validará el motivo del viaje para Expense. Ejemplo: Yes/No
closingCard String (Enum) 3 Campo que le informa si el motivo del viaje se presentará solo al cierre de la tarjeta. Ejemplo: Yes/No
integrationCode String 3 Código de integración de motivo de viaje (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'MOTIVO1010'

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
message String 5 Resultado Exitoso o Error al cambiar el campo de gestión. Ejemplo: True/False

Requests

A través de este método el cliente podrá obtener toda la información relacionada a las solicittudes de su ambiente.

GET /requests

Solicitud

request GET /requests
Propiedad Tipo Tamaño Obligatorio Descripción
filters.approverId Guid 100 No ID de identificación del aprodador de la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
filters.tripStatus String (Enum) 36 No Status del viaje de la solicitud. Ejemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
filters.expenseStatus String (Enum) 24 No Status de expense de la solicitud. Ejemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'
filters.datesFilters String 15 No Tipo de fecha en la cuál los campos 'Initial Date' y 'Final Date' serán usados para realizar la consulta.
Ejemplo: 'approvalDate', 'quotationDate', 'issueDate', 'selectionDate', 'tripInitialDate', 'tripEndDate', 'requestDate'
filters.initialDate String (Date Time) 24 No Fecha inicial del filtro de fechas, será la fecha inicial del tipo de fecha seleccionada en el filtro 'datesFilters'.
Obs: Pasa a ser obligatorio en caso de seleccionar un valor del campo 'datesFilters'.
Ejemplo: 2019-09-18
filters.initialChangeDate String (Date Time) 24 No Fecha/hora inicial de la modificación de la solicitud. Ejemplo: 2019-09-18
filters.finalChangeDate String (Date Time) 24 No Fecha/hora final de la modificación de la solicitud. Ejemplo: 2019-09-18
filters.initialApprovationDate String (Date Time) 24 No Fecha/hora inicial de la aprobación da solicitud. Ejemplo: 2019-09-18
filters.finalApprovationDate String (Date Time) 24 No Fecha/hora final de la aprobación de la solicitud. Ejemplo: 2019-09-18
filters.initialApprovationRefundDate String (Date Time) 24 No Fecha/hora inicial de la aprobación del reembolso de la solicitud. Ejemplo: 2019-09-18
filters.finalApprovationRefundDate String (Date Time) 24 No Fecha/hora final de la aprobación del reembolso de la solicitud. Ejemplo: 2019-09-18
filters.finalDate String (Date Time) 24 No Fecha final del filtro de fechas, será la fecha final del tipo de fecha seleccionado en el filtro 'datesFilters'.
Obs: Pasa a ser obligatorio en caso de seleccionar un valor del campo 'datesFilters'.
Ejemplo: 2019-09-18
filters.requestNumber Number 20 No Número de la solicitud específica para ser recuperada.
filters.page String (Enum) 100 No Página solicitada para la recuperación de la información de las solicitudes. Ejemplo: 2
filters.products String (Enum) 15 No Tipo de producto de la solicitud. Ejemplo: 'air', 'hotels', 'rental', 'road', 'advancedPayment', 'refund'

Response

[
  {
    "amountFlights": 0,
    "amountHotels": 0,
    "amountRentals": 0,
    "amountBus": 0,
    "amountServices": 0,
    "amountAdvancePayments": 0,
    "amountRefunds": 0,
    "amountFlightsNationalOnline": 0,
    "amountFlightsNationalOffline": 0,
    "amountFlightsInternationalOnline": 0,
    "amountFlightsInternationalOffline": 0,
    "amountHotelsNationalOnline": 0,
    "amountHotelsNationalOffline": 0,
    "amountHotelsInternationalOnline": 0,
    "amountHotelsInternationalOffline": 0,
    "amountRentalsNationalOnline": 0,
    "amountRentalsNationalOffline": 0,
    "amountRentalsInternationalOnline": 0,
    "amountRentalsInternationalOffline": 0,
    "amountBusNationalOnline": 0,
    "amountBusNationalOffline": 0,
    "amountBusInternationalOnline": 0,
    "amountBusInternationalOffline": 0,
    "requestId": "00000000-0000-0000-0000-000000000000",
    "requestNumber": 0,
    "tripStatus": "open",
    "expenseStatus": "awaitingIssue"
    "advancePaymentStatus": "finalized"
  }
]
Propiedad Tipo Tamaño Descripción
amountFlights Number (int) 100 Cantidad de vuelos de la solicitud. Ejemplo: 2
amountHotels Number (int) 100 Cantidad de hoteles de la solicitud. Ejemplo: 2
amountRentals Number (int) 100 Cantidad de renta de auto de la solicitud. Ejemplo: 2
amountBus Number (int) 100 Cantidad de autobús de la solicitud. Ejemplo: 2
amountServices Number (int) 100 Cantidad de servicios de la solicitud. Ejemplo: 2
amountAdvancePayments Number (int) 100 Cantidad de gastos de anticipo de la solicitud. Ejemplo: 2
amountRefunds Number (int) 100 Cantidad de gastos de rembolso de la solicitud. Ejemplo: 2
amountFlightsNationalOnline Number (int) 100 Cantidad de vuelos nacionales online de la solicitud. Ejemplo: 2
amountFlightsNationalOffline Number (int) 100 Cantidad de vuelos nacionales offline de la solicitud. Ejemplo: 2
amountFlightsInternationalOnline Number (int) 100 Cantidad de vuelos internacionales online de la solicitud. Ejemplo: 2
amountFlightsInternationalOffline Number (int) 100 Cantidad de vuelos internacionales offline de la solicitud. Ejemplo: 2
amountHotelsNationalOnline Number (int) 100 Cantidad de hoteles nacionales online en la solicitud. Ejemplo: 2
amountHotelsNationalOffline Number (int) 100 Cantidad de hoteles nacionais offline en la solicitud. Ejemplo: 2
amountHotelsInternationalOnline Number (int) 100 Cantidad de hoteles internacionales online en la solicitud. Ejemplo: 2
amountHotelsInternationalOffline Number (int) 100 Cantidad de hoteles internacionales offline en la solicitud. Ejemplo: 2
amountRentalsNationalOnline Number (int) 100 Cantidad de renta de auto nacional online en la solicitud. Ejemplo: 2
amountRentalsNationalOffline Number (int) 100 Cantidad de renta de auto nacional offline en la solicitud. Ejemplo: 2
amountRentalsInternationalOnline Number (int) 100 Cantidad de renta de auto internacional online en la solicitud. Ejemplo: 2
amountRentalsInternationalOffline Number (int) 100 Cantidad de renta de auto internacional offline en la solicitud. Ejemplo: 2
amountBusNationalOnline Number (int) 100 Cantidad de autobús nacional online en la solicitud. Ejemplo: 2
amountBusNationalOffline Number (int) 100 Cantidad de autobús nacional offline en la solicitud. Ejemplo: 2
amountBusInternationalOnline Number (int) 100 Cantidad de autobús internacional online en la solicitud. Ejemplo: 2
amountBusInternationalOffline Number (int) 100 Cantidad de autobús internacional offline en la solicitud. Ejemplo: 2
requestId Guid 36 ID de identificación de la solicitud retornada. Ejemplo: 00000000-0000-0000-0000-000000000000
requestNumber Number (int) 100 Número de la solicitud retornada. Ejemplo: 50
tripStatus String 32 Status de viaje de la solicitud. Ejemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
expenseStatus String 20 Status de expense de la solicitud. Ejemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'
advancePaymentStatus String 32 Status del pago del anticipo de la solicitud. Ejemplo: 'saved', 'awaitingQuotation', 'awaitingSelection', 'awaitingApproval', 'awaitingPayment', 'finalized'

GET /requests/{requestId}

Request

Request GET

Response

{
  "agency": "string",
  "agencyCode": "string",
  "selfTicket": "yes",
  "selfBook": "yes",
  "typeTrip": "both",
  "tripRefunded": "yes",
  "country": "string",
  "reasonTraveling": "string",
  "authorizationCode": "string",
  "tripInitialDate": "2020-02-26T23:50:22.496Z",
  "tripFinalDate": "2020-02-26T23:50:22.496Z",
  "expirationDate": "2020-02-26T23:50:22.496Z",
  "quotationDate": "2020-02-26T23:50:22.496Z",
  "emissionDate": "2020-02-26T23:50:22.496Z",
  "selectionDate": "2020-02-26T23:50:22.496Z",
  "requestDate": "2020-02-26T23:50:22.496Z",
  "approvalMeritDate": "2020-02-26T23:50:22.496Z",
  "approvalCostDate": "2020-02-26T23:50:22.496Z",
  "observation": "string",
  "conferenceRefundDate": "2020-02-26T23:50:22.496Z",
  "approvalRefundDate": "2020-02-26T23:50:22.496Z",
  "paymentRefundDate": "2020-02-26T23:50:22.496Z",
  "tripCancellationDate": "2020-02-26T23:50:22.496Z",
  "creditAdvancePaymentDate": "2020-02-26T23:50:22.496Z",
  "parentRequestId": "00000000-0000-0000-0000-000000000000",
  "parentRequestNumber": 0,
  "requestId": "00000000-0000-0000-0000-000000000000",
  "requestNumber": 0,
  "tripStatus": "open",
  "expenseStatus": "awaitingIssue"
}
Propiedad Tipo Tamaño Descripción
agency String 50 Nombre de la agencia (razón) a la que pertenece la solicitud. Ejemplo: Travel Agency
agencyCode String 50 Código de integración de la agencia. Ejemplo: rwrd-sc
selfTicket String 3 Campo que indica si la solicitud es 'SelfTicket' o no. Ejemplo: Yes/No
selfBook String 3 Campo que indica si la solicitud es 'SelfBook' o no. Ejemplo: Yes/No
typeTrip String (Enum) 14 Tipo de viaje de la solicitud. Ejemplo: 'both', 'international', 'domestic'
tripRefunded String 3 Campo que indica si la solicitud es reembolsable. Ejemplo: Yes/No
country String 255 Nombre del País de la solicitud. Ejemplo: Brasil
reasonTraveling String 255 Descripción del motivo de viaje de la solicitud. Ejemplo: Visita a cliente.
authorizationCode String 255 Código de autorización de la solicitud. Ejemplo: PEC 251735131839.6618.4280
tripInitialDate String (Date Time) 24 Fecha inicial de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
tripFinalDate String (Date Time) 24 Fecha final de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
expirationDate String (Date Time) 24 Fecha de expiración de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
quotationDate String (Date Time) 24 Fecha de la cotización de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
emissionDate String (Date Time) 24 Fecha de la emisión de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
selectionDate String (Date Time) 24 Fecha de la elección de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
requestDate String (Date Time) 24 Fecha de inclusión de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
approvalMeritDate String (Date Time) 24 Fecha de aprobación de mérito de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
approvalCostDate String (Date Time) 24 Fecha de aprobación de costo de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
observation String 50 Observación de la solicitud. Ejemplo: La tarifa del hotel debe ser con descuento.
conferenceRefundDate String (Date Time) 24 Fecha de confirmación de reembolso de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
approvalRefundDate String (Date Time) 24 Fecha de aprobación de reembolso de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
paymentRefundDate String (Date Time) 24 Fecha del pago del reembolso de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
tripCancellationDate String (Date Time) 24 Fecha de cancelación del viaje de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
creditAdvancePaymentDate String (Date Time) 24 Fecha del anticipo de crédito de la solicitud. Ejemplo: 2019-09-18T16:48:22.490Z
parentRequestId Guid 36 ID de identificación de la solicitud padre. Ejemplo: 00000000-0000-0000-0000-000000000000
parentRequestNumber Number (int) 100 Número de la solicitud padre. Ejemplo: 50
requestId Guid 36 ID de identificación de la solicitud retornada. Ejemplo: 00000000-0000-0000-0000-000000000000
requestNumber Number (int) 100 Número de la solicitud retornada. Ejemplo: 50
tripStatus String 32 Status del viaje de la solicitud. Ejemplo: 'open', 'requested', 'awaitingPermissionAuthorization', 'awaitingQuotation', 'awaitingDefinitionOfReserve', 'reserving', 'awaitingBudget', 'awaitingSelection', 'waitingDefinitionApprover', 'awaitingApprovalOfCost', 'awaitingIssue', 'issued', 'canceled', 'expired', 'rejected', 'finalized'
expenseStatus String 20 Status del expense de la solicitud. Ejemplo: 'awaitingIssue', 'awaitingLaunch', 'awaitingConfirmation', 'awaitingApproval', 'awaitingPayment', 'finalized'

POST /requests/concluderefund/{requestId}

Solicitud

requisição POST /requests/concluderefund/{requestId}
Propiedad Tipo Tamaño Requerido Descripción
userId Guid 36 Si Solicitud de identificación que tiene el reembolso que se debe completar/finalizar. Ejemplo: 00000000-0000-0000-0000-000000000000

Respuesta

resposta POST /requests/concluderefund/{requestId}
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en completar/finalizar el reembolso. Ejemplo: True/False

GET /requests/roads/terminals

Request

Request GET

Response

[
  {
    "terminalCity": "string"
  }
]
Propiedad Tipo Tamaño Descripción
terminalCity String 255 Nombre de la terminal localizada en la Ciudad. Ejemplo: JIQUIRICA (BA, BRASIL)

POST /requests

Request

{
  "tripStatus": "open",
  "typeTrip": "international",
  "reasonTravel": "string",
  "observation": "string",
  "authorizationCode": "string",
  "approvations": [
    {
      "login": "string",
      "email": "string",
      "fullName": "string"
    }
  ],
  "traveler": {
    "login": "string",
    "email": "string",
    "fullName": "string"
  },
  "requester": {
    "login": "string",
    "email": "string",
    "fullName": "string"
  },
  "allocations": [
    {
      "costCenterCode": "string",
      "costCenterDescription": "string",
      "companyName": "string",
      "percentage": 0,
      "levelsCostCenter": [
        {
          "level": 0,
          "company": "string",
          "code": "string",
          "acronym": "string",
          "description": "string"
        }
      ]
    }
  ],
  "requestFields": [
    {
      "field": "string",
      "content": "string"
    }
  ],
  "travelLegs": [
    {
      "date": "2020-03-25T13:23:35.611Z",
      "origin": "string",
      "destination": "string",
      "typeDate": "dawnConsideringArrival",
      "cabin": "string",
      "class": "string",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "advancePayments": [
    {
      "expense": "string",
      "coin": "string",
      "quantity": 0,
      "value": 0,
      "observation": "string"
    }
  ],
  "hotels": [
    {
      "checkin": "2020-03-25T13:23:35.611Z",
      "checkout": "2020-03-25T13:23:35.611Z",
      "hotel": "string",
      "city": "string",
      "cityId": 0,
      "typeApartament": "double",
      "bedType": "singleType",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "rentals": [
    {
      "vehicleCategory": "economic",
      "airConditioning": true,
      "driver": true,
      "carType": "manual",
      "provider": "string",
      "pickUp": "2020-03-25T13:23:35.611Z",
      "dropOff": "2020-03-25T13:23:35.611Z",
      "pickUpLocation": "string",
      "dropOffLocation": "string",
      "observation": "string",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "roadLegs": [
    {
      "originCity": "string",
      "originTerminal": "string",
      "destinationCity": "string",
      "destinationTerminal": "string",
      "originCountryCode": 0,
      "destinationCountryCode": 0,
      "origin": "string",
      "destination": "string",
      "originCityCode": 0,
      "destinationCityCode": 0,
      "date": "2020-03-25T13:23:35.611Z",
      "schedule": "string",
      "period": "AnyTime",
      "typeWindowTime": "Undefined",
      "formPayment": {
        "description": "string",
        "card": {
          "user": "string",
          "formPayment": "string",
          "cardNumber": "string"
        }
      }
    }
  ],
  "services": [
    {
      "service": "string",
      "quantidade": 0,
      "date": "2020-03-25T13:23:35.611Z",
      "observation": "string",
      "requestFields": [
        {
          "field": "string",
          "content": "string"
        }
      ]
    }
  ]
}
Propiedad Tipo Tamaño Obligatorio Descripción
tripStatus String (Enum) 36 Si Status del viaje de la solicitud. Ejemplo: 'open', 'awaitingQuotation'.
typeTrip String (Enum) 13 Si Tipo de viaje de la solicitud. Ejemplo: 'both', 'international', 'domestic'
reasonTravel String 40 Si Descripción del motivo de viaje registrado en el cliente. Ejemplo: Entrenamiento, Rendición, Reunión con cliente.
observation String 255 No Observación ingresada por el usuario en el momento de la solicitud de autobús. Ejemplo: "Validar Cotización para 2 pedidos offline"
authorizationCode String 255 No Código de autorización de la tarjeta vinculada al gasto. Ejemplo: 9573
traveler UserInfo (Object) 1 No Arreglo responsable por enviar la información del viajero de la solicitud
requester UserInfo (Object) 1 No Arreglo responsable por enviar la información del solicitante de la solicitud
allocations UserInfo (Object) 1 Si Arreglo responsable por enviar la información de la locación del costo de la solicitud
requestFields RequestField (Object) 1 No Arreglo responsable por enviar la información de los campos gerenciales de la solicitud
travelLegs Leg (Object) 1 No Arreglo responsable por enviar la información de los tramos aéreos
advancePayments AdvancePaymentsRQ (Object) 1 No Arreglo responsable por enviar la información del anticipo.
hotels HotelRQ (Object) 1 No Arreglo responsable por enviar la información de los tramos de hotel.
rentals RentalRQ (Object) 1 No Arreglo responsable por enviar la información de los tramos de alquiler de auto de la solicitud
roadLegs Leg (Object) 1 No Arreglo responsable por enviar la información de los tramos de autobús de la solicitud.
services ServiceRQ (Object) 1 No Arreglo responsable por enviar la información de los servicios de la solicitud.
approvations Arreglo responsable por enviar la información de los aprobadores de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
login String 255 Si Login del usuario aprobador de la solicitud. Ejemplo: aprobador.uno
email String 255 Si Email del usuario aprobador de la solicitud. Ejemplo: aprobador.uno@argo.com
fullName String 255 Si Nombre completo del usuario aprobador de la solicitud. Ejemplo: Aprobador Principal
traveler Arreglo responsable por enviar la información del viajero de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
login String 3 Si Login del usuario viajero de la solicitud. Ejemplo: viajero.uno
email String 255 Si Email del usuario viajero de la solicitud. Ejemplo: viajero.uno@argo.com
fullName String 100 Si Nombre completo del usuario viajero de la solicitud. Ejemplo: Viajero Principal.
requester Arreglo responsable por enviar la información del solicitante de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
login String 3 Si Login del usuario solicitante de la solicitud. Ejemplo: solicitante.uno
email String 255 Si Email del usuario solicitante de la solicitud. Ejemplo: solicitante.uno@argo.com
fullName String 100 Si Nombre completo del usuario solicitante de la solicitud. Ejemplo: Solicitante Principal.
allocations Arreglo responsable por enviar la información de la locación del costo de la solicitud.
Propiedad Tipo Tamaño Obligatorio Descripción
costCenterCode String 30 Si Código del centro de costo. Ejemplo: 128031/26
costCenterDescription String 50 Si Descripción del Centro de Costo. Ejemplo: Serv. Sup. VP FCA(Nordeste)/Serv.Trecho-EEOEEN
companyName String 30 No Nombre de la empresa vinculada al Centro de Costo. Ejemplo: Soporte Volpiano
percentage Number (Double) 3 Si Porcentaje de atribución del débito del Centro de Costo. Ejemplo: 15.50
levelsCostCenter LevelCostCenterVM (Object) 1 No Arreglo responsable por enviar la información de los niveles del centro de costo de la asignación del costo de la solicitud.
levelsCostCenter Arreglo responsable por enviar la información de los niveles del centro de costo de la asignación del costo de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
level Number (Integer) 100 No Nivel del centro de costo vinculado a la solicitud. Ejemplo: 1, 2
company String 255 No Empresa vinculada al centro de custo. Ejemplo: Soporte Volpiano - Filial
code String 30 Si Código del centro de costo. Ejemplo: 128031/26
acronym String 10 No Sigla del Centro de Costo. Ejemplo: CCVPFCA
description String 50 Si Descripción del Centro de Costo. Ejemplo: Serv. Sup. VP FCA(Noreste)/Serv.Trecho-EEOEEN - Filial
requestFields Arreglo responsable por enviar la información de los campos gerenciales de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
field String 255 No Identificador del campo gerencial. Ejemplo: argo_division
content String 255 No Contenido ingresado en el campo gerencial. Ejemplo: Temporal
travelLegs Arreglo responsable por enviar la información de los tramos aéreos.
Propiedad Tipo Tamaño Obligatorio Descripción
origin String 50 Si Ciudad de origen del tramo del viaje. Ejemplo: Sao Paulo
destination String 50 Si Ciudad de destino del tramo del viaje. Ejemplo: Río de Janeiro
date String (Date Time) 24 No Fecha del tramo. Ejemplo: 2019-02-05
schedule String 255 No Horario del tramo. Ejemplo: 06
period String (Enum) 12 No Periodo del tramo. Ejemplo: 'AnyTime', 'EarlyMorning', 'Morning', 'Afternoon', 'Evening', 'Defined'
typeWindowTime String (Enum) 9 No Tipo da ventana de tempo del tramo. Ejemplo: 'Undefined', 'departure', 'arrival'
formPayment FormPayment (Object) 1 No Arreglo responsable por enviar la información de la forma de pago del tramo aéreo.
advancePayments Arreglo responsable por enviar la información del anticipo
Propiedad Tipo Tamaño Obligatorio Descripción
expense String 255 No Nombre del gasto de anticipo vinculado a la solicitud. Ejemplo: Viatico
coin String 3 No Tipo da moneda utilizada. Ejemplo: USD
quantity Number 100 No Cantidad de gasto de anticipo. Ejemplo: 2
value Number 100 No Valor del anticipo. Ejemplo: 15
observation String 255 No Observación del anticipo. Ejemplo: Viatico para pago de comida y transporte.
hotels Arreglo responsable por enviar la información del hotel
Propiedad Tipo Tamaño Obligatorio Descripción
checkin String (DateTime) 24 No Fecha de checkin del hotel. Ejemplo: 2019-08-22T12:00:00
checkout String (DateTime) 24 No Fecha de checkout del hotel. Ejemplo: 2019-08-22T12:00:00
hotel String 50 No Nombre del Hotel. Ejemplo: Comfort Hotel Fortaleza
city String 50 No Ciudad donde se encuentra el hotel. Ejemplo: RIO DE JANEIRO / RJ
cityId Number 100   Id de la Ciudad donde se encuentra el hotel. Ejemplo: 00000000-0000-0000-0000-000000000000
typeApartament String 50 No Tipo de habitación reservada. Ejemplo: Single
bedType String 50 No Tipo de cama de la habitación reservada. Ejemplo: Single
observation String 255 No Observaciones al respecto del hotel reservado.
formPayment FormPayment (Object) 1 No Arreglo responsable por enviar la información de la forma de pago del hospedaje
rentals Arreglo responsable por enviar la información del alquiler de auto de la solicitud
Propiedad Tipo Tamaño Obligatorio Descripción
vehicleCategory String (Enum) 12 No Categoria en la cuál el vehículo pertence. Ejemplo: 'economy', 'intermediate', 'superior', 'compact', 'special'
airConditioning string 5 No Campo que indica si el vehículo tiene o no aire acondicionado. Ejemplo: true/false
driver string 3 No Indica si el vehículo será contratado con chofer.
carType String (Enum) 10 No Tipo de transmisión del vehículo. Ejemplo: automatic/manual
provider String 100 No Proveedor de donde será solicitada la información del alquiler de auto. Ejemplo: AMADEUSWS
pickUp String (DateTime) 24 No Fecha de retirada del vehículo. Ejemplo: 2019-08-18T12:00:00 
dropOff String (DateTime) 24 No Fecha de devolución del vehículo. Ejemplo: 2019-08-22T12:00:00
pickUpLocation String 255 No Local de retirada del vehículo. Ejemplo: Sao Paulo / SP, Brasil (SAO)
dropOffLocation String 255 No Local de devolución del vehículo. Ejemplo: Rio de Janeiro / RJ, Brasil - Galeão (GIG)
observation String 255 No Observaciones al respecto del vehículo reservado. Ejemplo: El vehículo está con problema en la puerta trasera izquierda.
formPayment FormPayment (Object) 1 No Arreglo responsable por enviar la información de la forma de pago del alquiler de auto.
roadLegs Arreglo responsable por enviar la información del tramo de autobús de la solicitud.
Propiedad Tipo Tamaño Obligatorio Descripción
originCity String 50 Si Ciudad de origen del tramo del viaje. Ejemplo: Campinas
originTerminal String 50 Si Terminal de origen del tramo del viaje. Ejemplo: CAMPINAS (SP, BRASIL) / SP, Brasil (CPQ)
destinationCity String 50 Si Ciudad de destino del tramo del viaje. Ejemplo: Sao Paulo
destinationTerminal String 50 No Terminal de destino del tramo del viaje. Ejemplo: SÃO PAULO - TIETE (SP, BRASIL) / SP, Brasil (SAO)
originCountryCode Number (Integer) 100 No Código del país de origen del tramo. Ejemplo: 29
destinationCountryCode Number (Integer) 100 No Código del país de destino del trecho. Ejemplo: 29
originCityCode Number (Integer) 100 No Código de la ciudad de orige del tramo. Ejemplo: 4831
destinationCityCode Number (Integer) 100 No Código de la ciudad de destino del tramo. Ejemplo: 5287
origin String 50 No Ciudad de origen del tramo del viaje. Ejemplo: Campinas
destination String 50 No Ciudad de destino del tramo del viaje. Ejemplo: Sao Paulo
date String (Date Time) 24 No Fecha del tramo. Ejemplo: 2019-02-05
schedule String 255 No Horario del tramo. Ejemplo: 06
period String (Enum) 12 No Periodo del tramo. Ejemplo: 'AnyTime', 'EarlyMorning', 'Morning', 'Afternoon', 'Evening', 'Defined'
typeWindowTime String (Enum) 9 No Tipo da ventana de tiempo del tramo. Ejemplo: 'Undefined', 'departure', 'arrival'
formPayment FormPayment (Object) 1 No Objeto responsable por transportar as informações da forma de pago da solicitud
services Arreglo responsable por enviar la información del servicio de la solicitud.
Propiedad Tipo Tamaño Obligatorio Descripción
service String 255 No Nombre del servicio. Ejemplo: Compra de equipaje.
Quantidade Number 50 No Cantidad de servicios de la solicitud. Ejemplo: 1
date String 24 No Fecha del servicio. Ejemplo: 2020-01-08T15:00:00
observation String 255 No Observación del servicio. Ejemplo: Se solicitó equipaje extra por no incluir inicialmente.
requestFields ManagementFieldRSVM (Object) 1 No Arreglo responsable por enviar la información de los campos gerenciales.
requestFields Arreglo responsable por enviar la información de los campos gerenciales
Propiedad Tipo Tamaño Obligatorio Descripción
content String 50 No Contenido presentado en el campo. Ejemplo: 08/01/2003
field String 50 No Identificador del campo. Ejemplo: sustentacao_ajweg_checkin3
formPayment Arreglo responsable por enviar la información de la forma de pago del producto
Propiedad Tipo Tamaño Obligatorio Descripción
description String 255 No Descripción de la forma de pago de la solicitud. Ejemplo: Creditcard
card Card (Object) 1 No Arreglo responsable por enviar la información de la tarjeta utilizada en la solicitud.
card Arreglo responsable por enviar la información del tarjeta utilizada en la solicitud.
Propiedad Tipo Tamaño Obligatorio Descripción
user String 255 No Nombre del usuario utilizador de la tarjeta. Ejemplo: Mauricio
formPayment String 255 No Forma de pago de tarjeta. Ejemplo: Tarjeta de crédito
cardNumber String 255 No Número de lo tarjeta. Ejemplo: 3216-8394-9403-0604

Response

Propiedad Tipo Tamaño Descripción
nroSolic Number (int) 10 Número de solicitud generado. Ejemplo: 2

POST /requests/cancel/{requestId}

Request

{
  "product": "air",
  "cancelReason": "string"
}
Propiedad Tipo Tamaño Obligatorio Descripción
product String (Enum) 15 Si Información del producto que será cancelado. Ejemplo: 'air', 'hotels', 'rental', 'service', 'road', 'advancedPayment', 'refund', 'all'
cancelReason String 255 Si Descripción del motivo por el cuál la solicitud se está cancelando. Ejemplo: Cancelada porque no cumpplió con la política de la empresa.

Response

Response PUT
Propiedad Tipo Tamaño Descripción
message String 5 éxito o error al cancelar la solicitud. Ejemplo: True/False

RequestsAgents

A través de este servicio, es posible identificar la información del asesor de viajes / asistente de la solicitud abierta en Argo.

GET /requests/{requestId}/agents

Solicitud

Solicitud GET

Respuesta

{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"userId": "00000000-0000-0000-0000-000000000000",
	"email": "string",
	"login": "string",
	"firstName": "string",
	"lastName": "string",
	"telephone": "string",
	"thirdParty": "yes",
	"groups": [
		"admin"
	],
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID del usuario registrado. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 24 Correo electrónico de contacto del asistente de la solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 24 Inicio de sesión de contacto del asistente de solicitud. Ejemplo: roberto.luiz
firstName String 3 Nombre del usuario de la solicitud. Ejemplo: Roberto
lastName Int 5 Apellido del usuario de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del usuario de la solicitud. Ejemplo: 995463154
thirdParty String 8 Indicador que indica si el asistente está subcontratado o no. Ejemplo: yes/no
groups String 23 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'

RequestsAllocations

Mediante este método, es posible recuperar la asignación de débito (método de pago) utilizada en una solicitud determinada. Para recuperar esta información, es necesario tener el ID de la solicitud que desea consultar.

GET /requests/{requestId}/allocations

Solicitud

Solicitud GET

Respuesta

[
	{
		"costCenterCode": "string",
		"costCenterDescription": "string",
		"companyId": "00000000-0000-0000-0000-000000000000",
		"companyName": "string",
		"companyCode": "string",
		"companyReference": "string",
		"percentage": 0,
		"ledgerAccountCode": "string",
		"ledgerAccountDescription": "string",
		"projectCode": "string",
		"projectDescription": "string",
		"levelsCostCenters": [
			{
				"costCenterCode": "string",
				"costCenterDescription": "string",
				"level": 0,
				"companyName": "string"
			}
		]
	}
]
Propiedad Tipo Tamaño Descripción
costCenterCode String 30 Código de centro de costos relacionada con la asignación de deuda. Ejemplo: 001
costCenterDescription String 50 Descripción del centro de costos relacionada con la asignación de deuda. Ejemplo: desarrollo
companyId String (Guid) 36 Identificación de la empresa relacionada con la asignación de deuda. Ejemplo: 00000000-0000-0000-0000-000000000000
companyName String 30 Nombre de la empresa relacionada con la asignación de la deuda. Ejemplo: Argo
companyCode String 30 Código de integración de la empresa relacionado con la asignación de deuda. Ejemplo: 50043
companyReference String 30 Referencia de la empresa que está relacionada con la asignación de la deuda. Ejemplo: 0001/006433
percentage Integer 3 Porcentaje vinculado a la asignación de deuda. Ejemplo: 50
ledgerAccountCode String 20 Cuenta Contable relacionado con la asignación de deuda. Ejemplo: 111
ledgerAccountDescription String 50 DDescripción de la Cuenta Contable relacionada con la asignación de deuda. Ejemplo: Cuenta de mayor Argo
projectCode String 30 Código de proyecto relacionado con la asignación de deuda. Ejemplo: EB4008_VG_25B8750VGN_VN
projectDescription String 50 Descripción del proyecto relacionado con la asignación de deuda. Ejemplo: actividades de innovación
levelsCostCenters Niveles de centros de costos vinculados a la asignación de deuda
Propiedad Tipo Tamaño Descripción
costCenterCode String 30 Código de Centro de Costos relacionado con la asignación de la deuda. Ejemplo: 002
costCenterDescription String 50 Descripción del Centro de Costos relacionado con la asignación de deuda. Ejemplo: centro de costos Argo
level Integer 3 Nivel de Centro de Costos relacionado con la asignación de deuda. Ejemplo: 001
companyName String 30 Nombre de la Empresa relacionada con la asignación de deuda. Ejemplo: Argo Solutions

RequestsApprovals

Mediante este método, es posible recuperar los datos de los aprobadores de una solicitud específica. Para esto, es necesario tener el ID de la solicitud que desea consultar. Además, a través del PUT es posible aprobar / reprobar una solicitud.

GET /requests/{requestId}/approvals

Solicitud

Solicitud GET

Respuesta

[
	{
		"approver": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"realApprover": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"approved": "yes",
		"approvalDate": "2020-03-06T14:32:24.607Z"
	}
]
approver El objeto contiene la información de aprobación del usuario relacionada con la solicitud
Propiedad Tipo Tamaño Descripción
clientId String(Guid) 36 ID del cliente al que está vinculado el aprobador. Ejemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID de usuario del aprobador. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 256 Correo electrónico del usuario aprobador. Ejemplo: pedro.silva@argo.com
login String 256 Inicio de sesión del usuario aprobador. Ejemplo: pedro.silva
firstName String 20 Nombre del usuario aprobador. Ejemplo: Pedro
lastName String 20 Apellido del usuario aprobador. Ejemplo: Silva
telephone String 30 Teléfono del usuario aprobador. Ejemplo: 5511998525545
fax String 30 Fax del usuario aprobador. Ejemplo: 5511998525545
registration Strin 20 Registro del usuario aprobador. Ejemplo: 464545
thirdParty String(Enum) 3 Indica si el usuario que aprueba es un "tercero". Ejemplo: Yes/No
groups String(Enum) 10 Grupo al que pertenece el usuario aprobador. Ejemplo: admin, financial, manager, user.
rg String 14 RG (documento nacional de identificación civil en Brasil) del usuario aprobador. Ejemplo: 265487745
cpf String 12 CPF (registro de persona en Brasil) del usuario aprobador. Ejemplo: 36548425612
passport String 20 Pasaporte del usuario aprobador. Ejemplo: BR123456
employeeId String 20 Registro del usuario aprobador. Ejemplo: 464545
fullName String 100 Nombre completo del usuario aprobador. Ejemplo: Pedro Silva
integrationCode String 50 Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
department String 50 Departamento vinculado al registro del usuario aprobador. Ejemplo: desarrollo
realApprover El objeto contiene la información del usuario que aprobó la solicitud.
Propiedad Tipo Tamaño Descripción
clientId String(Guid) 36 ID del cliente al que está vinculado el aprobador. Ejemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID de usuario del aprobador. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 256 Correo electrónico del usuario aprobador. Ejemplo: pedro.silva@argo.com
login String 256 Inicio de sesión del usuario aprobador. Ejemplo: pedro.silva
firstName String 20 Nombre del usuario aprobador. Ejemplo: Pedro
lastName String 20 Apellido del usuario aprobador. Ejemplo: Silva
telephone String 30 Teléfono del usuario aprobador. Ejemplo: 5511998525545
fax String 30 Fax del usuario aprobador. Ejemplo: 5511998525545
registration String 20 Registro del usuario aprobador. Ejemplo: 464545
thirdParty String(Enum) 3 Indica si el usuario que aprueba es un "tercero". Ejemplo: Yes/No
groups String(Enum) 10 Grupo al que pertenece el usuario aprobador. Ejemplo: admin, financial, manager, user.
rg String 14 RG (documento nacional de identificación civil en Brasil) del usuario aprobador. Ejemplo: 265487745
cpf String 12 CPF (registro de persona en Brasil) del usuario aprobador. Ejemplo: 36548425612
passport String 20 Pasaporte del usuario aprobador. Ejemplo: BR123456
employeeId String 20 Registro del usuario aprobador. Ejemplo: 464545
fullName String 100 Nombre completo del usuario aprobador. Ejemplo: Pedro Silva
integrationCode String 50 Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
department String 50 Departamento vinculado al registro del usuario aprobador. Ejemplo: desarrollo
approved String(Enum) 3 Indica si la solicitud tiene un estado aprobado. Ejemplo: Yes
approvalDate String(Datetime) 24 Fecha de aprobación de la solicitud. Ejemplo: 2020-03-06T14:32:24.607Z

PUT /requests/{requestId}/approvals

Solicitud

Solicitud PUT
Propiedad Tipo Tamaño Requerido Descripción
typeOfReprovation String(Enum) 7 Si Tipo de producto a ser aprobado / reprobado. Ejemplo: air, rental, hotels
action String(Enum) 10 No Medidas a tomar en relación con la Solicitud. Ejemplo: approve, disapprove
approver El objeto contiene la información del usuario aprobador
Propiedad Tipo Tamaño Requerido Descripción
numberList Number(Integer) 100 No Número en la lista de aprobadores. Ejemplo: 1
representative String(Enum) 3 No Si el aprobador es un delegado. Ejemplo: Yes, No
allocation String(Enum) 3 No Si el aprobador tiene asignación. Ejemplo: Yes, No
level String(Enum) 3 No Si el aprobador tiene un nivel. Ejemplo: Yes, No
scope Number(Decimal) 100 No Argo permite la creación de estructuras de aprobación por rango de valores para los tipos: "sequential" y "single". Esta propiedad permite definir el rango registrado en la estructura
email String 256 Si Correo electrónico del usuario aprobador. Ejemplo: argo@useargo.com
login String 256 Si Sesión del Usuario Aprobador de inicio. Ejemplo: argo.teste
fullName String 100 No Nombre completo del usuario aprobador. Ejemplo: João Silva
reason String 200 No Motivo de la aprobación / reprobación. Ejemplo: valor superior al permitido

Respuesta

Respuesta PUT
Propiedad Tipo Tamaño Descripción
Message String(Enum) 5 Mensaje de retorno de acción. Ejemplo: True/False

RequestsFlightsQuotations

A través de este método, es posible recuperar los datos de una cotización aérea ingresada en una solicitud. Para obtener estos datos es necesario informar el ID de la OS.

Para obtener más información sobre cotizaciones aéreas, consulte la Wiki.

GET

Solicitud

Solicitud GET

Respuesta

[
	{
		"webServiceId": "string",
		"locator": "string",
		"ticket": "string",
		"ticketDate": "2020-03-11T18:38:52.583Z",
		"coin": "string",
		"bacenCodeCoin": "string",
		"taxCoin": "string",
		"justificationLegs": [
			{
				"type": "string",
				"description": "string"
			}
		],
		"bacenCodeCoinTaxCode": "string",
		"codeAgreementApplied": "string",
        "taxValue": 0,
        "taxIva": 0,
        "taxTua": 0,
        "otherTax": 0,
		"ticketValue": 0,
		"ticketValueMore": 0,
		"ticketValueLess": 0,
		"ticketExchange": 0,
		"valueTicketReference": 0,
		"exchangeTax": 0,
		"totalValue": 0,
		"approvedTotalValue": 0,
		"fullFare": 0,
		"departureDate": "2020-03-11T18:38:52.583Z",
		"reissue": {
			"reissueOriginalTicket": "string",
			"reissueNumberMcoCredit": "string",
			"reissueDateMcoCredit": "2020-03-11T18:38:52.583Z",
			"reissueValueMcoCredit": 0,
			"reissueNumberEmdFine": "string",
			"reissueDateEmdFine": "2020-03-11T18:38:52.583Z",
			"emdAuthorizationReissue": "string",
			"reissueAmountEmdFine": 0
		},
		"arrivalDate": "2020-03-11T18:38:52.583Z",
		"immediateIssue": true,
		"onlineIssue": true,
		"observation": "string",
		"id": "string",
		"quotationId": "00000000-0000-0000-0000-000000000000",
		"online": "yes",
		"formPayment": {
			"description": "string",
			"typePayment": "invoiced",
			"code": "string",
			"air": "yes",
			"hotels": "yes",
			"rental": "yes",
			"service": "yes",
			"bus": "yes",
			"restrictive": "yes",
			"alternativeUATP": "yes",
			"card": {
				"paymentName": "string",
				"name": "string",
				"cardNumber": "string",
				"flag": "string",
				"active": "yes",
				"providerId": "string",
				"webServiceId": "string"
			},
			"billingCode": "string",
			"billingDescription": "string"
            "cardAuthorization": "string"
		},
		"issuedOnline": "yes",
		"agentUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"issuerUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"airOffereds": [
			{
				"id": "string",
				"airline": "string",
				"numberFlight": "string",
				"date": "string",
				"hour": "string",
				"scales": 0,
				"connections": 0,
				"amount": "string",
				"totalAmount": 0,
				"grouped": "yes"
			}
		],
		"airQuotedsLegs": [
			{
				"LegId": "00000000-0000-0000-0000-000000000000",
				"parentLegId": "00000000-0000-0000-0000-000000000000",
				"quantityScales": 0,
				"quantityConnections": 0,
				"departureDate": "2020-03-11T18:38:52.583Z",
				"arrivalDate": "2020-03-11T18:38:52.583Z",
				"departure": "string",
				"departureDescription": "string",
				"departureCity": "string",
				"departureCountry": "string",
				"arrival": "string",
				"arrivalDescription": "string",
				"arrivalCity": "string",
				"arrivalCountry": "string",
				"cabin": "string",
				"cabinClass": "string",
				"fareCode": "string",
				"marketingAirline": "string",
				"marketingAirlineDescription": "string",
				"operationAirline": "string",
				"operationAirlineDescription": "string",
				"departureTerminal": "string",
				"flightNumber": "string",
				"aircraft": "string",
				"seat": "string",
				"observation": "string",
				"locatorAirline": "string"
			}
		],
		"feesLeg": [
			{
				"feeId": "00000000-0000-0000-0000-000000000000",
				"initialDate": "2020-03-11T18:38:52.583Z",
				"finalDate": "2020-03-11T18:38:52.583Z",
				"initialHour": "string",
				"finalHour": "string",
				"dayWeek": "monday",
				"name": "string",
				"description": "string",
				"typeTrip": "both",
				"action": "quotation",
				"online": "yes",
				"service": "air",
				"amount": 0,
				"percentage": 0,
				"ceilingPrice": 0,
				"inclusionDate": "2020-03-11T18:38:52.583Z"
			}
		]
	}
]
Propiedad Tipo Tamaño Descripción
webServiceId String 50 Código del servicio web donde se consultó la cotización aérea. Ejemplo: GOL
locator String 10 Localizador de reservas. Ejemplo: ZN3FYK
ticket String 20 Número de boleto Ejemplo: XQL6MX
ticketDate String(DateTime) 24 Fecha de emisión del boleto. Ejemplo: 2019-09-18T16:48:22.490Z
coin String 3 Moneda utilizada en la cotización. Ejemplo: BRL
bacenCodeCoin Number(int) 14 Código de moneda relacionada con el precio del servicio aéreo. Ejemplo: 790
taxCoin Number(double) 16 Código de moneda relacionada con la tasa de impuesto del servicio aéreo. Ejemplo: BRL
justificationLegs Objeto responsable para retornar las justificaciones de la cotización aérea
Propiedad Tipo Tamaño Descripción
type String 255 Tipo de justificación. Exemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descripción de la justificación. Exemplo: Vuelo elegido está con valor arriba de los permitido.
Propiedad Tipo Tamaño Descripción
bacenCodeCoinTaxCode Number(int) 14 Código de Bacen para el tipo de cambio de moneda. Ejemplo: 790
codeAgreementApplied String 50 Código "Codeshare" de la aerolínea que vendió el boleto. Ejemplo: JJ124
taxValue Number(double) 16 Cantidad de la tarifa del boleto. Ejemplo: 65.9
taxIva Number(decimal) 16 Suma de las tarifas de los billetes con IVA. Ejemplo: 80.9
taxTua Number(decimal) 16 Soma das taxas de TUA no bilhete. Exemplo: 120.6
otherTax Number(decimal) 16 Suma de otras tarifas de entradas. Ejemplo: 37.1
ticketValue Number(double) 16 Boleto / valor del boleto. Ejemplo: 1460.97
ticketValueMore Number(double) 16 Valor agregado al valor del ticket. Ejemplo: 0
ticketValueLess Number(double) 16 El valor disminuyó al valor del boleto. Ejemplo: 0
ticketExchange Number(double) 16 Valor de cambio del boleto. Ejemplo: 1
valueTicketReference Number(double) 16 Valor de referencia del ticket. Ejemplo: 1718.1
exchangeTax Number(double) 16 Valor del tipo de cambio. Ejemplo: 1
totalValue Number(double) 16 Valor total del boleto. Ejemplo: 1526.87
approvedTotalValue Number(double) 16 Valor total aprobado para cotización. Ejemplo: 1525.87
fullFare Number(double) 16 Valor más alto de la tarifa del vuelo relacionado con la cotización. Ejemplo: 4398
departureDate String(DateTime) 24 Fecha de salida del vuelo relacionada con la cotización. Ejemplo: 2020-09-18T16:48:22.490Z
reissue Objeto responsable de devolver la información de reemisión del boleto
Propiedad Tipo Tamaño Descripción
reissueOriginalTicket String 20 Número de boleto que fue reeditado. Ejemplo: 9572388231627
reissueNumberMcoCredit String 20 Número de boleto reemitido con crédito MCO (Miscellaneous charges order). Ejemplo: 9572388231929
reissueDateMcoCredit String(DateTime) 24 Fecha de emisión reemitida con crédito MCO (Miscellaneous charges order). Ejemplo: 2020-09-18T16:48:22.490Z
reissueValueMcoCredit Number(Decimal) 16 Monto del boleto reemitido con crédito MCO (Miscellaneous charges order). Ejemplo: 850.00
reissueNumberEmdFine String 20 Número de EMD (Electronic Miscellaneous Document) con la multa de reemisión. Ejemplo: EGSD/V6X/SC-PENF
reissueDateEmdFine String(DateTime) 24 Fecha de EMD (Electronic Miscellaneous Document) con la multa de reemisión. Ejemplo: 2020-09-18T16:48:22.490Z
emdAuthorizationReissue String 20 Código de autorización de EMD (Electronic Miscellaneous Document) para la reemisión. Ejemplo: 072189
reissueAmountEmdFine Number(Decimal) 16 Importe de la multa EMD (Electronic Miscellaneous Document) por la reemisión. Ejemplo: 150.00
Propiedad Tipo Tamaño Descripción
arrivalDate String(DateTime) 24 Fecha de llegada del vuelo. Ejemplo: 2020-09-18T16:48:22.490Z
immediateIssue Boolean 5 Campo que Indica si la emisión se llevó a cabo de inmediato. Ejemplo: false
onlineIssue Boolean 5 Campo que indica si la emisión fue On-Line. Ejemplo: true
observation String 255 Observaciones sobre cotización. Ejemplo: cotizado con un valor superior al esperado.
id Number(int) 50 ID del vuelo en la cotización aérea. Ejemplo: 1, 3, 5
quotationId Number(int) 50 ID de la cotización. Si un segmento aéreo tiene 7 comillas, es esta variable la que aumentará
online String 3 Campo que Indica si la reserva se realizó a través del módulo On-Line. Ejemplo: yes/no
formPayment Objeto responsable de devolver la información del método de pago de la solicitud
Propiedad Tipo Tamaño Descripción
description String 255 Descripción del método de pago de la solicitud. Ejemplo: facturado
typePayment String (Enum) 15 Tipo de pago utilizados en la solicitud. Ejemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integración del método de pago. (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'TIPOFATURA1010'
Air String 3 Campo que indica si el método de pago se puede utilizar para la compra de aéreo. Ejemplo: yes/no
hotels String 3 Campo que indica si el método de pago se puede utilizar para comprar alojamiento. Ejemplo: yes/no
rental String 3 Campo que indica si el método de pago se puede utilizar para la compra de Arrendamiento. Ejemplo: yes/no
service String 3 Campo que indica si el método de pago se puede utilizar para compra de Servicio. Ejemplo: yes/no
bus String 3 Campo que indica si el método de pago puede usarse para la adquisición de Autobus. Ejemplo: yes/no
restrictive String 3 Campo que indica si la facturación es del tipo restrictivo. Ejemplo: yes/no
alternativeUATP String 3 Campo que indica si la facturación es de tipo UATP. Ejemplo: yes/no
card Objeto responsable de devolver la información de la tarjeta de crédito relacionada con el método de pago
Propiedad Tipo Tamaño Descripción
paymentName String 50 Nombre del método de pago de la tarjeta. Ejemplo: tarjeta de crédito
name String 50 Nombre del titular de la tarjeta. Por ejemplo: Argo Cartão
cardNumber String 255 Número de tarjeta. Ejemplo: 3216-8394-9403-0604
flag String 50 Campo que Indica el tipo detarjeta. Ejemplo: Visa, Mastercard
active String 3 Campo que indica si la tarjeta está activa. Ejemplo: yes/no
providerId String 50 ID del proveedor de la tarjeta. Ejemplo: T0009015590A999118
webServiceId String 50 ID del servicio web de la tarjeta (solo tarjeta virtual). Ejemplo: B2BPAY, WEX, CONFERMA
Propiedad Tipo Tamaño Descripción
billingCode String 50 Código de facturación del método de pago. Ejemplo: BV5
billingDescription String 50 Descripción del código de facturación de la forma de pago. Ejemplo: FACTURACIÓN TOTAL PARA LA AGENCIA
cardAuthorization String 50 Código de Seguridad de la tarjeta de crédito que haya sido registrado en el campo "Tipo de Facturación de la Solicitud", en el momento de la emisión de una reserva aérea
issuedOnline String(Enum) 3 Campo que indica si la cotización se emitió en línea. Ejemplo: Yes, No
agentUser Objeto responsable de devolver la información del usuario asesor
Propiedad Tipo Tamaño Descripción
clientId String(Guid) 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID del usuario asesor. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del usuario de la OS. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del usuario de la solicitud. Ejemplo: roberto.luiz
firstName String 255 Nombre del usuario asesor de la solicitud. Ejemplo: Roberto
lastName String 255 Apellido del usuario asesor de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del usuario asesor de la solicitud. Ejemplo: 9 95463154
fax String 50 Fax del usuario asesor de la solicitud. Ejemplo: 9 95463154
registration String 255 ID de registro de usuario. Ejemplo: 10377192
thirdParty String(Enum) 3 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
groups String(Enum) 10 Grupo en el que se inserta el usuario: Exemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de identificación de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
passport String 20 Número de pasaporte de usuario. Ejemplo: BR123456
employeeId String 255 Identificador de registro de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario asistente (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
department String 255 Departamento del usuario. Ejemplo: Operacional
issuerUser Objeto responsable de devolver la información del usuario emisor
Propiedad Tipo Tamaño Descripción
clientId String(Guid) 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
userId String(Guid) 36 ID de usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del emisor de la solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del emisor de la solicitud. Ejemplo: roberto.luiz
firstName String 255 Nombre del emisor de la solicitud Ejemplo: Roberto
lastName String 255 Apellido del emisor de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del emisor de la solicitud. Ejemplo: 9 95463154
fax String 50 Fax del emisor de la solicitud. Ejemplo: 9 95463154
registration String 255 Identificador de registro de usuario. Ejemplo: 10377192
thirdParty String(Enum) 3 Campo que indica si el emisor está subcontratado o no. Ejemplo: yes/no
groups String(Enum) 10 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de identificación de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
passport String 20 Número de pasaporte de usuario. Ejemplo: BR123456
employeeId String 255 Identificador de registro de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: emisor principal
integrationCode String 255 Código de integración del usuario emisor (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
department String 255 Departamento del usuario. Ejemplo: operacional
airOffereds Objeto responsable de devolver la información de los vuelos ofrecidos
Propiedad Tipo Tamaño Descripción
id String 5 ID del vuelo ofrecido. Ejemplo: 1, 3, 5
airline String 50 Código de la Aerolínea. Ejemplo: G3
numberFlight String 4 Número de vuelo de la cotización. Ejemplo: 1557
date String 40 Fecha de vuelo. Ejemplo: 2020-09-18T16:48:22.490Z
hour String 20 Horario de vuelo. Ejemplo: 07:05
scales String 4 Número de paradas que tiene el vuelo. Ejemplo: 0
connections String 4 Número de conexiones que tiene el vuelo. Ejemplo: 0
amount String 100 Valor del boleto. Ejemplo: 1150.00
totalAmount Number 100 Valor total del boleto. Ejemplo: 1715.00
grouped String(Enum) 3 Campo que indica si el vuelo se ha agrupado en un localizador. Ejemplo: Yes, No
airQuotedsLegs Objeto responsable de devolver la información de los segmentos ofrecidas
Propiedad Tipo Tamaño Descripción
LegId String(Enum) 36 ID del segmento ofrecido. Ejemplo: 00000000-0000-0000-0000-000000000000
parentLegId String(Enum) 36 ID del segmento "Parent". Ejemplo: 00000000-0000-0000-0000-000000000000
quantityScales Number(Int) 100 Número de escalas del segmento. Ejemplo: 2
quantityConnections Number(Int) 100 Número de conexiones del segmento. Ejemplo: 1
departureDate String(DateTime) 24 Fecha de salida. Ejemplo: 2020-09-18T16:48:22.490Z
arrivalDate String(DateTime) 24 Fecha de llegada. Ejemplo: 2020-09-19T16:48:22.490Z
departure String 3 Acrónimo del aeropuerto de origen. Ejemplo: SAO, GIG
departureDescription String 50 Descripción de la ciudad de origen. Ejemplo: São Paulo
departureCity String 50 Ciudad de origen del segmento. Ejemplo: São Paulo
departureCountry String 50 País de origen del segmento. Ejemplo: Brasil
arrival String 3 Acrónimo del aeropuerto de destino. Ejemplo: SAO, GIG
arrivalDescription String 50 Descripción del aeropuerto de destino. Ejemplo: Congonhas
arrivalCity String 50 Ciudad del aeropuerto de destino. Ejemplo: São Paulo
arrivalCountry String 50 País de destino del segmento. Ejemplo: Brasil
cabin String 1 Clase de servicio, es decir, la cabina que se utilizará. Ejemplo: Y
cabinClass String 5 Cabina de la clase del tramo. Ejemplo: W
fareCode String 2000 Fare Basis del segmento del vuelo. Ejemplo: K100BG/OWNR/N§0~{0}31~X
marketingAirline String 3 Aerolínea que emitió el boleto. Ejemplo: JJ, G3
marketingAirlineDescription String 50 Descripción de la aerolínea que emitió el boleto. Ejemplo: Latam, Passaredo, Azul
operationAirline String 3 Aerolínea que opera el segmento. Ejemplo: JJ, G3
operationAirlineDescription String 50 Descripción de la aerolínea que opera el segmento. Ejemplo: Latam, Passaredo, Azul
departureTerminal String 100 Nombre de la terminal de origen. Ejemplo: Congonhas
flightNumber String 5 Número de vuelo. Ejemplo: 1890, 3557
aircraft String 30 Modelo de avión. Ejemplo: E95
seat String 60 Número de asiento. Ejemplo: 18D
observation String 200 Observaciones relevantes relacionadas con el segmento. Ejemplo: reunión de emergencia
locatorAirline String 10 Localizador de la aerolínea. Ejemplo: SZFOEV
feesLeg Objeto responsable de devolver la información de tarifa para los segmentos de cotización aérea
Propiedad Tipo Tamaño Descripción
feeId Int 50 ID de la tarifa vinculada a la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Fecha de inicio de la solicitud. Ejemplo: 2019-08-22
finalDate String (DateTime) 24 Fecha de finalización de la solicitud. Ejemplo: 2019-08-22
initialHour String (DateTime) 24 Hora inicial de solicitud. Ejemplo: 2019-08-22
finalHour String (DateTime) 24 Hora de finalización de la solicitud. Ejemplo: 2019-08-22
dayWeek String 10 Dia de la semana. Ejemplo: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'
name String 50 Nombre de la tarifa. Ejemplo: Experience Bundle
description String 1024 Descripción de la tarifa. Ejemplo: se cobrarán R$ 15,00 por la emisión de paquetes de secciones nacionales o internacionales, realizadas online o offline. Para todas las solicitudes (abiertas desde 29/11/2019) en este cliente. Si la llamada se realiza entre las 00:00 y las 23:59 .
typeTrip String (Enum) 13 Tipo de viaje al que está vinculada la tarifa. Ejemplo: 'both', 'international', 'domestic'
action String 13 Tipo de acción tomada para cobrar la tarifa. Ejemplo: 'quotation', 'ticketing'
online String 3 Campo que informa si la tarifa está relacionada con una transacción online. Ejemplo: yes/no
service String 7 Tipo de servicio que incluye la tarifa. Ejemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Importe de la tarifa. Ejemplo: 20
percentage Number 100 Porcentaje de tarifa. Ejemplo: 5
ceilingPrice Number 100 Valor máximo de la tarifa. Ejemplo: 35
inclusionDate String (DateTime) 24 Fecha de inclusión de tarifa. Ejemplo: 2020-03-11T19:29:50.873Z

RequestsFees

Mediante este método, es posible recuperar las Tarifas cobradas en una solicitud determinada. Para realizar esta consulta, es necesario informar el ID de la OS. Para más información sobre tarifas, consulte el Wiki.

GET /requests/{requestId}/fees

Solicitud

Solicitud GET

Respuesta

[
	{
		"feeId": "00000000-0000-0000-0000-000000000000",
		"initialDate": "2020-03-10T21:33:17.204Z",
		"finalDate": "2020-03-10T21:33:17.204Z",
		"name": "string",
		"description": "string",
		"typeTrip": "both",
		"action": "quotation",
		"online": "yes",
		"service": "air",
		"amount": 0,
		"percentage": 0,
		"ceilingPrice": 0,
		"inclusionDate": "2020-03-10T21:33:17.204Z"
	}
]
Propiedad Tipo Tamaño Descripción
feeId Int 50 ID de la tarifa vinculada a la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Fecha de inicio de la solicitud. Ejemplo: 2019-08-22
finalDate String (DateTime) 24 Fecha de finalización de la solicitud. Ejemplo: 2019-08-22
name String 50 Nombre de la tarifa Ejemplo: Experience Bundle
description String 1024 Descripción de la tarifa. Ejemplo: se cobrarán R $ 15,00 por la emisión de paquetes de secciones nacionales o internacionales, realizadas online o offline. Para todas las solicitudes (abiertas desde 29/11/2019) en este cliente. Si la llamada se realiza entre las 00:00 y las 23:59
typeTrip String (Enum) 13 Tipo de viaje al que está vinculada la tarifa. Ejemplo: 'both', 'international', ´domestic'
action String 13 Tipo de acción tomada para la tarifa. Ejemplo: 'quotation', 'ticketing'
online String 3 Campo que informa si la tarifa fue Online. Ejemplo: yes/no
service String 7 Tipo de servicio de la tarifa. Ejemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Importe de la tarifa. Ejemplo: 20
percentage Number 100 Porcentaje de la tarifa. Ejemplo: 5
ceilingPrice Number 100 Valor máximo de la tarifa. Ejemplo: 35
inclusionDate String (DateTime) 24 Fecha de inclusión de tarifa. Ejemplo:

RequestsFlightsRequesteds

A través de este método, es posible recuperar los datos para emitir una solicitud aérea. Para recuperar los detalles es necesario informar a la identificación de la OS.

GET /requests/{requestId}/flights/requesteds

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": "string",
		"quotationId": "00000000-0000-0000-0000-000000000000",
		"date": "2020-03-05T16:51:01.221Z",
		"departure": "string",
		"departureDescription": "string",
		"arrival": "string",
		"arrivalDescription": "string",
		"online": "yes",
		"cabin": "string",
		"compartment": "string",
		"observation": "string"
	}
]
Propiedad Tipo Tamaño Descripción
id Number(Integer) 3 Código de búsqueda aérea del tramo solicitado. Ejemplo: 0
quotationId String(Guid) 36 ID de presupuesto relacionado con el segmento solicitado. Ejemplo: 00000000-0000-0000-0000-000000000000
date String(DateTime) 24 Fecha del segmento solicitado. Ejemplo: 2020-09-18T16:48:22.490Z
departure String 3 Acrónimo del aeropuerto de origen. Ejemplo: CGH, GIG
departureDescription String 50 Descripción de la ciudad de origen. Ejemplo: São Paulo, Congonhas
arrival String 3 Acrónimo del aeropuerto de destino. Ejemplo: CGH, GIG
arrivalDescription String 50 Descripción de la ciudad de destino. Ejemplo: São Paulo, Congonhas
online String 3 Campo que Indica si la sección relacionada con la solicitud se eligió a través del buscador Online (en línea). Ejemplo: Yes
cabin String 1 Clase de servicio (cabina reservada). Ejemplo: Y
observation String 255 Observaciones relevantes relacionadas con el segmento. Ejemplo: reunión de emergencia

RequestsFollowUps

A través de este método, es posible recuperar los datos de FollowUp para una solicitud. Para recuperar los detalles, es necesario ingresar el ID del SO en el requestId.

GET /requests/{requestId}/followups

Request

requisição GET

Response

[
  {
    "recipients": "string",
    "message": "string",
    "inclusionDate": "2021-01-12T19:05:55.719Z",
    "sentBy": "string"
  }
]
Propiedad Tipo Tamaño Descripción
recipients String 512 Direcciones de correo electrónico de todos los destinatarios a los que se les envió un correo electrónico de FollowUp. Ejemplo: email1@teste.com;email2@teste
message String 512 Mensaje registrado en el FollowUp. Ejemplo: OS creada por el Consultor a nombre de un Viajero
inclusionDate DateTime 23 Fecha/hora de creación del FollowUp. Ejemplo: 2021-01-06T16:15:01.000
sentBy String 20 Nombre del usuario responsable de crear el FollowUp. Ejemplo: argo

POST /requests/{requestId}/followups

Request

{
	"recipients": "usuario@teste.com",
	"copyRecipients": "copia@teste.com",
	"AllRecipients": true,
	"message": "No es posible emitir el SO debido a un problema con la cotización.",
	"sentByEmail": true,
	"sentToAgency": true
}
Propiedad Tipo Tamaño Obligatorio Descripción
recipients String 512* No Direcciones de correo electrónico de los destinatarios a los que se debe enviar el mensaje de FollowUp. Ejemplo: email1@teste.com;email2@teste.com / * OBS: La suma de la longitud de los campos recipients, copyrecipients, correos electrónicos de la agencia (sentToAgency) y otros correos electrónicos (AllRecipients) no debe superar los 512 caracteres.
copyRecipients String 512* No Direcciones de correo electrónico de los destinatarios de la copia, a los que se debe enviar el mensaje de FollowUp. Ejemplo: email3@teste.com;email4@teste.com / * OBS: La suma de la longitud de los campos recipients, copyrecipients, correos electrónicos de la agencia (sentToAgency) y otros correos electrónicos (AllRecipients) no debe superar los 512 caracteres.
AllRecipients Boolean 5 No Define si las direcciones de correo electrónico de todas las personas involucradas en la OS deben agregarse a la lista de destinatarios al enviar el correo electrónico de FollowUp. Ejemplo: True/False / * OBS: La suma de la longitud de los campos recipients, copyrecipients, correos electrónicos de la agencia (sentToAgency) y otros correos electrónicos (AllRecipients) no debe superar los 512 caracteres.
message String(Guid) 512 Mensaje registrado en el FollowUp. Ejemplo: OS creada por el Consultor a nombre de un Viajero
sentByEmail Boolean 5 No Define si se debe enviar un FollowUp por correo electrónico. Ejemplo: True/False
sentToAgency Boolean 5 No Define si las direcciones de correo electrónico de la Agencia deben agregarse automáticamente a la lista de destinatarios, al enviar el correo electrónico de FollowUp. Ejemplo: True/False / * OBS: La suma de la longitud de los campos recipients, copyrecipients, correos electrónicos de la agencia (sentToAgency) y otros correos electrónicos (AllRecipients) no debe superar los 512 caracteres.

Response

resposta POST
Propiedad Tipo Tamaño Descripción
Message Number (int?) - Número de FollowUp registrados en la OS. Ejemplo: 5

RequestsHotelsApartmentDetails

Devolve la informaci�n del apartamento del hotel de la cotizaci�n. Para realizar esa consulta es necesario informar el ID de la OS.

GET /requests/{requestId}/hotels/apartmentdetails

Request

Request GET

Response

[
    {
        "hotelRequestedId": "int",
        "quotationId": "int",
        "apartmentName": "string",
        "apartmentType": "string",
        "apartmentId": 0,
        "checkin": "2020-03-11T19:29:50.871Z",
        "checkout": "2020-03-11T19:29:50.871Z",
        "expirationDate": "2020-03-11T19:29:50.871Z"
    }        
]
Propiedad Tipo Tama�o Descripci�n
hotelRequestedId Int 50 ID del hotel en la cotizaci�n. Ejemplo: 1, 3, 5
quotationId Int 50 ID de identificaci�n de la cotizaci�n elegida (solo producto Hotels). Ejemplo: 1, 3, 5
apartmentName String 3 Nombre/informaci�n del apartamento del hotel. Ejemplo: Individual
apartmentType String 3 Valor que describe el tipo de apartamento. Ejemplo: Individual, Double, Triple o Quadruple
apartmentId Int 100 ID del departamento devuelto. Ejemplo: 1, 3, 5
checkin String (DateTime) 24 Fecha de ingreso al hotel. Ejemplo: 2019-08-20T12:00:00
checkout String (DateTime) 24 Fecha de salida del hotel. Ejemplo: 2019-08-22T12:00:00
expirationDate String (DateTime) 24 Fecha de expiraci�n de Plazo de cancelaci�n sin penalizaci�n. Ejemplo: 2019-12-19T12:00:00.000

RequestsHotelsQuotations

A través de ese método es posible obtener todas las informaciones relacionadas a la cotización de hospedaje vinculada a una determinada solicitud. Para realizar esa consulta es necesario informar el ID de la OS.

GET /requests/{requestId}/hotels/quotations

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": "string",
		"quotationId": "string",
		"online": "yes",
		"hotel": "string",
		"city": "string",
		"state": "string",
		"localization": "string",
		"country": "string",
		"hotelData": {
			"hotelId": "00000000-0000-0000-0000-000000000000",
			"city": "string",
			"webServiceId": "string",
			"integrationCode": "string",
			"name": "string",
			"address": "string",
			"neighborHood": "string",
			"cep": "string",
			"telephone": "string",
			"email": "string",
			"webSite": "string",
			"latitude": "string",
			"longitude": "string",
			"iss": 0,
			"tourismTax": 0,
			"serviceTax": 0,
			"coffee": "yes",
			"amenities": "string",
			"stars": 0,
			"hotelApartament": {
				"hotelId": "00000000-0000-0000-0000-000000000000",
				"name": "string",
				"apartamentType": "string",
				"apartamentId": 0,
				"expiration": "string",
				"coin": "string",
				"dailyValue": 0
			}
		},
		"formPayment": {
			"description": "string",
			"typePayment": "invoiced",
			"code": "string",
			"air": "yes",
			"hotels": "yes",
			"rental": "yes",
			"service": "yes",
			"bus": "yes",
			"restrictive": "yes",
			"alternativeUATP": "yes",
			"card": {
				"paymentName": "string",
				"name": "string",
				"cardNumber": "string",
				"flag": "string",
				"active": "yes",
				"providerId": "string",
				"webServiceId": "string"
			},
			"billingCode": "string",
			"billingDescription": "string"
		},
		"justificationLegs": [
			{
				"type": "string",
				"description": "string"
			}
		],
		"dailyQuantity": 0,
		"coin": "string",
		"bacenCodeCoin": "string",
		"dailyValue": 0,
		"totalValue": 0,
		"approvedTotalValue": 0,
		"webService": "string",
		"observation": "string",
		"voucher": "string",
		"voucherDate": "2020-03-11T19:29:50.871Z",
		"agentUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"issuerUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"userId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"firstName": "string",
			"lastName": "string",
			"telephone": "string",
			"fax": "string",
			"registration": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"passport": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"hostedOffer": [
			{
				"id": "string",
				"hotel": "string",
				"apartament": "double",
				"bed": "doubleType",
				"observation": "string",
				"value": "string",
				"totalValue": 0
			}
		],
		"apartamentType": "double",
		"bedType": "doubleType",
		"dailyValuePlus": 0,
		"dailyValueLess": 0,
		"dailyPercentagePlus": 0,
		"dailyPercentageLess": 0,
		"totalPercentagePlus": 0,
		"totalPercentageLess": 0,
		"fees": [
			{
				"feeId": "00000000-0000-0000-0000-000000000000",
				"initialDate": "2020-03-11T19:29:50.872Z",
				"finalDate": "2020-03-11T19:29:50.872Z",
				"initialHour": "string",
				"finalHour": "string",
				"dayWeek": "monday",
				"name": "string",
				"description": "string",
				"typeTrip": "both",
				"action": "quotation",
				"online": "yes",
				"service": "air",
				"amount": 0,
				"percentage": 0,
				"ceilingPrice": 0,
				"inclusionDate": "2020-03-11T19:29:50.873Z"
			}
		],
	}
]
Propiedad Tipo Tamaño Descripción
id Int 50 ID del hotel en la cotización. Ejemplo: 1, 3, 5
quotationId Int 50 ID de identificación de la cotización elegida (solo producto Hotels). Ejemplo: 1, 3, 5
online String 3 Campo que indica si el hotel se reservó a través del módulo en línea. Ejemplo: yes/no
dailyQuantity Number 100 Número de noches en la cotización. Ejemplo: 10
coin String 3 Moneda utilizada en la cotización. Ejemplo: BRL
bacenCodeCoin Number 5 Código de moneda utilizado por el hotel. Ejemplo: 790
dailyValue Number 100 Tarifa diaria ingresada en la cotización. Ejemplo: 45,00
totalValue Number 100 Valor total del hotel. Ejemplo: 450,00
approvedTotalValue Number 100 Valor total aprobado. Ejemplo: 450,00
webService String 255 Servicio web utilizado en la reserva. Ejemplo: AMADEUSWS
observation String 255 Observación de la cotización del hotel. Ejemplo: EXECUTIVO TWIN BREAKFAST INCLUIDED
voucher String 255 Voucher del hotel. Ejemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Fecha del Voucher. Ejemplo: 2019-12-18T20:33:58.400
netCommissionedRateType String 12 Indica si la tarifa de la habitación es Net o Comisionada. Ejemplo: Net/Comissionada
apartamentType String (Enum) 50 Descripción del tipo de apartamento. Ejemplo: 'individual', 'double', 'triple' o 'quadruple'
bedType String (Enum) 10 Tipo de cama. Ejemplo: 'singleType', 'doubleType' y 'twinType'
dailyValuePlus Number 100 Valor agregado a la tarifa diaria del hotel. Ejemplo: 10,00
dailyValueLess Number 100 Valor disminuyó a la tarifa diaria del hotel. Ejemplo: 10,00
dailyPercentagePlus Number 100 Porcentaje agregado al valor diario del hotel. Ejemplo: 2,00
dailyPercentageLess Number 100 El porcentaje disminuyó al valor diario del hotel. Ejemplo: 2,00
totalPercentagePlus Number 100 Porcentaje total agregado al valor total. Ejemplo: 5,00
totalPercentageLess Number 100 Porcentaje total disminuyó a valor. Ejemplo: 5,00
clientId Guid 36 ID de Identificación del cliente de la Cuenta Contable. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID de usuario al que pertenece la tarjeta. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 100 Correo electrónico del usuario registrado. Ejemplo: pedro@silva.com
login String 50 Inicio de sesión del usuario a registrarse. Ejemplo: Argo2019
firstname String 20 Nombre del usuario a registrar. Ejemplo: Pedro
lastName String 20 Apellido del usuario a registrar. Ejemplo: Silva
telephone String 30 Teléfono de contacto del hotel. Ejemplo: +55 (16) 3343-2325
fax String 30 Fax del usuario aprobador. Ejemplo: 5511998525545
registration String 255 Registro del usuario aprobador. Ejemplo: 464545
thirdParty String 3 Indica si el usuario que aprueba es un "tercero". Ejemplo: Yes/No
groups String 10 Grupo al que pertenece el usuario aprobador. Ejemplo: admin, financial, manager, user.
rg String 15 RG (documento nacional de identificación civil en Brasil) del usuario aprobador. Ejemplo: 265487745
cpf String 15 CPF (registro de persona en Brasil) del usuario aprobador. Ejemplo: 36548425612
passport String 20 Pasaporte del usuario aprobador. Ejemplo: BR123456
employeeId String 20 Registro del usuario aprobador. Ejemplo: 464545
fullname String 100 Nombre completo del usuario aprobador. Ejemplo: Pedro Silva
integrationCode String 50 Código que puede ser utilizado por otros sistemas en el proceso de integración. Ejemplo: 001
department String 50 Departamento vinculado al registro del usuario aprobador. Ejemplo: desarrollo
hotelData Objeto responsable de devolver la información del hotel de la cotizació
Propiedad Tipo Tamaño Descripción
hotelId Guid 36 ID del hotel. Ejemplo: 00000000-0000-0000-0000-000000000000
city String 50 Nombre de la ciudad donde se encuentra el hotel. Ejemplo: Adamantina
webServiceId String 255 ID del servicio web que proporciona la información del hotel. Ejemplo: AMADEUS
integrationCode String 3 Código de integración de motivo de viaje (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'MOTIVO1010'
name String 50 Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
address String 50 Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
neighborHood String 50 Barrio del hotel. Ejemplo: Meirelles
cep String 8 Código postal de la ubicación del hotel. Ejemplo: 14815000
telephone String 23 Teléfono de contacto del hotel: ejemplo: +55 (16) 3343-2325
email String 50 Correo electrónico de contacto del hotel. Ejemplo: hotelsb2b@hotelsbtwob
webSite String 50 Sitio web del hotel. Ejemplo: http://www.hotelsbtwob.com/
latitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 255348752
longitude Number (Float?) 100 Coordenadas geográficas de la ubicación del hotel. Ejemplo: 485526208
iss Number (Decimal?) 100 Tasa obligatoria por el servicio prestado por el Hotel. Ejemplo: 5,00
tourismTax Number (Decimal?) 100 Tasa turística del hotel. Ejemplo: 10,00
serviceTax Number (Decimal?) 100 Cargo por servicio de hotel. Ejemplo: 5,00
coffee String 3 Información sobre la existencia del servicio de desayuno en el Hotel. Ejemplo yes/no
amenities String 255 Servicios encontrados en el Hotel. Ejemplo: WIFI
stars Number (int) 100 Valoración del hotel. Ejemplo: 3
hotel String 50 Nombre del Hotel. Ejemplo: Comfort Hotel Fortaleza
city String 50 Nombre de la ciudad donde se encuentra el hotel. Ejemplo: Adamantina
state String 2 Acrónimo del estado donde se encuentra el hotel. Ejemplo: SP
localization String 50 Dirección de ubicación del hotel. Ejemplo: Rua Frei Mansueto, 160
country String 50 Acrónimo del país donde se encuentra el hotel. Ejemplo: BR
hotelApartament Objeto responsable de devolver la información del apartamento del hotel de la cotización
Propiedad Tipo Tamaño Descripción
hotelId Guid 36 ID del hotel devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
name String 50 Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
apartamentType String (Enum) 50 Valor que describe el tipo de apartamento. Ejemplo: Individual, Double, Triple o Quadruple
apartamentId Number (int) 100 ID del departamento devuelto. Ejemplo: 1, 3, 5
expiration String 50 Fecha de validez de la tarifa del apartamento. Ejemplo: 2019-09-18
coin String 3 Moneda relacionada con la tarifa de la habitación. Ejemplo: BRL
dailyValue Number (Double) 100 Tarifa diaria del apartamento. Ejemplo: 45,00
formPayment Objeto responsable de devolver la información del método de pago de la solicitud
Propiedad Tipo Tamaño Descripción
description String 255 Descripción del método de pago de la solicitud. Ejemplo: facturado
typePayment String (Enum) 15 Tipos de pago utilizados. Ejemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integración del método de pago. (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'TIPOFATURA1010'
air String 3 La propiedad indica si el método de pago se puede utilizar para el producto aéreo. Ejemplo: yes/no
hotels String 3 La propiedad indica si el método de pago se puede utilizar para el producto de hotel. Ejemplo: yes/no
rental String 3 La propiedad indica si el método de pago se puede utilizar para el producto de alquiler de auto. Ejemplo: yes/no
service String 3 Campo que indica si el método de pago se puede usar para el producto del Servicio. Ejemplo: yes/no
bus String 3 Campo que indica si el método de pago se puede utilizar para el producto Road. Ejemplo: yes/no
restrictive String 3 Campo que indica si la facturación es del tipo restrictivo. Ejemplo: yes/no
alternativeUATP String 3 Campo que indica si la facturación es de tipo UATP. Ejemplo: yes/no
card Objeto responsable de devolver la información de la tarjeta utilizada en la solicitud
Propiedad Tipo Tamaño Descripción
paymentName String 50 Nombre del método de pago de la tarjeta. Ejemplo: tarjeta de crédito
name String 255 Nombre del usuario que utilizó la tarjeta. Ejemplo: Maurício
cardNumber String 255 Número de tarjeta. Ejemplo: 3216-8394-9403-0604
flag String 50 Indica el tipo tarjeta. Ejemplo: Visa, Mastercard
active String 3 El campo indica si la tarjeta está activa. Ejemplo: yes/no
providerId String 50 ID del proveedor de la tarjeta. Ejemplo: T0009015590A999118
webServiceId String 50 ID del servicio web de la tarjeta (solo tarjeta virtual). Ejemplo: B2BPAY, WEX, CONFERMA
cardAuthorization String 50 Código de Seguridad de la tarjeta de crédito que haya sido registrado en el campo "Tipo de Facturación de la Solicitud", en el momento de la emisión de una reserva aérea
billingCode String 50 Código de facturación del método de pago. Ejemplo: BV5
billingDescription String 50 Descripción del código de facturación de la forma de pago. Ejemplo: FACTURACIÓN TOTAL PARA LA AGENCIA
justificationLegs Objeto responsable de devolver las justificaciones de presupuesto del hotel
Propiedad Tipo Tamaño Descripción
type String 255 Tipo de justificación. Ejemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descripción de la justificación. Ejemplo: el hotel no cae por debajo del límite diario del viajero.
agentUser Objeto responsable de devolver la información del usuario asistente
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID del usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del asistente de solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del solicitante del OS. Ejemplo: roberto.luiz
firstName String 255 Nombre del Usuario de la solicitud.Ejemplo: Roberto
lastName String 255 Apellido del Usuario de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del Usuario de la Solicitud. Ejemplo: 9 95463154
fax String 50 Fax del Usuario de la Solicitud. Ejemplo: 9 95463154
registration String 20 Identificador de registro de usuario. Ejemplo: 10377192
thirdParty String 3 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario: ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG del usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
employeeId String 255 ID Número de Empleado del usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
department String 255 Departamento del usuario. Ejemplo: legal
issuerUser Objeto responsable de devolver la información del usuario emisor
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID del usuario. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del emisor de la solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del emisor de la solicitud. Ejemplo: roberto.luiz
firstName String 255 Nombre del emisor de la solicitud. Ejemplo: Roberto
lastName String 255 Apellido del emisor de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del emisor de la solicitud. Ejemplo: 9 95463154
fax String 50 Fax del emisor de la solicitud. Ejemplo: 9 95463154
registration String 20 Registro del usuario. Ejemplo: 464545
thirdParty String 3 Indicador que indica si el emisor es un tercero o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario: ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG del usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
passport String 20 Número de pasaporte de usuario. Ejemplo: BR123456
employeeId String 255 Identificador de registro de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración de usuario emisor (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUEMISSOR1010'
department String 255 Departamento del usuario. Ejemplo: compras
hostedOffer Objeto responsable de devolver la información del alojamiento ofrecido
Propiedad Tipo Tamaño Descripción
id String 50 ID del alojamiento ofrecido (combinación del ID del hospedaje y ID cotización). Ejemplo: 1_1, 0_1
hotel String 50 Nombre del Hotel. Ejemplo: Comfort Hotel Fortaleza
apartament String (Enum) 50 Valor que describe el tipo de apartamento. Ejemplo: 'induvidual', 'double', 'triple' o 'quadruple'
bed String (Enum) 10 Tipo de cama ofrecida. Ejemplo: 'singleType', 'doubleType' y 'twinType'
observation String 255 Observación del alojamiento ofrecido. Ejemplo: EXECUTIVO TWIN BREAKFAST INCLUIDED
hotel String 50 Nombre del hotel. Ejemplo: Comfort Hotel Fortaleza
value String 100 Valores cobrados por el alojamiento ofrecido. Ejemplo: 45,00 + 10,00
totalValue Number 100 Cálculo de los valores presentados en la propiedad 'value' (valor diario + impuestos). Ejemplo: 55,00
fees Objeto responsable de devolver la información de tarifa para la cotización de alojamiento
Propiedad Tipo Tamaño Descripción
feeId Int 50 ID de la tarifa vinculada a la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Fecha de inicio de la solicitud. Ejemplo: 2019-08-22
finalDate String (DateTime) 24 Fecha de finalización de la solicitud. Ejemplo: 2019-08-22
name String 50 Nombre de la tarifa. Ejemplo: Experience Bundle
description String 1024 Descripción de la tarifa. Ejemplo: se cobrarán R $ 15,00 por la emisión de paquetes de secciones nacionales o internacionales, realizadas en línea o fuera de línea. Para todas las solicitudes (abiertas desde 29/11/2019) en este cliente. Si la llamada se realiza entre las 00:00 y las 23:59.
typeTrip String (Enum) 13 Tipo de viaje al que está vinculada la tarifa. Ejemplo: 'both', 'international', 'domestic'
action String 13 Tipo de acción tomada para la tarifa. Ejemplo: 'quotation', 'ticketing'
online String 3 El establecimiento informa si la tarifa es en línea. Ejemplo: yes/no
service String 7 Tipo de servicio de tarifa. Ejemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Importe de la tarifa. Ejemplo: 20
percentage Number 100 Porcentaje de tarifa. Ejemplo: 5
ceilingPrice Number 100 Valor máximo de la tarifa. Ejemplo: 35
inclusionDate String (DateTime) 24 Fecha de inclusión de tarifa. Ejemplo: 2020-03-11T19:29:50.873Z

GET /requests/{requestId}/hotels/apartamentdetails

Devolve la información del apartamento del hotel de la cotización. Para realizar esa consulta es necesario informar el ID de la OS.

Request

Request GET

Response

[
    {
        "hotelRequestedId": "int",
        "quotationId": "int",
        "apartamentName": "string",
        "apartamentType": "string",
        "apartamentId": 0,
        "checkin": "2020-03-11T19:29:50.871Z",
        "checkout": "2020-03-11T19:29:50.871Z",
        "expirationDate": "2020-03-11T19:29:50.871Z"
    }        
]
Propiedad Tipo Tamaño Descripción
hotelRequestedId Int 50 ID del hotel en la cotización. Ejemplo: 1, 3, 5
quotationId Int 50 ID de identificación de la cotización elegida (solo producto Hotels). Ejemplo: 1, 3, 5
apartamentName String 3 Nombre/información del apartamento del hotel. Ejemplo: Individual
apartamentType String 3 Valor que describe el tipo de apartamento. Ejemplo: Individual, Double, Triple o Quadruple
apartamentId Int 100 ID del departamento devuelto. Ejemplo: 1, 3, 5
checkin String (DateTime) 24 Fecha de ingreso al hotel. Ejemplo: 2019-08-20T12:00:00
checkout String (DateTime) 24 Fecha de salida del hotel. Ejemplo: 2019-08-22T12:00:00
expirationDate String (DateTime) 24 Fecha de expiración de Plazo de cancelación sin penalización. Ejemplo: 2019-12-19T12:00:00.000

RequestsHotelsRequesteds

Mediante este método, es posible recuperar datos de hoteles vinculados a una solicitud específica. Para obtener esta información, es necesario que el ID de la solicitud que desea buscar esté informada.

GET /requests/{requestId}/hotels/requesteds

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": 0,
		"online": "yes",
		"checkin": "2020-03-10T21:33:17.250Z",
		"checkout": "2020-03-10T21:33:17.250Z",
		"city": "string",
		"apartamentType": "string",
		"bedType": "string",
		"observation": "string"
	}
]
Propiedad Tipo Tamaño Descripción
id Int 50 ID del hotel en la solicitud. Ejemplo: 1, 3, 5
online String 3 Campo que indica si el hotel se reservó a través del módulo en línea. Ejemplo: yes/no
checkin String (DateTime) 24 Fecha de ingreso al hotel. Ejemplo: 2019-08-22T12:00:00
checkout String (DateTime) 24 Fecha de salida del hotel. Ejemplo: 2019-08-22T12:00:00
city String 50 Ciudad donde se encuentra el hotel. Ejemplo: RIO DE JANEIRO / RJ
apartamentType String 50 Tipo de apartamento reservado. Ejemplo: Single
bedType String 50 Tipo de cama en el apartamento reservado. Ejemplo: Single
observation String 255 Observaciones sobre el hotel alquilado Ejemplo. Habitacion doble con aire

RequestsJustifications

Mediante este método, es posible recuperar las justificaciones de viaje insertadas en una solicitud. La inclusión de la justificación en un sistema operativo puede ocurrir por varias razones, como el incumplimiento de las políticas de viaje. Para obtener estos datos, es necesario informar el ID de la solicitud. Para más información ver el Wiki.

GET requests/{requestId}/justifications

Solicitud

Solicitud GET

Respuesta

[
	{
		"type": "string",
		"description": "string"
	}
]
Propiedad Tipo Tamaño Descripción
type String 6 Tipo de justificación relacionada con la solicitud. Ejemplo: ESCAER, ESCHOS
description String 255 Descripción de la justificación relacionada con la solicitud. Ejemplo: mejor tarifa en el período.

requestsManagementFields

Mediante este método, es posible recuperar los campos gerenciales vinculados a una solicitud determinada. Para obtener esta información, es necesario informar el ID de la solicitud.

GET /requests/{requestId}/managementfields

Solicitud

Solicitud GET

Respuesta

[
	{
		"managementFieldId": "string",
		"content": "string"
	}
]
Propiedad Tipo Tamaño Descripción
managementFieldId String 100 ID del campo gerencial relacionado con la solicitud. Ejemplo: Reserva_Ficticia_Argo
content String 8000 Contenido del campo gerencial relacionado con la solicitud. Ejemplo: E2989298929

POST /requests/{requestId}/managementfields

Solicitud

requisição POST
Propiedad Tipo Tamaño Obligatorio Descripción
complement String 10 No Complemento del campo gerencial relacionado con la solicitud. Ejemplo: Argo_reserva
managementFieldId String 100 Si ID de campo gerencial relacionado con la solicitud. Ejemplo: Reserva_Ficticia_Argo
content String 8000 Si Contenido del campo de gestión relacionado con la solicitud. Ejemplo: E2989298929

Respuesta

resposta POST /requests/{requestId}/managementfields
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en la inserción del ámbito empresarial. Ejemplo: True/False

PUT /requests/{requestId}/managementfields

Solicitud

requisição PUT
Propiedad Tipo Tamaño Obligatorio Descripción
complement String 10 No Complemento del campo gerencial relacionado con la solicitud. Ejemplo: Argo_reserva
managementFieldId String 100 Si ID de campo gerencial relacionado con la solicitud. Ejemplo: Reserva_Ficticia_Argo
content String 8000 Si Contenido del campo de gestión relacionado con la solicitud. Ejemplo: E2989298929

Respuesta

resposta PUT /requests/{requestId}/managementfields
Propiedad Tipo Tamaño Descripción
message String 5 Éxito o fracaso en el cambio de campo de la gestión. Ejemplo: True/False

RequestsReasonsTravel

El motivo del viaje es información obligatoria al abrir la OS. Mediante este método es posible recuperarlo. Recordando que para obtener esta información, es necesario informar la identificación de la solicitud. Para obtener más información sobre los motivos de viaje, consulte el Wiki.

GET requests/{requestId}/reasonstravel

Solicitud

Solicitud GET

Respuesta

{
	"reasonTravelId": "00000000-0000-0000-0000-000000000000",
	"description": "string",
	"alert": "string",
	"initialDate": "2020-03-05T10:51:18.895Z",
	"finalDate": "2020-03-05T10:51:18.895Z",
	"legs": [
		"air"
	],
	"requiresDescription": "yes",
	"requiresAuthorization": "yes",
	"quotationAvailable": "yes",
	"allowCompanions": "yes",
	"validateExpenseReport": "yes",
	"closingCard": "yes",
	"integrationCode": "string"
}
Propiedad Tipo Tamaño Descripción
reasonTravelId String(Guid) 36 ID del motivo del viaje de la solicitud. Ejemplo: 58791410-a137-4c50-b948-v090f2b474fv
description String 50 Descripción del motivo del viaje. Ejemplo: entrenamiento
alert String 2000 Mensaje de alerta cuando se selecciona el motivo del viaje. Ejemplo: el motivo del viaje no permite viajes internacionales
initialDate String(DateTime) 24 Fecha de inicio del motivo del viaje. Ejemplo: 2019-10-02T19:47:10.450Z
finalDate String(DateTime) 24 Fecha de finalización del motivo del viaje. Ejemplo: 2019-10-02T19:47:10.450Z
legs String(Enum) 15 A qué productos está vinculado el motivo del viaje. Ejemplo: Air, Rental, Refund
requiresDescription String(Enum) 3 Indica si la descripción es obligatoria cuando se selecciona el motivo del viaje. Ejemplo: Yes/No
requiresAuthorization String(Enum) 3 Indica si la solicitud requiere autorización cuando se selecciona el motivo del viaje. Ejemplo: Yes/No
quotationAvailable String(Enum) 3 Indica si el motivo del viaje ingresado en la solicitud requiere una cotización. Ejemplo: Yes/No
allowCompanions String(Enum) 3 Indica si el motivo del viaje seleccionado en la solicitud permite la inclusión de acompañantes. Ejemplo: Yes/No
validateExpenseReport String(Enum) 3 Indica si el motivo de viaje ingresado en la solicitud requiere reporte de Expense. Ejemplo: Yes/No
closingCard String(Enum) 3 Indica si el motivo del viaje ingresado en la solicitud permite que se cierre la tarjeta. Ejemplo: Yes/No
integrationCode String 30 Código de integración del motivo de viaje. Ejemplo: 175

RequestsRentalsQuotations

A través de este método es posible obtener toda la información relacionada con la cotización de alquiler de auto, relacionada a una determinada solicitud. Para realizar esta consulta es necesario informar el ID de la solicitud (O.S.) de Argo.

GET /requests/{requestId}/rentals/quotations

Solicitud

Solicitud GET
[
 {
    "id": "String",
    "quotationId": "String",
    "carRental": "String",
    "carRentalIata": "String",
    "vehicle": "String",
    "pickUpLocation": "String",
    "dropOffLocation": "String",
    "pickUpAdress": "String",
    "dropOffAdress": "String",
    "airConditioning": "yes",
    "driver": "yes",
    "category": "economy",
    "gear": "automatic",
    "gps": "yes",
    "observation": "String",
    "integrationCode": "String",
    "country": "String",
    "webService": "String",
    "voucher": "String",
    "voucherDate": "2021-03-18T18:50:52.974Z",
    "dailyQuantity": 0,
    "coin": "String",
    "bacenCodeCoin": "String",
    "dailyValue": 0,
    "totalValue": 0,
    "approvedTotalValue": 0,
    "dailyValuePlus": 0,
    "dailyValueLess": 0,
    "dailyPercentagePlus": 0,
    "dailyPercentageLess": 0,
    "totalPercentagePlus": 0,
    "totalPercentageLess": 0,
    "additionalServicesValue": 0,
    "returnValue": 0,
    "safeValue": 0,
    "otherValue": 0,
    "agentUser": {
      "clientId": "00000000-0000-0000-0000-000000000000",
      "email": "String",
      "login": "String",
      "firstName": "String",
      "lastName": "String",
      "telephone": "String",
      "fax": "String",
      "registration": "String",
      "thirdParty": "yes",
      "groups": [
        "admin"
      ],
      "rg": "String",
      "cpf": "String",
      "passport": "String",
      "employeeId": "String",
      "fullName": "String",
      "integrationCode": "String",
      "department": "String"
    },
    "issuerUser": {
      "clientId": "00000000-0000-0000-0000-000000000000",
      "email": "String",
      "login": "String",
      "firstName": "String",
      "lastName": "String",
      "telephone": "String",
      "fax": "String",
      "registration": "String",
      "thirdParty": "yes",
      "groups": [
        "admin"
      ],
      "rg": "String",
      "cpf": "String",
      "passport": "String",
      "employeeId": "String",
      "fullName": "String",
      "integrationCode": "String",
      "department": "String"
    },
    "fees": [
      {
        "feeId": "00000000-0000-0000-0000-000000000000",
        "initialDate": "2021-03-18T18:50:52.974Z",
        "finalDate": "2021-03-18T18:50:52.974Z",
        "initialHour": "String",
        "finalHour": "String",
        "dayWeek": "monday",
        "name": "String",
        "description": "String",
        "typeTrip": "both",
        "action": "quotation",
        "online": "yes",
        "service": "air",
        "amount": 0,
        "percentage": 0,
        "ceilingPrice": 0,
        "inclusionDate": "2021-03-18T18:50:52.974Z"
      }
    ],
    "justificationLegs": [
      {
        "type": "String",
        "description": "String"
      }
    ],
    "formPayment": {
      "description": "String",
      "typePayment": "invoiced",
      "code": "String",
      "air": "yes",
      "hotels": "yes",
      "rental": "yes",
      "service": "yes",
      "bus": "yes",
      "restrictive": "yes",
      "alternativeUATP": "yes",
      "card": {
        "paymentName": "String",
        "name": "String",
        "cardNumber": "String",
        "flag": "String",
        "active": "yes",
        "providerId": "String",
        "webServiceId": "String"
      },
      "billingCode": "String",
      "billingDescription": "String"
    },
    "rentalOffer": [
      {
        "id": "String",
        "airConditioning": "yes",
        "category": "economy",
        "driver": "yes",
        "totalValue": 0
      }
    ]
  }   
]
Propiedad Tipo Tamaño Descripción
id Int 2 ID de lo solicitado en el alquiler del vehículo. Ejemplo: 1, 3, 5
quotationId Int 2 ID de la cotización. Si un segmento de alquiler tiene 7 cotizaciones, esta variable se incrementará
carRental String 10 Nombre de la empresa de alquiler.
carRentalIata String 10 Código Iata de la empresa de alquiler.: 7878
vehicle String 50 Vehículo (nombre, marca). Detalles del vehículo Ejemplo. Ford Focus
pickUpLocation String 255 Lugar de recogida del vehículo. Ejemplo. São Paulo (dirección)
dropOffLocation String 255 Lugar de devolución del vehículo. Ejemplo. São Paulo (dirección)
pickUpAdress String 255 Dirección de recogida del vehículo. Ejemplo. São Paulo
dropOffAdress String 255 Dirección de devolución del vehículo. Ejemplo. São Paulo
airConditioning String 3 Campo que indica si el vehículo tiene aire acondicionado o no. Ejemplo: yes/no
driver String 3 Indicador que indica si el vehículo será contratado con un conductor.: Yes/No
category String (Enum) 30 Indica la categoría del vehículo. Ejemplo: economía, superior, especial, etc
gear String (Enum) 10 Indica el tipo de intercambio de vehículos. Ejemplo: manual o automático
gps String 3 Indica si el vehículo será contratado con GPS. Ejemplo: yes/No
country String 50 Acrónimo del país del segmento de alquiler. BR
integrationCode String 255 Código de integración del usuario asistente (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
Observation String 255 Observación de la cotización del vehículo Ejemplo: Recogida a las 12 horas..
coin String 3 Código de Moneda de la cotización realizada. Ejemplo: BRL
bacenCodeCoin Number 5 Código de moneda utilizado por el empresa de alquiler. Ejemplo: 790
dailyQuantity Number 100 Número de noches de alquiler de vehículos Ejemplo: 5
dailyValue Number 100 Tarifa diaria de alquiler. Ejemplo: 70,00
totalValue Number 100 Importe total del alquiler. Ejemplo: 150,00
approvedTotalValue Number 100 Valor total aprobado. Ejemplo: 450,00
dailyValuePlus Number 100 Mayor valor dependiendo del número de noches. Ejemplo: 50,00
dailyValueLess Number 100 Menor valor dependiendo del número de noches. Ejemplo: 50,00
dailyPercentagePlus Number 100 Valor porcentual mayor de la tarifa diaria. Ejemplo: 10
dailyPercentageLess Number 100 Valor porcentual menor de la tarifa diaria. Ejemplo: 10
totalPercentagePlus Number 100 Porcentaje de valor mayor, que se aplicará al valor total. Ejemplo: 10
totalPercentageLess Number 100 Porcentaje de valor menor, que se aplicará al valor total. Ejemplo: 10
returnValue Number 100 Valor devuelto
safeValue Number 100 Precio del seguro.
otherValue Number 100 Otras contabilizaciones de valor
voucher String 255 Bono de alquiler. Ejemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Fecha del Voucher. Ejemplo: 2019-12-18T20:33:58.400
webService String 255 Servicio web utilizado en la reserva. Ejemplo: AMADEUSWS
additionalServicesValue Number 100 Valores adicionales
justificationLegs Objeto responsable de devolver las justificaciones de presupuesto del hotel
Propiedad Tipo Tamaño Descripción
type String 255 Tipo de justificación. Ejemplo: REPHOS, ESCAER, ESCHOS
description String 255 Descripción de la justificación. Ejemplo: el hotel no cae por debajo del límite diario del viajero.
agentUser Objeto responsable de devolver la información del usuario asistente
Propiedad Tipo Tamaño Descripción
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
employeeId String 255 ID Número de Empleado del usuario. Ejemplo: 10377192
department String 255 Departamento del usuario. Ejemplo: legal
integrationCode String 255 Código de integración del usuario (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
email String 50 Correo electrónico de contacto del asistente de solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del solicitante de la solicitud. Ejemplo: roberto.luiz
telephone String 50 Teléfono del encargado de la solicitud. Ejemplo: 9 95463154
cpf String 15 Número de CPF del usuario. Ejemplo:665.854.965-63
rg String 15 Número de RG de usuario.: 45.585.412-X
fax String 50 Fax del encargado de la solicitud. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
clientId Guid 36 ID del cliente devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
groups String 10 Grupo en el que se inserta el usuario: ejemplo: 'user', 'admin', 'manager', 'financial'
issuerUser Objeto responsable de devolver la información del usuario emisor
Propiedad Tipo Tamaño Descripción
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
employeeId String 255 Identificador de registro de usuario. Ejemplo: 10377192
department String 255 Departamento del usuario. Ejemplo: legal
integrationCode String 255 Código de integración del usuario asistente (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
email String 50 Correo electrónico de contacto del asistente de la solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del solicitante de la OS. Ejemplo: roberto.luiz
telephone String 50 Teléfono del asistente de la solicitud. Ejemplo: 9 95463154
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
rg String 15 Número de RG del usuario. Ejemplo: 45.585.412-X
fax String 50 Fax del Usuario de la Solicitud. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
clientId Guid 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
groups String 10 Grupo en el que se inserta el usuario: ejemplo: 'user', 'admin', 'manager', 'financial'
fees Objeto responsable de devolver la información de tarifa para la cotización de alojamiento
Propiedad Tipo Tamaño Descripción
feeId Guid 36 ID de la tarifa vinculada a la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDate String 24 Fecha de inicio de la solicitud. Ejemplo: 2019-08-22
finalDate String 24 Fecha de finalización de la solicitud. Ejemplo: 2019-08-22
name String 100 Nombre de la tarifa. Ejemplo: Experience Bundle
description String 1024 Descripción de la tarifa. Ejemplo: se cobrarán R $ 15,00 por la emisión de paquetes de secciones nacionales o internacionales, realizadas en línea o fuera de línea. Para todas las solicitudes (abiertas desde 29/11/2019) en este cliente. Si la llamada se realiza entre las 00:00 y las 23:59.
typeTrip String (Enum) 20 Propiedad que indica el tipo de viaje que se aplica la tarifa. Ejemplo: Domestic, International o both
action String 20 Indica cuándo se aplica la tarifa. Ejemplo: Quotation o Ticketing
online String 3 Campo que indica si el hotel se reservó a través del módulo en línea. Ejemplo: yes/no
service String(Enum) 20 Campo que indica si el método de pago se puede usar para el producto del Servicio. Ejemplo: yes/no
amount double 10 Importe de la tarifa. Ejemplo: 20
percentage double 10 Porcentaje de tarifa. Ejemplo: 5
ceilingProce double 10 Valor máximo de la tarifa. Ejemplo: 35
inclusionDate String 24 Fecha de inclusión de tarifa. Ejemplo: 2020-03-11T19:29:50.873Z
formPayment Objeto responsable de devolver la información del método de pago de la solicitud
Propiedad Tipo Tamaño Descripción
description String 255 Descripción del método de pago de la solicitud. Ejemplo: facturado
typePayment String (Enum) 15 Tipos de pago utilizados. Ejemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integración del método de pago. (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'TIPOFATURA1010'
Air String 3 Propiedad que indica si el pago puede utilizarse para el pasaje aéreo. Ejemplo: yes/no
hotels String 3 Propiedad que indica si el pago se puede usar para hospedaje. Ejemplo: yes/no
rental String 3 La propiedad indica si el método de pago se puede utilizar para el producto de alquiler de auto. Ejemplo: yes/no
service String 3 Campo que indica si el método de pago se puede usar para el producto del Servicio. Ejemplo: yes/no
bus String 3 Campo que indica si el método de pago se puede utilizar para el producto Road. Ejemplo: yes/no
restrictive String 3 Propiedad que indica si el pago es restrictivo. Ejemplo: yes/no
alternativeUATP String 3 Propiedad que indica si el pago es UATP. Ejemplo: yes/no
billingCode String 50 Código de facturación del método de pago. Ejemplo: BV5
billingDescription String 50 Descripción del código de facturación de la forma de pago. Ejemplo: FACTURACIÓN TOTAL PARA LA AGENCIA
card Objeto responsable de devolver la información de la tarjeta utilizada en la solicitud
Propiedad Tipo Tamaño Descripción
paymentName String 50 Nombre del método de pago con tarjeta Ejemplo: tarjeta de crédito
name String 50 Nombre de usuario del titular de la tarjeta.: Pedro Silva
cardNumber String 255 Número de tarjeta. Ejemplo: 3216-8394-9403-0604
flag String 50 Indica el tipo tarjeta. Ejemplo: Visa, Mastercard
active String 3 El campo indica si la tarjeta está activa. Ejemplo: yes/no
providerId String 50 ID del proveedor de la tarjeta. Ejemplo: T0009015590A999118
webServiceId String 50 ID del servicio web de la tarjeta (solo tarjeta virtual). Ejemplo: B2BPAY, WEX, CONFERMA
rentalOffer Objeto responsable de devolver los alquileres ofrecidos
Propiedad Tipo Tamaño Descripción
id String 50 ID de oferta de alquiler.
category String 20 Categoría de oferta. Enum (economy,intermediate,superior,compact,special)
totalValue double 10 Valor de oferta total.
airConditioning String 3 Campo que indica si el vehículo tiene aire acondicionado o no. Ejemplo: yes/no
driver String 3 Indicador que indica si el vehículo será contratado con un conductor.: Yes/No

RequestsRentalsRequesteds

A través de este método, es posible recuperar información relacionada con el alquiler de vehículos vinculada a una solicitud específica. Para obtener estos datos es necesario informar a la identificación del OS.

GET /requests/{requestId}/rentals/requesteds

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": 0,
		"carRental": "string",
		"pickUpLocation": "string",
		"dropOffLocation": "string",
		"dropOffDate": "2020-03-10T21:33:17.277Z",
		"pickUpDate": "2020-03-10T21:33:17.277Z",
		"airConditioning": "yes",
		"driver": "yes",
		"category": "economy",
		"gear": "automatic",
		"observation": "string",
		"gps": "yes"
	}
]
Propiedad Tipo Tamaño Descripción
id Int 50 ID que identifica la ubicación en la solicitud. Ejemplo: 1, 3, 5
carRental String 50 Nombre de la empresa de alquiler donde se realizó el alquiler. Ejemplo: ATESA
pickUpLocation String 255 Lugar de recogida del vehículo. Ejemplo: São Paulo / SP, Brasil (SAO)
dropOffLocation String 255 Lugar de devolución del vehículo. Ejemplo: Rio de Janeiro / RJ, Brasil - Galeão (GIG)
dropOffDate String (DateTime) 24 Fecha de devolución del vehículo. Ejemplo: 2019-08-22T12:00:00
pickUpDate String (DateTime) 24 Fecha de recogida del vehículo. Ejemplo: 2019-08-18T12:00:00
airConditioning String 3 El campo indica si el vehículo tiene aire acondicionado. Ejemplo: yes/no
driver String 3 El campo indica si el vehículo tiene un conductor privado. Ejemplo: yes/no
category String (Enum) 12 Categoría a la que pertenece el vehículo. Exemplo: 'economy', 'intermediate', 'superior', 'compact', 'special'
gear String (Enum) 10 Tipo de cambio de vehículo. Ejemplo: automatic/manual
observation String 255 Observaciones sobre el vehículo alquilado Ejemplo: Retirada a partir de las 08.00.
gps String 3 El campo indica si el vehículo tiene GPS. Ejemplo: yes/no

RequestsRequesters

A través de este método, es posible recuperar los datos de un solicitante de un OS determinado. Para obtener esta información, es necesario informar el ID de la solicitud.

GET / requests/{requestId}/requesters

Solicitud

Solicitud GET

Respuesta

{
	"clientId": "00000000-0000-0000-0000-000000000000",
	"userId": "00000000-0000-0000-0000-000000000000",
	"email": "string",
	"login": "string",
	"firstName": "string",
	"lastName": "string",
	"telephone": "string",
	"fax": "string",
	"thirdParty": "yes",
	"groups": [
		"admin"
	],
	"rg": "string",
	"cpf": "string",
}
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID del usuario solicitante devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 24 Correo electrónico de contacto del solicitante de solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 24 Inicio de sesión del solicitante de solicitud. Ejemplo: roberto.luiz
firstName String 3 Nombre del solicitante de solicitud. Ejemplo: Roberto
lastName Int 5 Apellido del solicitante de solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del solicitante de solicitud. Ejemplo: 9 95463154
fax String Fax del solicitante de solicitud. Ejemplo: 9 95463154
thirdParty String 8 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
groups String 25 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String Número de CPF del usuario. Ejemplo: 665.854.965-63

RequestsRoadsQuotations

Mediante este método, es posible recuperar los datos que se citaron en una solicitud de ruta determinada.

Al realizar esta solicitud, se devolverán los datos que el consultor ingresó en la solicitud (en línea / fuera de línea). En el caso de una cotización en línea, las secciones con los valores más bajos se registrarán como cotizaciones ofrecidas.

Wiki

GET

Solicitud

Solicitud GET

Respuesta

[ 
	{
		"id": "2", 
		"quotationId": "1", 
		"online": "no", 
		"typeTrip": "domestic", 
		"agent": { 
			"clientId": "3f9a4a0c-9c7f-414d-8d15-a8502bb4f6cb", 
			"email": "rodrigo.lins@useargo.com", 
			"login": "rodrigo.lins@argo", 
			"thirdParty": "no", 
			"groups": [ 
				"admin" 
			], 
			"fullName": "RODRIGO LINS" 
		}, 
		"emitter": { 
			"clientId": "3f9a4a0c-9c7f-414d-8d15-a8502bb4f6cb", 
			"email": "rodrigo.lins@useargo.com", 
			"login": "rodrigo.lins@argo", 
			"thirdParty": "no", 
			"groups": [ 
				"admin" 
			], 
			"fullName": "RODRIGO LINS" 
		}, 
		"inclusionDate": "2020-03-23T09:12:00.587", 
		"changeDate": "2020-03-23T09:12:00.587", 
		"expirationDate": "2020-03-27T12:00:00", 
		"boarding": "2020-06-06T19:00:00", 
		"landing": "2020-06-06T23:00:00", 
		"originTerminal": "São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)", 
		"originCity": "São Paulo", 
		"destinationCity": "Catanduva", 
		"destinationTerminal": "CATANDUVA (SP, BRASIL) / SP, Brasil", 
		"marketingAirline": "Viação Commeta", 
		"formPayment": { 
			"description": "Cartao - tdos produtos", 
			"typePayment": "creditCard", 
			"air": "yes", 
			"hotels": "yes", 
			"rental": "yes", 
			"service": "yes", 
			"bus": "yes", 
			"restrictive": "no", 
			"alternativeUATP": "no", 
			"card": { 
				"cardNumber": "1111-1111-1111-1111", 
				"flag": "VI", 
				"active": "no" 
			} 
		}, 
		"feesLeg": [], 
		"coin": "BRL", 
		"bacenCodeCoin": "790", 
		"passageValuePlus": 0.0, 
		"passageValueLess": 0.0, 
		"percentagePassagePlus": 0.0, 
		"percentagePassageLess": 0.0, 
		"totalValue": 150.0, 
		"percentageTotalPlus": 0.0, 
		"percentageTotalLess": 0.0, 
		"observation": "" 
	} 
]
Propiedad Tipo Tamaño Descripción
id Int 50 ID de identificación de lo solicitado al Bus. Ejemplo: 1, 3, 5
quotationId Int 50 Id de identificación de cotización. Si un tramo de carretera tiene 7 comillas, es esta variable la que aumentará
online String 3 Campo que indica si el Bus se reservó en línea. Ejemplo: yes/no
typeTrip String (enum) 15 Indica qué tipo de viaje se está realizando para este segmento. Ejemplo: Domestic, International
agentUser Objeto responsable de devolver la información del usuario asistente
Propriedadae Tipo Tamaño Descripción
email String 50 Correo electrónico de contacto del asistente de solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión del asistente del OS. Ejemplo: roberto.luiz
telephone String 50 Teléfono del asistente de solicitud. Ejemplo: 9 95463154
fax String 50 Fax del asistente de solicitud. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el asistente está subcontratado o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
employeeId String 255 ID del Número de Empleado del usuario. Ejemplo: 10377192
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario asistente (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
department String 255 Departamento del usuario. Ejemplo: legal
groups String(Enum) 10 Grupo en el que se inserta el usuario: ejemplo: 'user', 'admin', 'manager', 'financial'

RequestsRoadsRequesteds

Mediante este método, es posible recuperar los datos de la solicitud de autobus. Para obtener esta información, debe ingresar el ID de la solicitud.

Para obtener más información sobre la aplicación vial, consulte el Wiki.

GET

Solicitud

Solicitud GET

Respuesta

[ 
	{ 
		"id": "1", 
		"date": "2019-05-05T00:00:00", 
		"inclusionDate": "2019-04-12T09:38:37.503", 
		"changeDate": "2019-04-12T09:38:37.503", 
		"originCity": "São Paulo", 
		"originTerminal": "São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)", 
		"destinationCity": "São José do Rio Preto", 
		"destinationTerminal": "São José do Rio Preto (SP, Brasil) / SP, Brasil (SJP)", 
		"finder": "no", 
		"typeTrip": "domestic", 
		"observation": "", 
		"dateFlag": "IS" 
	} 
]
Propiedad Tipo Tamaño Descripción
Id String 2 ID del tramo solicitado de autobus. Si hay 2 solicitudes de autobus, cada sección contendrá un código diferente. Ejemplo: 1 y 2
Date String (Date Time) 24 Fecha de salida del tramo de autobus. Ejemplo: 2019-04-12T09:38:37.503
InclusionDate String (Date Time) 24 Fecha de solicitud del tramo de autobus. Ejemplo: 2019-04-12T09:38:37.503
ChangeDate String (Date Time) 24 Fecha de cambio de registro. Será la misma fecha de inclusión, si el registro no ha sido modificado. Ejemplo: 2019-04-12T09:38:37.503
originCity String (Number) 4 Ciudad de origen solicitado. Ejemplo: São Paulo
originTerminal String 100 Nombre de la terminal de origen de autobuses. Ejemplo: São Paulo - Barra Funda (SP, Brasil) / SP, Brasil (SAO)
destinationCity String (Number) 4 Ciudad de destino solicitado. Ejemplo: São José
destinationTerminal String 100 Nombre de la terminal de destino de autobuses. Ejemplo: São José do Rio Preto (SP, Brasil) / SP, Brasil (SJP)
finder string 3 Campo que indica si el tramo se solicitó en línea. Ejemplo: yes/no
typeTrip String (enum) 15 Indica el tipo de viaje. Ejemplo: Domestic, International
observation String 255 Observación de la solicitud del tramo de autobus. Ejemplo: visita al proveedor
dateFlag String 2 Indicativo de cómo se considerará el tiempo para el segmento. Ejemplo: IS - indifferentConsideringDeparture; PC - dawnConsideringArrival

RequestsServicesQuotations

Mediante este método, es posible recuperar los datos de cotización de los servicios vinculados a una solicitud. Para obtener estos datos, es necesario informar el ID de la solicitud. Para obtener más información sobre cotizaciones de servicios, consulte nuestra Wiki.

GET /requests/{requestId}/services/quotations

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": "string",
		"quotationId": "string",
		"service": "string",
		"serviceDate": "2020-03-19T11:54:19.958Z",
		"provider": "string",
		"totalValue": 0,
		"approvedTotalValue": 0,
		"observation": "string",
		"voucher": "string",
		"voucherDate": "2020-03-19T11:54:19.958Z",
		"formPaymentUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"telephone": "string",
			"fax": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"formPayment": {
			"description": "string",
			"typePayment": "invoiced",
			"code": "string",
			"air": "yes",
			"hotels": "yes",
			"rental": "yes",
			"service": "yes",
			"bus": "yes",
			"restrictive": "yes",
			"alternativeUATP": "yes",
			"card": {
				"paymentName": "string",
				"name": "string",
				"cardNumber": "string",
				"flag": "string",
				"active": "yes",
				"providerId": "string",
				"webServiceId": "string"
			},
			"billingCode": "string",
			"billingDescription": "string"
		},
		"schedulingUser": {
			"clientId": "00000000-0000-0000-0000-000000000000",
			"email": "string",
			"login": "string",
			"telephone": "string",
			"fax": "string",
			"thirdParty": "yes",
			"groups": [
				"admin"
			],
			"rg": "string",
			"cpf": "string",
			"employeeId": "string",
			"fullName": "string",
			"integrationCode": "string",
			"department": "string"
		},
		"serviceFields": [
			{
				"field": "string",
				"content": "string"
			}
		],
		"fees": [
			{
				"feeId": "00000000-0000-0000-0000-000000000000",
				"initialDate": "2020-03-19T11:54:19.958Z",
				"finalDate": "2020-03-19T11:54:19.958Z",
				"initialHour": "string",
				"finalHour": "string",
				"dayWeek": "monday",
				"name": "string",
				"description": "string",
				"typeTrip": "both",
				"action": "quotation",
				"online": "yes",
				"service": "air",
				"amount": 0,
				"percentage": 0,
				"ceilingPrice": 0,
				"inclusionDate": "2020-03-19T11:54:19.958Z"
			}
		],
		"coin": "string",
		"servicesOffers": [
			{
				"id": "string",
				"service": "string",
				"totalValue": 0
			}
		]
	}
]
Propiedad Tipo Tamaño Descripción
id Int 50 ID del tramo del servicio. Ejemplo: 1, 3, 5
quotationId Int 2 Id de la cotización.
service String 255 Nombre del servicio ingresado en la cotización. Ejemplo: TRANSFER
serviceDate String 24 Fecha del servicio. Ejemplo: 2020-01-08T15:00:00
provider String 50 Proveedor de donde proviene la información del servicio. Ejemplo: ARGO, AMADEUSWS
coin String 3 Tipo de moneda utilizada en la cotización. Ejemplo: BRL
totalValue Number 100 Valor total del servicio. Ejemplo: 450,00
approvedTotalValue Number 100 Cantidad total aprobada. Ejemplo: 450,00
observation String 255 Observación de la cotización del servicio. Ejemplo: solicitud de servicio del aeropuerto
voucher String 255 Valor del comprobante de servicio. Ejemplo: 1911995542/5525518
voucherDate String (DateTime) 24 Fecha en que se confirmó el comprobante. Ejemplo: 2019-12-18T20:33:58.400
formPayment Objeto responsable de devolver la información del método de pago de la solicitud
Propiedad Tipo Tamaño Descripción
description String 255 Descripción del método de pago de la solicitud. Ejemplo: facturado
typePayment String (Enum) 15 Tipos de pago utilizados. Ejemplo: 'direct Payment', 'creditCard', 'governmentBody', 'invoiced'
code String 50 Código de integración del método de pago. (Este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'TIPOFATURA1010'
air String 3 Campo que indica si el método de pago se puede utilizar para el producto aéreo. Ejemplo: yes/no
hotels String 3 Campo que indica si el método de pago se puede utilizar para el producto de alojamiento. Ejemplo: yes/no
rental String 3 Campo que indica si el método de pago se puede usar para el producto Arrendamiento de auto. Ejemplo: yes/no
service String 3 Campo que indica si el método de pago se puede usar para el producto del Servicio. Ejemplo: yes/no
bus String 3 Campo que indica si el método de pago se puede utilizar para el producto Autobus. Ejemplo: yes/no
restrictive String 3 Campo que indica si la facturación es del tipo restrictivo. Ejemplo: yes/no
alternativeUATP String 3 Campo que indica si la facturación es del tipo UATP. Ejemplo: yes/no
billingCode String 50 Código de facturación del método de pago. Ejemplo: BV5
billingDescription String 50 Descripción del código de facturación de la forma de pago. Ejemplo: FACTURACIÓN TOTAL PARA LA AGENCIA
card Objeto responsable de devolver la información de la tarjeta utilizada en la solicitud
Propiedad Tipo Tamaño Descripción
user String 255 Nombre del usuario que utilizó la tarjeta.: Maurício
formPayment String 255 Tipo de facturación de tarjeta. Ejemplo: tarjeta de crédito
cardNumber String 255 Número de tarjeta. Ejemplo: 3216-8394-9403-0604
flag String 50 Indica el tipo de tarjeta. Ejemplo: Visa, Mastercard
active String 3 El campo indica si la tarjeta está activa. Ejemplo: yes/no
providerId String 50 ID del proveedor de la tarjeta. Ejemplo: T0009015590A999118
webServiceId String 50 ID del servicio web de la tarjeta (solo tarjeta virtual). Ejemplo: B2BPAY, WEX, CONFERMA
formPaymentUser Objeto responsable de devolver la información del usuario que utilizó el método de pago
Propiedad Tipo Tamanha Descripción
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del usuario. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión de usuario. Ejemplo: roberto.luiz
telephone String 50 Teléfono del usuario. Ejemplo: 9 95463154
fax String 50 Fax de usuario. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el usuario está subcontratado o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
employeeId String 255 ID Número de empleado de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUARIO1010'
department String 255 Departamento del usuarios. Ejemplo: legal
formPaymentUser Objeto responsable de devolver la información del usuario que utilizó el método de pago
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente devuelto. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del usuario. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión de usuario. Ejemplo: roberto.luiz
telephone String 50 Teléfono del usuario Ejemplo: 9 95463154
fax String 50 Fax de usuario. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el usuario está subcontratado o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
employeeId String 255 ID Número de empleado de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUARIO1010'
department String 255 Departamento del usuario. Ejemplo: legal
schedulingUser Objeto responsable de devolver la información del usuario que reservó el servicio
Propiedad Tipo Tamaño Descripción
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 50 Correo electrónico de contacto del usuario. Ejemplo: roberto.luiz@fdtps.br
login String 50 Inicio de sesión de usuario. Ejemplo: roberto.luiz
telephone String 50 Teléfono del usuario. Ejemplo: 9 95463154
fax String 50 Fax de usuario. Ejemplo: 9 95463154
thirdParty String 3 Campo que indica si el usuario está subcontratado o no. Ejemplo: yes/no
groups String 10 Grupo en el que se inserta el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 15 Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String 15 Número de CPF del usuario. Ejemplo: 665.854.965-63
employeeId String 255 ID Número de empleado de usuario. Ejemplo: 10377192
fullName String 255 Nombre completo del usuario. Ejemplo: aprobador principal
integrationCode String 255 Código de integración del usuario (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUARIO1010'
department String 255 Departamento de usuarios. Ejemplo: operacional
serviceFields Objeto responsable de devolver información de los campos gerenciales
Propiedad Tipo Tamaño Descripción
content String 50 Contenido mostrado en el campo. Ejemplo: 08/01/2003
field String 50 Identificador de campo. Ejemplo: sustentacao_ajweg_checkin3
fees Objeto responsable de devolver la información de tarifas para la cotización del servicio
Propiedad Tipo Tamaño Descripción
feeId Int 50 ID de la tarifa vinculada a la solicitud. Ejemplo: 00000000-0000-0000-0000-000000000000
initialDate String (DateTime) 24 Fecha de inicio de la solicitud. Ejemplo: 2019-08-22
finalDate String (DateTime) 24 Fecha de finalización de la solicitud. Ejemplo: 2019-08-22
initialHour String (DateTime) 24 Hora de inicio de la solicitud. Ejemplo: 2019-08-22
finalHour String (DateTime) 24 Hora de finalización de la solicitud. Ejemplo: 2019-08-22
dayWeek String 10 Día de la semana de solicitud. Ejemplo: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'
name String 50 Nombre de la tarifa. Ejemplo: Experience Bundle
description String 1024 Descripción de la tarifa. Ejemplo: se cobrarán R $ 15,00 por la emisión de paquetes de secciones nacionales o internacionales, realizadas en línea o fuera de línea. Para todas las solicitudes (abiertas desde 29/11/2019) en este cliente. Si la llamada se realiza entre las 00:00 y las 23:59.
typeTrip String (Enum) 13 Tipo de viaje al que está vinculada la tarifa. Ejemplo: 'both', 'international', 'domestic'
action String 13 Tipo de acción tomada para la tarifa. Ejemplo: 'quotation', 'ticketing'
online String 3 Campo que informa si la tarifa está en línea. Ejemplo: yes/no
service String 7 Tipo de servicio de tarifa. Ejemplo: 'air', 'hotels', 'rental', 'service', 'bus', 'bundle'
amount Number 100 Importe de la tarifa. Ejemplo: 20
percentage Number 100 Porcentaje de tarifa. Ejemplo: 5
ceilingPrice Number 100 Valor máximo de la tarifa. Ejemplo: 35
inclusionDate String (DateTime) 24 Fecha de inclusión de tarifa. Ejemplo: 2020-03-11T19:29:50.873Z
servicesOffers Objeto responsable de devolver la información del servicio ofrecido
Propiedad Tipo Tamaño Descripción
service String 50 Nombre del servicio Ejemplo: limpieza de ventanas de apartamentos
id String 50 Identificador de servicio ofrecido (combinación de servicoId y cotacaoId). Ejemplo: 1_1, 0_1
totalValue Number 100 Cálculo de los valores presentados en la propiedad ‘value’(valor diario + impuestos). Ejemplo: 55,00

RequestsServicesRequested

Mediante este método, es posible recuperar información de solicitudes de servicio. Para obtener estos datos es necesario informar el ID de la solicitud. Para obtener más información sobre los servicios, consulte nuestra Wiki.

GET /requests/{requestId}/services/requested

Solicitud

Solicitud GET

Respuesta

[
	{
		"id": "string",
		"service": "string",
		"quantity": 0,
		"date": "2020-03-25T11:03:21.630Z",
		"observation": "string",
		"managementsFields": [
			{
				"field": "string",
				"content": "string"
			}
		]
	}
]
Propiedad Tipo Tamaño Descripción
id Number 50 ID del servicio. Ejemplo: 1, 3, 5
service String 255 Nombre del servicio Ejemplo: compra de equipaje
quantity Number 50 Número de servicios en la solicitud. Ejemplo: 1
date String 24 Fecha de servicio. Ejemplo: 2020-01-08T15:00:00
observation String 255 Observaciones del Servicio. Ejemplo: solicitud de servicio en el aeropuerto
managementsFields Objeto responsable de devolver información de los campos gerenciales
Propiedad Tipo Tamaño Descripción
content String 50 Contenido mostrado en el campo. Ejemplo: 08/01/2003
field String 50 Identificador de campo. Ejemplo: sustentacao_ajweg_checkin3

RequestsTravelers

Mediante este método, es posible recuperar datos relacionados con viajeros vinculados a una solicitud.

GET / requests/{requestId}/travelers

Solicitud

Solicitud GET

Respuesta

[
	{
                "typeUser": "string",
		"clientId": "00000000-0000-0000-0000-000000000000",
		"userId": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"login": "string",
		"firstName": "string",
		"lastName": "string",
		"telephone": "string",
		"fax": "string",
		"registration": "string",
		"thirdParty": "yes",
		"groups": [
			"admin"
		],
		"rg": "string",
		"cpf": "string",
		"passport": "string",
		"employeeId": "string",
		"fullName": "string",
		"integrationCode": "string",
		"department": "string",
        "product" = "string",
        "id" = "int",
        "quotationId" = "int"
	}
]
Propiedad Tipo Tamaño Descripción
typeUser String (Enum) 9 Tipo de usuario en la solicitud. Ejemplo: Traveler/Companion
clientId Guid 36 ID del cliente devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
userId Guid 36 ID del usuario devuelta. Ejemplo: 00000000-0000-0000-0000-000000000000
email String 24 Correo electrónico de contacto del viajero de la solicitud. Ejemplo: roberto.luiz@fdtps.br
login String 24 Inicio de sesión del viajero de la solicitud. Ejemplo: roberto.luiz
firstName String 50 Nombre del viajero de la solicitud. Ejemplo: Roberto
lastName String 50 Apellido del viajero de la solicitud. Ejemplo: Luiz
telephone String 50 Teléfono del viajero de la solicitud. Ejemplo: 9 95463154
fax String 50 Fax del viajero de la solicitud. Ejemplo: 9 95463154
registration String 20 Registro del usuario viajero. Ejemplo: 464545
thirdParty String 3 El campo indica si el viajero está subcontratado o no. Ejemplo: yes/no
groups String 25 Grupo al que está vinculado el usuario. Ejemplo: 'user', 'admin', 'manager', 'financial'
rg String 50 Número de RG de usuario. Ejemplo: 45.585.412-X
cpf String 50 Número de CPF del usuario. Ejemplo: 665.854.965-63
passport String 20 Pasaporte del usuario. Ejemplo: BR123456
fullName String 255 Nombre completo del usuario. Ejemplo: Roberto Oliveira Luiz
integrationCode String 255 Código de integración de usuario viajero (este código puede ser utilizado por otros sistemas en el proceso de integración). Ejemplo: 'USUATENDENTE1010'
employeeId String 255 ID Número de empleado del usuario. Ejemplo: 10377192
department String 255 Departamento del usuarios. Ejemplo: legal
product String 255 Nombre del producto relacionado. Ejemplo: Hotels
id Int 50 ID de identificación del hotel en la cotización (solo producto Hotels). Ejemplo: 1, 3, 5
quotationId Int 50 ID de identificación de la cotización elegida (solo producto Hotels). Ejemplo: 1, 3, 5
Spanish