Skip to main content
PATCH
/
v1
/
purchase-orders
/
{purchaseOrderId}
Update purchase order
curl --request PATCH \
  --url https://api.light.inc/v1/purchase-orders/{purchaseOrderId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USD",
  "purchaseOrderDate": "2023-12-25",
  "vendorEmail": "<string>",
  "deliveryAddress": "<string>",
  "deliveryDate": "2023-12-25",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "purchaseRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "IN_DRAFT",
  "totalAmount": 123,
  "totalNetAmount": 123,
  "totalTaxAmount": 123,
  "erpNumber": "<string>",
  "description": "<string>",
  "currency": "USD",
  "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendorEmail": "<string>",
  "deliveryAddress": "<string>",
  "deliveryDate": "2023-12-25",
  "documentKey": "<string>",
  "failureContext": {
    "name": "<string>",
    "type": "BAD_REQUEST",
    "errors": [
      {
        "type": "<string>",
        "message": "<string>",
        "path": [
          "<string>"
        ],
        "context": {}
      }
    ]
  },
  "editStatus": "ALL_EDITS_ALLOWED",
  "purchaseOrderDate": "2023-12-25",
  "erpSyncedAt": "2023-11-07T05:31:56Z",
  "lockedAt": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "purchaseOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "unitPrice": 123,
      "amount": 123,
      "netAmount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "customProperties": [
        {
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "values": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupInternalName": "<string>",
              "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "internalName": "<string>",
              "label": "<string>",
              "context": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

​
purchaseOrderId
string<uuid>
required

Body

application/json;charset=UTF-8
​
customProperties
(object | null)[] | null

List of custom properties to set on the vendor. Replaces the existing set.

​
vendorId
string<uuid> | null
​
companyEntityId
string<uuid> | null
​
ownerId
string<uuid> | null
​
currency
string | null
Example:

"USD"

​
purchaseOrderDate
string<date> | null
​
vendorEmail
string | null
​
deliveryAddress
string | null
​
deliveryDate
string<date> | null
​
description
string | null

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>
​
companyId
string<uuid>
​
createdBy
string<uuid>
​
companyEntityId
string<uuid>
​
purchaseRequestId
string<uuid>
​
state
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
IN_DRAFT,
RESET_PENDING,
APPROVED_ACCOUNTING_ENTRY_PENDING,
OPEN,
CLOSE_PENDING,
CLOSED,
CANCEL_PENDING,
CANCELLED
​
totalAmount
integer<int64>
​
totalNetAmount
integer<int64>
​
totalTaxAmount
integer<int64>
​
erpNumber
string
​
description
string
​
currency
string
Example:

"USD"

​
ownerId
string<uuid>
​
vendorId
string<uuid>
​
vendorEmail
string
​
deliveryAddress
string
​
deliveryDate
string<date>
​
documentKey
string
​
failureContext
object

Failure context when vendor onboarding fails.

​
editStatus
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
ALL_EDITS_ALLOWED,
ALL_EDITS_LOCKED
​
purchaseOrderDate
string<date>
​
erpSyncedAt
string<date-time>
​
lockedAt
string<date-time>
​
closedAt
string<date-time>
​
cancelledAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
lines
object[]
​
customProperties
(object | null)[]

Custom properties set on the vendor.