Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Endpoints
PurchaseOrderListApi
[Description]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 | |||||||
|---|---|---|---|---|---|---|---|
Operation | Logged in User | Parameters | Method | Performed As | Request Query | Request Body | Response |
POST | |||||||
PurchaseOrderDetailApi
[Description]
/api/PurchaseOrderDetailApi
Operation
Orders. | Logged in User |
/api/PurchaseOrderDefaultsApi
Operation
Logged in User
Parameters
- |
Body
Response
GET
Returns a purchase order and it's lines by PONumber
POST
Create or update Purchase Order
PUT
PurchaseOrderDefaultsApi
[Description]
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 |
- |
Description
Key
PurchaseOrdersKey
PurchaseOrderFields
PurchaseOrdersPurchaseOrderFields
Rows
Array [PurchaseOrdersDetailLine]
ValidationErrors
Array [MvcValidationError]
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
POST | Admin User | - | ||
PUT | Admin User | - |
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 | Admin User | - | ||
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 |
. |
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
Activity code.
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
PurchaseOrdersKey
Property
Data Type
Description
PONumber
Integer
Purchase Order number.
CopyPONumber
Integer
LogHeaderId
Integer
Service log code
UseJobCode
String
Job code
FromPlantLog
Boolean
LogJobCode
String
PurchaseOrdersListItem
Property
Data Type
Description
PONumber
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
⬆️ Back to top
PurchaseOrderLine
Property | Data Type | Description |
|---|---|---|
Key | The unique key for the line. | |
PONumber | 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 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 | Original cost | |
total Order Cost of the Purchase Order. | ||
OriginalCostValue | The total Order Cost of the Purchase Order. | |
OutstandingValue | Number | The total Outstanding Cost of the Purchase Order. |
OutstandingCostValue | CellDataNet value expected to be processed | The total Outstanding Cost of the Purchase Order. |
UpdatedDate ApprovedDate | StringUpdated | dateThe Date this Purchase Order was Approved. |
ApprovedDate RequiredDate | StringApproved | dateThe Date this Purchase Order is required by. |
RequiredDate UpdatedDate | String | Required date. |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. | OriginalKey | PurchaseOrdersKey | CurrentKey | PurchaseOrdersKey | Key | PurchaseOrdersKey | Index | Integer |
PurchaseOrdersPurchaseOrderFields
The Date this record was last updated. |
⬆️ Back to top
PurchaseOrderApiModel
Property | Data Type | Description |
|---|---|---|
Key | The unique key of the Purchase Order. | |
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. |
⬆️ Back to top
PurchaseOrderFields
Property | Data Type | Description | PrintButton | SplitButtonViewData | AttachmentsDialog | FileAttachmentsViewData|
|---|---|---|---|---|---|---|
PONumber | The Number of the Purchase Order number. | |||||
Location | The Location in Purchase Order. | |||||
ProfitCentre | The Profit Centre. | |||||
Supplier | The Supplier. | |||||
Contact | The Contact personPerson. | |||||
WorkflowType | The Workflow typeType. | |||||
WorkflowStatus | The Workflow Status. | |||||
EnteredBy | The name of the Person who entered datacreated the Purchase Order. | |||||
Purchaser | The Purchaser. | |||||
Approver | The Approver. | |||||
POReference | The Reference. | |||||
PODate | The Purchase Order dateDate. | |||||
StandingPO | The Standing Purchase Order status. | |||||
DocketPO | Docket status | |||||
flag. | ||||||
Currency | The Currency of the Purchase Order. | |||||
FCRate | The Rate of foreign currency. | |||||
FCFixed POReason | The foreign currency rate applied. | POReason | PickerViewDatareason for the Purchase Order. | |||
POType | The Purchase Order typeType. | |||||
Job | The Job. | |||||
JobCode | String | The Job Code. | ||||
FinancialCompanyCode | String | The Financial company Code. | ||||
Address | The Address. | |||||
StreetLine1 | Street line 1 for address. | |||||
StreetLine2 | Street line 2 for address. | |||||
Suburb | Suburb for address. | |||||
City | City of the address. | |||||
PostCode | Post code of the address. | |||||
State | State of the address. | |||||
Country | Country of the address | |||||
DeliveryAddress | Delivery address | |||||
RequiredDate | Required date. | |||||
FollowUpDate | Follow up date. | |||||
ExpectedDate | Expected date. | |||||
RevisedDate | Revised date. | |||||
Comments | NoteThe Comments on the Purchase Order. | |||||
CompletedField | The Completed flag on the Purchase Order. | |||||
Completed status | NoAccrual | Afe | ||||
CopyFromPurchaseOrder | Copy from Purchase Order number | UseJob | Copy | |||
Recost | 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 | WorkflowDetails | 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. |
Example
POST
| title | Click to view |
|---|
Request
| language | json |
|---|
Response
| language | json |
|---|
Response sample
| language | json |
|---|
Boolean | The Completed flag on the Purchase Order. | |
Approved | Boolean | The Approved flag on the Purchase Order. |
AttachmentsDialog | 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 | Description |
|---|---|---|
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. |
⬆️ Back to top
PurchaseOrderDetailLine
Property | Data Type | Description |
|---|---|---|
Key | The unique key for the line. | |
JobCode | The Job Code on the Line. | |
LogHeaderID | Integer | The ID of the Log on the Line |
LogHeader | The Log on the Line | |
LineCode | The Catalogue Line. | |
ActivityCode | The Activity Code on the Line. | |
LineDescription | The Line Description. | |
Details | The Details text. | |
WorkCentreCode | The Work Centre Code on the Line. | |
Unit | The Unit of measurement. | |
Reference | The 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 | |
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 | The Completed flag on the Line. |
⬆️ Back to top
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|