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 la empresa a consultar. |
modalityId | String | Sí | Identificador de la modalidad de pago. |
identifier | String | Sí | Identificador del cliente (número de cuenta, NIF, etc.). |
Response
Response Examples
200 OK
404 Not Found
401 Unauthorized
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:///debts \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE' \ --header 'Content-Type: application/json' \ --data '{ "companyCode": "", "modalityId": "", "identifier": "" }'