Skip to main content
GET
Purchase requisitions with every field of the records each row points at: asset, cost centre, department, maintenance plan, requested by, site, warehouse, work order.

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
requisition_number
string
title
string
description
string
status
string
status_label
string
status_category
string
origin
string
priority
string
site_id
string
site_code
string
site_name
string
asset_id
string
asset_number
string
work_order_id
string
work_order_number
string
maintenance_plan_id
string
maintenance_plan_number
string
maintenance_plan_name
string
purchase_recommendation_id
string
warehouse_id
string
warehouse_name
string
department_id
string
cost_center_id
string
budget_id
string
budget_code
string
budget_name
string
budget_available
string
requested_by_user_id
string
requested_by
string
required_by
string
justification
string
estimated_total
string
estimated_total_currency_id
string
currency_code
string
submitted_at
string
approved_at
string
approved_by
string
rejected_at
string
rejection_reason
string
cancelled_at
string
cancellation_reason
string
line_count
string
awaiting_permission
string
approvals_outstanding
string
purchase_order_count
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
asset__asset_number
string
asset__name
string
asset__serial_number
string
asset__asset_category_code
string
asset__asset_category
string
asset__asset_category_ancestor_ids
string
asset__asset_category_path
string
asset__asset_category_root_code
string
asset__asset_category_root
string
asset__asset_class_code
string
asset__asset_class
string
asset__asset_class_is_default
string
asset__status
string
asset__status_label
string
asset__status_category
string
asset__criticality
string
asset__criticality_rank
string
asset__criticality_response_minutes
string
asset__site_code
string
asset__site_name
string
asset__location_name
string
asset__latitude
string
asset__longitude
string
asset__parent_asset_number
string
asset__manufacturer
string
asset__model_code
string
asset__model_name
string
asset__purchase_date
string
asset__installation_date
string
asset__commissioning_date
string
asset__warranty_expires_on
string
asset__health_score
string
asset__is_retired
string
asset__custodian
string
asset__custodian_email
string
asset__custody_since
string
asset__custom_fields
string
asset__created_at
string
asset__created_by_name
string
asset__updated_at
string
asset__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
department__code
string
department__name
string
department__business_unit_name
string
department__cost_centre_name
string
department__manager_name
string
department__maintenance_manager_name
string
department__is_active
string
department__workers
string
department__assets
string
maintenance_plan__inspection_template_code
string
maintenance_plan__inspection_template_name
string
maintenance_plan__raises_inspection
string
maintenance_plan__plan_number
string
maintenance_plan__name
string
maintenance_plan__description
string
maintenance_plan__maintenance_type
string
maintenance_plan__maintenance_type_name
string
maintenance_plan__status
string
maintenance_plan__status_label
string
maintenance_plan__status_category
string
maintenance_plan__site_code
string
maintenance_plan__priority_code
string
maintenance_plan__priority_name
string
maintenance_plan__criticality
string
maintenance_plan__trigger_combination
string
maintenance_plan__estimated_duration_minutes
string
maintenance_plan__lead_time_days
string
maintenance_plan__tolerance_days
string
maintenance_plan__sla_response_minutes
string
maintenance_plan__sla_resolution_minutes
string
maintenance_plan__assigned_team_name
string
maintenance_plan__preferred_worker_name
string
maintenance_plan__preferred_vendor_name
string
maintenance_plan__assigned_to_user_name
string
maintenance_plan__end_date
string
maintenance_plan__reminder_days
string
maintenance_plan__use_contract_visits
string
maintenance_plan__requires_permit
string
maintenance_plan__requires_shutdown
string
maintenance_plan__safety_instructions
string
maintenance_plan__instructions
string
maintenance_plan__auto_generate_work_order
string
maintenance_plan__current_version_number
string
maintenance_plan__last_generated_at
string
maintenance_plan__is_active
string
maintenance_plan__asset_count
string
maintenance_plan__asset_category_count
string
maintenance_plan__place_count
string
maintenance_plan__scope_names
string
maintenance_plan__asset_category_codes
string
maintenance_plan__asset_category_names
string
maintenance_plan__asset_names
string
maintenance_plan__place_names
string
maintenance_plan__task_count
string
maintenance_plan__requirement_count
string
maintenance_plan__trigger_count
string
maintenance_plan__frequency
string
maintenance_plan__next_due_at
string
maintenance_plan__work_orders_generated
string
maintenance_plan__custom_fields
string
maintenance_plan__created_at
string
maintenance_plan__created_by_name
string
maintenance_plan__updated_at
string
maintenance_plan__updated_by_name
string
requested_by__email
string
requested_by__username
string
requested_by__sign_in_handle
string
requested_by__name
string
requested_by__phone
string
requested_by__status
string
requested_by__last_login_at
string
requested_by__worker_number
string
requested_by__worker_name
string
requested_by__worker_type
string
requested_by__worker_is_active
string
requested_by__worker_teams
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
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
work_order__work_order_number
string
work_order__title
string
work_order__description
string
work_order__remarks
string
work_order__work_order_type
string
work_order__work_order_type_name
string
work_order__is_planned
string
work_order__is_emergency
string
work_order__priority
string
work_order__priority_name
string
work_order__priority_rank
string
work_order__status
string
work_order__status_label
string
work_order__status_category
string
work_order__is_open
string
work_order__allows_technician_edit
string
work_order__allows_parts_consumption
string
work_order__allows_labour_entry
string
work_order__allows_sla_extension
string
work_order__origin
string
work_order__reported_by_user_name
string
work_order__asset_number
string
work_order__asset_name
string
work_order__site_code
string
work_order__planned_start_at
string
work_order__planned_end_at
string
work_order__due_at
string
work_order__response_due_at
string
work_order__resolution_due_at
string
work_order__actual_start_at
string
work_order__actual_end_at
string
work_order__actual_duration_minutes
string
work_order__closed_at
string
work_order__readiness_score
string
work_order__is_ready
string
work_order__requires_permit
string
work_order__permit_required
string
work_order__safety_instructions
string
work_order__safety_briefing
string
work_order__problem_code
string
work_order__failure_code
string
work_order__resolution_code
string
work_order__resolution_code_name
string
work_order__resolution_notes
string
work_order__is_warranty_covered
string
work_order__sla_breached
string
work_order__estimated_duration_minutes
string
work_order__total_cost
string
work_order__labour_cost
string
work_order__parts_cost
string
work_order__vendor_cost
string
work_order__status_is_terminal
string
work_order__assigned_vendor_name
string
work_order__assigned_team_name
string
work_order__vendor_technician
string
work_order__vendor_technician_phone
string
work_order__assignees
string
work_order__cc
string
work_order__task_count
string
work_order__mandatory_tasks_outstanding
string
work_order__custom_fields
string
work_order__is_unassigned
string
work_order__age_days
string
work_order__turnaround_minutes
string
work_order__turnaround_running
string
work_order__checked_in_minutes
string
work_order__checked_in_since
string
work_order__is_overdue
string
work_order__sla_breached_now
string
work_order__created_at
string
work_order__created_by_name
string
work_order__updated_at
string
work_order__updated_by_name
string
reference_records
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

