Documentation / @facturometro/core / CreditNoteLineInput
Interface: CreditNoteLineInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1053
BG-25 INVOICE LINE.
A group of business terms providing information on individual Invoice lines.
Builder input for CreditNoteLine: 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-16
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/
Properties
accountingCost?
optionalaccountingCost?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:1123
BT-133 Invoice line Buyer accounting reference.
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
Cardinality
0..1
See
allowanceCharge?
optionalallowanceCharge?:LineAllowanceChargeInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:1158
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.
Cardinality
0..n
Rules
BR-CO-23, BR-CO-24
See
creditedQuantity
creditedQuantity:
QuantityInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1092
BT-129 Invoiced quantity.
The quantity of items (goods or services) that is charged in the Invoice line.
Attribute unitCode (BT-130 Invoiced quantity unit of measure): The unit of measure that applies to the invoiced quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the "Intro" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
Cardinality
1..1
Rules
BR-22
Codelist
unitCode: UNECERec20 https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
Rules
unitCode: BR-23
See
documentReference?
optionaldocumentReference?:DocumentReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1147
LINE OBJECT IDENTIFIER.
Cardinality
0..1
Rules
PEPPOL-EN16931-R100, PEPPOL-EN16931-R101
See
id
id:
string
Defined in: packages/core/src/model/credit-note.types.generated.ts:1063
BT-126 Invoice line identifier.
A unique identifier for the individual line within the Invoice.
Cardinality
1..1
Rules
BR-21
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/cbc-ID/
invoicePeriod?
optionalinvoicePeriod?:LinePeriodInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1132
BG-26 INVOICE LINE PERIOD.
A group of business terms providing information about the period relevant for the Invoice line.
Cardinality
0..1
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/cac-InvoicePeriod/
item
item:
ItemInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1167
BG-31 ITEM INFORMATION.
A group of business terms providing information about the goods and services invoiced.
Cardinality
1..1
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/cac-Item/
lineExtensionAmount?
optionallineExtensionAmount?:string|number|AmountInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1113
BT-131 Invoice line net amount.
The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals.
Optional in the builder input: when omitted, the builder computes it as the quantity times the price per unit (BT-129 × BT-146 / BT-149), rounded to two decimals, plus the line charges and minus the line allowances (BT-141, BT-136); a price base quantity of zero throws a RangeError.
Attribute currencyID: Mandatory attribute. Use BT-5
Cardinality
1..1
Rules
BR-24, PEPPOL-EN16931-R120, BR-DEC-23, 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
note?
optionalnote?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:1072
BT-127 Invoice line note.
A textual note that gives unstructured information that is relevant to the Invoice line.
Cardinality
0..1
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/cbc-Note/
orderLineReference?
optionalorderLineReference?:OrderLineReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1139
ORDER LINE REFERENCE.
Cardinality
0..1
See
price
price:
PriceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:1177
BG-29 PRICE DETAILS.
A group of business terms providing information about the price applied for the goods and services invoiced on the Invoice line.
Cardinality
1..1
See
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/cac-Price/