Debts Endpoint

POST/debts

Consulta de facturas pendientes de pago

Objetivo

El endpoint /debts permite consultar las facturas pendientes de pago para una empresa en particular dado un identificador provisto por el cliente. En los casos en los cuales no se encuentre deuda o haya algún parámetro erróneo, se responderá con un error.

Request

Headers

Campo	Tipo	Obligatorio	Descripción
x-authorization-token	String	Sí	Token de autenticación obtenido en el login.
x-api-key	String	Sí	API Key proporcionada para el acceso a la API.

Body Parameters

Campo	Tipo	Obligatorio	Descripción
companyCode	String	Sí	Código de compañía.
modalityId	String	Sí	Identificador de modalidad.
queryData	Object[]	Sí	Objeto con el identificador de la factura.
externalRequestId	String	Sí	Identificador de consulta enviado por el cliente de tapi
externalClientId	String	Sí	Identificador único de cada usuario del cliente de tapi. Este es utilizado para el flujo de Recordatorios.

Response

Response Body

Parámetro	Tipo	Descripción
operationId	String	ID único de la consulta.
companyCode	String	Código de la compañía.
companyName	String	Nombre de la compañía.
customerId	String	ID del cliente.
customerName	String	Nombre del cliente.
customerAddress	String	Dirección del cliente.
debts	Object[]	Detalle de la deuda.
tx	String	Identificador de la transacción interno de tapi.
mainTx	String	Identificador de la transacción interno de tapi.

Response Examples

200 OK

Consideraciones

Es necesario proporcionar un identificador válido para el cliente.
El formato del identificador puede variar según la empresa.
Se devolverán todas las deudas pendientes para el cliente identificado.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://services.homo.tapila.cloud/debts \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
  "companyCode": "",
  "modalityId": "",
  "queryData": [{"identifierName":"","identifierValue":""}],
  "externalRequestId": "",
  "externalClientId": ""
}'

API Reference