Overview

Provides access to Purchase Order related data.

Endpoints

The resources available in this module.

PurchaseOrderListApi

Provides API access to the Purchase Orders List (#/PurchaseOrders/List.aspx) Web Workbench screen.

/api/PurchaseOrderListApi
Method	Performed As	Request Query	Request Body	Response
POST Retrieve a filtered list of Purchase Orders.	Logged in User	-	GridRequestParametersApi	GridResult<PurchaseOrderLine>

PurchaseOrderDetailApi

Provides API access to the Purchase Order detail (#/PurchaseOrders/List.aspx) dialog Web Workbench screen.

/api/PurchaseOrderDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific Purchase Order.	Admin User	PurchaseOrderKey	-	PurchaseOrderApiModel
POST Update an existing Purchase Order.	Admin User	-	PurchaseOrderApiModel	PurchaseOrderApiModel
PUT Create a new Purchase Order.	Admin User	-	PurchaseOrderApiModel	PurchaseOrderApiModel

PurchaseOrderDefaultsApi

Provides API access to the default line logic on the Purchase Order detail (#/PurchaseOrders/List.aspx) dialog Web Workbench screen.

/api/PurchaseOrderDefaultsApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieves Purchase Order Line default values for a given line key.	Admin User	PurchaseOrderDetailKey	-	PurchaseOrderDetailLine

Models

The definitions of models specific to endpoints in this module.

PurchaseOrderKey

Property	Data Type	Description
PONumber	Integer	The unique Number of the Purchase Order.

⬆️ Back to top

PurchaseOrderLine

Property	Data Type	Description
Key	PurchaseOrderKey	The unique key for the line.
PONumber	CellData	The unique Number of the Purchase Order.
PODate	String	The Purchase Order Date.
SupplierId	Integer	The ID of the Company this Purchase Order is for.
SupplierName	String	The name of the Company this Purchase Order is for.
PurchaserId	Integer	The ID of the user who created this Purchase Order.
PurchaserName	String	The name of the user who created this Purchase Order.
AssignedToId	Integer	The ID of the user assigned to this Purchase Order.
AssignedToName	String	The name of the user assigned to this Purchase Order.
EnteredById	Integer	The ID of the user who created this Purchase Order.
POStatus	String	The Status of Purchase Order.
Reference	String	The Reference Text.
Completed	Boolean	The Completed flag on the Purchase Order.
Approved	Boolean	The Approved flag on the Purchase Order.
Currency	String	The Code of the Currency this Purchase Order is in.
POType	String	The Purchase Order type.
PODetails	String	The Details on the Purchase Order.
OriginalValue	Number	The total Order Cost of the Purchase Order.
OriginalCostValue	CellData	The total Order Cost of the Purchase Order.
OutstandingValue	Number	The total Outstanding Cost of the Purchase Order.
OutstandingCostValue	CellData	The total Outstanding Cost of the Purchase Order.
ApprovedDate	String	The Date this Purchase Order was Approved.
RequiredDate	String	The Date this Purchase Order is required by.
UpdatedDate	String	The Date this record was last updated.

⬆️ Back to top

PurchaseOrderApiModel

Property	Data Type	Description
Key	PurchaseOrdersKey
PurchaseOrderFields	PurchaseOrdersPurchaseOrderFields
Rows	Array [PurchaseOrdersDetailLine]
ValidationErrors	Array [MvcValidationError]

⬆️ Back to top

PurchaseOrdersDetailKey

Property	Data Type	Description
KeyName	String	Key
PurchaseOrderLineId	Integer	Code of Purchase Order line.
PurchaserId	Integer	Purchase Order id.
FinCoCode	String	Financial company code
JobCode	String	Job code.
LineCode	Integer	Line code
ActivityCode	String	Activity code.
WorkCentreCode	String	Work Centre code.
GstTypeCode	String	Tax type

⬆️ Back to top

PurchaseOrdersDetailLine

Property	Data Type	Description
PurchaseOrderLineID	Integer	Purchase Order line.
RequiredDate	String	Required date.
FollowUpDate	String	Follow up date.
ExpectedDate	String	Expected date.
CheckboxDisabled	Boolean	Check box Disabled status.
CheckboxDisabledLabel	String	Checkbox Disable label
Complete	Boolean	Complete status.
LineDesc	Boolean	Line description.
CatalogueLineID	Integer	Catalogue line id.
ReferenceValue	String	Reference text.
JobCode	CellData	Job code.
LineCode	CellData	Line code.
ActivityCode	CellData	Activity code.
LineDescription	CellData	Line description.
Details	CellData	Details text.
WorkCentreCode	CellData	Work Centre code.
Unit	CellData	Unit of measurement.
Reference	CellData	Reference text.
FCUnitCost	CellData	Unit cost in foreign currency.
OrderQuantity	CellData	Order quantity
FCOrderCost	CellData	Order cost in foreign currency
OutstandingQuantity	CellData	Outstanding quantity.
FCOutstandingCost	CellData	Outstanding cost foreign currency
Gst	CellData	Tax
GstRate	CellData	Tax rate
GstTypeCode	CellData	Code of Tax type
Delete	CellData
LineDetails	CellData	Line description.
Budget	CellData	Budget name.
BudgetDetails	CellData	Budget details
Completed	CellData	Completed status.
LogHeaderID	Integer	Service log id.
LogHeader	CellData
Status	String	Status.
ReadonlyFlag	Integer	Read Only status.
ReadonlyMessage	String	Read Only message.
OriginalKey	PurchaseOrdersDetailKey
CurrentKey	PurchaseOrdersDetailKey
Key	PurchaseOrdersDetailKey
Index	Integer

⬆️ Back to top

PurchaseOrdersPurchaseOrderFields

Property	Data Type	Description
PrintButton	SplitButtonViewData
AttachmentsDialog	FileAttachmentsViewData
PONumber	StringViewData	Purchase Order number
Location	PickerViewData	Location in Purchase Order
ProfitCentre	PickerViewData	Profit Centre
Supplier	PickerViewData	Supplier
Contact	PickerViewData	Contact person.
WorkflowType	PickerViewData	Workflow type.
WorkflowStatus	StringViewData
EnteredBy	StringViewData	Person who entered data.
Purchaser	PickerViewData	Purchaser
Approver	PickerViewData	Approver.
POReference	StringViewData	Reference.
PODate	DateViewData	Purchase Order date.
StandingPO	BoolViewData	Standing Purchase Order status.
DocketPO	DropdownViewData	Docket status
Currency	DropdownViewData	Currency
FCRate	DecimalViewData	Rate of foreign currency.
FCFixed	BoolViewData	The foreign currency rate applied.
POReason	PickerViewData
POType	PickerViewData	Purchase Order type.
Job	PickerViewData	Job
Address	PickerViewData	Address
StreetLine1	StringViewData	Street line 1 for address.
StreetLine2	StringViewData	Street line 2 for address.
Suburb	StringViewData	Suburb for address.
City	StringViewData	City of the address.
PostCode	StringViewData	Post code of the address.
State	StringViewData	State of the address.
Country	StringViewData	Country of the address
DeliveryAddress	StringViewData	Delivery address
RequiredDate	DateViewData	Required date.
FollowUpDate	DateViewData	Follow up date.
ExpectedDate	DateViewData	Expected date.
RevisedDate	DateViewData	Revised date.
Comments	StringViewData	Note.
CompletedField	BoolViewData	Completed status
NoAccrual	BoolViewData
Afe	PickerViewData
CopyFromPurchaseOrder	PickerViewData	Copy from Purchase Order number
UseJob	PickerViewData
Copy	ButtonViewData
Recost	ButtonViewData	Recost calculation.
IsNew	Boolean	New status.
Approved	Boolean	Approved status.
Completed	Boolean	Completed status.
CanApprove	Boolean	Can approve or not.
CanUnapprove	Boolean	Can Unappvove or not.
ShowStructuredAddressFields	Boolean
ControlButtons	ControlButtonsViewData
Import	ButtonViewData
WorkflowDetails	ButtonViewData
MoreBtn	SplitButtonViewData
JobCode	String	Job code
Table	String
DiscussionTypeId	String
FinancialCompanyCode	String	Financial company code
CanCancel	Boolean	Can Cancel status.
CanUncancel	Boolean	Can UnCancel status.
CanSendBack	Boolean	Can Send back status.
CanAssign	Boolean	Can assign to person status.
CanReview	Boolean	Can Review status
CanSubmit	Boolean	Can Submit status
CanComplete	Boolean	Can Complete status.
CanCopy	Boolean	Can Copy status.
CanEdit	Boolean	Can Edit status.

Overview

Endpoints

PurchaseOrderListApi

PurchaseOrderDetailApi

PurchaseOrderDefaultsApi

Models

PurchaseOrderKey

PurchaseOrderLine

PurchaseOrderApiModel

PurchaseOrdersDetailKey

PurchaseOrdersDetailLine

PurchaseOrdersPurchaseOrderFields

Example

%title

Request

Response

Response sample