Cancelar una factura

El punto final PUT /pic/link/purchase-invoices/cancel le permite cancelar 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

Esta solicitud no contiene parámetros de tipo Path

🔍 Query

Esta solicitud no contiene parámetros de tipo Query

💪 Body

JSON

{
  "inputs": [
    PurchaseInvoiceCancellation
  ]
}

Nombre	Tipo	Por defecto	Descripción
inputs	Array[PurchaseInvoiceCancellation]	Required	Lista de facturas a cancelar

---

PurchaseInvoiceCancellation

{
  "id": string
}

Nombre	Tipo	Por defecto	Descripción
id	string	Required	Identificador de factura

caution

La fecha de cancelación debe estar en formato DD-MM-AAAA para poder procesarse correctamente.

Ejemplos

🖥️ cURL

curl --location 'https://<identifier>.api.appliqloud.com/pic/invoices/cancel' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
    "inputs": [
        {
          "id": "20001",
          "cancelDate": "04-10-2023"
        },
        {
          "id": "20002",
          "cancelDate": "02-10-2023"
        }
    ]
}'

🐍 Python

import requests

request_body = {
  "inputs": [
      {
        "id": "20001",
        "cancelDate": "04-10-2023"
      },
      {
        "id": "20002",
        "cancelDate": "02-10-2023"
      }
  ]
}

response = requests.put(f'https://{<identifier>}.api.appliqloud.com/pic/invoices/cancel', 
                        json=request_body)

caution

Asegúrese de modificar los campos <identifier> y <token> con el identificador de su empresa y el token de autenticación respectivamente.

Respuestas

✅ 200

Las facturas fueron pagadas exitosamente

{
  "success": [
    {
      "id": "20001",
    },
    {
      "id": "20002",
    }
  ],
  "errors": []
}

🔒 401

Se requiere autorización o las credenciales no son correctas

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "request": "PUT /pic/invoices/cancel",
    "cause": "UnauthorizedException",
    "message": "Authorization required"
}

🚧 500

Error interno de la aplicación (comuníquese con support@appliqloud.com o abra un ticket de soporte)

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "request": "PUT /pic/invoices/cancel",
    "cause": "InternalServerError",
    "message": "Internal Server Error"
}