Actualizar el pago de una factura

El punto final PUT /pic/link/invoice-paids/update le permite actualizar 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

Esta solicitud no contiene parámetros de tipo Path

🔍 Query

Esta solicitud no contiene parámetros de tipo Query

💪 Body

Cuerpo del JSON

{
  "inputs": [
    InvoicePayment
  ]
}

Nombre	Tipo	Por defecto	Descripción
inputs	Array[InvoicePayment]	Required	Lista de pagos de facturas a actualizar

---

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 de pago
amount	float	Required	Cantidad del pago
currencyId	bool	false	Identificador de la moneda

caution

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

info

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.

Exjemplos

🖥️ cURL

curl -X PUT --location 'https://<identifier>.api.appliqloud.com/pic/link/invoice-payments/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
    "inputs": [
        {
          "paymentId": "6000098",
          "purchaseInvoiceId": "2001",
          "paymentDate": "2024-08-09",
          "amount": 12500.0,
          "currencyId": "USD"
        }
    ]
}'

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

Los pagos se actualizaron correctamente.

{
  "success": [
    {
      "paymentId": "6000098",
      "invoicePaymentStatus": "TRANSFERRED",
      "purchaseInvoiceId": "20001",
      "vendorBusinessPartnerId": "2598",
      "paymentDate": "2024-08-09",
      "amount": 12500.0,
      "currency": "USD"
    }
  ],
  "errors": []
}

⚠️ 200 (with errors)

Hay un error en la solicitud.

{
  "success": [],
  "errors": [
    {
      "traceId": "3095a0a77f80436ba104eb2fc24ba343"
      "cause": "InvoicePaymentNotFoundException",
      "message": "Invoice payment 6000098 not found in backend SAP_APQ",
      "context": {
        "id": "6000098",
        "backend_id": "SAP_APQ"
      }
    }
  ]
}

🔒 401

Se requiere autorización o las credenciales no son correctas

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

🚧 500

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"
      }
    ]
}