Registrar el pago de una factura
El punto final POST /pic/link/invoice-paids/create
le permite registrar un pago. 👔💼🤝
Authorización
Este endpoint requiere autenticación a través de Basic Auth
con el nombre de usuario y contraseña del backend que lo consumirá. Para crear y configurar un backend, siga el tutorial de backends
Parámetros requeridos
- 👣 Path
- 🔍 Query
- 💪 Body
Esta solicitud no contiene parámetros de tipo Path
Esta solicitud no contiene parámetros de tipo Query
Cuerpo del JSON
{
"inputs": [
InvoicePayment
]
}
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
inputs | Array[ InvoicePayment ] | Required | Listado de pagos de facturas a registrar |
InvoicePayment
{
"paymentId": string,
"purchaseInvoiceId": string,
"paymentDate": string,
"amount": float,
"currencyId": string
}
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
paymentId | string | Required | Identificador de pago en el sistema externo |
purchaseInvoiceId | string | Fecha de envío de la petición | Identificador de la factura |
paymentDate | strinf | Required | Fecha del pago |
amount | float | Required | Cantidad del pago |
currencyId | bool | false | Identificador de la moneda |
La fecha de pago debe estar en formato DD-MM-AAAA
para poder procesarse correctamente.
El campo purchaseInvoiceId
debe corresponder a una factura válida de una orden de compra creada desde el mismo backend. Solo puede registrar pagos en facturas obtenidas a través del punto final GET /pic/link/purchase-invoices/find
.
Ejemplos
- 🖥️ cURL
curl --location 'https://<identifier>.api.appliqloud.com/pic/link/invoice-payments/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
"inputs": [
{
"paymentId": "6000098",
"purchaseInvoiceId": "2001",
"paymentDate": "2024-08-09",
"amount": 12500.0,
"currencyId": "USD"
}
]
}'
Asegúrese de modificar los campos <identifier>
y <token>
con el identificador de su empresa y el token de autenticación respectivamente.
Respuestas
- ✅ 201
- ⚠️ 201 (with errors)
- 🔒 401
- 🚧 500
Los pagos se registraron exitosamente
{
"success": [
{
"paymentId": "6000098",
"invoicePaymentStatus": "TRANSFERRED",
"purchaseInvoiceId": "20001",
"vendorBusinessPartnerId": "2598",
"paymentDate": "2024-08-09",
"amount": 12500.0,
"currency": "USD"
}
],
"errors": []
}
Hay un error en la solicitud.
{
"success": [],
"errors": [
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"cause": "InvalidPaymentAmountException",
"message": "Payment 6000097 amount (3500.0) exceeds the remaining amount (2250.0) for invoice 3305",
"context": {
"id": "6000097".
"amount": "3500",
"remaining_amount": "2250",
"invoice_id": "3305"
}
}
]
}
Se requiere autorización o las credenciales no son correctas
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"request": "POST /pic/invoices/payments",
"cause": "UnauthorizedException",
"message": "Authorization required"
}
Error interno de la aplicación (comuníquese con support@appliqloud.com o abra un ticket de soporte)
{
"success": [],
"errors": [
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"cause": "InternalServerError",
"message": "Internal Server Error"
}
]
}