Skip to main content
GET
Purchase orders with totals, receipt and invoice progress, and whether delivery is overdue.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
purchase_order_number
string
title
string
description
string
status
string
status_label
string
status_category
string
vendor_id
string
vendor_number
string
vendor_name
string
purchase_requisition_id
string
requisition_number
string
vendor_quote_id
string
contract_id
string
site_id
string
site_code
string
site_name
string
warehouse_id
string
warehouse_name
string
cost_center_id
string
currency_id
string
currency_code
string
order_date
string
promised_date
string
payment_terms_days
string
delivery_terms
string
ship_to_address
string
vendor_reference
string
subtotal_amount
string
tax_amount
string
shipping_amount
string
total_amount
string
receipt_status
string
invoice_status
string
issued_at
string
issued_by
string
acknowledged_at
string
closed_at
string
closed_reason
string
cancelled_at
string
cancellation_reason
string
notes
string
created_by_user_id
string
created_by
string
line_count
string
quantity_outstanding
string
receipt_count
string
invoice_count
string
delivery_overdue
string
awaiting_permission
string
approvals_outstanding
string
custom_fields
string
row_version
string
created_at
string
updated_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

acknowledged_at
string<timestamp with time zone>
approvals_outstanding
integer<bigint>
awaiting_permission
string<character varying>
Maximum string length: 120
cancellation_reason
string<text>
cancelled_at
string<timestamp with time zone>
closed_at
string<timestamp with time zone>
closed_reason
string<text>
contract_id
string<uuid>

Note: This is a Foreign Key to contracts.id.

cost_center_id
string<uuid>

Note: This is a Foreign Key to cost_centre_settings.id.

created_at
string<timestamp with time zone>
created_by
string<character varying>
Maximum string length: 200
created_by_user_id
string<uuid>

Note: This is a Foreign Key to my_profile.user_id.

currency_code
string<character varying>
Maximum string length: 3
currency_id
string<uuid>
custom_fields
string<jsonb>
delivery_overdue
boolean<boolean>
delivery_terms
string<character varying>
Maximum string length: 120
description
string<text>
id
string<uuid>

Note: This is a Primary Key.

invoice_count
integer<bigint>
invoice_status
string<character varying>
Maximum string length: 20
issued_at
string<timestamp with time zone>
issued_by
string<character varying>
Maximum string length: 200
line_count
integer<bigint>
notes
string<text>
order_date
string<date>
payment_terms_days
integer<integer>
promised_date
string<date>
purchase_order_number
string<character varying>
Maximum string length: 60
purchase_requisition_id
string<uuid>

Note: This is a Foreign Key to purchase_requisitions.id.

quantity_outstanding
number<numeric>
receipt_count
integer<bigint>
receipt_status
string<character varying>
Maximum string length: 20
requisition_number
string<character varying>
Maximum string length: 60
row_version
integer<bigint>
ship_to_address
string<text>
shipping_amount
number<numeric>
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

Note: This is a Foreign Key to site_settings.id.

site_name
string<character varying>
Maximum string length: 200
status
string<character varying>
Maximum string length: 60
status_category
string<character varying>
Maximum string length: 20
status_label
string<character varying>
Maximum string length: 150
subtotal_amount
number<numeric>
tax_amount
number<numeric>
title
string<character varying>
Maximum string length: 250
total_amount
number<numeric>
updated_at
string<timestamp with time zone>
vendor_id
string<uuid>

Note: This is a Foreign Key to vendor_directory.vendor_id.

vendor_name
string<character varying>
Maximum string length: 200
vendor_number
string<character varying>
Maximum string length: 60
vendor_quote_id
string<uuid>

Note: This is a Foreign Key to rfq_quote_comparison.vendor_quote_id.

vendor_reference
string<character varying>
Maximum string length: 120
warehouse_id
string<uuid>

Note: This is a Foreign Key to warehouse_settings.id.

warehouse_name
string<character varying>
Maximum string length: 200