The Purchase Order object
Attributes
id string
Unique identifier for the object.
created_at string
ISO 8601 timestamp of when the object was created.
updated_at string
ISO 8601 timestamp of when the object was last updated.
status string
Default: draft
title string
supplier string required
supplier_name string
company string required
transaction_date string required
schedule_date string
order_confirmation_no string
order_confirmation_date string
customer string
customer_name string
customer_contact_person string
customer_contact_display string
customer_contact_mobile string
customer_contact_email string
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string required
conversion_rate number required
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean
Default: false
set_warehouse string
is_subcontracted boolean
Default: false
supplier_warehouse string
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
disable_rounded_total boolean
Default: false
in_words string
advance_paid number
payment_terms_template string
tc_name string
terms string
ref_sq string
party_account_currency string
inter_company_order_reference string
per_received number
per_billed number
letter_head string
select_print_heading string
group_same_items boolean
Default: false
language string
from_date string
to_date string
auto_repeat string
tax_category string
set_reserve_warehouse string
billing_address string
billing_address_display string
is_internal_supplier boolean
Default: false
represents_company string
cost_center string
project string
is_old_subcontracting_flow boolean
Default: false
set_from_warehouse string
incoterm string
named_place string
advance_payment_status string
has_unit_price_items boolean
Default: false
dispatch_address string
dispatch_address_display string
supplier_group string
mps string
transaction_time string
signing_document_id string
The Purchase Order object
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
} GET
/api/buying/purchase-order/{id} Retrieve a purchase order
Retrieves the details of an existing purchase order. Supply the unique purchase order ID that was returned from a previous request.
Path parameters
id string required
The identifier of the purchase order to retrieve.
Returns
Returns the purchase order object if a valid identifier was provided.
GET /api/buying/purchase-order/{id}
curl https://api.overplane.dev/api/buying/purchase-order/purchase-order_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
} GET
/api/buying/purchase-order List all purchase orders
Returns a list of purchase orders. The results are sorted by creation date, with the most recently created appearing first.
Query parameters
limit integer
Maximum number of objects to return. Default: 20.
offset integer
Number of objects to skip for pagination. Default: 0.
Returns
A paginated list of purchase order objects.
GET /api/buying/purchase-order
curl https://api.overplane.dev/api/buying/purchase-order \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
}
],
"has_more": false,
"total": 1
} POST
/api/buying/purchase-order Create a purchase order
Creates a new purchase order object.
Body parameters
status string
Default: draft
title string
supplier string required
supplier_name string
company string required
transaction_date string required
schedule_date string
order_confirmation_no string
order_confirmation_date string
customer string
customer_name string
customer_contact_person string
customer_contact_display string
customer_contact_mobile string
customer_contact_email string
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string required
conversion_rate number required
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean
Default: false
set_warehouse string
is_subcontracted boolean
Default: false
supplier_warehouse string
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
disable_rounded_total boolean
Default: false
in_words string
advance_paid number
payment_terms_template string
tc_name string
terms string
ref_sq string
party_account_currency string
inter_company_order_reference string
per_received number
per_billed number
letter_head string
select_print_heading string
group_same_items boolean
Default: false
language string
from_date string
to_date string
auto_repeat string
tax_category string
set_reserve_warehouse string
billing_address string
billing_address_display string
is_internal_supplier boolean
Default: false
represents_company string
cost_center string
project string
is_old_subcontracting_flow boolean
Default: false
set_from_warehouse string
incoterm string
named_place string
advance_payment_status string
has_unit_price_items boolean
Default: false
dispatch_address string
dispatch_address_display string
supplier_group string
mps string
transaction_time string
signing_document_id string
Returns
Returns the newly created purchase order object if the call succeeded.
POST /api/buying/purchase-order
curl https://api.overplane.dev/api/buying/purchase-order \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"supplier":"supplier_example","company":"Example Corp","transaction_date":"2024-01-15","currency":"USD","conversion_rate":0}' Response
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
} PATCH
/api/buying/purchase-order/{id} Update a purchase order
Updates the specified purchase order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path parameters
id string required
The identifier of the purchase order to update.
Body parameters
status string
Default: draft
title string
supplier string
supplier_name string
company string
transaction_date string
schedule_date string
order_confirmation_no string
order_confirmation_date string
customer string
customer_name string
customer_contact_person string
customer_contact_display string
customer_contact_mobile string
customer_contact_email string
supplier_address string
contact_person string
address_display string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string
conversion_rate number
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean
Default: false
set_warehouse string
is_subcontracted boolean
Default: false
supplier_warehouse string
scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
taxes_and_charges string
shipping_rule string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string
Default: Grand Total
base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_in_words string
base_rounded_total number
grand_total number
rounding_adjustment number
rounded_total number
disable_rounded_total boolean
Default: false
in_words string
advance_paid number
payment_terms_template string
tc_name string
terms string
ref_sq string
party_account_currency string
inter_company_order_reference string
per_received number
per_billed number
letter_head string
select_print_heading string
group_same_items boolean
Default: false
language string
from_date string
to_date string
auto_repeat string
tax_category string
set_reserve_warehouse string
billing_address string
billing_address_display string
is_internal_supplier boolean
Default: false
represents_company string
cost_center string
project string
is_old_subcontracting_flow boolean
Default: false
set_from_warehouse string
incoterm string
named_place string
advance_payment_status string
has_unit_price_items boolean
Default: false
dispatch_address string
dispatch_address_display string
supplier_group string
mps string
transaction_time string
signing_document_id string
Returns
Returns the updated purchase order object.
PATCH /api/buying/purchase-order/{id}
curl https://api.overplane.dev/api/buying/purchase-order/purchase-order_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","title":"title_example"}' Response
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
} DELETE
/api/buying/purchase-order/{id} Delete a purchase order
Permanently deletes a purchase order. This cannot be undone.
Path parameters
id string required
The identifier of the purchase order to delete.
Returns
Returns a confirmation that the purchase order has been deleted.
DELETE /api/buying/purchase-order/{id}
curl https://api.overplane.dev/api/buying/purchase-order/purchase-order_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "purchase-order_abc123",
"deleted": true
} POST
/api/buying/purchase-order/{id}/submit Submit a purchase order
Submits a draft purchase order, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the purchase order to act on.
Returns
Returns the purchase order object with updated status.
POST /api/buying/purchase-order/{id}/submit
curl https://api.overplane.dev/api/buying/purchase-order/purchase-order_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
} POST
/api/buying/purchase-order/{id}/cancel Cancel a purchase order
Cancels a submitted purchase order, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the purchase order to act on.
Returns
Returns the purchase order object with updated status.
POST /api/buying/purchase-order/{id}/cancel
curl https://api.overplane.dev/api/buying/purchase-order/purchase-order_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "purchase-order_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"supplier": "supplier_example",
"supplier_name": "supplier_name_example",
"company": "Example Corp",
"transaction_date": "2024-01-15",
"schedule_date": "2024-01-15",
"order_confirmation_no": "order_confirmation_no_example",
"order_confirmation_date": "2024-01-15",
"customer": "customer_example",
"customer_name": "customer_name_example",
"customer_contact_person": "customer_contact_person_example",
"customer_contact_display": "customer_contact_display_example",
"customer_contact_mobile": "customer_contact_mobile_example",
"customer_contact_email": "user@example.com",
"supplier_address": "supplier_address_example",
"contact_person": "contact_person_example",
"address_display": "address_display_example",
"contact_display": "contact_display_example",
"contact_mobile": "contact_mobile_example",
"contact_email": "user@example.com",
"shipping_address": "shipping_address_example",
"shipping_address_display": "shipping_address_display_example",
"currency": "USD",
"conversion_rate": 0,
"buying_price_list": "buying_price_list_example",
"price_list_currency": "USD",
"plc_conversion_rate": 0,
"ignore_pricing_rule": false,
"set_warehouse": "set_warehouse_example",
"is_subcontracted": false,
"supplier_warehouse": "supplier_warehouse_example",
"scan_barcode": "scan_barcode_example",
"total_qty": 0,
"base_total": 0,
"base_net_total": 0,
"total": 0,
"net_total": 0,
"total_net_weight": 0,
"taxes_and_charges": "taxes_and_charges_example",
"shipping_rule": "shipping_rule_example",
"other_charges_calculation": "other_charges_calculation_example",
"base_taxes_and_charges_added": 0,
"base_taxes_and_charges_deducted": 0,
"base_total_taxes_and_charges": 0,
"taxes_and_charges_added": 0,
"taxes_and_charges_deducted": 0,
"total_taxes_and_charges": 0,
"apply_discount_on": "Grand Total",
"base_discount_amount": 0,
"additional_discount_percentage": 0,
"discount_amount": 0,
"base_grand_total": 0,
"base_rounding_adjustment": 0,
"base_in_words": "base_in_words_example",
"base_rounded_total": 0,
"grand_total": 0,
"rounding_adjustment": 0,
"rounded_total": 0,
"disable_rounded_total": false,
"in_words": "in_words_example",
"advance_paid": 0,
"payment_terms_template": "payment_terms_template_example",
"tc_name": "tc_name_example",
"terms": "terms_example",
"ref_sq": "ref_sq_example",
"party_account_currency": "USD",
"inter_company_order_reference": "Example Corp",
"per_received": 0,
"per_billed": 0,
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"group_same_items": false,
"language": "language_example",
"from_date": "2024-01-15",
"to_date": "2024-01-15",
"auto_repeat": "auto_repeat_example",
"tax_category": "tax_category_example",
"set_reserve_warehouse": "set_reserve_warehouse_example",
"billing_address": "billing_address_example",
"billing_address_display": "billing_address_display_example",
"is_internal_supplier": false,
"represents_company": "Example Corp",
"cost_center": "cost_center_example",
"project": "project_example",
"is_old_subcontracting_flow": false,
"set_from_warehouse": "set_from_warehouse_example",
"incoterm": "incoterm_example",
"named_place": "named_place_example",
"advance_payment_status": "advance_payment_status_example",
"has_unit_price_items": false,
"dispatch_address": "dispatch_address_example",
"dispatch_address_display": "dispatch_address_display_example",
"supplier_group": "supplier_group_example",
"mps": "mps_example",
"transaction_time": "transaction_time_example",
"signing_document_id": "signing_document_id_example"
}Line items
Child objects that belong to this purchase order. These are accessed via the parent's ID.
Purchase Order Item
Attributes
idx integer
purchase_order_id string required
item_code string required
supplier_part_no string
item_name string required
schedule_date string required
expected_delivery_date string
description string
image string
image_view string
qty number required
stock_uom string required
uom string required
conversion_factor number required
price_list_rate number
discount_percentage number
discount_amount number
last_purchase_rate number
base_price_list_rate number
rate number
amount number
base_rate number required
base_amount number required
pricing_rules string
is_free_item boolean
net_rate number
net_amount number
base_net_rate number
base_net_amount number
weight_per_unit number
total_weight number
weight_uom string
warehouse string
project string
material_request string
material_request_item string
sales_order string
sales_order_item string
supplier_quotation string
supplier_quotation_item string
delivered_by_supplier boolean
blanket_order string
blanket_order_rate number
item_group string
brand string
bom string
include_exploded_items boolean
stock_qty number
received_qty number
returned_qty number
billed_amt number
item_tax_rate string
expense_account string
cost_center string
page_break boolean
item_tax_template string
manufacturer string
manufacturer_part_no string
against_blanket_order boolean
is_fixed_asset boolean
stock_uom_rate number
actual_qty number
company_total_stock number
margin_type string
margin_rate_or_amount number
rate_with_margin number
base_rate_with_margin number
production_plan string
production_plan_item string
production_plan_sub_assembly_item string
product_bundle string
sales_order_packed_item string
fg_item string
fg_item_qty number
from_warehouse string
wip_composite_asset string
job_card string
distributed_discount_amount number
subcontracted_qty number
Endpoints
GET
/api/buying/purchase-order-item?parent_id={id} POST
/api/buying/purchase-order-item PATCH
/api/buying/purchase-order-item/{id} DELETE
/api/buying/purchase-order-item/{id} POST
/api/buying/purchase-order-item/reorder Purchase Order Item object
{
"id": "purchase-order-item_abc123",
"idx": 1,
"purchase_order_id": "purchase_order_id_example",
"item_code": "item_code_example",
"supplier_part_no": "supplier_part_no_example",
"item_name": "item_name_example",
"schedule_date": "2024-01-15",
"expected_delivery_date": "2024-01-15",
"description": "description_example",
"image": "image_example",
"image_view": "image_view_example",
"qty": 0,
"stock_uom": "stock_uom_example",
"uom": "uom_example",
"conversion_factor": 0,
"price_list_rate": 0,
"discount_percentage": 0,
"discount_amount": 0,
"last_purchase_rate": 0,
"base_price_list_rate": 0,
"rate": 0,
"amount": 0,
"base_rate": 0,
"base_amount": 0,
"pricing_rules": "pricing_rules_example",
"is_free_item": false,
"net_rate": 0,
"net_amount": 0,
"base_net_rate": 0,
"base_net_amount": 0,
"weight_per_unit": 0,
"total_weight": 0,
"weight_uom": "weight_uom_example",
"warehouse": "warehouse_example",
"project": "project_example",
"material_request": "material_request_example",
"material_request_item": "material_request_item_example",
"sales_order": "sales_order_example",
"sales_order_item": "sales_order_item_example",
"supplier_quotation": "supplier_quotation_example",
"supplier_quotation_item": "supplier_quotation_item_example",
"delivered_by_supplier": false,
"blanket_order": "blanket_order_example",
"blanket_order_rate": 0,
"item_group": "item_group_example",
"brand": "brand_example",
"bom": "bom_example",
"include_exploded_items": false,
"stock_qty": 0,
"received_qty": 0,
"returned_qty": 0,
"billed_amt": 0,
"item_tax_rate": "item_tax_rate_example",
"expense_account": "expense_account_example",
"cost_center": "cost_center_example",
"page_break": false,
"item_tax_template": "item_tax_template_example",
"manufacturer": "manufacturer_example",
"manufacturer_part_no": "manufacturer_part_no_example",
"against_blanket_order": false,
"is_fixed_asset": false,
"stock_uom_rate": 0,
"actual_qty": 0,
"company_total_stock": 0,
"margin_type": "margin_type_example",
"margin_rate_or_amount": 0,
"rate_with_margin": 0,
"base_rate_with_margin": 0,
"production_plan": "production_plan_example",
"production_plan_item": "production_plan_item_example",
"production_plan_sub_assembly_item": "production_plan_sub_assembly_item_example",
"product_bundle": "product_bundle_example",
"sales_order_packed_item": "sales_order_packed_item_example",
"fg_item": "fg_item_example",
"fg_item_qty": 1,
"from_warehouse": "from_warehouse_example",
"wip_composite_asset": "wip_composite_asset_example",
"job_card": "job_card_example",
"distributed_discount_amount": 0,
"subcontracted_qty": 0
}Purchase Order Item Supplied
Attributes
idx integer
purchase_order_id string required
main_item_code string
rm_item_code string
required_qty number
rate number
amount number
bom_detail_no string
reference_name string
conversion_factor number
stock_uom string
reserve_warehouse string
supplied_qty number
consumed_qty number
returned_qty number
total_supplied_qty number
Endpoints
GET
/api/buying/purchase-order-item-supplied?parent_id={id} POST
/api/buying/purchase-order-item-supplied PATCH
/api/buying/purchase-order-item-supplied/{id} DELETE
/api/buying/purchase-order-item-supplied/{id} POST
/api/buying/purchase-order-item-supplied/reorder Purchase Order Item Supplied object
{
"id": "purchase-order-item-supplied_abc123",
"idx": 1,
"purchase_order_id": "purchase_order_id_example",
"main_item_code": "main_item_code_example",
"rm_item_code": "rm_item_code_example",
"required_qty": 0,
"rate": 0,
"amount": 0,
"bom_detail_no": "bom_detail_no_example",
"reference_name": "reference_name_example",
"conversion_factor": 0,
"stock_uom": "stock_uom_example",
"reserve_warehouse": "reserve_warehouse_example",
"supplied_qty": 0,
"consumed_qty": 0,
"returned_qty": 0,
"total_supplied_qty": 0
}