Documentation / @facturometro/core / CreditNoteInput
Interface: CreditNoteInput ​
Defined in: packages/core/src/model/credit-note.types.generated.ts:635
PEPPOL Credit Note 3.0 (ubl:CreditNote).
Builder input for CreditNote: 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-creditnote/
Properties ​
accountingCost? ​
optionalaccountingCost?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:758
BT-19 Buyer accounting reference.
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-AccountingCost/
accountingCustomerParty ​
accountingCustomerParty:
AccountingCustomerPartyInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:856
BG-7 BUYER.
A group of business terms providing information about the Buyer.
Cardinality ​
1..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingCustomerParty/
accountingSupplierParty ​
accountingSupplierParty:
AccountingSupplierPartyInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:847
BG-4 SELLER.
A group of business terms providing information about the Seller.
Cardinality ​
1..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AccountingSupplierParty/
additionalDocumentReference? ​
optionaladditionalDocumentReference?:AdditionalDocumentReferenceInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:831
BG-24 ADDITIONAL SUPPORTING DOCUMENTS.
A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
Cardinality ​
0..n
Rules ​
PEPPOL-EN16931-R080, DE-R-022
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AdditionalDocumentReference/
allowanceCharge? ​
optionalallowanceCharge?:AllowanceChargeInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:913
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.
Cardinality ​
0..n
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-AllowanceCharge/
billingReference? ​
optionalbillingReference?:BillingReferenceInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:796
BG-3 PRECEDING INVOICE REFERENCE.
A group of business terms providing information on one or more preceding Invoices.
Cardinality ​
0..n
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-BillingReference/
buyerReference? ​
optionalbuyerReference?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:769
BT-10 Buyer reference.
An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).
Cardinality ​
0..1
Rules ​
PEPPOL-EN16931-R003, DE-R-015
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-BuyerReference/
contractDocumentReference? ​
optionalcontractDocumentReference?:ContractDocumentReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:817
CONTRACT REFERENCE.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-ContractDocumentReference/
creditNoteLine ​
creditNoteLine:
CreditNoteLineInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:955
BG-25 INVOICE LINE.
A group of business terms providing information on individual Invoice lines.
Cardinality ​
1..n
Rules ​
BR-16
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-CreditNoteLine/
creditNoteTypeCode ​
creditNoteTypeCode:
"81"|"83"|"381"|"396"|"532"
Defined in: packages/core/src/model/credit-note.types.generated.ts:707
BT-3 Invoice type code.
A code specifying the functional type of the Invoice.
Cardinality ​
1..1
Codelist ​
UNCL1001-cn https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
Rules ​
BR-04, BR-CL-01, PEPPOL-EN16931-P0101
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-CreditNoteTypeCode/
customizationId? ​
optionalcustomizationId?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:648
BT-24 Specification identifier.
An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.
Cardinality ​
1..1
Default ​
urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Rules ​
PEPPOL-EN16931-R004, BR-01
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-CustomizationID/
delivery? ​
optionaldelivery?:DeliveryInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:885
BG-13 DELIVERY INFORMATION.
A group of business terms providing information about where and when the goods and services invoiced are delivered.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-Delivery/
despatchDocumentReference? ​
optionaldespatchDocumentReference?:DespatchDocumentReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:803
DESPATCH ADVICE REFERENCE.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-DespatchDocumentReference/
documentCurrencyCode ​
documentCurrencyCode:
string
Defined in: packages/core/src/model/credit-note.types.generated.ts:734
BT-5 Invoice currency code.
The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency. Only one currency shall be used in the Invoice, except for the VAT accounting currency code (BT-6) and the invoice total VAT amount in accounting currency (BT-111).
Cardinality ​
1..1
Codelist ​
ISO4217 https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
Rules ​
BR-05, BR-CL-04
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-DocumentCurrencyCode/
id ​
id:
string
Defined in: packages/core/src/model/credit-note.types.generated.ts:673
BT-1 Invoice number.
A unique identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used.
Cardinality ​
1..1
Rules ​
BR-02
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-ID/
invoicePeriod? ​
optionalinvoicePeriod?:InvoicePeriodInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:780
BG-14 DELIVERY OR INVOICE PERIOD.
A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period start date and/or end date must be used.
Cardinality ​
0..1
Rules ​
BR-IC-11
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-InvoicePeriod/
issueDate ​
issueDate:
string
Defined in: packages/core/src/model/credit-note.types.generated.ts:683
BT-2 Invoice issue date.
The date when the Invoice was issued. Format "YYYY-MM-DD"
Cardinality ​
1..1
Rules ​
BR-03, PEPPOL-EN16931-F001
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-IssueDate/
legalMonetaryTotal? ​
optionallegalMonetaryTotal?:LegalMonetaryTotalInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:945
BG-22 DOCUMENT TOTALS.
A group of business terms providing the monetary totals for the Invoice.
Optional in the builder input: when omitted, the builder computes the document totals from the lines, the document level allowances and charges and the VAT total (BR-CO-10 to BR-CO-16), stating BT-107 only when there are document level allowances, BT-108 only when there are document level charges.
Cardinality ​
1..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-LegalMonetaryTotal/
note? ​
optionalnote?:string[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:720
BT-22 Invoice note.
A textual note that gives unstructured information that is relevant to the Invoice as a whole. Such as the reason for any correction or assignment note in case the invoice has been factored. The element is not repeatable, except when both the Buyer and Seller are German, in which case the element can be repeated to meet specific national requirements.
Cardinality ​
0..n (UBL 2.1; the Peppol structure says 0..1 and PEPPOL-EN16931-R002 enforces it)
Rules ​
PEPPOL-EN16931-R002, BR-CL-08
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-Note/
orderReference? ​
optionalorderReference?:OrderReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:787
ORDER AND SALES ORDER REFERENCE.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-OrderReference/
originatorDocumentReference? ​
optionaloriginatorDocumentReference?:OriginatorDocumentReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:838
TENDER OR LOT REFERENCE.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-OriginatorDocumentReference/
payeeParty? ​
optionalpayeeParty?:PayeePartyInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:866
BG-10 PAYEE.
A group of business terms providing information about the Payee, i.e. the role that receives the payment. Shall be used when the Payee is different from the Seller.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-PayeeParty/
paymentMeans? ​
optionalpaymentMeans?:CreditNotePaymentMeansInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:895
BG-16 PAYMENT INSTRUCTIONS.
A group of business terms providing information about the payment.
Cardinality ​
0..n
Rules ​
DE-R-001
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-PaymentMeans/
paymentTerms? ​
optionalpaymentTerms?:PaymentTermsInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:902
PAYMENT TERMS.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-PaymentTerms/
profileId? ​
optionalprofileId?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:660
BT-23 Business process type.
Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.
Cardinality ​
1..1
Default ​
urn:fdc:peppol.eu:2017:poacc:billing:01:1.0Rules ​
PEPPOL-EN16931-R001, PEPPOL-EN16931-R007
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-ProfileID/
receiptDocumentReference? ​
optionalreceiptDocumentReference?:ReceiptDocumentReferenceInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:810
RECEIPT ADVICE REFERENCE.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-ReceiptDocumentReference/
taxCurrencyCode? ​
optionaltaxCurrencyCode?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:748
BT-6 VAT accounting currency code.
The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller. Shall be used in combination with the Invoice total VAT amount in accounting currency (BT-111), when the VAT accounting currency code differs from the Invoice currency code.
Cardinality ​
0..1
Codelist ​
ISO4217 https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
Rules ​
BR-CL-05, PEPPOL-EN16931-R005
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-TaxCurrencyCode/
taxPointDate? ​
optionaltaxPointDate?:string
Defined in: packages/core/src/model/credit-note.types.generated.ts:696
BT-7 Value added tax point date.
The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.This element is required if the Value added tax point date is different from the Invoice issue date.
Cardinality ​
0..1
Rules ​
BR-CO-03
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cbc-TaxPointDate/
taxRepresentativeParty? ​
optionaltaxRepresentativeParty?:TaxRepresentativePartyInput
Defined in: packages/core/src/model/credit-note.types.generated.ts:875
BG-11 SELLER TAX REPRESENTATIVE PARTY.
A group of business terms providing information about the Seller's tax representative.
Cardinality ​
0..1
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxRepresentativeParty/
taxTotal? ​
optionaltaxTotal?:TaxTotalInput[]
Defined in: packages/core/src/model/credit-note.types.generated.ts:931
TAX TOTAL.
When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.
Optional in the builder input: when omitted or empty, the builder adds the VAT total (BT-110) with a VAT breakdown line (BG-23) for every VAT category and rate the lines and the document level allowances and charges use. 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 its tax amount or one of its VAT breakdown lines omits its taxable or tax amount.
Cardinality ​
1..2
Rules ​
PEPPOL-EN16931-R054
See ​
https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-creditnote/cac-TaxTotal/