Versions Compared
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 | Logged in User | - |
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 | Admin User | - | ||
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 | Length | Description |
---|---|---|---|
PONumber | Integer | The unique Number of the Purchase Order. |
⬆️ Back to top
PurchaseOrderLine
Property | Data Type | Length | Description |
---|---|---|---|
Key | The unique key for the line. | ||
PONumber | 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 | String | 2000 | The Details on the Purchase Orderdetails. |
OriginalValue | Number | The 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 | 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
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 | Length | Description |
---|---|---|---|
PONumber | The Number of the Purchase Order. | ||
Location | 5 | The Location. | |
ProfitCentre | 20 | The Profit Centre. | |
Supplier | The Supplier. | ||
Contact | 50 | The Contact Person. | |
WorkflowType | 50 | The Workflow Type. | |
WorkflowStatus | The Workflow Status. | ||
EnteredBy | The name of the Person who created the Purchase Order. | ||
Purchaser | The Purchaser. | ||
Approver | The Approver. | ||
POReference | 20 | The Reference. | |
PODate | 8 | The Purchase Order Date. | |
StandingPO | The Standing Purchase flag. | ||
Currency | 10 | The Currency of the Purchase Order. | |
FCRate | 15,8 | The Rate of foreign currency. | |
POReason | 20 | The reason for the Purchase Order. | |
POType | 30 | The Purchase Order Type. | |
Job | The Job. | ||
JobCode | String | 20 | The Job Code. |
FinancialCompanyCode | String | 5 | The Financial company Code. |
Address | The Address. | ||
StreetLine1 | 40 | Street line 1 for address. | |
StreetLine2 | 40 | Street line 2 for address. | |
Suburb | 40 | Suburb for address. | |
City | 40 | City of the address. | |
PostCode | 10 | Post code of the address. | |
State | 40 | State of the address. | |
Country | 40 | Country of the address | |
DeliveryAddress | 2000 | Delivery address | |
RequiredDate | 8 | Required date. | |
FollowUpDate | 8 | Follow up date. | |
ExpectedDate | 8 | Expected date. | |
RevisedDate | 8 | Revised date. | |
Comments | The Comments on the Purchase Order. | ||
CompletedField | 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 | 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 | The unique key for the line. | ||
JobCode | 20 | The Job Code on the Line. | |
LogHeaderID | Integer | The ID of the Log on the Line | |
LogHeader | The Log on the Line | ||
LineCode | 30 | The Catalogue Line. | |
ActivityCode | 10 | The Activity Code on the Line. | |
LineDescription | 100 | The Line Description. | |
Details | 2000 | The Details text. | |
WorkCentreCode | 10 | The Work Centre Code on the Line. | |
Unit | 10 | The Unit of measurement. | |
Reference | 50 | The Reference text. | |
FCUnitCost | 15,4 | Unit cost in foreign currency. | |
OrderQuantity | 15,4 | Order quantity | |
FCOrderCost | Order cost in foreign currency | ||
OutstandingQuantity | 15,4 | Outstanding quantity. | |
FCOutstandingCost | Outstanding cost foreign currency | ||
Gst | Tax | ||
GstRate | 8,5 | Tax rate | |
GstTypeCode | 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 | The Completed flag on the Line. |
⬆️ Back to top
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|