LIlight
v1 - Purchase Orders

Get purchase order

Returns a purchase order by ID

get/v1/purchase-orders/{purchaseOrderId}

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

purchaseOrderIdstring uuid required

Response

default response

idstring uuid
companyIdstring uuid
createdBystring uuid
companyEntityIdstring uuid
purchaseRequestIdstring uuid
state'IN_DRAFT' | 'RESET_PENDING' | 'APPROVED_ACCOUNTING_ENTRY_PENDING' | 'OPEN' | 'CLOSE_PENDING' | 'CLOSED' | 'CANCEL_PENDING' | 'CANCELLED'

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

totalAmountinteger
totalNetAmountinteger
totalTaxAmountinteger
erpNumberstring
descriptionstring
currencystring
ownerIdstring uuid
vendorIdstring uuid
vendorEmailstring
deliveryAddressstring
deliveryDatestring date
documentKeystring
editStatus'ALL_EDITS_ALLOWED' | 'ALL_EDITS_LOCKED' | 'CORE_EDITS_LOCKED'

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

purchaseOrderDatestring date
erpSyncedAtstring date-time
lockedAtstring date-time
closedAtstring date-time
cancelledAtstring date-time
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.