v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Customers

Update invoice PO number

put/v3/customers/{id}/invoices/{invoiceId}/po

Path parameters

idstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

Customer ID

invoiceIdstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

Invoice ID

Request body

poNumberstring required

Purchase Order number for the invoice

Example request

{
  "poNumber": "PO-12345"
}

Response

Updated PO number

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrder": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "PO-12345"
    }
  }
}