Update the status of an invoice

The PUT /pic/link/purchase-invoices/status endpoint allows you to modify the status of an existing invoice. 💼🤝

Authorization

This endpoint requires authentication through Basic Auth with the username and password of the backend that will consume it. To create and configure a backend, follow the backends tutorial

Request parameters

👣 Path

This request does not contain parameters of type Path

🔍 Query

This request does not contain parameters of type Query

💪 Body

JSON

{
  "inputs": [
    PurchaseInvoiceStatusUpdate
  ]
}

Name	Type	Default	Description
inputs	Array[PurchaseInvoiceStatusUpdate]	Required	List of invoices to update

---

PurchaseInvoiceStatusUpdate

{
  "invoiceId": string,
  "status": PurchaseInvoiceStatus,
  "plannedPaymentDate": string | null,
  "rejectionComments": string | null
}

Name	Type	Default	Description
invoiceId	string	Required	Invoice identifier
status	PurchaseInvoiceStatus	Required	Invoice status
plannedPaymentDate	string | null	null	Date of the planned payment
rejectionComments	string | null	null	Rejection comments

caution

The plannedPaymentDate must be in YYYY-MM-DD format in order to be processed correctly.

tip

The invoiceId field can be obtained through the GET /pic/link/purchase-invoices/find endpoint

info

The plannedPaymentDate field is required when the status field value is APPROVED. Likewise, the rejectionComments field is required when the status field value is REJECTED

---

PurchaseInvoiceStatus

Possible values: [APPROVED, REJECTED]

Examples

🖥️ cURL

curl --location 'https://<identifier>.api.appliqloud.com/pic/link/purchase-invoices/status' \
--request PUT \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
    "inputs": [
        {
          "invoiceId": "1",
          "status": "REJECTED",
          "rejectionComments": "Please check the .pdf file"
        }
    ]
}'

caution

Make sure to modify the <identifier> and <token> fields with your company identifier and authentication token respectively.

Responses

✅ 200

Invoices were successfully updated

{
   "success": [
      {
         "header": {
            "invoiceId": "1",
            "invoiceStatus": "REJECTED",
            "accountingEntityId": "AE1",
            "vendorBusinessPartnerId": "1245",
            "purchaseOrderId": "450000001",
            "invoiceVendorId": "14156",
            "headerText": "Invoice",
            "invoiceDate": "2024-08-11",
            "fiscalYear": "2024",
            "totalAmount": 12000.0,
            "currencyId": "MXN",
            "paidAmount": 0.0,
            "plannedPaymentDate": null,
            "lastPaymentDate": null,
            "rejectionComments": "Please check the .pdf file",
            "invoiceFiles": [
               {
                  "fileType": "PDF",
                  "key": "invoices/d3d3dd51-c701-42f2-b1ff-558f68c3caa9.pdf",
                  "url":" https://s3.us-west-2.amazonaws.com/dev-apq-demos-bucket/invoices/d3d3dd51-c701-42f2-b1ff-558f68c3caa9.pdf"
               }
            ]
         },
         "items": [
            {
               "itemId": "10",
               "purchaseOrderItemId": "10",
               "unitId": "EA",
               "quantity": 2,
               "netUnitPrice": 6000.0,
               "netTotalPrice": 12000.0,
               "taxesAmount": 0.0,
               "extraChargesAmount": 0.0,
               "totalPrice": 12000.0,
               "itemText": null
            }
         ]
      }
   ],
   "errors": []
}

⚠️ 200 (with errors)

There is an error in the request

{
    "success": [],
    "errors": [
      {
        "traceId": "3095a0a77f80436ba104eb2fc24ba343"
        "cause": "PurchaseInvoiceNotFoundException",
        "message": "Purchase invoice 3 not found",
        "context": {
          "id": "3"
        }
      }
    ]
}

🔒 401

Authorization required or credentials are not correct

{
    "traceId": "3095a0a77f80436ba104eb2fc24ba343"
    "cause": "UnauthorizedException",
    "message": "Authorization required"
}

🚧 500

Internal server error (contact support@appliqloud.com or open a support ticket)

{
    "success": [],
    "errors": [     
      {
          "traceId": "3095a0a77f80436ba104eb2fc24ba343"
          "cause": "InternalServerError",
          "message": "Internal Server Error"
      }
    ]
}