Peppol

Invoice

Changes to generic fields

type Invoice {
  // ...all generic invoice fields
  dueDate: string;
  salesOrderRef?: string;
  purchaseOrderRef?: string;
  lines: [
    { 
      // ...other line item fields
      unit: UnitsOfMeasure;
      vat:{
       code: VatCodeUNTDID;
       exemptReason?: string;
      }
    }
  ];
  sender?: {
    // ...other sender fields 
    taxRepresentative?:{
      name:string;
      taxId: string;
      address: {
        country: string;
      }
    }
  };
  recipient:{
    peppolId: {
      endpointId: string;
    };
    taxRepresentative?:{
      name:string;
      taxId: string;
      address: {
        country: string;
      }
    }
  };
  shipToParty?:{
    name: string;
    taxId: string;
    address:{
      line1: string;
      line2: string;
      city: string;
      state: string;
      country: string;
      postalCode: string;
    }
  };
  paymentMeans?: [{
    ref: string;
    code: string;
    account: {
      iban?: string;
      number?: string;
      name: string;
      branch: string;
    };
    card: {
      pan: string;
      network: string;
      holderName: string;
    };
    directDebit: {
      id: string;
      ref: string;
    };
    other: {};
  }];
  attachments?: Attachment[];
  notes?: string;
};

type Attachment {
  name: string;
  contentType: 'application/pdf' | 'image/png' | 'image/jpeg' | 'text/csv' | 
               'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' |
               'application/vnd.oasis.opendocument.spreadsheet' ;
  data: string;
};

Field information

NameTypeRequiredDescription
duestring (ISO 8601 date)NoDeprecated in favour of "dueDate"
dueDatestring (ISO 8601 date)YesDue date of invoice
lines[].unitstringYesA value from an enumerated list as outlined on Units of Measure
lines[].vat.codestringYesA value from an enumerated list as outlined on VAT code classification (UNTDID 5305)
lines[].vat.exemptReasonstringConditionalIf the line VAT amount is 0, an exemption reason is required.
recipient.address.line1stringYesAddress line 1 (Street address/PO Box/Company name).
recipient.address.line2stringYesAddress line 2 (Apartment/Suite/Unit/Building).
recipient.address.citystringYesCity/District/Suburb/Town/Village.
recipient.address.statestringYesState/County/Province/Region.
recipient.address.countrystringYesThree-letter country code (ISO 3166-1 alpha-3)
recipient.address.postalCodestringYesZIP or postal code
recipient.peppolId.endpointIdstringYesPeppol ID of the recipient
recipient.taxRepresentativeObjectNoFor instances where a third-party tax representative is used.
recipient.taxRepresentative.namestringYesName of Tax Representative
recipient.taxRepresentative.taxIdstringYesTax ID of Tax Representative
recipient.taxRepresentative.address.countrystringYesCountry of Tax Representative
salesOrderRefstringNoSales order reference. An identifier of a referenced sales order, issued by the Seller.
purchaseOrderRefstringNoPurchase order reference. An identifier of a referenced purchase order, issued by the Buyer.
shipToPartyObjectNoFor instances where the ship-to party details differ and need to be explicitly stated.
shipToParty.namestringNoThe name of the party to which the goods and services are delivered.
shipToParty.taxIdstringNoTIN of the shipping recipient assigned by IRBM
shipToParty.address.line1stringNoDeliver to address line 1. The main address line in an address.
shipToParty.address.line2stringNoDeliver to address line 2. An additional address line in an address that can be used to give further details supplementing the main line.
shipToParty.address.citystringNoDeliver to city. The common name of the city, town or village, where the deliver to address is located.
shipToParty.address.statestringNoDeliver to country subdivision. The subdivision of a country.
shipToParty.address.countrystringNoDeliver to country code. A code that identifies the country.
shipToParty.address.postalCodestringNoDeliver to post code. The identifier for an addressable group of properties according to the relevant postal service.
paymentMeansObject ArrayNoFor instances where the payment means need to be explicitly stated.
paymentMeans.refstringNoRemittance information
A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process.
paymentMeans.codestringNoPayment means type code
The means, expressed as code, for how a payment is expected to be or has been settled.
paymentMeans.account.ibanstringNoIBAN Payment account identifier
A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. This would be used instead of account.number when provided.
paymentMeans.account.numberstringNoPayment account identifier
A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. This will only be used if when no IBAN number was specified.
paymentMeans.account.namestringNoPayment account name
The name of the payment account, at a payment service provider, to which payment should be made.
paymentMeans.account.branchstringNoThe branch identifier for the payment service provider where a payment account is located.
paymentMeans.card.panstringNo

Payment card primary account number
The Primary Account Number (PAN) of the card used for payment. In accordance with card payments security standards, an invoice should never include a full card primary account number.

Example: ****8400

paymentMeans.card.networkstringNoCard network like Visa or Mastercard
paymentMeans.card.holderNamestringNoPayment card holder name
The name of the payment card holder.
paymentMeans.directDebit.idstringNoMandate reference identifier
Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit.
paymentMeans.otherstringNoOther payment means details
attachmentsObject ArrayNoArray of attachment objects
attachment.namestringYesFile Name
attachment.contentTypestringYesFile MIME type. Allowed values include:
application/pdf
image/png
image/jpeg
text/csv
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.oasis.opendocument.spreadsheet
attachment.datastringYesBase64 encoded file content with a maximum size of 1MB
notesstringNoAny applicable or additional notes

Example CSV file

Invoice - Peppol.csv