Documentation / @facturometro/core / TaxTotalInput

Interface: TaxTotalInput

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

TAX TOTAL.

When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.

Builder input for TaxTotal: 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-R054

See

• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxTotal/
• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxTotal/

Properties

taxAmount?

optional taxAmount?: string | number | AmountInput

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

BT-110, BT-111 Invoice total VAT amount, Invoice total VAT amount in accounting currency.

The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals

Optional in the builder input: when omitted from the first tax total, the builder computes the VAT total (BT-110) as the sum of the VAT category tax amounts (BR-CO-14). A later tax total, such as the one stating the VAT total in the tax currency (BT-111), is never computed: createInvoice and createCreditNote throw a TypeError when it omits the tax amount.

Attribute currencyID: Mandatory attribute. Use BT-5 or BT-6.

Cardinality

1..1

Rules

BR-53, BR-CO-14, BR-DEC-13, BR-DEC-15, 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

• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxTotal/cbc-TaxAmount/
• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxTotal/cbc-TaxAmount/

---

taxSubtotal?

optional taxSubtotal?: TaxSubtotalInput[]

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

BG-23 VAT BREAKDOWN.

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

Cardinality

0..n

Rules

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

See

• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-TaxTotal/cac-TaxSubtotal/
• https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxTotal/cac-TaxSubtotal/