Content Comparison

Versions Compared

Version	Old Version 7	New Version Current
Changes made by	Cam Mackay	Bao TRINH
Saved on	May 21, 2024	Dec 18, 2024

Key

This line was added.
This line was removed.
Formatting was changed.

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	Length	Description
PONumber	Integer		The unique Number of the Purchase Order.

⬆️ Back to top

PurchaseOrderLine

Property	Data Type	Length	Description
Key	PurchaseOrderKey		The unique key for the line.
PONumber	CellData		The unique Number of the Purchase Order.
PODate	String	8	The Purchase Order Date.
SupplierId	Integer		The ID of the Company this Purchase Order is forsupplier id.
SupplierName	String	100	The name of the Company this Purchase Order is forsupplier name.
PurchaserId	Integer		The ID of the user who created this Purchase Orderpurchaser id.
PurchaserName	String		The name of the user who created this Purchase Orderpurchase name.
AssignedToId	Integer		The ID of the user assigned to this Purchase Orderassignee.
AssignedToName	String		The name of the user assigned to this Purchase Orderassignee.
EnteredById	Integer		The ID of the user who created this Purchase Order.
POStatus	String		The Status of Purchase Order.
Reference	String	20	The Reference Text.
Completed	Boolean		The Completed flag on the Purchase Order.
Approved	Boolean		The Approved flag on the Purchase Order.
Currency	String	10	The Code of the Currency this Purchase Order is incurrency.
POType	String	30	The Purchase Order type.
PODetails	StringThe Details on the Purchase Order	2000	The details.
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	StringThe Date this Purchase Order was Approved	8	Approved date.
RequiredDate	String	8	The Date this Purchase Order is required bydate.
UpdatedDate	StringThe Date this record was last updated	8	Last updated date.

⬆️ Back to top

PurchaseOrderApiModel

⬆️ 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

Job code.

LineCode

Line code.

ActivityCode

LineDescription

Line description.

Details

Details text.

WorkCentreCode

Work Centre code.

Unit

Unit of measurement.

Reference

Reference text.

FCUnitCost

Unit cost in foreign currency.

OrderQuantity

Order quantity

FCOrderCost

Order cost in foreign currency

OutstandingQuantity

Outstanding quantity.

FCOutstandingCost

Outstanding cost foreign currency

Gst

Tax

GstRate

Tax rate

GstTypeCode

Code of Tax type

Delete

LineDetails

Line description.

Budget

Budget name.

BudgetDetails

Budget details

Completed

Completed status.

LogHeaderID

Integer

Service log id.

LogHeader

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

Purchase Order number

Location

Location in Purchase Order

ProfitCentre

Supplier

Supplier

Contact

Contact person.

WorkflowType

WorkflowStatus

EnteredBy

Person who entered data.

Purchaser

Purchaser

Approver

Approver.

POReference

Reference.

PODate

Purchase Order date.

StandingPO

Standing Purchase Order status.

DocketPO

DropdownViewData

Docket status

Currency

DropdownViewData

Currency

FCRate

DecimalViewData

Rate of foreign currency.

FCFixed

The foreign currency rate applied.

POReason

POType

Purchase Order type.

Job

Job

Address

Address

StreetLine1

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

WorkCentreCode

String

Work Centre code.

GstTypeCode

String

Tax type

PurchaseOrderKey	The unique key of the Purchase Order.
PurchaseOrderFields	PurchaseOrderFields
Rows	Array<PurchaseOrderDetailLine>	The Purchase Order Lines.
ValidationErrors	Array<MvcValidationError>	A list of specific validation errors if the save was unsuccessful.

⬆️ Back to top

PurchaseOrderFields

