: Billing event that can be either invoice or credit note. It contains global information of the billing (inside billingHeader object) or about the line (billingLines object)
: Billing event that can be either invoice or credit note. It contains global information of the billing (inside billingHeader object) or about the line (billingLines object)
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"BILLING_HEADER"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"BILLING_LINES"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"INVOICE"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
This condition is used to ensure that the billingLines array contains the required fields when the issueTrigger is DELIVERY.
"BILLING_LINES"
"DELIVERY"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"PAYMENT"
This object is used to describe some technical meta information related to the event
The application source of this event
The version of the json format event
defines if the event contains information about Header or lines or both
Must contain a minimum of 1 items
primary key of the document, cannot be modified once the document is created. can mono mono or composite
unique internal billing id as known on the backend/source system
Must be at least 1 characters long
It contains global information about the billing.
represents the billing number of the document visible to customer
Must be at least 1 characters long
The account id that uniquely identifies the account to which the amount is billed to, can be equal to sold to. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Must be at least 1 characters long
"1234567"
"1234567_OVIA"
The account id that uniquely identifies the account to which the billing's line items were sold to. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Must be at least 1 characters long
"1234567"
"1234567_OVIA"
The account id that uniquely identifies the account in case it's different from billTo. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Must be at least 1 characters long
"1234567"
"1234567_OVIA"
Type of the document, invoice or credit notes
The status of the billing document. These statuses will be displayed to the user as CMS label mapped to the status.
- EFFECTIVE: The billing status when it is created.
- CANCELLED: The billing document has been cancelled.
- PAID: The invoice document has been paid in full.
- PARTIALLYPAID: The invoice document has been partially paid.
- PARTIALLYREFUNDED: The credit note document has been partially refunded, deducted from the credit limit or refund to the customer bank.
- REFUNDED: The credit note document has been refunded, deducted from the credit limit or refund to the customer bank.
- PROCESSING: The payment has been issued and it's waiting for the OpCo validation
Defines if invoice is triggered at sales order capture or at goods issue
date of issuing of the billing document
date when the invoice is due
last modification date (in date-time format)
total amount to be paid with detailed included taxes, surcharges ( like freight / shipping cost)
total price including taxes, including all costs
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Total shipping cost without taxes
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
The total amount of each tax.
Total tax amounts should be grouped by (type, percentage) to cover the case of different percentages for the same taxe type.
Contains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesThe actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 12000,
"scale": 4,
"currency": "EUR"
},
"percentage": 20
},
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 100,
"scale": 4,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE",
"isSurcharge": true,
"taxAmount": {
"amount": 260,
"scale": 2,
"currency": "EUR"
}
}
]
due amount left to be paid with detailed included taxes
due amount without taxes
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
The total amount of each tax.
Total tax amounts should be grouped by (type, percentage) to cover the case of different percentages for the same taxe type.
Contains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesThe actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
[
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 12000,
"scale": 4,
"currency": "EUR"
},
"percentage": 20
},
{
"type": "VAT",
"isSurcharge": false,
"taxAmount": {
"amount": 100,
"scale": 4,
"currency": "EUR"
},
"percentage": 5.5
},
{
"type": "ECOTAXE",
"isSurcharge": true,
"taxAmount": {
"amount": 260,
"scale": 2,
"currency": "EUR"
}
}
]
In case of credit note this will reference invoices (billing having billingNumber) for which the credit note is refunding
No Additional ItemsMust be at least 1 characters long
List of billing lines.
No Additional Itemsbilling line id of the billing document
sales order id of the sales order related to that line
Must be at least 1 characters long
sales order line id reference in this sales order id for that line ( can cover more than 1 line, potentially with different delivery order id in case of a split )
logistic order id of the logistic order related to that line
Must be at least 1 characters long
logistic order line id reference in this logistic order id for that line
Unique identifier for the product.
Must be at least 1 characters long
supplier id that has provided this product ( can be different from the manufacturer of the product )
quantity of this product in this line
Value must be greater or equal to 0
Total amount without shipping without taxes
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Shipping cost applied to this line also without taxes
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
all taxes applicable to this product
No Additional ItemsContains the tax informations with both percentage or exact amount as preferable.
A tax with a fixed amount.
No Additional PropertiesA tax represented by a percentage.
No Additional PropertiesA tax with a code, fixed amount, rate. Used to describe a marketplace tax.
No Additional PropertiesThe actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Type of tax which is applicable to the underlying product.
"VAT"
This flag determines if the tax is a surcharge to be added to netPrice/promotionalNetPrice before applying Tax. The Tax computation happens on top of ((netPrice or promotionalNetPrice)+surcharges)
true
The percentage of the net price
20.0
A tax code which identifies the tax applied to this item. It can be used to carry more details than the high level tax type information.
"VAT_5_5"
"VAT_10"
"VAT_20"
This flag determines if the tax applies to shipping costs.
Example: option and scenario costs.
Margins for the line.
margin related to this product for this line, as visible by the sales team
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
margin related to this product for this line, as published by accounting
The actual unscaled amount
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
Must be at most 3 characters long
"EUR"
Payment information related to this billing document. It contains the transaction id of the payment done by the customer for this invoice or credit note.
Unique identifier of the payment transaction
Must be at least 1 characters long
"23456789"