Actualizar el estado de una factura
El punto final PUT /pic/link/purchase-invoices/status
le permite modificar el estado de una factura existente. 💼🤝
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
JSON
{
"inputs": [
PurchaseInvoiceStatus
]
}
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
inputs | Array[ PurchaseInvoiceStatus ] | Required | Lista de facturas a cancelar |
PurchaseInvoiceStatus
{
"invoice_id": string,
"status": PurchaseInvoiceStatus,
"planned_payment_date": string,
"rejection_comments": string
}
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
invoiceId | string | Required | Identificador de factura |
status | PurchaseInvoiceStatus | Required | Estado de la factura |
plannedPaymentDate | string | Required | Fecha del pago previsto |
rejectionComments | string | Required | Comentarios de rechazo |
La fecha de pago estimada debe estar en formato DD-MM-AAAA
para poder procesarse correctamente.
InvoiceStatus
Valores posibles: [CREATED, TRANSFERRED, ACCOUNTING, REJECTED, CANCELLED, PARTIALLY_PAID, PAID]
Ejemplos
- 🖥️ cURL
- 🐍 Python
curl --location 'https://<identifier>.api.appliqloud.com/pic/invoices/status' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
"inputs": [
{
"id": "20001",
"status": "TRANSFERRED"
},
{
"id": "20002",
"status": "ACCOUNTING",
"plannedPaymentDate": "06-09-2024"
},
{
"id": "20003",
"status": "REJECTED",
"rejectionReason": "El monto no coincide con el precio real"
}
]
}'
import requests
request_body = {
"inputs": [
{
"id": "20001",
"status": "TRANSFERRED"
},
{
"id": "20002",
"status": "ACCOUNTING",
"plannedPaymentDate": "06-09-2024"
},
{
"id": "20003",
"status": "REJECTED",
"rejectionReason": "El monto no coincide con el precio real"
}
]
}
response = requests.put(f'https://{<identifier>}.api.appliqloud.com/pic/invoices/status',
json=request_body)
Asegúrese de modificar los campos <identifier>
y <token>
con el identificador de su empresa y el token de autenticación respectivamente.
Respuestas
- ✅ 200
- 🔒 401
- 🚧 500
Las facturas fueron canceladas exitosamente
{
"success": [
{
"id": "20001",
},
{
"id": "20002",
}
],
"errors": []
}
Se requiere autorización o las credenciales no son correctas
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"request": "PUT /pic/invoices/status",
"cause": "UnauthorizedException",
"message": "Authorization required"
}
Error interno de la aplicación (comuníquese con support@appliqloud.com o abra un ticket de soporte)
{
"traceId": "3095a0a77f80436ba104eb2fc24ba343"
"request": "PUT /pic/invoices/status",
"cause": "InternalServerError",
"message": "Internal Server Error"
}