/ubl:Invoice

Invoice

New Zealand | VRBL-Invoice-NZ-1p0
Download sample files
Context ID INV0001
Usage -

Description

VRBL is a general datamodel for an invoice based on UBL2.4 and Peppol PINT, that can be used as base for specializations that are used in various jurisdictions.

Child elements
Usage Element Description Cardinality
M cec:UBLExtensions Extensions Group 0..1
M cbc:CustomizationID Specification Identifier

Identifies a user-defined customization of UBL for a specific use.

 0..1
M cbc:ProfileID Business Process Type

Identifies a user-defined profile of the customization of UBL being used.

 0..1
M cbc:ID Invoice Number

An identifier for this document, assigned by the sender.

 1..1
M cbc:IssueDate Invoice Issue Date

The date, assigned by the sender, on which this document was issued.

 1..1
O cbc:DueDate Payment Due Date

The date on which Invoice is due.

 0..1
M cbc:InvoiceTypeCode Invoice Type Code

A code signifying the type of the Invoice.

 0..1
O cbc:Note Invoice Note

Free-form text pertinent to this document, conveying information that is not contained explicitly in other structures.

 0..n
M cbc:DocumentCurrencyCode Document Currency Code

A code signifying the default currency for this document.

 0..1
O cbc:TaxCurrencyCode Tax Accounting Currency

A code signifying the currency used for tax amounts in the Invoice.

 0..1
O cbc:AccountingCost Buyer Accounting Reference

The buyer's accounting code, applied to the Invoice as a whole, expressed as text.

 0..1
O cbc:BuyerReference Buyer Reference

A reference provided by the buyer used for internal routing of the document.

 0..1
O cac:InvoicePeriod Invoicing Period

A period to which the Invoice applies.

 0..n
O cac:OrderReference Order Reference

A reference to the Order with which this Invoice is associated.

 0..1
O* cac:BillingReference Preceding Invoice Reference

A reference to a billing document associated with this document.

 0..n
O cac:DespatchDocumentReference Despatch Advice Reference

A reference to a Despatch Advice associated with this document.

 0..n
O cac:ReceiptDocumentReference Receipt Advice Reference

A reference to a Receipt Advice associated with this document.

 0..n
O cac:OriginatorDocumentReference Tender Or Lot Reference

A reference to an originator document associated with this document.

 0..n
O cac:ContractDocumentReference Contract Reference

A reference to a contract associated with this document.

 0..n
O* cac:AdditionalDocumentReference Additional Document Reference Group

A reference to an additional document associated with this document.

 0..n
O cac:AdditionalDocumentReference[not(cac:Attachment)] Additional Document Reference

A reference to an additional document associated with this document.

 0..n
O cac:ProjectReference Project Reference

Information about a project.

 0..n
M cac:AccountingSupplierParty Seller

The accounting supplier party.

 1..1
M cac:AccountingCustomerParty Buyer

The accounting customer party.

 0..1
O cac:PayeeParty Payee

The payee.

 0..1
O cac:TaxRepresentativeParty Seller Tax Representative Party

The tax representative.

 0..1
O cac:Delivery Delivery Information

A delivery associated with this document.

 0..n
O* cac:PaymentMeans Payment Instructions

Expected means of payment.

 0..n
O* cac:PaymentTerms Payment Terms

A set of payment terms associated with this document.

 0..n
O cac:AllowanceCharge Allowance Charge Group

A discount or charge that applies to a price component.

 0..n
O* cac:AllowanceCharge[string(cbc:ChargeIndicator) = 'false'] Document Level Allowances

A discount or charge that applies to a price component.

 0..n
O* cac:AllowanceCharge[string(cbc:ChargeIndicator) = 'true'] Document Level Charges

A discount or charge that applies to a price component.

 0..n
M cac:TaxTotal[cbc:TaxAmount/@currencyID = ../cbc:DocumentCurrencyCode] Tax Total

The total amount of a specific type of tax.

 0..n
O cac:TaxTotal[cbc:TaxAmount/@currencyID = ../cbc:TaxCurrencyCode] Tax Total in Tax Accounting Currency

The total amount of a specific type of tax.

 0..n
M cac:LegalMonetaryTotal Document Totals

The total amount payable on the Invoice, including Allowances, Charges, and Taxes.

 1..1
