Jump to

• Request
• Response

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

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"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"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":"36",
                    "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
                    "example":"300000230447674"
                },
                "invoice":{
                    "type":"object",
                    "properties":{
                        "header":{
                            "type":"object",
                            "properties":{
                                "invoiceHeaderExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"Identifier Value"
                                },
                                "invoiceNumber":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                                    "example":"170000004-0001"
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":"100",
                                    "description":"Brief description up to 100 characters for the invoice.",
                                    "example":"Gearbox Order for Wind Tower"
                                },
                                "vendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "payToVendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "paymentTerms":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"Invoice Payment Terms",
                                    "example":"CM-Pay30Days"
                                },
                                "numberOfDays":{
                                    "type":"number",
                                    "maximum":"99",
                                    "minimum":"0",
                                    "description":"Payment due in number of days.",
                                    "example":"30"
                                },
                                "vendorDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which invoice is generated by vendor.",
                                    "example":"2021-09-15"
                                },
                                "invoiceDueDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                                    "example":"2021-10-15"
                                },
                                "invoiceReceivedDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice received date",
                                    "example":"2021-09-15"
                                },
                                "invoiceEnteredDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice entered date",
                                    "example":"2021-09-15"
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":"3",
                                    "description":"Currency Code",
                                    "example":"USD"
                                },
                                "exchangeRate":{
                                    "type":"number",
                                    "maximum":"100000000000",
                                    "minimum":"0",
                                    "description":"Exchange Rate"
                                },
                                "paymentDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which payment is done",
                                    "example":"2021-10-15"
                                },
                                "paymentNumber":{
                                    "type":"string",
                                    "maxLength":"20",
                                    "description":"Payment number"
                                },
                                "paymentType":{
                                    "type":"string",
                                    "enum":[
                                        "W1AP",
                                        "W1DR",
                                        "W1EL",
                                        "W1MN"
                                    ],
                                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                                    "example":"W1DR"
                                },
                                "paymentAmount":{
                                    "type":"number",
                                    "description":"Amount paid",
                                    "example":"800"
                                }
                            }
                        },
                        "lines":{
                            "type":"object",
                            "properties":{
                                "_data":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "invoiceLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderNumber":{
                                                "type":"string",
                                                "maxLength":"14",
                                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                                "example":"US164237"
                                            },
                                            "purchaseOrderLineNumber":{
                                                "type":"number",
                                                "maximum":"999",
                                                "minimum":"0",
                                                "description":"Item Number"
                                            },
                                            "description":{
                                                "type":"string",
                                                "maxLength":"100",
                                                "description":"Brief description up to 100 characters for the invoice.",
                                                "example":"Gearbox Order for Wind Tower"
                                            },
                                            "itemType":{
                                                "type":"string",
                                                "enum":[
                                                    "W1CP",
                                                    "W1CR",
                                                    "W1DS",
                                                    "W1FR",
                                                    "W1NR",
                                                    "W1TX",
                                                    "W1XR"
                                                ],
                                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                            },
                                            "quantity":{
                                                "type":"number",
                                                "maximum":"99999999.99999",
                                                "minimum":"0",
                                                "description":"Invoice quantity",
                                                "example":"20"
                                            },
                                            "unitPrice":{
                                                "type":"number",
                                                "maximum":"100000000000",
                                                "minimum":"-100000000000",
                                                "description":"Invoice Unit Price",
                                                "example":"40"
                                            },
                                            "lineAmount":{
                                                "type":"number",
                                                "description":"Invoice line amount",
                                                "example":"800"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":"30",
            "description":"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"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":"36",
            "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
            "example":"300000230447674"
        },
        "invoice":{
            "type":"object",
            "properties":{
                "header":{
                    "type":"object",
                    "properties":{
                        "invoiceHeaderExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Identifier Value"
                        },
                        "invoiceNumber":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                            "example":"170000004-0001"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":"100",
                            "description":"Brief description up to 100 characters for the invoice.",
                            "example":"Gearbox Order for Wind Tower"
                        },
                        "vendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "payToVendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "paymentTerms":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Invoice Payment Terms",
                            "example":"CM-Pay30Days"
                        },
                        "numberOfDays":{
                            "type":"number",
                            "maximum":"99",
                            "minimum":"0",
                            "description":"Payment due in number of days.",
                            "example":"30"
                        },
                        "vendorDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which invoice is generated by vendor.",
                            "example":"2021-09-15"
                        },
                        "invoiceDueDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                            "example":"2021-10-15"
                        },
                        "invoiceReceivedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice received date",
                            "example":"2021-09-15"
                        },
                        "invoiceEnteredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice entered date",
                            "example":"2021-09-15"
                        },
                        "currency":{
                            "type":"string",
                            "maxLength":"3",
                            "description":"Currency Code",
                            "example":"USD"
                        },
                        "exchangeRate":{
                            "type":"number",
                            "maximum":"100000000000",
                            "minimum":"0",
                            "description":"Exchange Rate"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which payment is done",
                            "example":"2021-10-15"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":"20",
                            "description":"Payment number"
                        },
                        "paymentType":{
                            "type":"string",
                            "enum":[
                                "W1AP",
                                "W1DR",
                                "W1EL",
                                "W1MN"
                            ],
                            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                            "example":"W1DR"
                        },
                        "paymentAmount":{
                            "type":"number",
                            "description":"Amount paid",
                            "example":"800"
                        }
                    }
                },
                "lines":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "invoiceLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderNumber":{
                                        "type":"string",
                                        "maxLength":"14",
                                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                        "example":"US164237"
                                    },
                                    "purchaseOrderLineNumber":{
                                        "type":"number",
                                        "maximum":"999",
                                        "minimum":"0",
                                        "description":"Item Number"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":"100",
                                        "description":"Brief description up to 100 characters for the invoice.",
                                        "example":"Gearbox Order for Wind Tower"
                                    },
                                    "itemType":{
                                        "type":"string",
                                        "enum":[
                                            "W1CP",
                                            "W1CR",
                                            "W1DS",
                                            "W1FR",
                                            "W1NR",
                                            "W1TX",
                                            "W1XR"
                                        ],
                                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                    },
                                    "quantity":{
                                        "type":"number",
                                        "maximum":"99999999.99999",
                                        "minimum":"0",
                                        "description":"Invoice quantity",
                                        "example":"20"
                                    },
                                    "unitPrice":{
                                        "type":"number",
                                        "maximum":"100000000000",
                                        "minimum":"-100000000000",
                                        "description":"Invoice Unit Price",
                                        "example":"40"
                                    },
                                    "lineAmount":{
                                        "type":"number",
                                        "description":"Invoice line amount",
                                        "example":"800"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : invoice

Type: object

Show Source

• header: object header
• lines: object lines

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object",
            "properties":{
                "invoiceHeaderExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Identifier Value"
                },
                "invoiceNumber":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                    "example":"170000004-0001"
                },
                "description":{
                    "type":"string",
                    "maxLength":"100",
                    "description":"Brief description up to 100 characters for the invoice.",
                    "example":"Gearbox Order for Wind Tower"
                },
                "vendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "payToVendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "paymentTerms":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Invoice Payment Terms",
                    "example":"CM-Pay30Days"
                },
                "numberOfDays":{
                    "type":"number",
                    "maximum":"99",
                    "minimum":"0",
                    "description":"Payment due in number of days.",
                    "example":"30"
                },
                "vendorDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which invoice is generated by vendor.",
                    "example":"2021-09-15"
                },
                "invoiceDueDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                    "example":"2021-10-15"
                },
                "invoiceReceivedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice received date",
                    "example":"2021-09-15"
                },
                "invoiceEnteredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice entered date",
                    "example":"2021-09-15"
                },
                "currency":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Currency Code",
                    "example":"USD"
                },
                "exchangeRate":{
                    "type":"number",
                    "maximum":"100000000000",
                    "minimum":"0",
                    "description":"Exchange Rate"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which payment is done",
                    "example":"2021-10-15"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":"20",
                    "description":"Payment number"
                },
                "paymentType":{
                    "type":"string",
                    "enum":[
                        "W1AP",
                        "W1DR",
                        "W1EL",
                        "W1MN"
                    ],
                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                    "example":"W1DR"
                },
                "paymentAmount":{
                    "type":"number",
                    "description":"Amount paid",
                    "example":"800"
                }
            }
        },
        "lines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "invoiceLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderNumber":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                "example":"US164237"
                            },
                            "purchaseOrderLineNumber":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"0",
                                "description":"Item Number"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":"100",
                                "description":"Brief description up to 100 characters for the invoice.",
                                "example":"Gearbox Order for Wind Tower"
                            },
                            "itemType":{
                                "type":"string",
                                "enum":[
                                    "W1CP",
                                    "W1CR",
                                    "W1DS",
                                    "W1FR",
                                    "W1NR",
                                    "W1TX",
                                    "W1XR"
                                ],
                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                            },
                            "quantity":{
                                "type":"number",
                                "maximum":"99999999.99999",
                                "minimum":"0",
                                "description":"Invoice quantity",
                                "example":"20"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":"100000000000",
                                "minimum":"-100000000000",
                                "description":"Invoice Unit Price",
                                "example":"40"
                            },
                            "lineAmount":{
                                "type":"number",
                                "description":"Invoice line amount",
                                "example":"800"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : header

Type: object

Show Source

• currency: string
  Maximum Length: 3

  Currency Code

  Example: 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: 100000000000

  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 date

  Example: 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 date

  Example: 2021-09-15
• numberOfDays: number
  Minimum Value: 0

  Maximum Value: 99

  Payment due in number of days.

  Example: 30
• paymentAmount: number
  Amount paid

  Example: 800
• paymentDate: string (date)
  The date on which payment is done

  Example: 2021-10-15
• paymentNumber: string
  Maximum Length: 20

  Payment number
• paymentTerms: string
  Maximum Length: 30

  Invoice Payment Terms

  Example: CM-Pay30Days
• paymentType: string
  Allowed Values: [ "W1AP", "W1DR", "W1EL", "W1MN" ]

  Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - Manual

  Example: 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

{
    "type":"object",
    "properties":{
        "invoiceHeaderExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "invoiceNumber":{
            "type":"string",
            "maxLength":"30",
            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
            "example":"170000004-0001"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "vendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "payToVendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "paymentTerms":{
            "type":"string",
            "maxLength":"30",
            "description":"Invoice Payment Terms",
            "example":"CM-Pay30Days"
        },
        "numberOfDays":{
            "type":"number",
            "maximum":"99",
            "minimum":"0",
            "description":"Payment due in number of days.",
            "example":"30"
        },
        "vendorDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which invoice is generated by vendor.",
            "example":"2021-09-15"
        },
        "invoiceDueDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
            "example":"2021-10-15"
        },
        "invoiceReceivedDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice received date",
            "example":"2021-09-15"
        },
        "invoiceEnteredDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice entered date",
            "example":"2021-09-15"
        },
        "currency":{
            "type":"string",
            "maxLength":"3",
            "description":"Currency Code",
            "example":"USD"
        },
        "exchangeRate":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"0",
            "description":"Exchange Rate"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which payment is done",
            "example":"2021-10-15"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":"20",
            "description":"Payment number"
        },
        "paymentType":{
            "type":"string",
            "enum":[
                "W1AP",
                "W1DR",
                "W1EL",
                "W1MN"
            ],
            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
            "example":"W1DR"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Amount paid",
            "example":"800"
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "invoiceLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderNumber":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                        "example":"US164237"
                    },
                    "purchaseOrderLineNumber":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"0",
                        "description":"Item Number"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":"100",
                        "description":"Brief description up to 100 characters for the invoice.",
                        "example":"Gearbox Order for Wind Tower"
                    },
                    "itemType":{
                        "type":"string",
                        "enum":[
                            "W1CP",
                            "W1CR",
                            "W1DS",
                            "W1FR",
                            "W1NR",
                            "W1TX",
                            "W1XR"
                        ],
                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                    },
                    "quantity":{
                        "type":"number",
                        "maximum":"99999999.99999",
                        "minimum":"0",
                        "description":"Invoice quantity",
                        "example":"20"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":"100000000000",
                        "minimum":"-100000000000",
                        "description":"Invoice Unit Price",
                        "example":"40"
                    },
                    "lineAmount":{
                        "type":"number",
                        "description":"Invoice line amount",
                        "example":"800"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "invoiceLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderNumber":{
                "type":"string",
                "maxLength":"14",
                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                "example":"US164237"
            },
            "purchaseOrderLineNumber":{
                "type":"number",
                "maximum":"999",
                "minimum":"0",
                "description":"Item Number"
            },
            "description":{
                "type":"string",
                "maxLength":"100",
                "description":"Brief description up to 100 characters for the invoice.",
                "example":"Gearbox Order for Wind Tower"
            },
            "itemType":{
                "type":"string",
                "enum":[
                    "W1CP",
                    "W1CR",
                    "W1DS",
                    "W1FR",
                    "W1NR",
                    "W1TX",
                    "W1XR"
                ],
                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
            },
            "quantity":{
                "type":"number",
                "maximum":"99999999.99999",
                "minimum":"0",
                "description":"Invoice quantity",
                "example":"20"
            },
            "unitPrice":{
                "type":"number",
                "maximum":"100000000000",
                "minimum":"-100000000000",
                "description":"Invoice Unit Price",
                "example":"40"
            },
            "lineAmount":{
                "type":"number",
                "description":"Invoice line amount",
                "example":"800"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 amount

  Example: 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: 99999999.99999

  Invoice quantity

  Example: 20
• unitPrice: number
  Minimum Value: -100000000000

  Maximum Value: 100000000000

  Invoice Unit Price

  Example: 40

{
    "type":"object",
    "properties":{
        "invoiceLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderNumber":{
            "type":"string",
            "maxLength":"14",
            "description":"Enterprise Resource Planning system generated Purchase Order number.",
            "example":"US164237"
        },
        "purchaseOrderLineNumber":{
            "type":"number",
            "maximum":"999",
            "minimum":"0",
            "description":"Item Number"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "itemType":{
            "type":"string",
            "enum":[
                "W1CP",
                "W1CR",
                "W1DS",
                "W1FR",
                "W1NR",
                "W1TX",
                "W1XR"
            ],
            "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
        },
        "quantity":{
            "type":"number",
            "maximum":"99999999.99999",
            "minimum":"0",
            "description":"Invoice quantity",
            "example":"20"
        },
        "unitPrice":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"-100000000000",
            "description":"Invoice Unit Price",
            "example":"40"
        },
        "lineAmount":{
            "type":"number",
            "description":"Invoice line amount",
            "example":"800"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• W1InvoiceSyn: object schema

{
    "type":"object",
    "properties":{
        "W1InvoiceSyn":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"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"
                        },
                        "externalReferenceId":{
                            "type":"string",
                            "maxLength":"36",
                            "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
                            "example":"300000230447674"
                        },
                        "invoice":{
                            "type":"object",
                            "properties":{
                                "header":{
                                    "type":"object",
                                    "properties":{
                                        "invoiceHeaderExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"Identifier Value"
                                        },
                                        "invoiceNumber":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                                            "example":"170000004-0001"
                                        },
                                        "description":{
                                            "type":"string",
                                            "maxLength":"100",
                                            "description":"Brief description up to 100 characters for the invoice.",
                                            "example":"Gearbox Order for Wind Tower"
                                        },
                                        "vendorLocationExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"External ID"
                                        },
                                        "payToVendorLocationExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"External ID"
                                        },
                                        "paymentTerms":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Invoice Payment Terms",
                                            "example":"CM-Pay30Days"
                                        },
                                        "numberOfDays":{
                                            "type":"number",
                                            "maximum":"99",
                                            "minimum":"0",
                                            "description":"Payment due in number of days.",
                                            "example":"30"
                                        },
                                        "vendorDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"The date on which invoice is generated by vendor.",
                                            "example":"2021-09-15"
                                        },
                                        "invoiceDueDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                                            "example":"2021-10-15"
                                        },
                                        "invoiceReceivedDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice received date",
                                            "example":"2021-09-15"
                                        },
                                        "invoiceEnteredDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice entered date",
                                            "example":"2021-09-15"
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":"3",
                                            "description":"Currency Code",
                                            "example":"USD"
                                        },
                                        "exchangeRate":{
                                            "type":"number",
                                            "maximum":"100000000000",
                                            "minimum":"0",
                                            "description":"Exchange Rate"
                                        },
                                        "paymentDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"The date on which payment is done",
                                            "example":"2021-10-15"
                                        },
                                        "paymentNumber":{
                                            "type":"string",
                                            "maxLength":"20",
                                            "description":"Payment number"
                                        },
                                        "paymentType":{
                                            "type":"string",
                                            "enum":[
                                                "W1AP",
                                                "W1DR",
                                                "W1EL",
                                                "W1MN"
                                            ],
                                            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                                            "example":"W1DR"
                                        },
                                        "paymentAmount":{
                                            "type":"number",
                                            "description":"Amount paid",
                                            "example":"800"
                                        }
                                    }
                                },
                                "lines":{
                                    "type":"object",
                                    "properties":{
                                        "_data":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "invoiceLineExternalId":{
                                                        "type":"string",
                                                        "maxLength":"60",
                                                        "description":"Identifier Value"
                                                    },
                                                    "purchaseOrderLineExternalId":{
                                                        "type":"string",
                                                        "maxLength":"60",
                                                        "description":"Identifier Value"
                                                    },
                                                    "purchaseOrderNumber":{
                                                        "type":"string",
                                                        "maxLength":"14",
                                                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                                        "example":"US164237"
                                                    },
                                                    "purchaseOrderLineNumber":{
                                                        "type":"number",
                                                        "maximum":"999",
                                                        "minimum":"0",
                                                        "description":"Item Number"
                                                    },
                                                    "description":{
                                                        "type":"string",
                                                        "maxLength":"100",
                                                        "description":"Brief description up to 100 characters for the invoice.",
                                                        "example":"Gearbox Order for Wind Tower"
                                                    },
                                                    "itemType":{
                                                        "type":"string",
                                                        "enum":[
                                                            "W1CP",
                                                            "W1CR",
                                                            "W1DS",
                                                            "W1FR",
                                                            "W1NR",
                                                            "W1TX",
                                                            "W1XR"
                                                        ],
                                                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                                    },
                                                    "quantity":{
                                                        "type":"number",
                                                        "maximum":"99999999.99999",
                                                        "minimum":"0",
                                                        "description":"Invoice quantity",
                                                        "example":"20"
                                                    },
                                                    "unitPrice":{
                                                        "type":"number",
                                                        "maximum":"100000000000",
                                                        "minimum":"-100000000000",
                                                        "description":"Invoice Unit Price",
                                                        "example":"40"
                                                    },
                                                    "lineAmount":{
                                                        "type":"number",
                                                        "description":"Invoice line amount",
                                                        "example":"800"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "syncRequestId":{
                            "type":"string",
                            "description":"(syncRequestId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"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"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":"36",
                    "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
                    "example":"300000230447674"
                },
                "invoice":{
                    "type":"object",
                    "properties":{
                        "header":{
                            "type":"object",
                            "properties":{
                                "invoiceHeaderExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"Identifier Value"
                                },
                                "invoiceNumber":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                                    "example":"170000004-0001"
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":"100",
                                    "description":"Brief description up to 100 characters for the invoice.",
                                    "example":"Gearbox Order for Wind Tower"
                                },
                                "vendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "payToVendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "paymentTerms":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"Invoice Payment Terms",
                                    "example":"CM-Pay30Days"
                                },
                                "numberOfDays":{
                                    "type":"number",
                                    "maximum":"99",
                                    "minimum":"0",
                                    "description":"Payment due in number of days.",
                                    "example":"30"
                                },
                                "vendorDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which invoice is generated by vendor.",
                                    "example":"2021-09-15"
                                },
                                "invoiceDueDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                                    "example":"2021-10-15"
                                },
                                "invoiceReceivedDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice received date",
                                    "example":"2021-09-15"
                                },
                                "invoiceEnteredDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice entered date",
                                    "example":"2021-09-15"
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":"3",
                                    "description":"Currency Code",
                                    "example":"USD"
                                },
                                "exchangeRate":{
                                    "type":"number",
                                    "maximum":"100000000000",
                                    "minimum":"0",
                                    "description":"Exchange Rate"
                                },
                                "paymentDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which payment is done",
                                    "example":"2021-10-15"
                                },
                                "paymentNumber":{
                                    "type":"string",
                                    "maxLength":"20",
                                    "description":"Payment number"
                                },
                                "paymentType":{
                                    "type":"string",
                                    "enum":[
                                        "W1AP",
                                        "W1DR",
                                        "W1EL",
                                        "W1MN"
                                    ],
                                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                                    "example":"W1DR"
                                },
                                "paymentAmount":{
                                    "type":"number",
                                    "description":"Amount paid",
                                    "example":"800"
                                }
                            }
                        },
                        "lines":{
                            "type":"object",
                            "properties":{
                                "_data":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "invoiceLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderNumber":{
                                                "type":"string",
                                                "maxLength":"14",
                                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                                "example":"US164237"
                                            },
                                            "purchaseOrderLineNumber":{
                                                "type":"number",
                                                "maximum":"999",
                                                "minimum":"0",
                                                "description":"Item Number"
                                            },
                                            "description":{
                                                "type":"string",
                                                "maxLength":"100",
                                                "description":"Brief description up to 100 characters for the invoice.",
                                                "example":"Gearbox Order for Wind Tower"
                                            },
                                            "itemType":{
                                                "type":"string",
                                                "enum":[
                                                    "W1CP",
                                                    "W1CR",
                                                    "W1DS",
                                                    "W1FR",
                                                    "W1NR",
                                                    "W1TX",
                                                    "W1XR"
                                                ],
                                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                            },
                                            "quantity":{
                                                "type":"number",
                                                "maximum":"99999999.99999",
                                                "minimum":"0",
                                                "description":"Invoice quantity",
                                                "example":"20"
                                            },
                                            "unitPrice":{
                                                "type":"number",
                                                "maximum":"100000000000",
                                                "minimum":"-100000000000",
                                                "description":"Invoice Unit Price",
                                                "example":"40"
                                            },
                                            "lineAmount":{
                                                "type":"number",
                                                "description":"Invoice line amount",
                                                "example":"800"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":"30",
            "description":"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"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":"36",
            "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
            "example":"300000230447674"
        },
        "invoice":{
            "type":"object",
            "properties":{
                "header":{
                    "type":"object",
                    "properties":{
                        "invoiceHeaderExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Identifier Value"
                        },
                        "invoiceNumber":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                            "example":"170000004-0001"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":"100",
                            "description":"Brief description up to 100 characters for the invoice.",
                            "example":"Gearbox Order for Wind Tower"
                        },
                        "vendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "payToVendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "paymentTerms":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Invoice Payment Terms",
                            "example":"CM-Pay30Days"
                        },
                        "numberOfDays":{
                            "type":"number",
                            "maximum":"99",
                            "minimum":"0",
                            "description":"Payment due in number of days.",
                            "example":"30"
                        },
                        "vendorDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which invoice is generated by vendor.",
                            "example":"2021-09-15"
                        },
                        "invoiceDueDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                            "example":"2021-10-15"
                        },
                        "invoiceReceivedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice received date",
                            "example":"2021-09-15"
                        },
                        "invoiceEnteredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice entered date",
                            "example":"2021-09-15"
                        },
                        "currency":{
                            "type":"string",
                            "maxLength":"3",
                            "description":"Currency Code",
                            "example":"USD"
                        },
                        "exchangeRate":{
                            "type":"number",
                            "maximum":"100000000000",
                            "minimum":"0",
                            "description":"Exchange Rate"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which payment is done",
                            "example":"2021-10-15"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":"20",
                            "description":"Payment number"
                        },
                        "paymentType":{
                            "type":"string",
                            "enum":[
                                "W1AP",
                                "W1DR",
                                "W1EL",
                                "W1MN"
                            ],
                            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                            "example":"W1DR"
                        },
                        "paymentAmount":{
                            "type":"number",
                            "description":"Amount paid",
                            "example":"800"
                        }
                    }
                },
                "lines":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "invoiceLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderNumber":{
                                        "type":"string",
                                        "maxLength":"14",
                                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                        "example":"US164237"
                                    },
                                    "purchaseOrderLineNumber":{
                                        "type":"number",
                                        "maximum":"999",
                                        "minimum":"0",
                                        "description":"Item Number"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":"100",
                                        "description":"Brief description up to 100 characters for the invoice.",
                                        "example":"Gearbox Order for Wind Tower"
                                    },
                                    "itemType":{
                                        "type":"string",
                                        "enum":[
                                            "W1CP",
                                            "W1CR",
                                            "W1DS",
                                            "W1FR",
                                            "W1NR",
                                            "W1TX",
                                            "W1XR"
                                        ],
                                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                    },
                                    "quantity":{
                                        "type":"number",
                                        "maximum":"99999999.99999",
                                        "minimum":"0",
                                        "description":"Invoice quantity",
                                        "example":"20"
                                    },
                                    "unitPrice":{
                                        "type":"number",
                                        "maximum":"100000000000",
                                        "minimum":"-100000000000",
                                        "description":"Invoice Unit Price",
                                        "example":"40"
                                    },
                                    "lineAmount":{
                                        "type":"number",
                                        "description":"Invoice line amount",
                                        "example":"800"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : invoice

Type: object

Show Source

• header: object header
• lines: object lines

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object",
            "properties":{
                "invoiceHeaderExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Identifier Value"
                },
                "invoiceNumber":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                    "example":"170000004-0001"
                },
                "description":{
                    "type":"string",
                    "maxLength":"100",
                    "description":"Brief description up to 100 characters for the invoice.",
                    "example":"Gearbox Order for Wind Tower"
                },
                "vendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "payToVendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "paymentTerms":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Invoice Payment Terms",
                    "example":"CM-Pay30Days"
                },
                "numberOfDays":{
                    "type":"number",
                    "maximum":"99",
                    "minimum":"0",
                    "description":"Payment due in number of days.",
                    "example":"30"
                },
                "vendorDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which invoice is generated by vendor.",
                    "example":"2021-09-15"
                },
                "invoiceDueDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                    "example":"2021-10-15"
                },
                "invoiceReceivedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice received date",
                    "example":"2021-09-15"
                },
                "invoiceEnteredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice entered date",
                    "example":"2021-09-15"
                },
                "currency":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Currency Code",
                    "example":"USD"
                },
                "exchangeRate":{
                    "type":"number",
                    "maximum":"100000000000",
                    "minimum":"0",
                    "description":"Exchange Rate"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which payment is done",
                    "example":"2021-10-15"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":"20",
                    "description":"Payment number"
                },
                "paymentType":{
                    "type":"string",
                    "enum":[
                        "W1AP",
                        "W1DR",
                        "W1EL",
                        "W1MN"
                    ],
                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                    "example":"W1DR"
                },
                "paymentAmount":{
                    "type":"number",
                    "description":"Amount paid",
                    "example":"800"
                }
            }
        },
        "lines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "invoiceLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderNumber":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                "example":"US164237"
                            },
                            "purchaseOrderLineNumber":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"0",
                                "description":"Item Number"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":"100",
                                "description":"Brief description up to 100 characters for the invoice.",
                                "example":"Gearbox Order for Wind Tower"
                            },
                            "itemType":{
                                "type":"string",
                                "enum":[
                                    "W1CP",
                                    "W1CR",
                                    "W1DS",
                                    "W1FR",
                                    "W1NR",
                                    "W1TX",
                                    "W1XR"
                                ],
                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                            },
                            "quantity":{
                                "type":"number",
                                "maximum":"99999999.99999",
                                "minimum":"0",
                                "description":"Invoice quantity",
                                "example":"20"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":"100000000000",
                                "minimum":"-100000000000",
                                "description":"Invoice Unit Price",
                                "example":"40"
                            },
                            "lineAmount":{
                                "type":"number",
                                "description":"Invoice line amount",
                                "example":"800"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : header

Type: object

Show Source

• currency: string
  Maximum Length: 3

  Currency Code

  Example: 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: 100000000000

  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 date

  Example: 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 date

  Example: 2021-09-15
• numberOfDays: number
  Minimum Value: 0

  Maximum Value: 99

  Payment due in number of days.

  Example: 30
• paymentAmount: number
  Amount paid

  Example: 800
• paymentDate: string (date)
  The date on which payment is done

  Example: 2021-10-15
• paymentNumber: string
  Maximum Length: 20

  Payment number
• paymentTerms: string
  Maximum Length: 30

  Invoice Payment Terms

  Example: CM-Pay30Days
• paymentType: string
  Allowed Values: [ "W1AP", "W1DR", "W1EL", "W1MN" ]

  Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - Manual

  Example: 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

{
    "type":"object",
    "properties":{
        "invoiceHeaderExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "invoiceNumber":{
            "type":"string",
            "maxLength":"30",
            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
            "example":"170000004-0001"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "vendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "payToVendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "paymentTerms":{
            "type":"string",
            "maxLength":"30",
            "description":"Invoice Payment Terms",
            "example":"CM-Pay30Days"
        },
        "numberOfDays":{
            "type":"number",
            "maximum":"99",
            "minimum":"0",
            "description":"Payment due in number of days.",
            "example":"30"
        },
        "vendorDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which invoice is generated by vendor.",
            "example":"2021-09-15"
        },
        "invoiceDueDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
            "example":"2021-10-15"
        },
        "invoiceReceivedDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice received date",
            "example":"2021-09-15"
        },
        "invoiceEnteredDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice entered date",
            "example":"2021-09-15"
        },
        "currency":{
            "type":"string",
            "maxLength":"3",
            "description":"Currency Code",
            "example":"USD"
        },
        "exchangeRate":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"0",
            "description":"Exchange Rate"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which payment is done",
            "example":"2021-10-15"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":"20",
            "description":"Payment number"
        },
        "paymentType":{
            "type":"string",
            "enum":[
                "W1AP",
                "W1DR",
                "W1EL",
                "W1MN"
            ],
            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
            "example":"W1DR"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Amount paid",
            "example":"800"
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "invoiceLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderNumber":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                        "example":"US164237"
                    },
                    "purchaseOrderLineNumber":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"0",
                        "description":"Item Number"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":"100",
                        "description":"Brief description up to 100 characters for the invoice.",
                        "example":"Gearbox Order for Wind Tower"
                    },
                    "itemType":{
                        "type":"string",
                        "enum":[
                            "W1CP",
                            "W1CR",
                            "W1DS",
                            "W1FR",
                            "W1NR",
                            "W1TX",
                            "W1XR"
                        ],
                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                    },
                    "quantity":{
                        "type":"number",
                        "maximum":"99999999.99999",
                        "minimum":"0",
                        "description":"Invoice quantity",
                        "example":"20"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":"100000000000",
                        "minimum":"-100000000000",
                        "description":"Invoice Unit Price",
                        "example":"40"
                    },
                    "lineAmount":{
                        "type":"number",
                        "description":"Invoice line amount",
                        "example":"800"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "invoiceLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderNumber":{
                "type":"string",
                "maxLength":"14",
                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                "example":"US164237"
            },
            "purchaseOrderLineNumber":{
                "type":"number",
                "maximum":"999",
                "minimum":"0",
                "description":"Item Number"
            },
            "description":{
                "type":"string",
                "maxLength":"100",
                "description":"Brief description up to 100 characters for the invoice.",
                "example":"Gearbox Order for Wind Tower"
            },
            "itemType":{
                "type":"string",
                "enum":[
                    "W1CP",
                    "W1CR",
                    "W1DS",
                    "W1FR",
                    "W1NR",
                    "W1TX",
                    "W1XR"
                ],
                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
            },
            "quantity":{
                "type":"number",
                "maximum":"99999999.99999",
                "minimum":"0",
                "description":"Invoice quantity",
                "example":"20"
            },
            "unitPrice":{
                "type":"number",
                "maximum":"100000000000",
                "minimum":"-100000000000",
                "description":"Invoice Unit Price",
                "example":"40"
            },
            "lineAmount":{
                "type":"number",
                "description":"Invoice line amount",
                "example":"800"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 amount

  Example: 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: 99999999.99999

  Invoice quantity

  Example: 20
• unitPrice: number
  Minimum Value: -100000000000

  Maximum Value: 100000000000

  Invoice Unit Price

  Example: 40

{
    "type":"object",
    "properties":{
        "invoiceLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderNumber":{
            "type":"string",
            "maxLength":"14",
            "description":"Enterprise Resource Planning system generated Purchase Order number.",
            "example":"US164237"
        },
        "purchaseOrderLineNumber":{
            "type":"number",
            "maximum":"999",
            "minimum":"0",
            "description":"Item Number"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "itemType":{
            "type":"string",
            "enum":[
                "W1CP",
                "W1CR",
                "W1DS",
                "W1FR",
                "W1NR",
                "W1TX",
                "W1XR"
            ],
            "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
        },
        "quantity":{
            "type":"number",
            "maximum":"99999999.99999",
            "minimum":"0",
            "description":"Invoice quantity",
            "example":"20"
        },
        "unitPrice":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"-100000000000",
            "description":"Invoice Unit Price",
            "example":"40"
        },
        "lineAmount":{
            "type":"number",
            "description":"Invoice line amount",
            "example":"800"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : SYNCINVOICE_response

Type: object

Show Source

• W1InvoiceSyn: object W1InvoiceSyn

{
    "type":"object",
    "properties":{
        "W1InvoiceSyn":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"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"
                        },
                        "externalReferenceId":{
                            "type":"string",
                            "maxLength":"36",
                            "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
                            "example":"300000230447674"
                        },
                        "invoice":{
                            "type":"object",
                            "properties":{
                                "header":{
                                    "type":"object",
                                    "properties":{
                                        "invoiceHeaderExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"Identifier Value"
                                        },
                                        "invoiceNumber":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                                            "example":"170000004-0001"
                                        },
                                        "description":{
                                            "type":"string",
                                            "maxLength":"100",
                                            "description":"Brief description up to 100 characters for the invoice.",
                                            "example":"Gearbox Order for Wind Tower"
                                        },
                                        "vendorLocationExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"External ID"
                                        },
                                        "payToVendorLocationExternalId":{
                                            "type":"string",
                                            "maxLength":"60",
                                            "description":"External ID"
                                        },
                                        "paymentTerms":{
                                            "type":"string",
                                            "maxLength":"30",
                                            "description":"Invoice Payment Terms",
                                            "example":"CM-Pay30Days"
                                        },
                                        "numberOfDays":{
                                            "type":"number",
                                            "maximum":"99",
                                            "minimum":"0",
                                            "description":"Payment due in number of days.",
                                            "example":"30"
                                        },
                                        "vendorDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"The date on which invoice is generated by vendor.",
                                            "example":"2021-09-15"
                                        },
                                        "invoiceDueDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                                            "example":"2021-10-15"
                                        },
                                        "invoiceReceivedDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice received date",
                                            "example":"2021-09-15"
                                        },
                                        "invoiceEnteredDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"Invoice entered date",
                                            "example":"2021-09-15"
                                        },
                                        "currency":{
                                            "type":"string",
                                            "maxLength":"3",
                                            "description":"Currency Code",
                                            "example":"United States Dollars"
                                        },
                                        "exchangeRate":{
                                            "type":"number",
                                            "maximum":"100000000000",
                                            "minimum":"0",
                                            "description":"Exchange Rate"
                                        },
                                        "paymentDate":{
                                            "type":"string",
                                            "format":"date",
                                            "description":"The date on which payment is done",
                                            "example":"2021-10-15"
                                        },
                                        "paymentNumber":{
                                            "type":"string",
                                            "maxLength":"20",
                                            "description":"Payment number"
                                        },
                                        "paymentType":{
                                            "type":"string",
                                            "enum":[
                                                "W1AP",
                                                "W1DR",
                                                "W1EL",
                                                "W1MN"
                                            ],
                                            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                                            "example":"W1DR"
                                        },
                                        "paymentAmount":{
                                            "type":"number",
                                            "description":"Amount paid",
                                            "example":"800"
                                        }
                                    }
                                },
                                "lines":{
                                    "type":"object",
                                    "properties":{
                                        "_data":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "invoiceLineExternalId":{
                                                        "type":"string",
                                                        "maxLength":"60",
                                                        "description":"Identifier Value"
                                                    },
                                                    "purchaseOrderLineExternalId":{
                                                        "type":"string",
                                                        "maxLength":"60",
                                                        "description":"Identifier Value"
                                                    },
                                                    "purchaseOrderNumber":{
                                                        "type":"string",
                                                        "maxLength":"14",
                                                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                                        "example":"US164237"
                                                    },
                                                    "purchaseOrderLineNumber":{
                                                        "type":"number",
                                                        "maximum":"999",
                                                        "minimum":"0",
                                                        "description":"Item Number"
                                                    },
                                                    "description":{
                                                        "type":"string",
                                                        "maxLength":"100",
                                                        "description":"Brief description up to 100 characters for the invoice.",
                                                        "example":"Gearbox Order for Wind Tower"
                                                    },
                                                    "itemType":{
                                                        "type":"string",
                                                        "enum":[
                                                            "W1CP",
                                                            "W1CR",
                                                            "W1DS",
                                                            "W1FR",
                                                            "W1NR",
                                                            "W1TX",
                                                            "W1XR"
                                                        ],
                                                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                                    },
                                                    "quantity":{
                                                        "type":"number",
                                                        "maximum":"99999999.99999",
                                                        "minimum":"0",
                                                        "description":"Invoice quantity",
                                                        "example":"20"
                                                    },
                                                    "unitPrice":{
                                                        "type":"number",
                                                        "maximum":"100000000000",
                                                        "minimum":"-100000000000",
                                                        "description":"Invoice Unit Price",
                                                        "example":"40"
                                                    },
                                                    "lineAmount":{
                                                        "type":"number",
                                                        "description":"Invoice line amount",
                                                        "example":"800"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "syncRequestId":{
                            "type":"string",
                            "description":"(syncRequestId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : W1InvoiceSyn

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"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"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":"36",
                    "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
                    "example":"300000230447674"
                },
                "invoice":{
                    "type":"object",
                    "properties":{
                        "header":{
                            "type":"object",
                            "properties":{
                                "invoiceHeaderExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"Identifier Value"
                                },
                                "invoiceNumber":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                                    "example":"170000004-0001"
                                },
                                "description":{
                                    "type":"string",
                                    "maxLength":"100",
                                    "description":"Brief description up to 100 characters for the invoice.",
                                    "example":"Gearbox Order for Wind Tower"
                                },
                                "vendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "payToVendorLocationExternalId":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"External ID"
                                },
                                "paymentTerms":{
                                    "type":"string",
                                    "maxLength":"30",
                                    "description":"Invoice Payment Terms",
                                    "example":"CM-Pay30Days"
                                },
                                "numberOfDays":{
                                    "type":"number",
                                    "maximum":"99",
                                    "minimum":"0",
                                    "description":"Payment due in number of days.",
                                    "example":"30"
                                },
                                "vendorDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which invoice is generated by vendor.",
                                    "example":"2021-09-15"
                                },
                                "invoiceDueDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                                    "example":"2021-10-15"
                                },
                                "invoiceReceivedDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice received date",
                                    "example":"2021-09-15"
                                },
                                "invoiceEnteredDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Invoice entered date",
                                    "example":"2021-09-15"
                                },
                                "currency":{
                                    "type":"string",
                                    "maxLength":"3",
                                    "description":"Currency Code",
                                    "example":"United States Dollars"
                                },
                                "exchangeRate":{
                                    "type":"number",
                                    "maximum":"100000000000",
                                    "minimum":"0",
                                    "description":"Exchange Rate"
                                },
                                "paymentDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"The date on which payment is done",
                                    "example":"2021-10-15"
                                },
                                "paymentNumber":{
                                    "type":"string",
                                    "maxLength":"20",
                                    "description":"Payment number"
                                },
                                "paymentType":{
                                    "type":"string",
                                    "enum":[
                                        "W1AP",
                                        "W1DR",
                                        "W1EL",
                                        "W1MN"
                                    ],
                                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                                    "example":"W1DR"
                                },
                                "paymentAmount":{
                                    "type":"number",
                                    "description":"Amount paid",
                                    "example":"800"
                                }
                            }
                        },
                        "lines":{
                            "type":"object",
                            "properties":{
                                "_data":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "invoiceLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderLineExternalId":{
                                                "type":"string",
                                                "maxLength":"60",
                                                "description":"Identifier Value"
                                            },
                                            "purchaseOrderNumber":{
                                                "type":"string",
                                                "maxLength":"14",
                                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                                "example":"US164237"
                                            },
                                            "purchaseOrderLineNumber":{
                                                "type":"number",
                                                "maximum":"999",
                                                "minimum":"0",
                                                "description":"Item Number"
                                            },
                                            "description":{
                                                "type":"string",
                                                "maxLength":"100",
                                                "description":"Brief description up to 100 characters for the invoice.",
                                                "example":"Gearbox Order for Wind Tower"
                                            },
                                            "itemType":{
                                                "type":"string",
                                                "enum":[
                                                    "W1CP",
                                                    "W1CR",
                                                    "W1DS",
                                                    "W1FR",
                                                    "W1NR",
                                                    "W1TX",
                                                    "W1XR"
                                                ],
                                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                            },
                                            "quantity":{
                                                "type":"number",
                                                "maximum":"99999999.99999",
                                                "minimum":"0",
                                                "description":"Invoice quantity",
                                                "example":"20"
                                            },
                                            "unitPrice":{
                                                "type":"number",
                                                "maximum":"100000000000",
                                                "minimum":"-100000000000",
                                                "description":"Invoice Unit Price",
                                                "example":"40"
                                            },
                                            "lineAmount":{
                                                "type":"number",
                                                "description":"Invoice line amount",
                                                "example":"800"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":"30",
            "description":"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"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":"36",
            "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.",
            "example":"300000230447674"
        },
        "invoice":{
            "type":"object",
            "properties":{
                "header":{
                    "type":"object",
                    "properties":{
                        "invoiceHeaderExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Identifier Value"
                        },
                        "invoiceNumber":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                            "example":"170000004-0001"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":"100",
                            "description":"Brief description up to 100 characters for the invoice.",
                            "example":"Gearbox Order for Wind Tower"
                        },
                        "vendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "payToVendorLocationExternalId":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"External ID"
                        },
                        "paymentTerms":{
                            "type":"string",
                            "maxLength":"30",
                            "description":"Invoice Payment Terms",
                            "example":"CM-Pay30Days"
                        },
                        "numberOfDays":{
                            "type":"number",
                            "maximum":"99",
                            "minimum":"0",
                            "description":"Payment due in number of days.",
                            "example":"30"
                        },
                        "vendorDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which invoice is generated by vendor.",
                            "example":"2021-09-15"
                        },
                        "invoiceDueDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                            "example":"2021-10-15"
                        },
                        "invoiceReceivedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice received date",
                            "example":"2021-09-15"
                        },
                        "invoiceEnteredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Invoice entered date",
                            "example":"2021-09-15"
                        },
                        "currency":{
                            "type":"string",
                            "maxLength":"3",
                            "description":"Currency Code",
                            "example":"United States Dollars"
                        },
                        "exchangeRate":{
                            "type":"number",
                            "maximum":"100000000000",
                            "minimum":"0",
                            "description":"Exchange Rate"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"The date on which payment is done",
                            "example":"2021-10-15"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":"20",
                            "description":"Payment number"
                        },
                        "paymentType":{
                            "type":"string",
                            "enum":[
                                "W1AP",
                                "W1DR",
                                "W1EL",
                                "W1MN"
                            ],
                            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                            "example":"W1DR"
                        },
                        "paymentAmount":{
                            "type":"number",
                            "description":"Amount paid",
                            "example":"800"
                        }
                    }
                },
                "lines":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "invoiceLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderLineExternalId":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Identifier Value"
                                    },
                                    "purchaseOrderNumber":{
                                        "type":"string",
                                        "maxLength":"14",
                                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                        "example":"US164237"
                                    },
                                    "purchaseOrderLineNumber":{
                                        "type":"number",
                                        "maximum":"999",
                                        "minimum":"0",
                                        "description":"Item Number"
                                    },
                                    "description":{
                                        "type":"string",
                                        "maxLength":"100",
                                        "description":"Brief description up to 100 characters for the invoice.",
                                        "example":"Gearbox Order for Wind Tower"
                                    },
                                    "itemType":{
                                        "type":"string",
                                        "enum":[
                                            "W1CP",
                                            "W1CR",
                                            "W1DS",
                                            "W1FR",
                                            "W1NR",
                                            "W1TX",
                                            "W1XR"
                                        ],
                                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                                    },
                                    "quantity":{
                                        "type":"number",
                                        "maximum":"99999999.99999",
                                        "minimum":"0",
                                        "description":"Invoice quantity",
                                        "example":"20"
                                    },
                                    "unitPrice":{
                                        "type":"number",
                                        "maximum":"100000000000",
                                        "minimum":"-100000000000",
                                        "description":"Invoice Unit Price",
                                        "example":"40"
                                    },
                                    "lineAmount":{
                                        "type":"number",
                                        "description":"Invoice line amount",
                                        "example":"800"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : invoice

Type: object

Show Source

• header: object header
• lines: object lines

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object",
            "properties":{
                "invoiceHeaderExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Identifier Value"
                },
                "invoiceNumber":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"This is the vendor's invoice number and it is unique for each vendor location.",
                    "example":"170000004-0001"
                },
                "description":{
                    "type":"string",
                    "maxLength":"100",
                    "description":"Brief description up to 100 characters for the invoice.",
                    "example":"Gearbox Order for Wind Tower"
                },
                "vendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "payToVendorLocationExternalId":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"External ID"
                },
                "paymentTerms":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Invoice Payment Terms",
                    "example":"CM-Pay30Days"
                },
                "numberOfDays":{
                    "type":"number",
                    "maximum":"99",
                    "minimum":"0",
                    "description":"Payment due in number of days.",
                    "example":"30"
                },
                "vendorDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which invoice is generated by vendor.",
                    "example":"2021-09-15"
                },
                "invoiceDueDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
                    "example":"2021-10-15"
                },
                "invoiceReceivedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice received date",
                    "example":"2021-09-15"
                },
                "invoiceEnteredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Invoice entered date",
                    "example":"2021-09-15"
                },
                "currency":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Currency Code",
                    "example":"United States Dollars"
                },
                "exchangeRate":{
                    "type":"number",
                    "maximum":"100000000000",
                    "minimum":"0",
                    "description":"Exchange Rate"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The date on which payment is done",
                    "example":"2021-10-15"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":"20",
                    "description":"Payment number"
                },
                "paymentType":{
                    "type":"string",
                    "enum":[
                        "W1AP",
                        "W1DR",
                        "W1EL",
                        "W1MN"
                    ],
                    "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
                    "example":"W1DR"
                },
                "paymentAmount":{
                    "type":"number",
                    "description":"Amount paid",
                    "example":"800"
                }
            }
        },
        "lines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "invoiceLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderLineExternalId":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Identifier Value"
                            },
                            "purchaseOrderNumber":{
                                "type":"string",
                                "maxLength":"14",
                                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                                "example":"US164237"
                            },
                            "purchaseOrderLineNumber":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"0",
                                "description":"Item Number"
                            },
                            "description":{
                                "type":"string",
                                "maxLength":"100",
                                "description":"Brief description up to 100 characters for the invoice.",
                                "example":"Gearbox Order for Wind Tower"
                            },
                            "itemType":{
                                "type":"string",
                                "enum":[
                                    "W1CP",
                                    "W1CR",
                                    "W1DS",
                                    "W1FR",
                                    "W1NR",
                                    "W1TX",
                                    "W1XR"
                                ],
                                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                            },
                            "quantity":{
                                "type":"number",
                                "maximum":"99999999.99999",
                                "minimum":"0",
                                "description":"Invoice quantity",
                                "example":"20"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":"100000000000",
                                "minimum":"-100000000000",
                                "description":"Invoice Unit Price",
                                "example":"40"
                            },
                            "lineAmount":{
                                "type":"number",
                                "description":"Invoice line amount",
                                "example":"800"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : header

Type: object

Show Source

• currency: string
  Maximum Length: 3

  Currency Code

  Example: 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: 100000000000

  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 date

  Example: 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 date

  Example: 2021-09-15
• numberOfDays: number
  Minimum Value: 0

  Maximum Value: 99

  Payment due in number of days.

  Example: 30
• paymentAmount: number
  Amount paid

  Example: 800
• paymentDate: string (date)
  The date on which payment is done

  Example: 2021-10-15
• paymentNumber: string
  Maximum Length: 20

  Payment number
• paymentTerms: string
  Maximum Length: 30

  Invoice Payment Terms

  Example: CM-Pay30Days
• paymentType: string
  Allowed Values: [ "W1AP", "W1DR", "W1EL", "W1MN" ]

  Payment Type * `W1AP` - Regular AP Processing, * `W1DR` - Draft, * `W1EL` - Electronic, * `W1MN` - Manual

  Example: 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

{
    "type":"object",
    "properties":{
        "invoiceHeaderExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "invoiceNumber":{
            "type":"string",
            "maxLength":"30",
            "description":"This is the vendor's invoice number and it is unique for each vendor location.",
            "example":"170000004-0001"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "vendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "payToVendorLocationExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"External ID"
        },
        "paymentTerms":{
            "type":"string",
            "maxLength":"30",
            "description":"Invoice Payment Terms",
            "example":"CM-Pay30Days"
        },
        "numberOfDays":{
            "type":"number",
            "maximum":"99",
            "minimum":"0",
            "description":"Payment due in number of days.",
            "example":"30"
        },
        "vendorDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which invoice is generated by vendor.",
            "example":"2021-09-15"
        },
        "invoiceDueDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)",
            "example":"2021-10-15"
        },
        "invoiceReceivedDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice received date",
            "example":"2021-09-15"
        },
        "invoiceEnteredDate":{
            "type":"string",
            "format":"date",
            "description":"Invoice entered date",
            "example":"2021-09-15"
        },
        "currency":{
            "type":"string",
            "maxLength":"3",
            "description":"Currency Code",
            "example":"United States Dollars"
        },
        "exchangeRate":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"0",
            "description":"Exchange Rate"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which payment is done",
            "example":"2021-10-15"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":"20",
            "description":"Payment number"
        },
        "paymentType":{
            "type":"string",
            "enum":[
                "W1AP",
                "W1DR",
                "W1EL",
                "W1MN"
            ],
            "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual",
            "example":"W1DR"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Amount paid",
            "example":"800"
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "invoiceLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderLineExternalId":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Identifier Value"
                    },
                    "purchaseOrderNumber":{
                        "type":"string",
                        "maxLength":"14",
                        "description":"Enterprise Resource Planning system generated Purchase Order number.",
                        "example":"US164237"
                    },
                    "purchaseOrderLineNumber":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"0",
                        "description":"Item Number"
                    },
                    "description":{
                        "type":"string",
                        "maxLength":"100",
                        "description":"Brief description up to 100 characters for the invoice.",
                        "example":"Gearbox Order for Wind Tower"
                    },
                    "itemType":{
                        "type":"string",
                        "enum":[
                            "W1CP",
                            "W1CR",
                            "W1DS",
                            "W1FR",
                            "W1NR",
                            "W1TX",
                            "W1XR"
                        ],
                        "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
                    },
                    "quantity":{
                        "type":"number",
                        "maximum":"99999999.99999",
                        "minimum":"0",
                        "description":"Invoice quantity",
                        "example":"20"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":"100000000000",
                        "minimum":"-100000000000",
                        "description":"Invoice Unit Price",
                        "example":"40"
                    },
                    "lineAmount":{
                        "type":"number",
                        "description":"Invoice line amount",
                        "example":"800"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "invoiceLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderLineExternalId":{
                "type":"string",
                "maxLength":"60",
                "description":"Identifier Value"
            },
            "purchaseOrderNumber":{
                "type":"string",
                "maxLength":"14",
                "description":"Enterprise Resource Planning system generated Purchase Order number.",
                "example":"US164237"
            },
            "purchaseOrderLineNumber":{
                "type":"number",
                "maximum":"999",
                "minimum":"0",
                "description":"Item Number"
            },
            "description":{
                "type":"string",
                "maxLength":"100",
                "description":"Brief description up to 100 characters for the invoice.",
                "example":"Gearbox Order for Wind Tower"
            },
            "itemType":{
                "type":"string",
                "enum":[
                    "W1CP",
                    "W1CR",
                    "W1DS",
                    "W1FR",
                    "W1NR",
                    "W1TX",
                    "W1XR"
                ],
                "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
            },
            "quantity":{
                "type":"number",
                "maximum":"99999999.99999",
                "minimum":"0",
                "description":"Invoice quantity",
                "example":"20"
            },
            "unitPrice":{
                "type":"number",
                "maximum":"100000000000",
                "minimum":"-100000000000",
                "description":"Invoice Unit Price",
                "example":"40"
            },
            "lineAmount":{
                "type":"number",
                "description":"Invoice line amount",
                "example":"800"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 amount

  Example: 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: 99999999.99999

  Invoice quantity

  Example: 20
• unitPrice: number
  Minimum Value: -100000000000

  Maximum Value: 100000000000

  Invoice Unit Price

  Example: 40

{
    "type":"object",
    "properties":{
        "invoiceLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderLineExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Identifier Value"
        },
        "purchaseOrderNumber":{
            "type":"string",
            "maxLength":"14",
            "description":"Enterprise Resource Planning system generated Purchase Order number.",
            "example":"US164237"
        },
        "purchaseOrderLineNumber":{
            "type":"number",
            "maximum":"999",
            "minimum":"0",
            "description":"Item Number"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the invoice.",
            "example":"Gearbox Order for Wind Tower"
        },
        "itemType":{
            "type":"string",
            "enum":[
                "W1CP",
                "W1CR",
                "W1DS",
                "W1FR",
                "W1NR",
                "W1TX",
                "W1XR"
            ],
            "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost"
        },
        "quantity":{
            "type":"number",
            "maximum":"99999999.99999",
            "minimum":"0",
            "description":"Invoice quantity",
            "example":"20"
        },
        "unitPrice":{
            "type":"number",
            "maximum":"100000000000",
            "minimum":"-100000000000",
            "description":"Invoice Unit Price",
            "example":"40"
        },
        "lineAmount":{
            "type":"number",
            "description":"Invoice line amount",
            "example":"800"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : SYNCINVOICE_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"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."
                },
                "title":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":"9999",
                    "minimum":"0",
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"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."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":"0",
                            "minimum":"0",
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":"99999",
                            "minimum":"-99999",
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : SYNCINVOICE_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"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."
                },
                "title":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":"9999",
                    "minimum":"0",
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"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."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":"0",
                            "minimum":"0",
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":"99999",
                            "minimum":"-99999",
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top