einvoice-ts

Appearance

Documentation / @facturometro/core / LineAllowanceChargeInput

Interface: LineAllowanceChargeInput ​

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

BG-27, BG-28 INVOICE LINE ALLOWANCES OR CHARGES.

A group of business terms providing information about allowances or charges applicable to the individual Invoice line.

Builder input for LineAllowanceCharge: 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 ​

BR-CO-23, BR-CO-24

See ​

Properties ​

allowanceChargeReason? ​

optional allowanceChargeReason?: string

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

BT-139, BT-144 Line level allowance or charge reason.

The reason for the line level allowance or charge, expressed as text.

Cardinality ​

0..1

Rules ​

BR-42, BR-44, BR-CO-07, BR-CO-08, DK-R-004

See ​

allowanceChargeReasonCode? ​

optional allowanceChargeReasonCode?: string

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

BT-140, BT-145 Line level allowance or charge reason code.

The reason for the line level allowance or charge, expressed as a code.

Cardinality ​

0..1

Codelist ​

UNCL5189 https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/

Codelist ​

UNCL7161 https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/

Rules ​

BR-42, BR-44, BR-CO-07, BR-CO-08, PEPPOL-EN16931-CL003, PEPPOL-EN16931-CL002, DK-R-004, BR-CL-19, BR-CL-20

See ​

amount? ​

optional amount?: string | number | AmountInput

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

BT-136, BT-141 Line level allowance or charge amount.

The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals

Optional in the builder input: when omitted, createInvoice and createCreditNote compute it as the base amount times the percentage / 100, rounded to two decimals (BT-137 × BT-138 / 100 for an allowance, BT-142 × BT-143 / 100 for a charge), and throw a TypeError when neither the amount nor both baseAmount and multiplierFactorNumeric are given.

Attribute currencyID: Mandatory attribute. Use BT-5

Cardinality ​

1..1

Rules ​

BR-41, BR-43, BR-CL-03, PEPPOL-EN16931-R040, BR-DEC-24, BR-DEC-27, 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 ​

baseAmount? ​

optional baseAmount?: string | number | AmountInput

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

BT-137, BT-142 Line level allowance or charge base amount.

The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount. Must be rounded to maximum 2 decimals

Attribute currencyID: Mandatory attribute. Use BT-5

Cardinality ​

0..1

Rules ​

PEPPOL-EN16931-R041, BR-DEC-25, BR-DEC-28, 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 ​

chargeIndicator ​

chargeIndicator: string

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

cbc:ChargeIndicator.

Use “true” when informing about Charges and “false” when informing about Allowances

Cardinality ​

1..1

Rules ​

PEPPOL-EN16931-R043

See ​

multiplierFactorNumeric? ​

optional multiplierFactorNumeric?: string | number

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

BT-138, BT-143 Line level allowance or charge percentage.

The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.

Cardinality ​

0..1

Rules ​

PEPPOL-EN16931-R042

See ​

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