Skip to main content
GET
Purchase orders with every field of the records each row points at: contract, cost centre, requisition, site, vendor, warehouse.

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
work_order_id
string
work_order_number
string
work_order_title
string
asset_id
string
asset_number
string
asset_name
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
cost_center_code
string
cost_center_name
string
budget_id
string
budget_code
string
budget_name
string
budget_available
string
budget_committed
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
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
created_by_id
string
created_by_name
string
created_source
string
updated_at
string
updated_by_id
string
updated_by_name
string
contract__contract_number
string
contract__name
string
contract__contract_type
string
contract__contract_type_name
string
contract__contract_category
string
contract__status
string
contract__status_label
string
contract__status_category
string
contract__vendor_number
string
contract__vendor_name
string
contract__site_code
string
contract__site_name
string
contract__start_date
string
contract__end_date
string
contract__signed_on
string
contract__auto_renew
string
contract__renewal_notice_days
string
contract__contract_value
string
contract__covers_parts
string
contract__covers_labour
string
contract__covers_travel
string
contract__requires_authorized_vendor
string
contract__scope
string
contract__exclusions_summary
string
contract__owner_name
string
contract__external_reference
string
contract__notes
string
contract__is_live
string
contract__has_expired
string
contract__days_remaining
string
contract__in_renewal_window
string
contract__named_assets
string
contract__covered_asset_categories
string
contract__visits_included
string
contract__visits_used
string
contract__claims
string
contract__custom_fields
string
contract__created_at
string
contract__created_by_name
string
contract__updated_at
string
contract__updated_by_name
string
cost_centre__code
string
cost_centre__name
string
cost_centre__company_name
string
cost_centre__is_active
string
cost_centre__departments
string
site__code
string
site__name
string
site__timezone
string
site__is_active
string
site__company_name
string
site__business_unit_name
string
site__business_unit_parent_name
string
site__asset_count
string
vendor__vendor_number
string
vendor__name
string
vendor__vendor_type
string
vendor__is_oem
string
vendor__status
string
vendor__status_label
string
vendor__status_category
string
vendor__email
string
vendor__phone
string
vendor__website
string
vendor__payment_terms_days
string
vendor__onboarded_on
string
vendor__approved_on
string
vendor__performance_score
string
vendor__usable
string
vendor__categories
string
vendor__site_count
string
vendor__active_contracts
string
vendor__best_response_minutes
string
vendor__average_rating
string
vendor__rating_count
string
vendor__open_work_orders
string
vendor__warranty_work_orders
string
vendor__open_claims
string
vendor__is_assignable
string
vendor__compliance_expiring
string
vendor__warranty_authorisations
string
vendor__custom_fields
string
vendor__created_at
string
vendor__created_by_name
string
vendor__updated_at
string
vendor__updated_by_name
string
warehouse__code
string
warehouse__name
string
warehouse__site_code
string
warehouse__site_name
string
warehouse__warehouse_type
string
warehouse__keeper_name
string
warehouse__allows_negative_stock
string
warehouse__is_active
string
warehouse__bins
string
warehouse__parts_stocked
string
warehouse__units_on_hand
string
warehouse__negative_rows
string
reference_records
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>
asset_id
string<uuid>

Note: This is a Foreign Key to asset_contracts.asset_id.

asset_name
string<character varying>
Maximum string length: 250
asset_number
string<character varying>
Maximum string length: 80
awaiting_permission
string<character varying>
Maximum string length: 120
budget_available
number<numeric>
budget_code
string<character varying>
Maximum string length: 60
budget_committed
number<numeric>
budget_id
string<uuid>

Note: This is a Primary Key.

budget_name
string<character varying>
Maximum string length: 200
cancellation_reason
string<text>
cancelled_at
string<timestamp with time zone>
closed_at
string<timestamp with time zone>
closed_reason
string<text>
contract__auto_renew
boolean<boolean>
contract__claims
integer<bigint>
contract__contract_category
string<character varying>
Maximum string length: 30
contract__contract_number
string<character varying>
Maximum string length: 60
contract__contract_type
string<character varying>
Maximum string length: 40
contract__contract_type_name
string<character varying>
Maximum string length: 150
contract__contract_value
number<numeric>
contract__covered_asset_categories
integer<bigint>
contract__covers_labour
boolean<boolean>
contract__covers_parts
boolean<boolean>
contract__covers_travel
boolean<boolean>
contract__created_at
string<timestamp with time zone>
contract__created_by_name
string<character varying>
Maximum string length: 200
contract__custom_fields
string<jsonb>
contract__days_remaining
integer<integer>
contract__end_date
string<date>
contract__exclusions_summary
string<text>
contract__external_reference
string<character varying>
Maximum string length: 120
contract__has_expired
boolean<boolean>
contract__in_renewal_window
boolean<boolean>
contract__is_live
boolean<boolean>
contract__name
string<character varying>
Maximum string length: 200
contract__named_assets
integer<bigint>
contract__notes
string<text>
contract__owner_name
string<character varying>
Maximum string length: 200
contract__renewal_notice_days
integer<integer>
contract__requires_authorized_vendor
boolean<boolean>
contract__scope
string<text>
contract__signed_on
string<date>
contract__site_code
string<character varying>
Maximum string length: 50
contract__site_name
string<character varying>
Maximum string length: 200
contract__start_date
string<date>
contract__status
string<character varying>
Maximum string length: 60
contract__status_category
string<character varying>
Maximum string length: 20
contract__status_label
string<text>
contract__updated_at
string<timestamp with time zone>
contract__updated_by_name
string<character varying>
Maximum string length: 200
contract__vendor_name
string<character varying>
Maximum string length: 200
contract__vendor_number
string<character varying>
Maximum string length: 60
contract__visits_included
integer<bigint>
contract__visits_used
integer<bigint>
contract_id
string<uuid>

