einvoice-ts

Appearance

Documentation / @facturometro/einvoice / TaxSubtotalInput

Interface: TaxSubtotalInput ​

Defined in: packages/core/src/model/common.types.generated.ts:4468

BG-23 VAT BREAKDOWN.

A group of business terms providing information about VAT breakdown by different categories, rates and exemption reasons

Builder input for TaxSubtotal: decimals may be numbers; currencyId and defaultable elements (those with a default or fixed value) are optional; leaves whose attributes are all optional accept a plain string. The amounts the builder computes are optional as well; each one says how it is computed when omitted.

Rules ​

PEPPOL-EN16931-R053, BR-CO-18, BR-O-11

See ​

Properties ​

taxableAmount? ​

optional taxableAmount?: string | number | AmountInput

Defined in: packages/core/src/model/common.types.generated.ts:4490

BT-116 VAT category taxable amount.

Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals.

Optional in the builder input: when omitted from a VAT breakdown line of the first tax total, the builder computes it (BT-116) as the line net amounts plus the document level charges minus the document level allowances of that VAT category and rate. A later tax total is never computed: createInvoice and createCreditNote throw a TypeError when one of its VAT breakdown lines omits it.

Attribute currencyID: Mandatory attribute. Use BT-5

Cardinality ​

1..1

Rules ​

BR-45, BR-S-08, BR-Z-08, BR-E-08, BR-AE-08, BR-IC-08, BR-G-08, BR-O-08, BR-DEC-19, UBL-DT-01, BR-CL-03

Codelist ​

currencyID: ISO4217 https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/

Rules ​

currencyID: PEPPOL-EN16931-CL007, PEPPOL-EN16931-R051

See ​

taxAmount? ​

optional taxAmount?: string | number | AmountInput

Defined in: packages/core/src/model/common.types.generated.ts:4511

BT-117 VAT category tax amount.

The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.

Optional in the builder input: when omitted from a VAT breakdown line of the first tax total, the builder computes it as the taxable amount times the VAT rate (BT-116 × BT-119 / 100), rounded to two decimals; zero for a category without a rate. A later tax total is never computed: createInvoice and createCreditNote throw a TypeError when one of its VAT breakdown lines omits it.

Attribute currencyID: Mandatory attribute. Use BT-5

Cardinality ​

1..1

Rules ​

BR-46, BR-CO-17, BR-S-09, BR-Z-09, BR-E-09, BR-AE-09, BR-IC-09, BR-G-09, BR-O-09, BR-DEC-20, UBL-DT-01

Codelist ​

currencyID: ISO4217 https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/

Rules ​

currencyID: PEPPOL-EN16931-CL007, PEPPOL-EN16931-R051

See ​

taxCategory ​

taxCategory: TaxSubtotalTaxCategoryInput

Defined in: packages/core/src/model/common.types.generated.ts:4519

VAT CATEGORY.

Cardinality ​

1..1

See ​

MIT licensed. Specification artefacts belong to OpenPEPPOL, CEN and OASIS.