Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Provides access to Purchase Order related data.
Endpoints
PurchaseOrderDefaultsApi
[Description]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 |
GET
Retrieves Purchase Order default values for client side calculation by JobCode and other parameters.
PurchaseOrderDetailApi
[Description]POST | Logged in User | - |
PurchaseOrderDetailApi
Provides API access to the Purchase Order detail (#/PurchaseOrders/List.aspx) dialog Web Workbench screen.
/api/PurchaseOrderDetailApi | |||||||
|---|---|---|---|---|---|---|---|
Operation | Logged in User | Parameters | Method | Performed As | Request Query | Request Body | Response |
GET | POST | PUT | |||||
Retrieve a specific Purchase Order. | Admin User | - | ||
POST | Admin User | - | ||
PUT | Admin User | - |
PurchaseOrderDefaultsApi
[Description]
/api/ |
|---|
PurchaseOrderDefaultsApi | ||||
|---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
Retrieves Purchase Order default values for client side calculation by JobCode and other parameters. |
Models
PurchaseOrderApiModel
Property | Data Type | Description |
|---|---|---|
Key | ||
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 | 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 | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
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 |
⬆️ Back to top
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 | 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 | Original cost | |
OutstandingValue | Number | Outstanding |
OutstandingCostValue | 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 | ||
CurrentKey | ||
Key | ||
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 | Workflow type. | |
WorkflowStatus | ||
EnteredBy | Person who entered data. | |
Purchaser | Purchaser | |
Approver | Approver. | |
POReference | Reference. | |
PODate | Purchase Order date. | |
StandingPO | Standing Purchase Order status. | |
DocketPO | Docket status | |
Currency | Currency | |
FCRate | Rate of foreign currency. | |
FCFixed | The foreign currency rate applied. | |
POReason | ||
POType | Purchase Order type. | |
Job | Job | |
Address | 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 | Note. | |
CompletedField | 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. |
⬆️ Back to top
Example
%title
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Top of page
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|