What can we help you find? Products Coupa Product Documentation Integration Technical Documentation The Coupa Core API Resources Transactional Resources Purchase Orders API (/purchase_orders) Purchase Order Lines API

Purchase Order Lines API

Use the Order Line API to create, update, and display order line data on purchase orders.

Actions

Verb	Path	Action	Description
POST	`/api/purchase_order_lines`	create	You cannot create purchase order lines directly via the API
GET	`/api/purchase_order_lines`	index	Query purchase order lines
GET	`/api/purchase_order_lines/:id`	show	Show purchase order line
PUT	`/api/purchase_order_lines/:id`	update	You cannot update purchase order lines directly via the API
PUT	`/api/purchase_orders/:id`	update	Update the cost center for purchase orders via the API

Elements

Element	Description	Req'd	Unique	Allowable Value	In	Out	Data Type
account	The account associated with the Purchase Order line. Use this element if there is no split billing for a Purchase Order line; for example, if there is only one account associated with the Purchase Order line. If there is more than one account, use the `account-allocations` element.	yes			yes	yes	Account
account-allocations	The account information associated with the Purchase Order line. Use this element to designate split billing for a Purchase Order line; for example, if there is more than one account associated with the Purchase Order line. If there is only one account, use the `account` element.				yes	yes	Order Line Allocation
account-type	chart of accounts				yes		AccountType
accounting-total	accounting_total				yes	yes	decimal(32,4)
accounting-total-currency	accounting_total_currency				yes	yes	Currency
asset-tags	asset_tags				yes	yes	Asset Tag
attachments	attachments				yes	yes	Attachment
bulk-price	Bulk Price				yes	yes	Bulk Price
commodity	commodity				yes	yes	Commodity
contract	contract				yes	yes	Contract
created-at	Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ					yes	datetime
created-by	User who created					yes	User
currency	Currency of transaction	yes			yes	yes	Currency
department	department				yes	yes	Department
description	description	yes			yes	yes	string(255)
extra-line-attribute	Extra line attribute					yes	Extra Line Attributes:: Order Line Attribute
form-response	form_response				yes	yes	Form Response
id	Coupa unique identifier					yes	integer
invoice-stop	Invoice Stop flag					yes	boolean
invoiced	invoiced				yes	yes	decimal(32,6)
item	item				yes	yes	Item
line-num	line_num		yes		yes	yes	string(255)
match-type	Match type	3-way-fifo, 3-way, 2-way, direct_matching, none			yes	yes	string(255)
milestones	Milestones				yes	yes	Procurement::Milestone
minimum-order-quantity	Minimum order quantity					yes	decimal(30,6)
need-by-date	need_by_date				yes	yes	datetime
order-header-id	order_header_id				yes	yes	integer
order-header-number	PO Number					yes	string
easy_form_response_id	ID of the Easy Form Response					yes
period	period				yes	yes	Period
price	price	yes			yes	yes	decimal(30,6)
quantity	quantity				yes	yes	decimal(30,6)
receipt-approval-required	Receipt approval required					yes	boolean
receipt-required	receipt_required				yes	yes	boolean
received	Quantity/Amount received				yes	yes	integer/decimal
receiving-warehouse	Receiving warehouse				yes	yes	Warehouse
reporting-total	reporting_total				yes	yes	decimal(32,4)
requester	requester					yes	User
rfq-form-response	rfq_form_response					yes	Form Response
savings-pct	savings_pct				yes	yes	decimal(8,2)
service-type	Specifies the type of service. Field only available when services procurement is enabled in the instance. For more information about service types, see Introducing Services Maestro.			resource, quantity_deliverable, amount_deliverable, non_service		yes	string
status	transaction status				yes	yes	string(50)
sub-line-num	sub_line_num				yes	yes	integer
supp-aux-part-num	supp_aux_part_num				yes	yes	text
supplier	supplier				yes	yes	Supplier
supplier-order-number	supplier_order_number				yes	yes	string(255)
supplier-site-id	supplier site id					yes	integer
total	total				yes	yes	decimal(32,4)
type	type				yes	yes	string(100)
uom	unit of measure				yes	yes	UoM
updated-at	Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ					yes	datetime
updated-by	User who updated					yes	User
version	version				yes	yes	integer
manufacturer_name	Manufacturer Name				yes		string(255)
manufacturer_part_number	Manufacturer Part Number				yes		string(255)
external_reference_number	External Reference Number	yes			yes	yes	string(255)
external_reference_type	External Reference Type				yes	yes	string(255)
third_party_supplier					yes	yes
amount_components					yes	yes	[]
extra_line_attribute					yes
requisition_line_id	Requisition line ID					yes	RequisitionLine
recurring_rules	Recurring rules					yes
line_owner	Line owner				yes	yes
order_line_tax_detail	Oder line tax detail				yes	yes