M+ cac:InvoiceLine Invoice Line

A line describing an invoice item.

 1..n
Details

Example: NZ_CreditNote.xml

<ubl:Invoice>
  <ext:UBLExtensions>
    <ext:UBLExtension>
      <ext:ExtensionContent>
        <vrbl:InvoiceExtension>
          <vrbl:RoutingDetails>
            <vrbl:Sender>NZ00000000000</vrbl:Sender>
            <vrbl:Receiver>GENERIC_PEPPOL_UBL_NZ_1p0</vrbl:Receiver>
          </vrbl:RoutingDetails>
        </vrbl:InvoiceExtension>
      </ext:ExtensionContent>
    </ext:UBLExtension>
  </ext:UBLExtensions>
  <cbc:CustomizationID>urn:vertexinc:vrbl:billing:1#Invoice#VRBL-Invoice-NZ-1p0</cbc:CustomizationID>
  <cbc:ProfileID>urn:vertexinc:vrbl:billing:1</cbc:ProfileID>
  <cbc:ID>CN03</cbc:ID>
  <cbc:IssueDate>2022-07-31</cbc:IssueDate>
  <cbc:DueDate>2022-08-30</cbc:DueDate>
  <cbc:InvoiceTypeCode>381</cbc:InvoiceTypeCode>
  <cbc:Note>Adjustment note to reverse prior bill Invoice01.</cbc:Note>
  <cbc:DocumentCurrencyCode>NZD</cbc:DocumentCurrencyCode>
  <cbc:BuyerReference>0150abc</cbc:BuyerReference>
  <cac:InvoicePeriod>
    <cbc:StartDate>2022-06-15</cbc:StartDate>
    <cbc:EndDate>2022-07-15</cbc:EndDate>
  </cac:InvoicePeriod>
  <cac:BillingReference>
    <cac:InvoiceDocumentReference>
      <cbc:ID>Invoice01</cbc:ID>
      <cbc:IssueDate>2022-07-29</cbc:IssueDate>
    </cac:InvoiceDocumentReference>
  </cac:BillingReference>
  <cac:AdditionalDocumentReference>
    <cbc:ID>CN03.pdf</cbc:ID>
    <cac:Attachment>
      <cbc:EmbeddedDocumentBinaryObject mimeCode="application/pdf" filename="CN03.pdf">UGxhaW4gdGV4dCBpbiBwbGFjZSBvZiBwZGYgYXR0YWNobWVudCBmb3Igc2FtcGxlIGludm9pY2Vz</cbc:EmbeddedDocumentBinaryObject>
    </cac:Attachment>
  </cac:AdditionalDocumentReference>
  <cac:AccountingSupplierParty>
    <cac:Party>
      <cbc:EndpointID schemeID="0088">9506000140445</cbc:EndpointID>
      <cac:PostalAddress>
        <cbc:CityName>Auckland</cbc:CityName>
        <cbc:PostalZone>2912</cbc:PostalZone>
        <cbc:CountrySubentity>AUK</cbc:CountrySubentity>
        <cac:Country>
          <cbc:IdentificationCode>NZ</cbc:IdentificationCode>
        </cac:Country>
      </cac:PostalAddress>
      <cac:PartyLegalEntity>
        <cbc:RegistrationName>Supplier Official Name Ltd</cbc:RegistrationName>
        <cbc:CompanyID schemeID="0088">9506000140445</cbc:CompanyID>
      </cac:PartyLegalEntity>
    </cac:Party>
  </cac:AccountingSupplierParty>
  <cac:AccountingCustomerParty>
    <cac:Party>
      <cbc:EndpointID schemeID="0088">9429000000000</cbc:EndpointID>
      <cac:PartyIdentification>
        <cbc:ID>AccountNumber123</cbc:ID>
      </cac:PartyIdentification>
      <cac:PostalAddress>
        <cbc:StreetName>100 Queen Street</cbc:StreetName>
        <cbc:CityName>Christchurch</cbc:CityName>
        <cbc:PostalZone>2000</cbc:PostalZone>
        <cbc:CountrySubentity>CAN</cbc:CountrySubentity>
        <cac:Country>
          <cbc:IdentificationCode>NZ</cbc:IdentificationCode>
        </cac:Country>
      </cac:PostalAddress>
      <cac:PartyLegalEntity>
        <cbc:RegistrationName>Trotters Incorporated</cbc:RegistrationName>
        <cbc:CompanyID schemeID="0088">9429000000000</cbc:CompanyID>
      </cac:PartyLegalEntity>
      <cac:Contact>
        <cbc:Name>Lisa Johnson</cbc:Name>
      </cac:Contact>
    </cac:Party>
  </cac:AccountingCustomerParty>
  <cac:TaxTotal>
    <cbc:TaxAmount currencyID="NZD">23.91</cbc:TaxAmount>
    <cac:TaxSubtotal>
      <cbc:TaxableAmount currencyID="NZD">159.43</cbc:TaxableAmount>
      <cbc:TaxAmount currencyID="NZD">23.91</cbc:TaxAmount>
      <cac:TaxCategory>
        <cbc:ID>S</cbc:ID>
        <cbc:Percent>15</cbc:Percent>
        <cac:TaxScheme>
          <cbc:ID>GST</cbc:ID>
        </cac:TaxScheme>
      </cac:TaxCategory>
    </cac:TaxSubtotal>
  </cac:TaxTotal>
  <cac:LegalMonetaryTotal>
    <cbc:LineExtensionAmount currencyID="NZD">159.43</cbc:LineExtensionAmount>
    <cbc:TaxExclusiveAmount currencyID="NZD">159.43</cbc:TaxExclusiveAmount>
    <cbc:TaxInclusiveAmount currencyID="NZD">183.34</cbc:TaxInclusiveAmount>
    <cbc:PayableAmount currencyID="NZD">183.34</cbc:PayableAmount>
  </cac:LegalMonetaryTotal>
  <cac:InvoiceLine>
    <cbc:ID>1</cbc:ID>
    <cbc:InvoicedQuantity unitCode="KWH">325.2</cbc:InvoicedQuantity>
    <cbc:LineExtensionAmount currencyID="NZD">129.04</cbc:LineExtensionAmount>
    <cac:Item>
      <cbc:Name>Adjustment - reverse prior Electricity charges - all day rate NMI 9000074677</cbc:Name>
      <cac:ClassifiedTaxCategory>
        <cbc:ID>S</cbc:ID>
        <cbc:Percent>15</cbc:Percent>
        <cac:TaxScheme>
          <cbc:ID>GST</cbc:ID>
        </cac:TaxScheme>
      </cac:ClassifiedTaxCategory>
    </cac:Item>
    <cac:Price>
      <cbc:PriceAmount currencyID="NZD">0.3968</cbc:PriceAmount>
    </cac:Price>
  </cac:InvoiceLine>
  <cac:InvoiceLine>
    <cbc:ID>2</cbc:ID>
    <cbc:InvoicedQuantity unitCode="DAY">31</cbc:InvoicedQuantity>
    <cbc:LineExtensionAmount currencyID="NZD">30.39</cbc:LineExtensionAmount>
    <cac:Item>
      <cbc:Name>Adjustment - reverse prior Supply charge</cbc:Name>
      <cac:ClassifiedTaxCategory>
        <cbc:ID>S</cbc:ID>
        <cbc:Percent>15</cbc:Percent>
        <cac:TaxScheme>
          <cbc:ID>GST</cbc:ID>
        </cac:TaxScheme>
      </cac:ClassifiedTaxCategory>
    </cac:Item>
    <cac:Price>
      <cbc:PriceAmount currencyID="NZD">0.9803</cbc:PriceAmount>
    </cac:Price>
  </cac:InvoiceLine>
