Method

Performed As

Request Query

Request Body

Response

POST
Retrieve a filtered list of Purchase Orders.

Logged in User

-

GridRequestParametersApi

GridResult<PurchaseOrderListItemPurchaseOrderLine>

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

Operation

Logged in User

Parameters

Method

Performed As

Request Query

Request Body

Response

GET
Retrieves Purchase Order Line default values for client side calculation by JobCode and other parametersa given line key.

Admin User

PurchaseOrderDetailKey

-

PurchaseOrderDetailLine

PONumber

Integer

The unique Number of the Purchase Order

.

Key

PurchaseOrderKey

The unique key for the line.

PONumber

CellData

The unique Number of the Purchase Order.

PODate

String

PONumber

CellData

Purchase Order number.

PODate

String

Purchase Order date

SupplierId

Integer

Supplier id.

SupplierName

String

Supplier name.

PurchaserId

Integer

Purchaser id

PurchaserName

String

Name of purchaser.

Reference

String

Reference text.

Completed

Boolean

Completed status.

Approved

Boolean

Approved status.

Currency

String

Currency.

POType

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 original purchase value of all lines total Order Cost of the POPurchase Order.

POStatus OriginalCostValue

String

Status of Purchase Order.

AssignedToId

Integer

Assigned person id

AssignedToName

String

Assigned person name.

EnteredById

Integer

Person who entered data.

OriginalCostValue

CellData

Original cost

CellData

The total Order Cost of the Purchase Order.

OutstandingValue

Number

The total Outstanding Cost of the Purchase Order.

OutstandingCostValue

CellData

Net value expected to be processed.

UpdatedDate

String

Updated date.

The total Outstanding Cost of the Purchase Order.

ApprovedDate

String

The Date this Purchase Order was Approved date.

RequiredDate

StringRequired

dateThe Date this Purchase Order is required by.

Status UpdatedDate

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

PurchaseOrdersKey

CurrentKey

PurchaseOrdersKey

Key

PurchaseOrdersKey

Index

IntegerThe Date this record was last updated.

Key

PurchaseOrderKey

The unique key of the Purchase Order.

PurchaseOrderFields

PurchaseOrderFields

The general data associated withe the Purchase Order.

Rows

Array<PurchaseOrderDetailLine>

The Purchase Order Lines.

ValidationErrors

Array<MvcValidationError>

A list of specific validation errors if the save was unsuccessful.

PrintButton

SplitButtonViewData

AttachmentsDialog

FileAttachmentsViewData

PONumber

StringViewData

The Number of the Purchase Order number.

Location

PickerViewData

The Location in Purchase Order.

ProfitCentre

PickerViewData

The Profit Centre.

Supplier

PickerViewData

The Supplier.

Contact

PickerViewData

The Contact personPerson.

WorkflowType

PickerViewData

The Workflow typeType.

WorkflowStatus

StringViewData

The Workflow Status.

EnteredBy

StringViewData

The name of the Person who entered datacreated the Purchase Order.

Purchaser

PickerViewData

The Purchaser.

Approver

PickerViewData

The Approver.

POReference

StringViewData

The Reference.

PODate

DateViewData

The Purchase Order dateDate.

StandingPO

BoolViewData

The Standing Purchase Order statusflag.

DocketPO

DropdownViewData

Docket status

Currency

DropdownViewData

The Currency of the Purchase Order.

FCRate

DecimalViewData

The Rate of foreign currency.

FCFixed POReason

BoolViewDataPickerViewData

The foreign currency rate applied.

POReason

PickerViewData

reason for the Purchase Order.

POType

PickerViewData

The Purchase Order typeType.

Job

PickerViewData

The Job.

JobCode

String

The Job Code.

FinancialCompanyCode

String

The Financial company Code.

Address

PickerViewData

The 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

NoteThe Comments on the Purchase Order.

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.

The Completed flag on the Purchase Order.

Completed

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.

PurchaseOrderLineId

Integer

The unique ID of Purchase Order Line.

PurchaserId

Integer

The ID of the Purchaser of the Purchase Order.

FinCoCode

String

The Financial Company Code on the Purchase Order Line.

JobCode

String

The Job Code on the Purchase Order Line.

ActivityCode

String

The Activity Code on the Purchase Order Line.

WorkCentreCode

String

The Work Centre Code on the Purchase Order Line.

GstTypeCode

String

 The GST Type Code on the Purchase Order Line.

Key

PurchaseOrderDetailKey

The unique key for the line.

JobCode

CellData

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

The Catalogue Line.

ActivityCode

CellData

The Activity Code on the Line.

LineDescription

CellData

The Line Description.

Details

CellData

The Details text.

WorkCentreCode

CellData

The Work Centre Code on the Line.

Unit

CellData

The Unit of measurement.

Reference

CellData

The 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

RequiredDate

String

The Required Date on the Line.

FollowUpDate

String

The Follow Up Date on the Line.

ExpectedDate

String

The Expected Date on the Line.

Complete

Boolean

The Completed flag on the Line.

Completed

CellData

The Completed flag on the Line.