Skip to main content
POST
Lock purchase order

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

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 | null

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.