</ubl:Invoice>
Rules
Rule ID Error Message
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-79 The value of the Invoice Type Code must be contained in Invoice Type Code [VRBL-CL-AUNZ-InvoiceTypeCode]. Allowed values: 261, 380, 381, 389.
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-71 The Tax Point Date and the Period Description Code are mutually exclusive.
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-3 The Buyer Reference or the Purchase Order Reference ID must be provided.
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-80 The Invoice expects a maximum of one Payment Terms.
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-4 An Invoice that contains Document Level Allowance Tax Category Code, Document Level Charge Tax Category Code or Invoiced Item Tax Category Code equal to "Exempt from Tax" must contain exactly one Tax Subtotal with the Tax Subtotal Category ID equal to "Exempt from Tax".
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-5 An Invoice that contains Document Level Allowance Tax Category Code, Document Level Charge Tax Category Code or Invoiced Item Tax Category Code equal to "Export" must contain exactly one Tax Subtotal with the Tax Subtotal Category ID equal to "Export".
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-6 An Invoice that contains Document Level Allowance Tax Category Code, Document Level Charge Tax Category Code or Invoiced Item Tax Category Code equal to "Not subject to tax" must contain exactly one Tax Subtotal with the Tax Subtotal Category ID equal to "Not subject to tax".
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-74 An Invoice that contains a Tax Subtotal where the Tax Category ID is "O", must not contain other Tax Subtotal.
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-7 An Invoice that contains Document Level Allowance Tax Category Code, Document Level Charge Tax Category Code or Invoiced Item Tax Category Code equal to "Zero rated" must contain exactly one Tax Subtotal with the Tax Subtotal Category ID equal to "Zero rated".
VRBL-INV-PEPPOL-PINT-AUNZ-1p0-78 An Invoice that contains Document Level Allowance Tax Category Code, Document Level Charge Tax Category Code or Invoiced Item Tax Category Code equal to "Standard" must contain Tax Subtotal with the Tax Subtotal Category ID equal to "Standard".
VRBL-INV-PEPPOL-PINT-1 The Specification Identifier must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-2 The Invoice Number must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-4 The Invoice Type Code must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-5 The Document Currency Code must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-6 The Seller Name must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-7 The Buyer Name must be provided in the Invoice.
VRBL-INV-PEPPOL-PINT-8 The Seller Postal Address must exist within the Invoice.
VRBL-INV-PEPPOL-PINT-9 The Buyer Postal Address must exist within the Invoice.
VRBL-INV-PEPPOL-PINT-15 The Invoice expects a maximum of one Additional Document Reference Group where Additional Document Reference Document Type Code is '130'.
VRBL-INV-PEPPOL-PINT-16 The Business Process Type must exist within the Invoice.
VRBL-INV-PEPPOL-PINT-17 The Tax Accounting Currency must be different from Document Currency Code when provided.
VRBL-INV-PEPPOL-PINT-18 Only one Project Reference is allowed on document level.
VRBL-INV-PEPPOL-PINT-19 If Despatch Advice Reference exists then there must not be Despatch Advice Reference on document level.
VRBL-INV-PEPPOL-PINT-20 The Invoice expects a maximum of one Contract Reference ID.
VRBL-INV-PEPPOL-PINT-21 The Invoice expects a maximum of one Receiving Advice Reference ID.
VRBL-INV-PEPPOL-PINT-22 The Invoice expects a maximum of one Despatch Advice Reference ID.
VRBL-INV-PEPPOL-PINT-23 The Invoice expects a maximum of one Invoicing Period.
VRBL-INV-PEPPOL-PINT-24 The Invoice expects a maximum of one Delivery Information.
VRBL-INV-PEPPOL-PINT-28 The Invoice expects a maximum of one Project Reference ID.
VRBL-INV-PEPPOL-PINT-29 The Invoice expects a maximum of one Invoice Note.
VRBL-INV-PEPPOL-PINT-30 The Invoice expects a maximum of one Tender Or Lot Reference ID.
VRBL-INV-PEPPOL-PINT-31 The Invoice expects a maximum of one Payment Terms Instructions ID.
VRBL-INV-PEPPOL-PINT-32 The Invoice expects a maximum of one Payment Terms Note.
VRBL-INV-PEPPOL-PINT-33 The Invoice Issue Time must be formatted HH:MM:SS or HH:MM:SSS.
VRBL-INV-PEPPOL-PINT-89 The Invoice Total Tax Amount in Tax Accounting Currency and the Invoice Total Tax Amount must have the same operational sign.
VRBL-INV-CORE-4 The Specification Identifier must exist within the Invoice.
VRBL-INV-CORE-5 The Business Process Type must exist within the Invoice.
VRBL-INV-CORE-10 The Invoice Type Code must exist within the Invoice.
VRBL-INV-CORE-13 The Document Currency Code must exist within the Invoice.
VRBL-INV-CORE-563 The Tax Total Group is only allowed when using the currencies in Document Currency Code or Tax Accounting Currency.
VRBL-INV-CORE-36 The Invoice Number must be provided in the Invoice.
VRBL-INV-CORE-39 The Document Currency Code must be provided in the Invoice.
VRBL-INV-CORE-41 The Invoice Total Tax Amount and the Invoice Total Tax Amount in Tax Accounting Currency must all both positive, or all negative.
VRBL-INV-SYSTEM-1 If there is a value for Invoice Number, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-2 If there is a value for Invoice Type Code, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-3 If there is a value for Document Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-4 If there is a value for Buyer Accounting Reference, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-5 If there is a value for Buyer Reference, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-6 If there is a value for Seller Trading Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-7 If there is a value for Seller Tax ID used as DUNS, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-8 If there is a value for Seller Tax ID used as VAT ID, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-9 If there is a value for Seller City, the allowed maximum number of characters is 200.
VRBL-INV-SYSTEM-10 If there is a value for Seller Country Code, the allowed maximum number of characters is 50.
VRBL-INV-SYSTEM-11 If there is a value for Seller Postal Zone, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-12 If there is a value for Seller Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-13 If there is a value for Seller Contact Point, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-14 If there is a value for Seller Contact Telephone Number, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-15 If there is a value for Seller Contact Email Address, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-16 If there is a value for Seller Electronic Address, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-17 If there is a value for Buyer Trading Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-18 If there is a value for Buyer Tax ID used as DUNS, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-19 If there is a value for Buyer Tax ID used as VAT ID, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-20 If there is a value for Buyer City, the allowed maximum number of characters is 200.
VRBL-INV-SYSTEM-21 If there is a value for Buyer Country Code, the allowed maximum number of characters is 50.
VRBL-INV-SYSTEM-22 If there is a value for Buyer Postal Zone, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-23 If there is a value for Buyer Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-24 If there is a value for Buyer Contact Point, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-25 If there is a value for Buyer Contact Email Address, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-26 If there is a value for Buyer Contact Telephone Number, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-27 If there is a value for Buyer Electronic Address, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-28 If there is a value for Buyer Customer Party Name Group, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-29 If there is a value for Buyer Customer Party Tax Company ID used as DUNS, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-30 If there is a value for Buyer Customer Party Tax Company ID used as VAT ID, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-31 If there is a value for Buyer Customer Party City Name, the allowed maximum number of characters is 200.
VRBL-INV-SYSTEM-32 If there is a value for Buyer Customer Party Country Identification Code, the allowed maximum number of characters is 50.
VRBL-INV-SYSTEM-33 If there is a value for Buyer Customer Party Postal Zone, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-34 If there is a value for Buyer Customer Party Legal Entity Registration Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-35 If there is a value for Buyer Customer Party Contact Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-36 If there is a value for Buyer Customer Party Contact Electronic Mail, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-37 If there is a value for Buyer Customer Party Contact Telephone, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-38 If there is a value for Buyer Customer Party Endpoint ID, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-39 If there is a value for Tax Subtotal Taxable Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-40 If there is a value for Total Tax Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-41 If there is a value for Tax Subtotal Category ID, the allowed maximum number of characters is 50.
VRBL-INV-SYSTEM-42 If there is a value for Legal Monetary Total Line Extension Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-43 If there is a value for Legal Monetary Total Tax Exclusive Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-44 If there is a value for Legal Monetary Total Tax Inclusive Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-45 If there is a value for Legal Monetary Total Payable Amount Currency Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-46 If there is a value for Delivery Location City, the allowed maximum number of characters is 200.
VRBL-INV-SYSTEM-47 If there is a value for Delivery Location Postal Zone, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-48 If there is a value for Delivery Location Country Code, the allowed maximum number of characters is 50.
VRBL-INV-SYSTEM-49 If there is a value for Delivery Party Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-50 If there is a value for Payment Means Type Code, the allowed maximum number of characters is 25.
VRBL-INV-SYSTEM-51 If there is a value for Payment Account ID, the allowed maximum number of characters is 100.
VRBL-INV-SYSTEM-52 If there is a value for Payment Account Name, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-53 If there is a value for Payment Service Provider ID, the allowed maximum number of characters is 500.
VRBL-INV-SYSTEM-54 If there is a value for Purchase Order Reference ID, the allowed maximum number of characters is 300.
VRBL-INV-SYSTEM-55 If there is a value for Sales Order Reference ID, the allowed maximum number of characters is 300.