Note: This is a Foreign Key to contract_cover.contract_id.

cost_center_code
string<character varying>
Maximum string length: 50
cost_center_id
string<uuid>

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

cost_center_name
string<character varying>
Maximum string length: 200
cost_centre__code
string<character varying>
Maximum string length: 50
cost_centre__company_name
string<character varying>
Maximum string length: 200
cost_centre__departments
integer<bigint>
cost_centre__is_active
boolean<boolean>
cost_centre__name
string<character varying>
Maximum string length: 200
created_at
string<timestamp with time zone>
created_by_id
string<uuid>

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

created_by_name
string<character varying>
Maximum string length: 200
created_source
string<text>
currency_code
string<character varying>
Maximum string length: 3
currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

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_recommendations.purchase_requisition_id.

quantity_outstanding
number<numeric>
receipt_count
integer<bigint>
receipt_status
string<character varying>
Maximum string length: 20
reference_records
string<jsonb>
requisition_number
string<character varying>
Maximum string length: 60
row_version
integer<bigint>
ship_to_address
string<text>
shipping_amount
number<numeric>
site__asset_count
integer<bigint>
site__business_unit_name
string<character varying>
Maximum string length: 200
site__business_unit_parent_name
string<character varying>
Maximum string length: 200
site__code
string<character varying>
Maximum string length: 50
site__company_name
string<character varying>
Maximum string length: 200
site__is_active
boolean<boolean>
site__name
string<character varying>
Maximum string length: 200
site__timezone
string<character varying>
Maximum string length: 100
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_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<text>
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>
updated_by_id
string<uuid>

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

updated_by_name
string<character varying>
Maximum string length: 200
vendor__active_contracts
integer<bigint>
vendor__approved_on
string<date>
vendor__average_rating
number<numeric>
vendor__best_response_minutes
integer<integer>
vendor__categories
string<jsonb>
vendor__compliance_expiring
integer<bigint>
vendor__created_at
string<timestamp with time zone>
vendor__created_by_name
string<character varying>
Maximum string length: 200
vendor__custom_fields
string<jsonb>
vendor__email
string<public.citext>
vendor__is_assignable
boolean<boolean>
vendor__is_oem
boolean<boolean>
Maximum string length: 250
vendor__name
string<character varying>
Maximum string length: 200
vendor__onboarded_on
string<date>
vendor__open_claims
integer<bigint>
vendor__open_work_orders
integer<bigint>
vendor__payment_terms_days
integer<integer>
vendor__performance_score
number<numeric>
vendor__phone
string<character varying>
Maximum string length: 40
vendor__rating_count
integer<bigint>
vendor__site_count
integer<bigint>
vendor__status
string<character varying>
Maximum string length: 60
vendor__status_category
string<character varying>
Maximum string length: 20
vendor__status_label
string<text>
vendor__updated_at
string<timestamp with time zone>
vendor__updated_by_name
string<character varying>
Maximum string length: 200
vendor__usable
boolean<boolean>
vendor__vendor_number
string<character varying>
Maximum string length: 60
vendor__vendor_type
string<character varying>
Maximum string length: 40
vendor__warranty_authorisations
integer<bigint>
vendor__warranty_work_orders
integer<bigint>
vendor__website
string<character varying>
Maximum string length: 250
vendor_id
string<uuid>

Note: This is a Foreign Key to assignable_vendors.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__allows_negative_stock
boolean<boolean>
warehouse__bins
integer<bigint>
warehouse__code
string<character varying>
Maximum string length: 60
warehouse__is_active
boolean<boolean>
warehouse__keeper_name
string<character varying>
Maximum string length: 200
warehouse__name
string<character varying>
Maximum string length: 200
warehouse__negative_rows
integer<bigint>
warehouse__parts_stocked
integer<bigint>
warehouse__site_code
string<character varying>
Maximum string length: 50
warehouse__site_name
string<character varying>
Maximum string length: 200
warehouse__units_on_hand
number<numeric>
warehouse__warehouse_type
string<character varying>
Maximum string length: 30
warehouse_id
string<uuid>

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

warehouse_name
string<character varying>
Maximum string length: 200
work_order_id
string<uuid>

Note: This is a Foreign Key to asset_maintenance_plans.next_work_order_id.

work_order_number
string<character varying>
Maximum string length: 60
work_order_title
string<character varying>
Maximum string length: 250