Property	Data Type	Length	Description
PONumber	StringViewData		The Number of the Purchase Order.
Location	PickerViewData	5	The Location.
ProfitCentre	PickerViewData	20	The Profit Centre.
Supplier	PickerViewData		The Supplier.
Contact	PickerViewData	50	The Contact Person.
WorkflowType	PickerViewData	50	The Workflow Type.
WorkflowStatus	StringViewData		The Workflow Status.
EnteredBy	StringViewData		The name of the Person who created the Purchase Order.
Purchaser	PickerViewData		The Purchaser.
Approver	PickerViewData		The Approver.
POReference	StringViewData	20	The Reference.
PODate	DateViewData	8	The Purchase Order Date.
StandingPO	BoolViewData		The Standing Purchase flag.
Currency	DropdownViewData	10	The Currency of the Purchase Order.
FCRate	DecimalViewData	15,8	The Rate of foreign currency.
POReason	PickerViewData	20	The reason for the Purchase Order.
POType	PickerViewData	30	The Purchase Order Type.
Job	PickerViewData		The Job.
JobCode	String	20	The Job Code.
FinancialCompanyCode	String	5	The Financial company Code.
Address	PickerViewData		The Address.
StreetLine1	StringViewData	40	Street line 1 for address.
StreetLine2	StringViewData	40	Street line 2 for address.
Suburb	StringViewData	40	Suburb for address.
City	StringViewData	40	City of the address.
PostCode	StringViewData	10	Post code of the address.
State	StringViewData	40	State of the address.
Country	StringViewData	40	Country of the address
DeliveryAddress	StringViewData	2000	Delivery address
RequiredDate	DateViewData	8	Required date.
FollowUpDate	DateViewData	8	Follow up date.
ExpectedDate	DateViewData	8	Expected date.
RevisedDate	DateViewData	8	Revised date.
Comments	StringViewData		NoteThe Comments on the Purchase Order.
CompletedField	BoolViewData		The Completed flag on the Purchase Order.
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.

⬆️ Back to top

Example

%title

Expand

title	Click to view

Request

Code Block

language	json

Response

Code Block

language	json

Response sample

Code Block

language	json

⬆️ Top of page

	Boolean		The Completed flag on the Purchase Order.
Approved	Boolean		The Approved flag on the Purchase Order.
AttachmentsDialog	FileAttachmentsViewData		The file attachments information for the Purchase Order.
CanApprove	Boolean		A flag to indicate if the user has permissions to approve.
CanUnapprove	Boolean		A flag to indicate if the user has permissions to un-approve.
CanCancel	Boolean		A flag to indicate if the user has permissions to cancel.
CanUncancel	Boolean		A flag to indicate if the user has permissions to un-cancel.
CanSendBack	Boolean		A flag to indicate if the user has permissions to send back.
CanAssign	Boolean		A flag to indicate if the user has permissions to assign.
CanReview	Boolean		A flag to indicate if the user has permissions to review.
CanSubmit	Boolean		A flag to indicate if the user has permissions to submit.
CanComplete	Boolean		A flag to indicate if the user has permissions to complete.
CanCopy	Boolean		A flag to indicate if the user has permissions to copy.
CanEdit	Boolean		A flag to indicate if the user has permissions to edit.

⬆️ Back to top

PurchaseOrderDetailKey

Property	Data Type	Length	Description
PurchaseOrderLineId	Integer		The unique ID of Purchase Order Line.
PurchaserId	Integer		The ID of the Purchaser of the Purchase Order.
FinCoCode	String	5	The Financial Company Code on the Purchase Order Line.
JobCode	String	20	The Job Code on the Purchase Order Line.
ActivityCode	String	10	The Activity Code on the Purchase Order Line.
WorkCentreCode	String	10	The Work Centre Code on the Purchase Order Line.
GstTypeCode	String	10	The GST Type Code on the Purchase Order Line.

⬆️ Back to top

PurchaseOrderDetailLine

Property	Data Type	Length	Description
Key	PurchaseOrderDetailKey		The unique key for the line.
JobCode	CellData	20	The Job Code on the Line.
LogHeaderID	Integer		The ID of the Log on the Line
LogHeader	CellData		The Log on the Line
LineCode	CellData	30	The Catalogue Line.
ActivityCode	CellData	10	The Activity Code on the Line.
LineDescription	CellData	100	The Line Description.
Details	CellData	2000	The Details text.
WorkCentreCode	CellData	10	The Work Centre Code on the Line.
Unit	CellData	10	The Unit of measurement.
Reference	CellData	50	The Reference text.
FCUnitCost	CellData	15,4	Unit cost in foreign currency.
OrderQuantity	CellData	15,4	Order quantity
FCOrderCost	CellData		Order cost in foreign currency
OutstandingQuantity	CellData	15,4	Outstanding quantity.
FCOutstandingCost	CellData		Outstanding cost foreign currency
Gst	CellData		Tax
GstRate	CellData	8,5	Tax rate
GstTypeCode	CellData	10	Code of Tax type
RequiredDate	String	8	The Required Date on the Line.
FollowUpDate	String	8	The Follow Up Date on the Line.
ExpectedDate	String	8	The Expected Date on the Line.
Complete	Boolean		The Completed flag on the Line.
Completed	CellData		The Completed flag on the Line.

⬆️ Back to top

Table of Contents

minLevel	1
maxLevel	2
outline	false
type	list
separator	brackets
printable	false