approvals_outstanding
integer<bigint>
approved_at
string<timestamp with time zone>
approved_by
string<character varying>
Maximum string length: 200
asset__asset_category
string<character varying>
Maximum string length: 200
asset__asset_category_ancestor_ids
string[]
asset__asset_category_code
string<character varying>
Maximum string length: 60
asset__asset_category_path
string<text>
asset__asset_category_root
string<character varying>
Maximum string length: 200
asset__asset_category_root_code
string<character varying>
Maximum string length: 60
asset__asset_class
string<character varying>
asset__asset_class_code
string<character varying>
asset__asset_class_is_default
boolean<boolean>
asset__asset_number
string<character varying>
Maximum string length: 80
asset__commissioning_date
string<date>
asset__created_at
string<timestamp with time zone>
asset__created_by_name
string<character varying>
Maximum string length: 200
asset__criticality
string<character varying>
Maximum string length: 40
asset__criticality_rank
integer<smallint>
asset__criticality_response_minutes
integer<integer>
asset__custodian
string<character varying>
asset__custodian_email
string<public.citext>
asset__custody_since
string<date>
asset__custom_fields
string<jsonb>
asset__health_score
number<numeric>
asset__installation_date
string<date>
asset__is_retired
boolean<boolean>
asset__latitude
number<numeric>
asset__location_name
string<character varying>
Maximum string length: 200
asset__longitude
number<numeric>
asset__manufacturer
string<character varying>
Maximum string length: 200
asset__model_code
string<character varying>
Maximum string length: 80
asset__model_name
string<character varying>
Maximum string length: 200
asset__name
string<character varying>
Maximum string length: 250
asset__parent_asset_number
string<character varying>
Maximum string length: 80
asset__purchase_date
string<date>
asset__serial_number
string<character varying>
Maximum string length: 120
asset__site_code
string<character varying>
Maximum string length: 50
asset__site_name
string<character varying>
Maximum string length: 200
asset__status
string<character varying>
Maximum string length: 60
asset__status_category
string<character varying>
Maximum string length: 20
asset__status_label
string<text>
asset__updated_at
string<timestamp with time zone>
asset__updated_by_name
string<character varying>
Maximum string length: 200
asset__warranty_expires_on
string<date>
asset_id
string<uuid>

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

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_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>
cost_center_id
string<uuid>

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

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
custom_fields
string<jsonb>
department__assets
integer<bigint>
department__business_unit_name
string<character varying>
Maximum string length: 200
department__code
string<character varying>
Maximum string length: 50
department__cost_centre_name
string<character varying>
Maximum string length: 200
department__is_active
boolean<boolean>
department__maintenance_manager_name
string<character varying>
Maximum string length: 200
department__manager_name
string<character varying>
Maximum string length: 200
department__name
string<character varying>
Maximum string length: 200
department__workers
integer<bigint>
department_id
string<uuid>

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

