¿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:

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.

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:

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

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

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

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.

Tabla de Estatus de las Solicitudes

Anticipo / Gastos

Estatus del Viaje

Tabla de productos

CancelledProduct

Este servicio permite el usuario listar los productos que han sido cancelados en una solicitud, utilizando el ID.

GET /cancelledProduct

Solicitud

Respuesta

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

ConfigsAccountingAccount

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

Response

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

GET /accountingAccount/{accountingAccountId}

Request

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

POST /accountingAccount/{accountingAccountId}

Request

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

Response

PUT /accountingAccount/{accountingAccountId}

Request

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

Response

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

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

GET /approvals/v2

Solicitud

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

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

Respuesta

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

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

Respuesta

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

DELETE approvals/{approvalId}

Solicitud

Respuesta

GET /approvals/{approvalId}

Solicitud

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

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

POST /companies

Solicitud

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

Respuesta

GET /companies/{companyId}

Solicitud

Resposta

[
    {
        "companyId": "00000000-0000-0000-0000-000000000000",
        "companyName": "string",
        "active": "yes",
        "inclusionDate": "2020-10-29T10:32:26.367Z",
        "flagProject": "yes",
        "integrationCode": "string",
        "iata": "string",
        "star": "string",
        "referenceCode": "string"
    }
]

PUT /companies/{companyId}

Solicitud

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

Respuesta

ExpenseAdvancePayments

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

GET /expense/{requestId}/advancepayments

Solicitud

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

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

Resposta

[
    {
    "RequestNumber": 0,
    "RequestId": "00000000-0000-0000-0000-000000000000",
    "ManualBlock": "string",
    "Name": "string",
    "Blocked": true,
    "Message": "string",
    "FinalDate": "2021-03-17T15:11:31.732Z",
    "FinalDateAdvance": "string",
    "BlockForecastDate": "string",
    "BlockedBy": "string",
    "BlockedDate": "string",
    "UnblockedDate": "string"
    }
]

ExpensePayments

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

POST /expense/payments (Obsoleto)

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

Respuesta

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

Respuesta

GET /expense/{requestId}/payments

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

Solicitud

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

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

Respuesta

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

Respuesta

ExpenseMobility

Este servicio permite insertar un gasto de tipo Mobilidad en Argo Expense.

POST /expense/mobility

Solicitud

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

ExpenseRefunds

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

GET /expense/{requestId}/refunds

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

ExpenseTypesPayments

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

GET /expense/typespayments

Solicitud

Respuesta

[
	{
		"typePaymentId": "bfd2223d-3ff6-4021-8116-46ce6bd824ce",
		"name": "Cash01",
		"typePayment": "advancedPayment";
		"userUpdateDescription": "MURILLO SIQUEIRA"
	}
]

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

Request

Response

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

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

Solicitud

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

GET /costcenters/{costCenterId}

Solicitud

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

POST /costcenters

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

Respuesta

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

PATCH /costcenters

Solicitud

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

Respuesta

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

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

Request

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

POST /creditcards

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

Response

GET /creditcards/{cardId}

Request

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

PUT /creditcards/{cardId}

Request

Response

DELETE /creditCards/{cardId}

Request

Response

ConfigsExpenseManagementFields

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

GET /expensemanagementsfields

Solicitud

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

POST /expensemanagementsfields

Solicitud

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

Respuesta

GET /expensemanagementsfields/{expenseManagementfieldId}

Solicitud

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

PUT /expensemanagementsfields/{expenseManagementfieldId}

Solicitud

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

Respuesta

GET /expensemanagementsfields/{expenseManagementfieldId}/values

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

Solicitud

Respuesta

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

POST /expensemanagementsfields/{expenseManagementfieldId}/values

Solicitud

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

Respuesta

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

Solicitud

Respuesta

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

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

Solicitud

Respuesta

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

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

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

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

Respuesta

GET /expenses/{expenseId}

Solicitud

Resposta

[
    {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "expenseId": "00000000-0000-0000-0000-000000000000",
        "inclusionDate": "2020-10-30T10:26:04.483Z",
        "changeDate": "2020-10-30T10:26:04.483Z",
        "companyId": "00000000-0000-0000-0000-000000000000",
        "accountingAccountId": "00000000-0000-0000-0000-000000000000",
        "active": "yes",
        "name": "string",
        "type": "advancedPayment",
        "day": 0,
        "air": 0,
        "hotel": 0,
        "rental": 0,
        "request": 0,
        "typeTrip": "both",
        "groupDay": 0,
        "groupRequest": 0,
        "plusLess": "yes",
        "plusLessValue": 0,
        "plusLessUtilization": "totalDay",
        "individualQuantity": "yes",
        "tax": 0,
        "category": "food",
        "kilometerValue": 0,
        "requiredVoucher": "yes",
        "requiredCFDI": "yes",
        "refundable": "yes",
        "proven": "yes",
        "costCenterId": "00000000-0000-0000-0000-000000000000",
        "leveld": "00000000-0000-0000-0000-000000000000"
    }
]

PUT /expenses/{expenseId}

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

Respuesta

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

Solicitud

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

GET /formspayments/{formPaymentId}

Solicitud

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

POST /formspayments

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

Respuesta

PUT /formspayments/{formPaymentId}

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

Respuesta

DELETE /formspayments/{formPaymentId}

Solicitud

Respuesta

GET /formspayments/{formPaymentId}/codesformspayments

Solicitud

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

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

Solicitud

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

POST /formspayments/{formPaymentId}/codesformspayments

Solicitud

Respuesta

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

Solicitud

Respuesta

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

Solicitud

Respuesta

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

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

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

Respuesta

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

GET /users

Solicitud

Respuesta

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

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

Respuesta

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

GET /users/{userId}/requesters

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

Solicitud

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

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

Respuesta

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

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

Respuesta

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

Solicitud

Respuesta

GET /users/{userId}/representatives

Recupera delegados vinculados al usuario

Solicitud

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

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

Respuesta

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

Respuesta

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

Solicitud

Respuesta

PUT /users/{userId}/sendEmailPassword

Solicitud

Respuesta

[
      {
        "message": "string"
      }
]