Synchronize Purchase Order
post
https://server:port/rest/apis/asset/purchasing/purchaseOrderSynchronization/
This REST service synchronizes an Enterprise Resource Planning (ERP) Purchase Order with the Work and Asset Management Purchase Order inbound integration object.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object-
externalReferenceId: string
Maximum Length:
36Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230453798 -
externalSystem: string
Maximum Length:
30The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP -
purchaseOrder: object
purchaseOrder
Nested Schema : header
Type:
Show Source
object-
buyerEmployeeExternalId: string
Maximum Length:
60Identifier Value -
creationDateTime: string
(date-time)
The creation date & time of the purchase order. If left blank, it's defaulted to system date & time when it's created in Work and Asset Management.Example:
2021-01-20T21:23:45.0Z -
currency: string
Maximum Length:
3Currency CodeExample:United States Dollars -
deliverToLocation: string
Maximum Length:
12Storeroom location where the goods are delivered.Example:452478085232 -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
exchangeRate: number
Minimum Value:
0Maximum Value:1.0E11The rate to convert the currency code values to the default currency.Example:1.5 -
freeOnBoard: string
Maximum Length:
30Determines the costs involved in the delivery of goods. -
issueDate: string
(date)
The approval date or the issue date for the purchase order. Integration passes the current date.Example:
2021-09-15 -
location: object
location
-
paymentTerms: string
Maximum Length:
30Payment terms between payee and vendor.Example:CM-Pay30Days -
purchaseDocumentType: string
Allowed Values:
[ "W1GP", "W1SR" ]Indicates where the purchase order is being generated from. * `W1GP` - General Purchase, * `W1SR` - Store ReplenishmentExample:W1GP -
purchaseOrderHeaderExternalId: string
Maximum Length:
60Identifier Value -
purchaseOrderNumber: string
Maximum Length:
14Enterprise Resource Planning system-generated Purchase Order number.Example:US164235 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
revisionNumber: number
Minimum Value:
-999Maximum Value:999Identification number for revisions to a purchase order.Example:0 -
shipToLocation: string
Maximum Length:
12Storeroom location where the goods are shipped.Example:452478085231 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
vendorLocationExternalId: string
Maximum Length:
60External ID
Nested Schema : location
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order.Example:300 New Jersey Avenue -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order.Example:Suite 1000 -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO addressExample:Washington -
country: string
Maximum Length:
3The Country Code for the PO address -
county: string
Maximum Length:
90The County for the PO addressExample:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address -
houseType: string
The House Type for the PO address
-
inCityLimit: boolean
Indicates whether or not this address is within the taxing boundary of the jurisdiction that's provided in the address.
-
number1: string
Maximum Length:
6Address number 1 for the PO address -
number2: string
Maximum Length:
4Address number 2 for the PO address -
postal: string
Maximum Length:
12The Postal Code for the PO addressExample:20001 -
state: string
Maximum Length:
6The Postal Code for the PO addressExample:District of Columbia -
suburb: string
Maximum Length:
64The Suburb for the PO address
Nested Schema : items
Type:
Show Source
object-
blanketContractLineExternalId: string
Maximum Length:
60External ID -
blanketContractLineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
blanketContractNumber: string
Maximum Length:
14Blanket Contract Number -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
itemType: string
Allowed Values:
[ "W1MC", "W1MT", "W1SV" ]Item type * `W1MC` - Miscellaneous, * `W1MT` - Materials, * `W1SV` - ServicesExample:W1MT -
lineAmount: number
Purchase Order line amountExample:
800 -
lineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
promiseDate: string
(date)
Purchase Order Promise DateExample:
2021-09-28 -
purchaseOrderLineExternalId: string
Maximum Length:
60Identifier Value -
purchaseRequisitionLineId: string
Maximum Length:
14Work and Asset Management Purchase Requisition Line ID sent out during the Purchase Requisition Sync.Example:97680207221035 -
purchaseToIssueRatio: number
Minimum Value:
0Maximum Value:99999999Purchase to Issue Ratio -
quantity: number
Minimum Value:
0Maximum Value:9.999999999999E7Purchase Order quantityExample:20 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
unitOfPurchase: string
Maximum Length:
30Purchase Order unit Of PurchaseExample:WD-EACH -
unitPrice: number
Minimum Value:
-1.0E11Maximum Value:1.0E11Purchase Order Unit PriceExample:40 -
vendorPartNumber: string
Maximum Length:
60Purchase Order vendorPartNumberExample:ASMON1
Nested Schema : input
Type:
Show Source
object-
externalReferenceId: string
Maximum Length:
36Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230453798 -
externalSystem: string
Maximum Length:
30The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP -
purchaseOrder: object
purchaseOrder
Nested Schema : header
Type:
Show Source
object-
buyerEmployeeExternalId: string
Maximum Length:
60Identifier Value -
creationDateTime: string
(date-time)
The creation date & time of the purchase order. If left blank, it's defaulted to system date & time when it's created in Work and Asset Management.Example:
2021-01-20T21:23:45.0Z -
currency: string
Maximum Length:
3Currency CodeExample:United States Dollars -
deliverToLocation: string
Maximum Length:
12Storeroom location where the goods are delivered.Example:452478085232 -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
exchangeRate: number
Minimum Value:
0Maximum Value:1.0E11The rate to convert the currency code values to the default currency.Example:1.5 -
freeOnBoard: string
Maximum Length:
30Determines the costs involved in the delivery of goods. -
issueDate: string
(date)
The approval date or the issue date for the purchase order. Integration passes the current date.Example:
2021-09-15 -
location: object
location
-
paymentTerms: string
Maximum Length:
30Payment terms between payee and vendor.Example:CM-Pay30Days -
purchaseDocumentType: string
Allowed Values:
[ "W1GP", "W1SR" ]Indicates where the purchase order is being generated from. * `W1GP` - General Purchase, * `W1SR` - Store ReplenishmentExample:W1GP -
purchaseOrderHeaderExternalId: string
Maximum Length:
60Identifier Value -
purchaseOrderNumber: string
Maximum Length:
14Enterprise Resource Planning system-generated Purchase Order number.Example:US164235 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
revisionNumber: number
Minimum Value:
-999Maximum Value:999Identification number for revisions to a purchase order.Example:0 -
shipToLocation: string
Maximum Length:
12Storeroom location where the goods are shipped.Example:452478085231 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
vendorLocationExternalId: string
Maximum Length:
60External ID
Nested Schema : location
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order.Example:300 New Jersey Avenue -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order.Example:Suite 1000 -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO addressExample:Washington -
country: string
Maximum Length:
3The Country Code for the PO address -
county: string
Maximum Length:
90The County for the PO addressExample:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address -
houseType: string
The House Type for the PO address
-
inCityLimit: boolean
Indicates whether or not this address is within the taxing boundary of the jurisdiction that's provided in the address.
-
number1: string
Maximum Length:
6Address number 1 for the PO address -
number2: string
Maximum Length:
4Address number 2 for the PO address -
postal: string
Maximum Length:
12The Postal Code for the PO addressExample:20001 -
state: string
Maximum Length:
6The Postal Code for the PO addressExample:District of Columbia -
suburb: string
Maximum Length:
64The Suburb for the PO address
Nested Schema : items
Type:
Show Source
object-
blanketContractLineExternalId: string
Maximum Length:
60External ID -
blanketContractLineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
blanketContractNumber: string
Maximum Length:
14Blanket Contract Number -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
itemType: string
Allowed Values:
[ "W1MC", "W1MT", "W1SV" ]Item type * `W1MC` - Miscellaneous, * `W1MT` - Materials, * `W1SV` - ServicesExample:W1MT -
lineAmount: number
Purchase Order line amountExample:
800 -
lineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
promiseDate: string
(date)
Purchase Order Promise DateExample:
2021-09-28 -
purchaseOrderLineExternalId: string
Maximum Length:
60Identifier Value -
purchaseRequisitionLineId: string
Maximum Length:
14Work and Asset Management Purchase Requisition Line ID sent out during the Purchase Requisition Sync.Example:97680207221035 -
purchaseToIssueRatio: number
Minimum Value:
0Maximum Value:99999999Purchase to Issue Ratio -
quantity: number
Minimum Value:
0Maximum Value:9.999999999999E7Purchase Order quantityExample:20 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
unitOfPurchase: string
Maximum Length:
30Purchase Order unit Of PurchaseExample:WD-EACH -
unitPrice: number
Minimum Value:
-1.0E11Maximum Value:1.0E11Purchase Order Unit PriceExample:40 -
vendorPartNumber: string
Maximum Length:
60Purchase Order vendorPartNumberExample:ASMON1
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object-
externalReferenceId: string
Maximum Length:
36Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230453798 -
externalSystem: string
Maximum Length:
30The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP -
purchaseOrder: object
purchaseOrder
Nested Schema : header
Type:
Show Source
object-
buyerEmployeeExternalId: string
Maximum Length:
60Identifier Value -
creationDateTime: string
(date-time)
The creation date & time of the purchase order. If left blank, it's defaulted to system date & time when it's created in Work and Asset Management.Example:
2021-01-20T21:23:45.0Z -
currency: string
Maximum Length:
3Currency CodeExample:United States Dollars -
deliverToLocation: string
Maximum Length:
12Storeroom location where the goods are delivered.Example:452478085232 -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
exchangeRate: number
Minimum Value:
0Maximum Value:1.0E11The rate to convert the currency code values to the default currency.Example:1.5 -
freeOnBoard: string
Maximum Length:
30Determines the costs involved in the delivery of goods. -
issueDate: string
(date)
The approval date or the issue date for the purchase order. Integration passes the current date.Example:
2021-09-15 -
location: object
location
-
paymentTerms: string
Maximum Length:
30Payment terms between payee and vendor.Example:CM-Pay30Days -
purchaseDocumentType: string
Allowed Values:
[ "W1GP", "W1SR" ]Indicates where the purchase order is being generated from. * `W1GP` - General Purchase, * `W1SR` - Store ReplenishmentExample:W1GP -
purchaseOrderHeaderExternalId: string
Maximum Length:
60Identifier Value -
purchaseOrderNumber: string
Maximum Length:
14Enterprise Resource Planning system-generated Purchase Order number.Example:US164235 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
revisionNumber: number
Minimum Value:
-999Maximum Value:999Identification number for revisions to a purchase order.Example:0 -
shipToLocation: string
Maximum Length:
12Storeroom location where the goods are shipped.Example:452478085231 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
vendorLocationExternalId: string
Maximum Length:
60External ID
Nested Schema : location
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order.Example:300 New Jersey Avenue -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order.Example:Suite 1000 -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO addressExample:Washington -
country: string
Maximum Length:
3The Country Code for the PO address -
county: string
Maximum Length:
90The County for the PO addressExample:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address -
houseType: string
The House Type for the PO address
-
inCityLimit: boolean
Indicates whether or not this address is within the taxing boundary of the jurisdiction that's provided in the address.
-
number1: string
Maximum Length:
6Address number 1 for the PO address -
number2: string
Maximum Length:
4Address number 2 for the PO address -
postal: string
Maximum Length:
12The Postal Code for the PO addressExample:20001 -
state: string
Maximum Length:
6The Postal Code for the PO addressExample:District of Columbia -
suburb: string
Maximum Length:
64The Suburb for the PO address
Nested Schema : items
Type:
Show Source
object-
blanketContractLineExternalId: string
Maximum Length:
60External ID -
blanketContractLineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
blanketContractNumber: string
Maximum Length:
14Blanket Contract Number -
description: string
Maximum Length:
100Descriptive information about the revision.Example:Meter For Central Storeroom -
itemType: string
Allowed Values:
[ "W1MC", "W1MT", "W1SV" ]Item type * `W1MC` - Miscellaneous, * `W1MT` - Materials, * `W1SV` - ServicesExample:W1MT -
lineAmount: number
Purchase Order line amountExample:
800 -
lineNumber: number
Minimum Value:
0Maximum Value:999The number referencing each Purchase Order Line. These should be unique between lines.Example:1 -
promiseDate: string
(date)
Purchase Order Promise DateExample:
2021-09-28 -
purchaseOrderLineExternalId: string
Maximum Length:
60Identifier Value -
purchaseRequisitionLineId: string
Maximum Length:
14Work and Asset Management Purchase Requisition Line ID sent out during the Purchase Requisition Sync.Example:97680207221035 -
purchaseToIssueRatio: number
Minimum Value:
0Maximum Value:99999999Purchase to Issue Ratio -
quantity: number
Minimum Value:
0Maximum Value:9.999999999999E7Purchase Order quantityExample:20 -
requiredDate: string
(date)
The date a purchase order is required by the requestor.Example:
2021-09-30 -
status: string
Maximum Length:
12Status of the purchase order based on business object lifecycle.Example:ISSUED -
unitOfPurchase: string
Maximum Length:
30Purchase Order unit Of PurchaseExample:WD-EACH -
unitPrice: number
Minimum Value:
-1.0E11Maximum Value:1.0E11Purchase Order Unit PriceExample:40 -
vendorPartNumber: string
Maximum Length:
60Purchase Order vendorPartNumberExample:ASMON1
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.