description
string<text>
estimated_total
number<numeric>
estimated_total_currency_id
string<uuid>

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

id
string<uuid>

Note: This is a Primary Key.

justification
string<text>
line_count
integer<bigint>
maintenance_plan__asset_category_codes
string[]
maintenance_plan__asset_category_count
integer<bigint>
maintenance_plan__asset_category_names
string<text>
maintenance_plan__asset_count
integer<bigint>
maintenance_plan__asset_names
string<text>
maintenance_plan__assigned_team_name
string<character varying>
Maximum string length: 200
maintenance_plan__assigned_to_user_name
string<character varying>
Maximum string length: 200
maintenance_plan__auto_generate_work_order
boolean<boolean>
maintenance_plan__created_at
string<timestamp with time zone>
maintenance_plan__created_by_name
string<character varying>
Maximum string length: 200
maintenance_plan__criticality
string<character varying>
Maximum string length: 40
maintenance_plan__current_version_number
integer<integer>
maintenance_plan__custom_fields
string<jsonb>
maintenance_plan__description
string<text>
maintenance_plan__end_date
string<date>
maintenance_plan__estimated_duration_minutes
integer<integer>
maintenance_plan__frequency
string<text>
maintenance_plan__inspection_template_code
string<character varying>
Maximum string length: 60
maintenance_plan__inspection_template_name
string<character varying>
Maximum string length: 250
maintenance_plan__instructions
string<text>
maintenance_plan__is_active
boolean<boolean>
maintenance_plan__last_generated_at
string<timestamp with time zone>
maintenance_plan__lead_time_days
integer<integer>
maintenance_plan__maintenance_type
string<character varying>
Maximum string length: 40
maintenance_plan__maintenance_type_name
string<character varying>
Maximum string length: 150
maintenance_plan__name
string<character varying>
Maximum string length: 250
maintenance_plan__next_due_at
string<timestamp with time zone>
maintenance_plan__place_count
integer<bigint>
maintenance_plan__place_names
string<text>
maintenance_plan__plan_number
string<character varying>
Maximum string length: 60
maintenance_plan__preferred_vendor_name
string<character varying>
Maximum string length: 200
maintenance_plan__preferred_worker_name
string<character varying>
Maximum string length: 200
maintenance_plan__priority_code
string<character varying>
Maximum string length: 40
maintenance_plan__priority_name
string<character varying>
Maximum string length: 150
maintenance_plan__raises_inspection
boolean<boolean>
maintenance_plan__reminder_days
integer<integer>
maintenance_plan__requirement_count
integer<bigint>
maintenance_plan__requires_permit
boolean<boolean>
maintenance_plan__requires_shutdown
boolean<boolean>
maintenance_plan__safety_instructions
string<text>
maintenance_plan__scope_names
string[]
maintenance_plan__site_code
string<character varying>
Maximum string length: 50
maintenance_plan__sla_resolution_minutes
integer<integer>
maintenance_plan__sla_response_minutes
integer<integer>
maintenance_plan__status
string<character varying>
Maximum string length: 60
maintenance_plan__status_category
string<character varying>
Maximum string length: 20
maintenance_plan__status_label
string<text>
maintenance_plan__task_count
integer<bigint>
maintenance_plan__tolerance_days
integer<integer>
maintenance_plan__trigger_combination
string<character varying>
Maximum string length: 10
maintenance_plan__trigger_count
integer<bigint>
maintenance_plan__updated_at
string<timestamp with time zone>
maintenance_plan__updated_by_name
string<character varying>
Maximum string length: 200
maintenance_plan__use_contract_visits
boolean<boolean>
maintenance_plan__work_orders_generated
integer<bigint>
maintenance_plan_id
string<uuid>

Note: This is a Foreign Key to maintenance_due.maintenance_plan_id.

maintenance_plan_name
string<character varying>
Maximum string length: 250
maintenance_plan_number
string<character varying>
Maximum string length: 60
origin
string<character varying>
Maximum string length: 30
priority
string<character varying>
Maximum string length: 20
purchase_order_count
integer<bigint>
purchase_recommendation_id
string<uuid>

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

