einvoice-ts

Appearance

Documentation / @facturometro/einvoice / UncheckedInvoice

Interface: UncheckedInvoice ​

Defined in: packages/core/src/model/invoice.types.generated.ts:1244

PEPPOL BIS Invoice 3.0 (ubl:Invoice).

Parser output for Invoice: every property is optional and codes are plain strings, because nothing has been validated yet.

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/

Properties ​

accountingCost? ​

optional accountingCost?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1381

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-invoice/cbc-AccountingCost/

accountingCustomerParty? ​

optional accountingCustomerParty?: UncheckedAccountingCustomerParty

Defined in: packages/core/src/model/invoice.types.generated.ts:1487

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-invoice/cac-AccountingCustomerParty/

accountingSupplierParty? ​

optional accountingSupplierParty?: UncheckedAccountingSupplierParty

Defined in: packages/core/src/model/invoice.types.generated.ts:1478

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-invoice/cac-AccountingSupplierParty/

additionalDocumentReference? ​

optional additionalDocumentReference?: UncheckedAdditionalDocumentReference[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1462

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-invoice/cac-AdditionalDocumentReference/

allowanceCharge? ​

optional allowanceCharge?: UncheckedAllowanceCharge[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1544

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-invoice/cac-AllowanceCharge/

billingReference? ​

optional billingReference?: UncheckedBillingReference[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1420

BG-3 PRECEDING INVOICE REFERENCE.

A group of business terms providing information on one or more preceding Invoices.

Cardinality ​

0..n

Rules ​

DE-R-026

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-BillingReference/

buyerReference? ​

optional buyerReference?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1392

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-invoice/cbc-BuyerReference/

contractDocumentReference? ​

optional contractDocumentReference?: UncheckedContractDocumentReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1448

CONTRACT REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-ContractDocumentReference/

customizationId? ​

optional customizationId?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1259

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 ​

ts
urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0

Rules ​

PEPPOL-EN16931-R004, BR-01

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-CustomizationID/

delivery? ​

optional delivery?: UncheckedDelivery

Defined in: packages/core/src/model/invoice.types.generated.ts:1516

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-invoice/cac-Delivery/

despatchDocumentReference? ​

optional despatchDocumentReference?: UncheckedDespatchDocumentReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1427

DESPATCH ADVICE REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-DespatchDocumentReference/

documentCurrencyCode? ​

optional documentCurrencyCode?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1357

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-invoice/cbc-DocumentCurrencyCode/

dueDate? ​

optional dueDate?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1306

BT-9 Payment due date.

The date when the payment is due.Format "YYYY-MM-DD". In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

Cardinality ​

0..1

Rules ​

PEPPOL-EN16931-F001, BR-CO-25

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-DueDate/

id? ​

optional id?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1284

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-invoice/cbc-ID/

invoiceLine? ​

optional invoiceLine?: UncheckedInvoiceLine[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1574

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-invoice/cac-InvoiceLine/

invoicePeriod? ​

optional invoicePeriod?: UncheckedInvoicePeriod

Defined in: packages/core/src/model/invoice.types.generated.ts:1403

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-invoice/cac-InvoicePeriod/

invoiceTypeCode? ​

optional invoiceTypeCode?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1317

BT-3 Invoice type code.

A code specifying the functional type of the Invoice.

Cardinality ​

1..1

Codelist ​

UNCL1001-inv https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/

Rules ​

BR-04, BR-CL-01, PEPPOL-EN16931-P0100, DE-R-017

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-InvoiceTypeCode/

issueDate? ​

optional issueDate?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1294

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-invoice/cbc-IssueDate/

kind ​

kind: "Invoice"

Defined in: packages/core/src/model/invoice.types.generated.ts:1246

Discriminant of the document union: always Invoice.

legalMonetaryTotal? ​

optional legalMonetaryTotal?: UncheckedLegalMonetaryTotal

Defined in: packages/core/src/model/invoice.types.generated.ts:1564

BG-22 DOCUMENT TOTALS.

A group of business terms providing the monetary totals for the Invoice.

Cardinality ​

1..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-LegalMonetaryTotal/

note? ​

optional note?: string[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1330

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 legal 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-invoice/cbc-Note/

orderReference? ​

optional orderReference?: UncheckedOrderReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1410

ORDER AND SALES ORDER REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-OrderReference/

originatorDocumentReference? ​

optional originatorDocumentReference?: UncheckedOriginatorDocumentReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1441

TENDER OR LOT REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-OriginatorDocumentReference/

payeeParty? ​

optional payeeParty?: UncheckedPayeeParty

Defined in: packages/core/src/model/invoice.types.generated.ts:1497

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-invoice/cac-PayeeParty/

paymentMeans? ​

optional paymentMeans?: UncheckedInvoicePaymentMeans[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1526

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-invoice/cac-PaymentMeans/

paymentTerms? ​

optional paymentTerms?: UncheckedPaymentTerms

Defined in: packages/core/src/model/invoice.types.generated.ts:1533

PAYMENT TERMS.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-PaymentTerms/

profileId? ​

optional profileId?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1271

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 ​

ts
urn:fdc:peppol.eu:2017:poacc:billing:01:1.0

Rules ​

PEPPOL-EN16931-R001, PEPPOL-EN16931-R007

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-ProfileID/

projectReference? ​

optional projectReference?: UncheckedProjectReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1469

PROJECT REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-ProjectReference/

receiptDocumentReference? ​

optional receiptDocumentReference?: UncheckedReceiptDocumentReference

Defined in: packages/core/src/model/invoice.types.generated.ts:1434

RECEIPT ADVICE REFERENCE.

Cardinality ​

0..1

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cac-ReceiptDocumentReference/

taxCurrencyCode? ​

optional taxCurrencyCode?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1371

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, PEPPOL-EN16931-R055

See ​

https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-TaxCurrencyCode/

taxPointDate? ​

optional taxPointDate?: string

Defined in: packages/core/src/model/invoice.types.generated.ts:1343

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-invoice/cbc-TaxPointDate/

taxRepresentativeParty? ​

optional taxRepresentativeParty?: UncheckedTaxRepresentativeParty

Defined in: packages/core/src/model/invoice.types.generated.ts:1506

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-invoice/cac-TaxRepresentativeParty/

taxTotal? ​

optional taxTotal?: UncheckedTaxTotal[]

Defined in: packages/core/src/model/invoice.types.generated.ts:1555

TAX TOTAL.

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

Cardinality ​

1..2

Rules ​

PEPPOL-EN16931-R054

See ​

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

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