Documentation / @facturometro/einvoice / AllowanceChargeInput
Interface: AllowanceChargeInput
Defined in: packages/core/src/model/common.types.generated.ts:4257
BG-20, BG-21 DOCUMENT LEVEL ALLOWANCES AND CHARGES.
A group of business terms providing information about allowances applicable to the Invoice as a whole. A group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.
Builder input for AllowanceCharge: 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.
See
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/
Properties
allowanceChargeReason?
optionalallowanceChargeReason?:string
Defined in: packages/core/src/model/common.types.generated.ts:4297
BT-97, BT-104 Document level allowance or charge reason.
The reason for the document level allowance or charge, expressed as text. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason
Cardinality
0..1
Rules
BR-33, BR-38, BR-CO-05, BR-CO-06, BR-CO-21, BR-CO-22, DK-R-004
See
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/cbc-AllowanceChargeReason/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-AllowanceChargeReason/
allowanceChargeReasonCode?
optionalallowanceChargeReasonCode?:string
Defined in: packages/core/src/model/common.types.generated.ts:4284
BT-98, BT-105 Document level allowance or charge reason code.
The reason for the document level allowance or charge, expressed as a code. For allowances a subset of codelist UNCL5189 is to be used, and for charges codelist UNCL7161 applies. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason
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-33, BR-38, BR-CO-05, BR-CO-06, BR-CO-21, BR-CO-22, PEPPOL-EN16931-CL003, PEPPOL-EN16931-CL002, DK-R-004, BR-CL-19, BR-CL-20
See
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/cbc-AllowanceChargeReasonCode/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-AllowanceChargeReasonCode/
amount?
optionalamount?:string|number|AmountInput
Defined in: packages/core/src/model/common.types.generated.ts:4329
BT-92, BT-99 Document 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-93 × BT-94 / 100 for an allowance, BT-100 × BT-101 / 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-31, BR-36, BR-CL-03, PEPPOL-EN16931-R040, BR-DEC-01, BR-DEC-05, 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
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/cbc-Amount/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-Amount/
baseAmount?
optionalbaseAmount?:string|number|AmountInput
Defined in: packages/core/src/model/common.types.generated.ts:4346
BT-93, BT-100 Document level allowance or charge base amount.
The base amount that may be used, in conjunction with the document level allowance or charge percentage, to calculate the document 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-02, BR-DEC-06, 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-AllowanceCharge/cbc-BaseAmount/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-BaseAmount/
chargeIndicator
chargeIndicator:
string
Defined in: packages/core/src/model/common.types.generated.ts:4268
cbc:ChargeIndicator.
Use “true” when informing about Charges and “false” when informing about Allowances.
Cardinality
1..1
Rules
PEPPOL-EN16931-R043
See
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/cbc-ChargeIndicator/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-ChargeIndicator/
multiplierFactorNumeric?
optionalmultiplierFactorNumeric?:string|number
Defined in: packages/core/src/model/common.types.generated.ts:4309
BT-94, BT-101 Document level allowance or charge percentage.
The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance or charge amount. To state 20%, use value 20.
Cardinality
0..1
Rules
PEPPOL-EN16931-R042
See
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-AllowanceCharge/cbc-MultiplierFactorNumeric/
- https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/cbc-MultiplierFactorNumeric/
taxCategory
taxCategory:
AllowanceChargeTaxCategoryInput
Defined in: packages/core/src/model/common.types.generated.ts:4354
TAX CATEGORY.
Cardinality
1..1