reference_records
string<jsonb>
rejected_at
string<timestamp with time zone>
rejection_reason
string<text>
requested_by
string<character varying>
Maximum string length: 200
requested_by__email
string<public.citext>
requested_by__last_login_at
string<timestamp with time zone>
requested_by__name
string<character varying>
Maximum string length: 200
requested_by__phone
string<character varying>
Maximum string length: 40
requested_by__sign_in_handle
string<text>
requested_by__status
string<character varying>
Maximum string length: 30
requested_by__username
string<public.citext>
requested_by__worker_is_active
boolean<boolean>
requested_by__worker_name
string<character varying>
Maximum string length: 200
requested_by__worker_number
string<character varying>
Maximum string length: 60
requested_by__worker_teams
string<jsonb>
requested_by__worker_type
string<character varying>
Maximum string length: 150
requested_by_user_id
string<uuid>

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

required_by
string<date>
requisition_number
string<character varying>
Maximum string length: 60
row_version
integer<bigint>
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>
submitted_at
string<timestamp with time zone>
title
string<character varying>
Maximum string length: 250
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
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__actual_duration_minutes
integer<integer>
work_order__actual_end_at
string<timestamp with time zone>
work_order__actual_start_at
string<timestamp with time zone>
work_order__age_days
integer<integer>
work_order__allows_labour_entry
boolean<boolean>
work_order__allows_parts_consumption
boolean<boolean>
work_order__allows_sla_extension
boolean<boolean>
work_order__allows_technician_edit
boolean<boolean>
work_order__asset_name
string<character varying>
Maximum string length: 250
work_order__asset_number
string<character varying>
Maximum string length: 80
work_order__assigned_team_name
string<character varying>
Maximum string length: 200
work_order__assigned_vendor_name
string<character varying>
Maximum string length: 200
work_order__assignees
string<jsonb>
work_order__cc
string<jsonb>
work_order__checked_in_minutes
integer<integer>
work_order__checked_in_since
string<timestamp with time zone>
work_order__closed_at
string<timestamp with time zone>
work_order__created_at
string<timestamp with time zone>
work_order__created_by_name
string<character varying>
Maximum string length: 200
work_order__custom_fields
string<jsonb>
work_order__description
string<text>
work_order__due_at
string<timestamp with time zone>
work_order__estimated_duration_minutes
integer<integer>
work_order__failure_code
string<character varying>
Maximum string length: 80
work_order__is_emergency
boolean<boolean>
work_order__is_open
boolean<boolean>
work_order__is_overdue
boolean<boolean>
work_order__is_planned
boolean<boolean>
work_order__is_ready
boolean<boolean>
work_order__is_unassigned
boolean<boolean>
work_order__is_warranty_covered
boolean<boolean>
work_order__labour_cost
number<numeric>
work_order__mandatory_tasks_outstanding
integer<bigint>
work_order__origin
string<character varying>
Maximum string length: 30
work_order__parts_cost
number<numeric>
work_order__permit_required
boolean<boolean>
work_order__planned_end_at
string<timestamp with time zone>
work_order__planned_start_at
string<timestamp with time zone>
work_order__priority
string<character varying>
Maximum string length: 40
work_order__priority_name
string<character varying>
Maximum string length: 150
work_order__priority_rank
integer<smallint>
work_order__problem_code
string<character varying>
Maximum string length: 80
work_order__readiness_score
number<numeric>
work_order__remarks
string<text>
work_order__reported_by_user_name
string<character varying>
Maximum string length: 200
work_order__requires_permit
boolean<boolean>
work_order__resolution_code
string<character varying>
Maximum string length: 60
work_order__resolution_code_name
string<character varying>
Maximum string length: 200
work_order__resolution_due_at
string<timestamp with time zone>
work_order__resolution_notes
string<text>
work_order__response_due_at
string<timestamp with time zone>
work_order__safety_briefing
string<text>
work_order__safety_instructions
string<text>
work_order__site_code
string<character varying>
Maximum string length: 50
work_order__sla_breached
boolean<boolean>
work_order__sla_breached_now
boolean<boolean>
work_order__status
string<character varying>
Maximum string length: 60
work_order__status_category
string<character varying>
Maximum string length: 20
work_order__status_is_terminal
boolean<boolean>
work_order__status_label
string<text>
work_order__task_count
integer<bigint>
work_order__title
string<character varying>
Maximum string length: 250
work_order__total_cost
number<numeric>
work_order__turnaround_minutes
integer<integer>
work_order__turnaround_running
boolean<boolean>
work_order__updated_at
string<timestamp with time zone>
work_order__updated_by_name
string<character varying>
Maximum string length: 200
work_order__vendor_cost
number<numeric>
work_order__vendor_technician
string<character varying>
Maximum string length: 120
work_order__vendor_technician_phone
string<character varying>
Maximum string length: 40
work_order__work_order_number
string<character varying>
Maximum string length: 60
work_order__work_order_type
string<character varying>
Maximum string length: 40
work_order__work_order_type_name
string<character varying>
Maximum string length: 150
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