Method

Performed As

Request Query

Request Body

Response

POST
Retrieve a filtered list of Purchase Orders.

Logged in User

-

GridRequestParametersApi

GridResult<PurchaseOrderListItem>

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

Body

Response

GET
Retrieves Purchase Order default values for client side calculation by JobCode and other parameters.

Key

PurchaseOrdersKey

PurchaseOrderFields

PurchaseOrdersPurchaseOrderFields

Rows

Array [PurchaseOrdersDetailLine]

ValidationErrors

Array [MvcValidationError]

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

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

PONumber

Integer

Purchase Order number.

CopyPONumber

Integer

LogHeaderId

Integer

Service log code

UseJobCode

String

Job code

FromPlantLog

Boolean

LogJobCode

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

Purchase Order type.

PODetails

String

Details.

OriginalValue

Number

The original purchase value of all lines of the PO.

POStatus

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

OutstandingValue

Number

Outstanding

OutstandingCostValue

CellData

Net value expected to be processed.

UpdatedDate

String

Updated date.

ApprovedDate

String

Approved date.

RequiredDate

String

Required date.

Status

String

Status.

ReadonlyFlag

Integer

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

PurchaseOrdersKey

CurrentKey

PurchaseOrdersKey

Key

PurchaseOrdersKey

Index

Integer

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.