Synchronize Invoice
post
https://server:port/rest/apis/asset/purchasing/invoiceSynchronization/
This REST service synchronizes Enterprise Resource Planning (ERP) Invoice and Payments with Work and Asset Management, by creating Work and Asset Management Invoice inbound integration objects.
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:
36
Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230447674
-
externalSystem: string
Maximum Length:
30
The 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
-
invoice: object
invoice
Nested Schema : header
Type:
Show Source
object
-
currency: string
Maximum Length:
3
Currency CodeExample:USD
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
exchangeRate: number
Minimum Value:
0
Maximum Value:1.0E11
Exchange Rate -
invoiceDueDate: string
(date)
Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)Example:
2021-10-15
-
invoiceEnteredDate: string
(date)
Invoice entered dateExample:
2021-09-15
-
invoiceHeaderExternalId: string
Maximum Length:
60
Identifier Value -
invoiceNumber: string
Maximum Length:
30
This is the vendor's invoice number and it is unique for each vendor location.Example:170000004-0001
-
invoiceReceivedDate: string
(date)
Invoice received dateExample:
2021-09-15
-
numberOfDays: number
Minimum Value:
0
Maximum Value:99
Payment due in number of days.Example:30
-
paymentAmount: number
Amount paidExample:
800
-
paymentDate: string
(date)
The date on which payment is doneExample:
2021-10-15
-
paymentNumber: string
Maximum Length:
20
Payment number -
paymentTerms: string
Maximum Length:
30
Invoice Payment TermsExample:CM-Pay30Days
-
paymentType: string
Allowed Values:
[ "W1AP", "W1DR", "W1EL", "W1MN" ]
Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - ManualExample:W1DR
-
payToVendorLocationExternalId: string
Maximum Length:
60
External ID -
vendorDate: string
(date)
The date on which invoice is generated by vendor.Example:
2021-09-15
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
invoiceLineExternalId: string
Maximum Length:
60
Identifier Value -
itemType: string
Allowed Values:
[ "W1CP", "W1CR", "W1DS", "W1FR", "W1NR", "W1TX", "W1XR" ]
Invoice Item Type: * `W1CP` - Credit for Price Adjustment, * `W1CR` - Credit for Quantity Adjustment, * `W1DS` - Discount, * `W1FR` - Freight, * `W1NR` - Normal, * `W1TX` - Tax, * `W1XR` - Extra Cost -
lineAmount: number
Invoice line amountExample:
800
-
purchaseOrderLineExternalId: string
Maximum Length:
60
Identifier Value -
purchaseOrderLineNumber: number
Minimum Value:
0
Maximum Value:999
Item Number -
purchaseOrderNumber: string
Maximum Length:
14
Enterprise Resource Planning system generated Purchase Order number.Example:US164237
-
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Invoice quantityExample:20
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Invoice Unit PriceExample:40
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230447674
-
externalSystem: string
Maximum Length:
30
The 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
-
invoice: object
invoice
Nested Schema : header
Type:
Show Source
object
-
currency: string
Maximum Length:
3
Currency CodeExample:USD
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
exchangeRate: number
Minimum Value:
0
Maximum Value:1.0E11
Exchange Rate -
invoiceDueDate: string
(date)
Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)Example:
2021-10-15
-
invoiceEnteredDate: string
(date)
Invoice entered dateExample:
2021-09-15
-
invoiceHeaderExternalId: string
Maximum Length:
60
Identifier Value -
invoiceNumber: string
Maximum Length:
30
This is the vendor's invoice number and it is unique for each vendor location.Example:170000004-0001
-
invoiceReceivedDate: string
(date)
Invoice received dateExample:
2021-09-15
-
numberOfDays: number
Minimum Value:
0
Maximum Value:99
Payment due in number of days.Example:30
-
paymentAmount: number
Amount paidExample:
800
-
paymentDate: string
(date)
The date on which payment is doneExample:
2021-10-15
-
paymentNumber: string
Maximum Length:
20
Payment number -
paymentTerms: string
Maximum Length:
30
Invoice Payment TermsExample:CM-Pay30Days
-
paymentType: string
Allowed Values:
[ "W1AP", "W1DR", "W1EL", "W1MN" ]
Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - ManualExample:W1DR
-
payToVendorLocationExternalId: string
Maximum Length:
60
External ID -
vendorDate: string
(date)
The date on which invoice is generated by vendor.Example:
2021-09-15
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
invoiceLineExternalId: string
Maximum Length:
60
Identifier Value -
itemType: string
Allowed Values:
[ "W1CP", "W1CR", "W1DS", "W1FR", "W1NR", "W1TX", "W1XR" ]
Invoice Item Type: * `W1CP` - Credit for Price Adjustment, * `W1CR` - Credit for Quantity Adjustment, * `W1DS` - Discount, * `W1FR` - Freight, * `W1NR` - Normal, * `W1TX` - Tax, * `W1XR` - Extra Cost -
lineAmount: number
Invoice line amountExample:
800
-
purchaseOrderLineExternalId: string
Maximum Length:
60
Identifier Value -
purchaseOrderLineNumber: number
Minimum Value:
0
Maximum Value:999
Item Number -
purchaseOrderNumber: string
Maximum Length:
14
Enterprise Resource Planning system generated Purchase Order number.Example:US164237
-
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Invoice quantityExample:20
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Invoice Unit PriceExample:40
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230447674
-
externalSystem: string
Maximum Length:
30
The 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
-
invoice: object
invoice
Nested Schema : header
Type:
Show Source
object
-
currency: string
Maximum Length:
3
Currency CodeExample:United States Dollars
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
exchangeRate: number
Minimum Value:
0
Maximum Value:1.0E11
Exchange Rate -
invoiceDueDate: string
(date)
Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)Example:
2021-10-15
-
invoiceEnteredDate: string
(date)
Invoice entered dateExample:
2021-09-15
-
invoiceHeaderExternalId: string
Maximum Length:
60
Identifier Value -
invoiceNumber: string
Maximum Length:
30
This is the vendor's invoice number and it is unique for each vendor location.Example:170000004-0001
-
invoiceReceivedDate: string
(date)
Invoice received dateExample:
2021-09-15
-
numberOfDays: number
Minimum Value:
0
Maximum Value:99
Payment due in number of days.Example:30
-
paymentAmount: number
Amount paidExample:
800
-
paymentDate: string
(date)
The date on which payment is doneExample:
2021-10-15
-
paymentNumber: string
Maximum Length:
20
Payment number -
paymentTerms: string
Maximum Length:
30
Invoice Payment TermsExample:CM-Pay30Days
-
paymentType: string
Allowed Values:
[ "W1AP", "W1DR", "W1EL", "W1MN" ]
Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - ManualExample:W1DR
-
payToVendorLocationExternalId: string
Maximum Length:
60
External ID -
vendorDate: string
(date)
The date on which invoice is generated by vendor.Example:
2021-09-15
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the invoice.Example:Gearbox Order for Wind Tower
-
invoiceLineExternalId: string
Maximum Length:
60
Identifier Value -
itemType: string
Allowed Values:
[ "W1CP", "W1CR", "W1DS", "W1FR", "W1NR", "W1TX", "W1XR" ]
Invoice Item Type: * `W1CP` - Credit for Price Adjustment, * `W1CR` - Credit for Quantity Adjustment, * `W1DS` - Discount, * `W1FR` - Freight, * `W1NR` - Normal, * `W1TX` - Tax, * `W1XR` - Extra Cost -
lineAmount: number
Invoice line amountExample:
800
-
purchaseOrderLineExternalId: string
Maximum Length:
60
Identifier Value -
purchaseOrderLineNumber: number
Minimum Value:
0
Maximum Value:999
Item Number -
purchaseOrderNumber: string
Maximum Length:
14
Enterprise Resource Planning system generated Purchase Order number.Example:US164237
-
quantity: number
Minimum Value:
0
Maximum Value:9.999999999999E7
Invoice quantityExample:20
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Invoice Unit PriceExample:40
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully 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:
60
URL 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:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully 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:
60
URL 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:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.