Skip to content
/
✏️ Update a draft invoice

Seqino PDP API (1.0.0)

Seqino PDP API - Modern interface to France's e-Invoicing services

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://pdp.seqino.dev/
Languages
Servers
Dev server
https://pdp.seqino.dev/api
Local development server
http://localhost:8052

👥 Clients

Operations

📋 Mandates

Operations

📝 Drafts

Operations

🆕 Create invoice draft from EN16931-compatible JSON

Request

Create a new invoice draft from EN16931-compatible JSON data.

This endpoint allows you to create a draft invoice that can be validated and refined before final submission. Drafts support partial data and can be updated multiple times before validation.

Security
APIKeyHeader
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
Bodyapplication/jsonrequired
specification_identifierstring(Specification Identifier)

Specification identifier (BT-24) - Peppol BIS 3.0 or French CIUS

Default "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
issue_datestring(date)(Issue Date)required

Invoice issue date (BT-2)

due_dateDue Date (string) or Due Date (null)(Due Date)

Payment due date (BT-9)

Any of:

Payment due date (BT-9)

string(date)(Due Date)
type_codestring(InvoiceTypeCode)required

Invoice type code (BT-3)

Enum"380""381""383""384"
currency_codestring(Currency Code)required

Invoice currency code (BT-5) - ISO 4217

tax_point_dateTax Point Date (string) or Tax Point Date (null)(Tax Point Date)

Tax point date (BT-7)

Any of:

Tax point date (BT-7)

string(date)(Tax Point Date)
value_added_tax_point_dateValue Added Tax Point Date (string) or Value Added Tax Point Date (null)(Value Added Tax Point Date)

Value added tax point date (BT-8)

Any of:

Value added tax point date (BT-8)

string(date)(Value Added Tax Point Date)
business_process_typeBusiness Process Type (string) or Business Process Type (null)(Business Process Type)

Business process type (BT-23)

Any of:

Business process type (BT-23)

string(Business Process Type)
buyer_referenceBuyer Reference (string) or Buyer Reference (null)(Buyer Reference)

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

Any of:

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

string(Buyer Reference)
purchase_order_referencePurchase Order Reference (string) or Purchase Order Reference (null)(Purchase Order Reference)

Purchase order reference (BT-13)

Any of:

Purchase order reference (BT-13)

string(Purchase Order Reference)
sales_order_referenceSales Order Reference (string) or Sales Order Reference (null)(Sales Order Reference)

Sales order reference (BT-14)

Any of:

Sales order reference (BT-14)

string(Sales Order Reference)
receiving_advice_referenceReceiving Advice Reference (string) or Receiving Advice Reference (null)(Receiving Advice Reference)

Receiving advice reference (BT-15)

Any of:

Receiving advice reference (BT-15)

string(Receiving Advice Reference)
despatch_advice_referenceDespatch Advice Reference (string) or Despatch Advice Reference (null)(Despatch Advice Reference)

Despatch advice reference (BT-16)

Any of:

Despatch advice reference (BT-16)

string(Despatch Advice Reference)
tender_or_lot_referenceTender Or Lot Reference (string) or Tender Or Lot Reference (null)(Tender Or Lot Reference)

Tender or lot reference (BT-17)

Any of:

Tender or lot reference (BT-17)

string(Tender Or Lot Reference)
invoice_object_identifierInvoice Object Identifier (string) or Invoice Object Identifier (null)(Invoice Object Identifier)

Invoiced object identifier (BT-18)

Any of:

Invoiced object identifier (BT-18)

string(Invoice Object Identifier)
buyer_accounting_referenceBuyer Accounting Reference (string) or Buyer Accounting Reference (null)(Buyer Accounting Reference)

Buyer accounting reference (BT-19)

Any of:

Buyer accounting reference (BT-19)

string(Buyer Accounting Reference)
project_referenceProject Reference (string) or Project Reference (null)(Project Reference)

Project reference (BT-11)

Any of:

Project reference (BT-11)

string(Project Reference)
contract_referenceContract Reference (string) or Contract Reference (null)(Contract Reference)

Contract reference (BT-12)

Any of:

Contract reference (BT-12)

string(Contract Reference)
sellerobject(Seller)required

Seller party information (BG-4)

seller.​namestring(Name)required

Party name

seller.​postal_addressobject(models__invoicing__Address)required
seller.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
seller.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
seller.​postal_address.​city_namestring(City Name)required
seller.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
seller.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
seller.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

seller.​electronic_addressElectronicAddress (object) or null
Any of:
seller.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
seller.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
seller.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
seller.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
seller.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
seller.​seller_identifierSeller Identifier (string) or Seller Identifier (null)(Seller Identifier)

Seller identifier (BT-29)

Any of:

Seller identifier (BT-29)

string(Seller Identifier)
seller.​seller_identifier_schemeSeller Identifier Scheme (string) or Seller Identifier Scheme (null)(Seller Identifier Scheme)

Seller identifier scheme (BT-30)

Any of:

Seller identifier scheme (BT-30)

string(Seller Identifier Scheme)
seller.​seller_vat_identifierSeller Vat Identifier (string) or Seller Vat Identifier (null)(Seller Vat Identifier)

Seller VAT identifier (BT-31)

Any of:

Seller VAT identifier (BT-31)

string(Seller Vat Identifier)
seller.​seller_tax_registration_identifierSeller Tax Registration Identifier (string) or Seller Tax Registration Identifier (null)(Seller Tax Registration Identifier)

Seller tax registration identifier (BT-32)

Any of:

Seller tax registration identifier (BT-32)

string(Seller Tax Registration Identifier)
seller.​seller_additional_legal_informationSeller Additional Legal Information (string) or Seller Additional Legal Information (null)(Seller Additional Legal Information)

Seller additional legal information (BT-33)

Any of:

Seller additional legal information (BT-33)

string(Seller Additional Legal Information)
buyerobject(Buyer)required

Buyer party information (BG-7)

buyer.​namestring(Name)required

Party name

buyer.​postal_addressobject(models__invoicing__Address)required
buyer.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
buyer.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
buyer.​postal_address.​city_namestring(City Name)required
buyer.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
buyer.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
buyer.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

buyer.​electronic_addressElectronicAddress (object) or null
Any of:
buyer.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
buyer.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
buyer.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
buyer.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
buyer.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
buyer.​buyer_identifierBuyer Identifier (string) or Buyer Identifier (null)(Buyer Identifier)

Buyer identifier (BT-46)

Any of:

Buyer identifier (BT-46)

string(Buyer Identifier)
buyer.​buyer_identifier_schemeBuyer Identifier Scheme (string) or Buyer Identifier Scheme (null)(Buyer Identifier Scheme)

Buyer identifier scheme (BT-47)

Any of:

Buyer identifier scheme (BT-47)

string(Buyer Identifier Scheme)
buyer.​buyer_legal_registration_identifierBuyer Legal Registration Identifier (string) or Buyer Legal Registration Identifier (null)(Buyer Legal Registration Identifier)

Buyer legal registration identifier (BT-47)

Any of:

Buyer legal registration identifier (BT-47)

string(Buyer Legal Registration Identifier)
buyer.​buyer_vat_identifierBuyer Vat Identifier (string) or Buyer Vat Identifier (null)(Buyer Vat Identifier)

Buyer VAT identifier (BT-48)

Any of:

Buyer VAT identifier (BT-48)

string(Buyer Vat Identifier)
invoice_linesArray of objects(Invoice Lines)non-emptyrequired

Invoice lines (BG-25)

invoice_lines[].​line_idstring(Line Id)required

Invoice line identifier

invoice_lines[].​invoiced_quantityInvoiced Quantity (number) or Invoiced Quantity (string)(Invoiced Quantity)required

Invoiced quantity

Any of:

Invoiced quantity

number(Invoiced Quantity)
invoice_lines[].​unit_of_measurestring(Unit Of Measure)required

Unit of measure code (BT-130) - Must be valid UN/ECE Recommendation 20 code (BR-CL-23). Common codes: C62 (unit/piece), HUR (hour), DAY (day), MON (month), MTR (meter), KGM (kilogram), LTR (liter)

invoice_lines[].​line_net_amountLine Net Amount (number) or Line Net Amount (string)(Line Net Amount)required

Invoice line net amount

Any of:

Invoice line net amount

number(Line Net Amount)
invoice_lines[].​item_namestring(Item Name)required

Item name

invoice_lines[].​item_descriptionItem Description (string) or Item Description (null)(Item Description)
Any of:
string(Item Description)
invoice_lines[].​item_priceItem Price (number) or Item Price (string)(Item Price)required

Item net price

Any of:

Item net price

number(Item Price)
invoice_lines[].​vat_category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
invoice_lines[].​vat_rateVat Rate (number) or Vat Rate (string) or Vat Rate (null)(Vat Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Vat Rate)
vat_breakdownsArray of objects(Vat Breakdowns)required

VAT breakdown (BG-23)

vat_breakdowns[].​category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
vat_breakdowns[].​rateRate (number) or Rate (string) or Rate (null)(Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Rate)
vat_breakdowns[].​taxable_amountTaxable Amount (number) or Taxable Amount (string)(Taxable Amount)required

VAT taxable amount

Any of:

VAT taxable amount

number(Taxable Amount)
vat_breakdowns[].​tax_amountTax Amount (number) or Tax Amount (string)(Tax Amount)required

VAT amount

Any of:

VAT amount

number(Tax Amount)
vat_breakdowns[].​exemption_reasonExemption Reason (string) or Exemption Reason (null)(Exemption Reason)
Any of:
string(Exemption Reason)
document_totalsobject(DocumentTotals-Input)required

Document level totals (BG-22)

document_totals.​sum_of_line_net_amountsSum Of Line Net Amounts (number) or Sum Of Line Net Amounts (string)(Sum Of Line Net Amounts)required

Sum of Invoice line net amount (BT-106)

Any of:

Sum of Invoice line net amount (BT-106)

number(Sum Of Line Net Amounts)
document_totals.​sum_of_allowancesSum Of Allowances (number) or Sum Of Allowances (string) or Sum Of Allowances (null)(Sum Of Allowances)

Sum of allowances on document level

Any of:

Sum of allowances on document level

number(Sum Of Allowances)
document_totals.​sum_of_chargesSum Of Charges (number) or Sum Of Charges (string) or Sum Of Charges (null)(Sum Of Charges)

Sum of charges on document level

Any of:

Sum of charges on document level

number(Sum Of Charges)
document_totals.​invoice_total_without_vatInvoice Total Without Vat (number) or Invoice Total Without Vat (string)(Invoice Total Without Vat)required

Invoice total amount without VAT (BT-109)

Any of:

Invoice total amount without VAT (BT-109)

number(Invoice Total Without Vat)
document_totals.​invoice_total_vat_amountInvoice Total Vat Amount (number) or Invoice Total Vat Amount (string)(Invoice Total Vat Amount)required

Invoice total VAT amount (BT-110)

Any of:

Invoice total VAT amount (BT-110)

number(Invoice Total Vat Amount)
document_totals.​invoice_total_with_vatInvoice Total With Vat (number) or Invoice Total With Vat (string)(Invoice Total With Vat)required

Invoice total amount with VAT (BT-112)

Any of:

Invoice total amount with VAT (BT-112)

number(Invoice Total With Vat)
document_totals.​paid_amountPaid Amount (number) or Paid Amount (string) or Paid Amount (null)(Paid Amount)

Paid amount

Any of:

Paid amount

number(Paid Amount)
document_totals.​rounding_amountRounding Amount (number) or Rounding Amount (string) or Rounding Amount (null)(Rounding Amount)

Rounding amount

Any of:

Rounding amount

number(Rounding Amount)
document_totals.​amount_due_for_paymentAmount Due For Payment (number) or Amount Due For Payment (string)(Amount Due For Payment)required

Amount due for payment (BT-115)

Any of:

Amount due for payment (BT-115)

number(Amount Due For Payment)
payment_termsPaymentTerms (object) or null

Payment instructions (BG-16)

Any of:

Payment instructions (BG-16)

notesArray of Notes (objects) or Notes (null)(Notes)

Invoice notes with optional subject codes (BT-22)

Any of:

Invoice notes with optional subject codes (BT-22)

order_referenceOrder Reference (string) or Order Reference (null)(Order Reference)

Deprecated: use purchase_order_reference instead

Any of:

Deprecated: use purchase_order_reference instead

string(Order Reference)
invoice_noteInvoice Note (string) or Invoice Note (null)(Invoice Note)

Deprecated: use notes instead. Invoice note (BT-22)

Any of:

Deprecated: use notes instead. Invoice note (BT-22)

string(Invoice Note)
preceding_invoice_referencePreceding Invoice Reference (string) or Preceding Invoice Reference (null)(Preceding Invoice Reference)

For credit notes - reference to original invoice (BT-25)

Any of:

For credit notes - reference to original invoice (BT-25)

string(Preceding Invoice Reference)
curl -i -X POST \
  https://pdp.seqino.dev/api/drafts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "specification_identifier": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
    "issue_date": "2024-01-15",
    "due_date": "2024-02-15",
    "type_code": "380",
    "currency_code": "EUR",
    "buyer_reference": "BR-2024-001",
    "purchase_order_reference": "PO-2024-456",
    "seller": {
      "name": "Seqino",
      "postal_address": {
        "street_name": "123 Rue de la République",
        "city_name": "Paris",
        "postal_zone": "75001",
        "country_code": "FR"
      },
      "electronic_address": {
        "scheme_id": "0225",
        "value": "123456789"
      },
      "tax_registrations": [
        {
          "scheme_id": "VAT",
          "value": "FR12345678901"
        }
      ],
      "legal_registration_name": "Seqino",
      "trading_name": "Seqino Corp",
      "seller_identifier": "SELLER123",
      "seller_identifier_scheme": "GLN",
      "seller_vat_identifier": "FR12345678901",
      "seller_tax_registration_identifier": "SIRET12345678901234",
      "seller_additional_legal_information": "Société par actions simplifiée au capital de 100 000 EUR"
    },
    "buyer": {
      "name": "Example BVBA",
      "postal_address": {
        "street_name": "Avenue Louise 123",
        "city_name": "Brussels",
        "postal_zone": "1050",
        "country_code": "BE"
      },
      "electronic_address": {
        "scheme_id": "0208",
        "value": "0987654394"
      },
      "tax_registrations": [
        {
          "scheme_id": "VAT",
          "value": "BE0987654394"
        }
      ],
      "legal_registration_name": "Example BVBA",
      "buyer_identifier": "BUYER456",
      "buyer_identifier_scheme": "GLN",
      "buyer_legal_registration_identifier": "0987654394",
      "buyer_vat_identifier": "BE0987654394"
    },
    "invoice_lines": [
      {
        "line_id": "1",
        "invoiced_quantity": 10,
        "unit_of_measure": "C62",
        "line_net_amount": 1000,
        "item_name": "Software License",
        "item_description": "Enterprise software license for 12 months",
        "item_price": 100,
        "vat_category_code": "S",
        "vat_rate": 20
      },
      {
        "line_id": "2",
        "invoiced_quantity": 5,
        "unit_of_measure": "HUR",
        "line_net_amount": 500,
        "item_name": "Consulting Services",
        "item_description": "Technical consulting and support",
        "item_price": 100,
        "vat_category_code": "S",
        "vat_rate": 20
      }
    ],
    "vat_breakdowns": [
      {
        "category_code": "S",
        "rate": 20,
        "taxable_amount": 1500,
        "tax_amount": 300
      }
    ],
    "document_totals": {
      "sum_of_line_net_amounts": 1500,
      "invoice_total_without_vat": 1500,
      "invoice_total_vat_amount": 300,
      "invoice_total_with_vat": 1800,
      "amount_due_for_payment": 1800
    },
    "payment_terms": {
      "description": "Payment due within 30 days",
      "due_date": "2024-02-15"
    },
    "invoice_note": "Sample draft for demonstration purposes"
  }'

Responses

Successful Response

Bodyapplication/json
draft_idstring(Draft Id)required
statusstring(InvoiceStatus)required
Enum"draft""submitted""validated""rejected""processed"
created_atstring(date-time)(Created At)required
Response
application/json
{
  "draft_id": "string",
  "status": "draft",
  "created_at": "2019-08-24T14:15:22Z"
}

📄 Get details of a draft invoice

Request

Get the details of a specific draft invoice.

Returns the complete draft data including all fields and their current values. This is useful for retrieving draft state before making updates.

Security
APIKeyHeader
Path
draft_idstring(Draft Id)required
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
curl -i -X GET \
  'https://pdp.seqino.dev/api/drafts/{draft_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/json
specification_identifierstring(Specification Identifier)

Specification identifier (BT-24) - Peppol BIS 3.0 or French CIUS

Default "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
issue_datestring(date)(Issue Date)required

Invoice issue date (BT-2)

due_dateDue Date (string) or Due Date (null)(Due Date)

Payment due date (BT-9)

Any of:

Payment due date (BT-9)

string(date)(Due Date)
type_codestring(InvoiceTypeCode)required

Invoice type code (BT-3)

Enum"380""381""383""384"
currency_codestring(Currency Code)required

Invoice currency code (BT-5) - ISO 4217

tax_point_dateTax Point Date (string) or Tax Point Date (null)(Tax Point Date)

Tax point date (BT-7)

Any of:

Tax point date (BT-7)

string(date)(Tax Point Date)
value_added_tax_point_dateValue Added Tax Point Date (string) or Value Added Tax Point Date (null)(Value Added Tax Point Date)

Value added tax point date (BT-8)

Any of:

Value added tax point date (BT-8)

string(date)(Value Added Tax Point Date)
business_process_typeBusiness Process Type (string) or Business Process Type (null)(Business Process Type)

Business process type (BT-23)

Any of:

Business process type (BT-23)

string(Business Process Type)
buyer_referenceBuyer Reference (string) or Buyer Reference (null)(Buyer Reference)

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

Any of:

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

string(Buyer Reference)
purchase_order_referencePurchase Order Reference (string) or Purchase Order Reference (null)(Purchase Order Reference)

Purchase order reference (BT-13)

Any of:

Purchase order reference (BT-13)

string(Purchase Order Reference)
sales_order_referenceSales Order Reference (string) or Sales Order Reference (null)(Sales Order Reference)

Sales order reference (BT-14)

Any of:

Sales order reference (BT-14)

string(Sales Order Reference)
receiving_advice_referenceReceiving Advice Reference (string) or Receiving Advice Reference (null)(Receiving Advice Reference)

Receiving advice reference (BT-15)

Any of:

Receiving advice reference (BT-15)

string(Receiving Advice Reference)
despatch_advice_referenceDespatch Advice Reference (string) or Despatch Advice Reference (null)(Despatch Advice Reference)

Despatch advice reference (BT-16)

Any of:

Despatch advice reference (BT-16)

string(Despatch Advice Reference)
tender_or_lot_referenceTender Or Lot Reference (string) or Tender Or Lot Reference (null)(Tender Or Lot Reference)

Tender or lot reference (BT-17)

Any of:

Tender or lot reference (BT-17)

string(Tender Or Lot Reference)
invoice_object_identifierInvoice Object Identifier (string) or Invoice Object Identifier (null)(Invoice Object Identifier)

Invoiced object identifier (BT-18)

Any of:

Invoiced object identifier (BT-18)

string(Invoice Object Identifier)
buyer_accounting_referenceBuyer Accounting Reference (string) or Buyer Accounting Reference (null)(Buyer Accounting Reference)

Buyer accounting reference (BT-19)

Any of:

Buyer accounting reference (BT-19)

string(Buyer Accounting Reference)
project_referenceProject Reference (string) or Project Reference (null)(Project Reference)

Project reference (BT-11)

Any of:

Project reference (BT-11)

string(Project Reference)
contract_referenceContract Reference (string) or Contract Reference (null)(Contract Reference)

Contract reference (BT-12)

Any of:

Contract reference (BT-12)

string(Contract Reference)
sellerobject(Seller)required

Seller party information (BG-4)

seller.​namestring(Name)required

Party name

seller.​postal_addressobject(models__invoicing__Address)required
seller.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
seller.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
seller.​postal_address.​city_namestring(City Name)required
seller.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
seller.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
seller.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

seller.​electronic_addressElectronicAddress (object) or null
Any of:
seller.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
seller.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
seller.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
seller.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
seller.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
seller.​seller_identifierSeller Identifier (string) or Seller Identifier (null)(Seller Identifier)

Seller identifier (BT-29)

Any of:

Seller identifier (BT-29)

string(Seller Identifier)
seller.​seller_identifier_schemeSeller Identifier Scheme (string) or Seller Identifier Scheme (null)(Seller Identifier Scheme)

Seller identifier scheme (BT-30)

Any of:

Seller identifier scheme (BT-30)

string(Seller Identifier Scheme)
seller.​seller_vat_identifierSeller Vat Identifier (string) or Seller Vat Identifier (null)(Seller Vat Identifier)

Seller VAT identifier (BT-31)

Any of:

Seller VAT identifier (BT-31)

string(Seller Vat Identifier)
seller.​seller_tax_registration_identifierSeller Tax Registration Identifier (string) or Seller Tax Registration Identifier (null)(Seller Tax Registration Identifier)

Seller tax registration identifier (BT-32)

Any of:

Seller tax registration identifier (BT-32)

string(Seller Tax Registration Identifier)
seller.​seller_additional_legal_informationSeller Additional Legal Information (string) or Seller Additional Legal Information (null)(Seller Additional Legal Information)

Seller additional legal information (BT-33)

Any of:

Seller additional legal information (BT-33)

string(Seller Additional Legal Information)
buyerobject(Buyer)required

Buyer party information (BG-7)

buyer.​namestring(Name)required

Party name

buyer.​postal_addressobject(models__invoicing__Address)required
buyer.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
buyer.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
buyer.​postal_address.​city_namestring(City Name)required
buyer.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
buyer.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
buyer.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

buyer.​electronic_addressElectronicAddress (object) or null
Any of:
buyer.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
buyer.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
buyer.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
buyer.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
buyer.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
buyer.​buyer_identifierBuyer Identifier (string) or Buyer Identifier (null)(Buyer Identifier)

Buyer identifier (BT-46)

Any of:

Buyer identifier (BT-46)

string(Buyer Identifier)
buyer.​buyer_identifier_schemeBuyer Identifier Scheme (string) or Buyer Identifier Scheme (null)(Buyer Identifier Scheme)

Buyer identifier scheme (BT-47)

Any of:

Buyer identifier scheme (BT-47)

string(Buyer Identifier Scheme)
buyer.​buyer_legal_registration_identifierBuyer Legal Registration Identifier (string) or Buyer Legal Registration Identifier (null)(Buyer Legal Registration Identifier)

Buyer legal registration identifier (BT-47)

Any of:

Buyer legal registration identifier (BT-47)

string(Buyer Legal Registration Identifier)
buyer.​buyer_vat_identifierBuyer Vat Identifier (string) or Buyer Vat Identifier (null)(Buyer Vat Identifier)

Buyer VAT identifier (BT-48)

Any of:

Buyer VAT identifier (BT-48)

string(Buyer Vat Identifier)
invoice_linesArray of objects(Invoice Lines)non-emptyrequired

Invoice lines (BG-25)

invoice_lines[].​line_idstring(Line Id)required

Invoice line identifier

invoice_lines[].​invoiced_quantitystring(Invoiced Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Invoiced quantity

invoice_lines[].​unit_of_measurestring(Unit Of Measure)required

Unit of measure code (BT-130) - Must be valid UN/ECE Recommendation 20 code (BR-CL-23). Common codes: C62 (unit/piece), HUR (hour), DAY (day), MON (month), MTR (meter), KGM (kilogram), LTR (liter)

invoice_lines[].​line_net_amountstring(Line Net Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Invoice line net amount

invoice_lines[].​item_namestring(Item Name)required

Item name

invoice_lines[].​item_descriptionItem Description (string) or Item Description (null)(Item Description)
Any of:
string(Item Description)
invoice_lines[].​item_pricestring(Item Price)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Item net price

invoice_lines[].​vat_category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
invoice_lines[].​vat_rateVat Rate (string) or Vat Rate (null)(Vat Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

string(Vat Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
vat_breakdownsArray of objects(Vat Breakdowns)required

VAT breakdown (BG-23)

vat_breakdowns[].​category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
vat_breakdowns[].​rateRate (string) or Rate (null)(Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

string(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
vat_breakdowns[].​taxable_amountstring(Taxable Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

VAT taxable amount

vat_breakdowns[].​tax_amountstring(Tax Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

VAT amount

vat_breakdowns[].​exemption_reasonExemption Reason (string) or Exemption Reason (null)(Exemption Reason)
Any of:
string(Exemption Reason)
document_totalsobject(DocumentTotals-Output)required

Document level totals (BG-22)

document_totals.​sum_of_line_net_amountsstring(Sum Of Line Net Amounts)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Sum of Invoice line net amount (BT-106)

document_totals.​sum_of_allowancesSum Of Allowances (string) or Sum Of Allowances (null)(Sum Of Allowances)

Sum of allowances on document level

Any of:

Sum of allowances on document level

string(Sum Of Allowances)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
document_totals.​sum_of_chargesSum Of Charges (string) or Sum Of Charges (null)(Sum Of Charges)

Sum of charges on document level

Any of:

Sum of charges on document level

string(Sum Of Charges)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
document_totals.​invoice_total_without_vatstring(Invoice Total Without Vat)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Invoice total amount without VAT (BT-109)

document_totals.​invoice_total_vat_amountstring(Invoice Total Vat Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Invoice total VAT amount (BT-110)

document_totals.​invoice_total_with_vatstring(Invoice Total With Vat)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Invoice total amount with VAT (BT-112)

document_totals.​paid_amountPaid Amount (string) or Paid Amount (null)(Paid Amount)

Paid amount

Any of:

Paid amount

string(Paid Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
document_totals.​rounding_amountRounding Amount (string) or Rounding Amount (null)(Rounding Amount)

Rounding amount

Any of:

Rounding amount

string(Rounding Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
document_totals.​amount_due_for_paymentstring(Amount Due For Payment)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Amount due for payment (BT-115)

payment_termsPaymentTerms (object) or null

Payment instructions (BG-16)

Any of:

Payment instructions (BG-16)

notesArray of Notes (objects) or Notes (null)(Notes)

Invoice notes with optional subject codes (BT-22)

Any of:

Invoice notes with optional subject codes (BT-22)

order_referenceOrder Reference (string) or Order Reference (null)(Order Reference)

Deprecated: use purchase_order_reference instead

Any of:

Deprecated: use purchase_order_reference instead

string(Order Reference)
invoice_noteInvoice Note (string) or Invoice Note (null)(Invoice Note)

Deprecated: use notes instead. Invoice note (BT-22)

Any of:

Deprecated: use notes instead. Invoice note (BT-22)

string(Invoice Note)
preceding_invoice_referencePreceding Invoice Reference (string) or Preceding Invoice Reference (null)(Preceding Invoice Reference)

For credit notes - reference to original invoice (BT-25)

Any of:

For credit notes - reference to original invoice (BT-25)

string(Preceding Invoice Reference)
Response
application/json
{
  "specification_identifier": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
  "issue_date": "2019-08-24",
  "due_date": "2019-08-24",
  "type_code": "380",
  "currency_code": "string",
  "tax_point_date": "2019-08-24",
  "value_added_tax_point_date": "2019-08-24",
  "business_process_type": "string",
  "buyer_reference": "string",
  "purchase_order_reference": "string",
  "sales_order_reference": "string",
  "receiving_advice_reference": "string",
  "despatch_advice_reference": "string",
  "tender_or_lot_reference": "string",
  "invoice_object_identifier": "string",
  "buyer_accounting_reference": "string",
  "project_reference": "string",
  "contract_reference": "string",
  "seller": {
    "name": "string",
    "postal_address": { … },
    "electronic_address": { … },
    "tax_registrations": [ … ],
    "legal_registration_name": "string",
    "trading_name": "string",
    "party_identifier": "string",
    "party_identifier_scheme": "string",
    "seller_identifier": "string",
    "seller_identifier_scheme": "string",
    "seller_vat_identifier": "string",
    "seller_tax_registration_identifier": "string",
    "seller_additional_legal_information": "string"
  },
  "buyer": {
    "name": "string",
    "postal_address": { … },
    "electronic_address": { … },
    "tax_registrations": [ … ],
    "legal_registration_name": "string",
    "trading_name": "string",
    "party_identifier": "string",
    "party_identifier_scheme": "string",
    "buyer_identifier": "string",
    "buyer_identifier_scheme": "string",
    "buyer_legal_registration_identifier": "string",
    "buyer_vat_identifier": "string"
  },
  "invoice_lines": [
    { … }
  ],
  "vat_breakdowns": [
    { … }
  ],
  "document_totals": {
    "sum_of_line_net_amounts": "string",
    "sum_of_allowances": "string",
    "sum_of_charges": "string",
    "invoice_total_without_vat": "string",
    "invoice_total_vat_amount": "string",
    "invoice_total_with_vat": "string",
    "paid_amount": "string",
    "rounding_amount": "string",
    "amount_due_for_payment": "string"
  },
  "payment_terms": {
    "description": "string",
    "due_date": "2019-08-24"
  },
  "notes": [
    { … }
  ],
  "order_reference": "string",
  "invoice_note": "string",
  "preceding_invoice_reference": "string"
}

✏️ Update a draft invoice

Request

Update an existing draft invoice.

Completely replaces the draft content with the provided data. The draft will be re-validated after the update.

Security
APIKeyHeader
Path
draft_idstring(Draft Id)required
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
Bodyapplication/jsonrequired
specification_identifierstring(Specification Identifier)

Specification identifier (BT-24) - Peppol BIS 3.0 or French CIUS

Default "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
issue_datestring(date)(Issue Date)required

Invoice issue date (BT-2)

due_dateDue Date (string) or Due Date (null)(Due Date)

Payment due date (BT-9)

Any of:

Payment due date (BT-9)

string(date)(Due Date)
type_codestring(InvoiceTypeCode)required

Invoice type code (BT-3)

Enum"380""381""383""384"
currency_codestring(Currency Code)required

Invoice currency code (BT-5) - ISO 4217

tax_point_dateTax Point Date (string) or Tax Point Date (null)(Tax Point Date)

Tax point date (BT-7)

Any of:

Tax point date (BT-7)

string(date)(Tax Point Date)
value_added_tax_point_dateValue Added Tax Point Date (string) or Value Added Tax Point Date (null)(Value Added Tax Point Date)

Value added tax point date (BT-8)

Any of:

Value added tax point date (BT-8)

string(date)(Value Added Tax Point Date)
business_process_typeBusiness Process Type (string) or Business Process Type (null)(Business Process Type)

Business process type (BT-23)

Any of:

Business process type (BT-23)

string(Business Process Type)
buyer_referenceBuyer Reference (string) or Buyer Reference (null)(Buyer Reference)

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

Any of:

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

string(Buyer Reference)
purchase_order_referencePurchase Order Reference (string) or Purchase Order Reference (null)(Purchase Order Reference)

Purchase order reference (BT-13)

Any of:

Purchase order reference (BT-13)

string(Purchase Order Reference)
sales_order_referenceSales Order Reference (string) or Sales Order Reference (null)(Sales Order Reference)

Sales order reference (BT-14)

Any of:

Sales order reference (BT-14)

string(Sales Order Reference)
receiving_advice_referenceReceiving Advice Reference (string) or Receiving Advice Reference (null)(Receiving Advice Reference)

Receiving advice reference (BT-15)

Any of:

Receiving advice reference (BT-15)

string(Receiving Advice Reference)
despatch_advice_referenceDespatch Advice Reference (string) or Despatch Advice Reference (null)(Despatch Advice Reference)

Despatch advice reference (BT-16)

Any of:

Despatch advice reference (BT-16)

string(Despatch Advice Reference)
tender_or_lot_referenceTender Or Lot Reference (string) or Tender Or Lot Reference (null)(Tender Or Lot Reference)

Tender or lot reference (BT-17)

Any of:

Tender or lot reference (BT-17)

string(Tender Or Lot Reference)
invoice_object_identifierInvoice Object Identifier (string) or Invoice Object Identifier (null)(Invoice Object Identifier)

Invoiced object identifier (BT-18)

Any of:

Invoiced object identifier (BT-18)

string(Invoice Object Identifier)
buyer_accounting_referenceBuyer Accounting Reference (string) or Buyer Accounting Reference (null)(Buyer Accounting Reference)

Buyer accounting reference (BT-19)

Any of:

Buyer accounting reference (BT-19)

string(Buyer Accounting Reference)
project_referenceProject Reference (string) or Project Reference (null)(Project Reference)

Project reference (BT-11)

Any of:

Project reference (BT-11)

string(Project Reference)
contract_referenceContract Reference (string) or Contract Reference (null)(Contract Reference)

Contract reference (BT-12)

Any of:

Contract reference (BT-12)

string(Contract Reference)
sellerobject(Seller)required

Seller party information (BG-4)

seller.​namestring(Name)required

Party name

seller.​postal_addressobject(models__invoicing__Address)required
seller.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
seller.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
seller.​postal_address.​city_namestring(City Name)required
seller.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
seller.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
seller.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

seller.​electronic_addressElectronicAddress (object) or null
Any of:
seller.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
seller.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
seller.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
seller.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
seller.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
seller.​seller_identifierSeller Identifier (string) or Seller Identifier (null)(Seller Identifier)

Seller identifier (BT-29)

Any of:

Seller identifier (BT-29)

string(Seller Identifier)
seller.​seller_identifier_schemeSeller Identifier Scheme (string) or Seller Identifier Scheme (null)(Seller Identifier Scheme)

Seller identifier scheme (BT-30)

Any of:

Seller identifier scheme (BT-30)

string(Seller Identifier Scheme)
seller.​seller_vat_identifierSeller Vat Identifier (string) or Seller Vat Identifier (null)(Seller Vat Identifier)

Seller VAT identifier (BT-31)

Any of:

Seller VAT identifier (BT-31)

string(Seller Vat Identifier)
seller.​seller_tax_registration_identifierSeller Tax Registration Identifier (string) or Seller Tax Registration Identifier (null)(Seller Tax Registration Identifier)

Seller tax registration identifier (BT-32)

Any of:

Seller tax registration identifier (BT-32)

string(Seller Tax Registration Identifier)
seller.​seller_additional_legal_informationSeller Additional Legal Information (string) or Seller Additional Legal Information (null)(Seller Additional Legal Information)

Seller additional legal information (BT-33)

Any of:

Seller additional legal information (BT-33)

string(Seller Additional Legal Information)
buyerobject(Buyer)required

Buyer party information (BG-7)

buyer.​namestring(Name)required

Party name

buyer.​postal_addressobject(models__invoicing__Address)required
buyer.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
buyer.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
buyer.​postal_address.​city_namestring(City Name)required
buyer.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
buyer.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
buyer.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

buyer.​electronic_addressElectronicAddress (object) or null
Any of:
buyer.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
buyer.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
buyer.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
buyer.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
buyer.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
buyer.​buyer_identifierBuyer Identifier (string) or Buyer Identifier (null)(Buyer Identifier)

Buyer identifier (BT-46)

Any of:

Buyer identifier (BT-46)

string(Buyer Identifier)
buyer.​buyer_identifier_schemeBuyer Identifier Scheme (string) or Buyer Identifier Scheme (null)(Buyer Identifier Scheme)

Buyer identifier scheme (BT-47)

Any of:

Buyer identifier scheme (BT-47)

string(Buyer Identifier Scheme)
buyer.​buyer_legal_registration_identifierBuyer Legal Registration Identifier (string) or Buyer Legal Registration Identifier (null)(Buyer Legal Registration Identifier)

Buyer legal registration identifier (BT-47)

Any of:

Buyer legal registration identifier (BT-47)

string(Buyer Legal Registration Identifier)
buyer.​buyer_vat_identifierBuyer Vat Identifier (string) or Buyer Vat Identifier (null)(Buyer Vat Identifier)

Buyer VAT identifier (BT-48)

Any of:

Buyer VAT identifier (BT-48)

string(Buyer Vat Identifier)
invoice_linesArray of objects(Invoice Lines)non-emptyrequired

Invoice lines (BG-25)

invoice_lines[].​line_idstring(Line Id)required

Invoice line identifier

invoice_lines[].​invoiced_quantityInvoiced Quantity (number) or Invoiced Quantity (string)(Invoiced Quantity)required

Invoiced quantity

Any of:

Invoiced quantity

number(Invoiced Quantity)
invoice_lines[].​unit_of_measurestring(Unit Of Measure)required

Unit of measure code (BT-130) - Must be valid UN/ECE Recommendation 20 code (BR-CL-23). Common codes: C62 (unit/piece), HUR (hour), DAY (day), MON (month), MTR (meter), KGM (kilogram), LTR (liter)

invoice_lines[].​line_net_amountLine Net Amount (number) or Line Net Amount (string)(Line Net Amount)required

Invoice line net amount

Any of:

Invoice line net amount

number(Line Net Amount)
invoice_lines[].​item_namestring(Item Name)required

Item name

invoice_lines[].​item_descriptionItem Description (string) or Item Description (null)(Item Description)
Any of:
string(Item Description)
invoice_lines[].​item_priceItem Price (number) or Item Price (string)(Item Price)required

Item net price

Any of:

Item net price

number(Item Price)
invoice_lines[].​vat_category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
invoice_lines[].​vat_rateVat Rate (number) or Vat Rate (string) or Vat Rate (null)(Vat Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Vat Rate)
vat_breakdownsArray of objects(Vat Breakdowns)required

VAT breakdown (BG-23)

vat_breakdowns[].​category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
vat_breakdowns[].​rateRate (number) or Rate (string) or Rate (null)(Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Rate)
vat_breakdowns[].​taxable_amountTaxable Amount (number) or Taxable Amount (string)(Taxable Amount)required

VAT taxable amount

Any of:

VAT taxable amount

number(Taxable Amount)
vat_breakdowns[].​tax_amountTax Amount (number) or Tax Amount (string)(Tax Amount)required

VAT amount

Any of:

VAT amount

number(Tax Amount)
vat_breakdowns[].​exemption_reasonExemption Reason (string) or Exemption Reason (null)(Exemption Reason)
Any of:
string(Exemption Reason)
document_totalsobject(DocumentTotals-Input)required

Document level totals (BG-22)

document_totals.​sum_of_line_net_amountsSum Of Line Net Amounts (number) or Sum Of Line Net Amounts (string)(Sum Of Line Net Amounts)required

Sum of Invoice line net amount (BT-106)

Any of:

Sum of Invoice line net amount (BT-106)

number(Sum Of Line Net Amounts)
document_totals.​sum_of_allowancesSum Of Allowances (number) or Sum Of Allowances (string) or Sum Of Allowances (null)(Sum Of Allowances)

Sum of allowances on document level

Any of:

Sum of allowances on document level

number(Sum Of Allowances)
document_totals.​sum_of_chargesSum Of Charges (number) or Sum Of Charges (string) or Sum Of Charges (null)(Sum Of Charges)

Sum of charges on document level

Any of:

Sum of charges on document level

number(Sum Of Charges)
document_totals.​invoice_total_without_vatInvoice Total Without Vat (number) or Invoice Total Without Vat (string)(Invoice Total Without Vat)required

Invoice total amount without VAT (BT-109)

Any of:

Invoice total amount without VAT (BT-109)

number(Invoice Total Without Vat)
document_totals.​invoice_total_vat_amountInvoice Total Vat Amount (number) or Invoice Total Vat Amount (string)(Invoice Total Vat Amount)required

Invoice total VAT amount (BT-110)

Any of:

Invoice total VAT amount (BT-110)

number(Invoice Total Vat Amount)
document_totals.​invoice_total_with_vatInvoice Total With Vat (number) or Invoice Total With Vat (string)(Invoice Total With Vat)required

Invoice total amount with VAT (BT-112)

Any of:

Invoice total amount with VAT (BT-112)

number(Invoice Total With Vat)
document_totals.​paid_amountPaid Amount (number) or Paid Amount (string) or Paid Amount (null)(Paid Amount)

Paid amount

Any of:

Paid amount

number(Paid Amount)
document_totals.​rounding_amountRounding Amount (number) or Rounding Amount (string) or Rounding Amount (null)(Rounding Amount)

Rounding amount

Any of:

Rounding amount

number(Rounding Amount)
document_totals.​amount_due_for_paymentAmount Due For Payment (number) or Amount Due For Payment (string)(Amount Due For Payment)required

Amount due for payment (BT-115)

Any of:

Amount due for payment (BT-115)

number(Amount Due For Payment)
payment_termsPaymentTerms (object) or null

Payment instructions (BG-16)

Any of:

Payment instructions (BG-16)

notesArray of Notes (objects) or Notes (null)(Notes)

Invoice notes with optional subject codes (BT-22)

Any of:

Invoice notes with optional subject codes (BT-22)

order_referenceOrder Reference (string) or Order Reference (null)(Order Reference)

Deprecated: use purchase_order_reference instead

Any of:

Deprecated: use purchase_order_reference instead

string(Order Reference)
invoice_noteInvoice Note (string) or Invoice Note (null)(Invoice Note)

Deprecated: use notes instead. Invoice note (BT-22)

Any of:

Deprecated: use notes instead. Invoice note (BT-22)

string(Invoice Note)
preceding_invoice_referencePreceding Invoice Reference (string) or Preceding Invoice Reference (null)(Preceding Invoice Reference)

For credit notes - reference to original invoice (BT-25)

Any of:

For credit notes - reference to original invoice (BT-25)

string(Preceding Invoice Reference)
curl -i -X PUT \
  'https://pdp.seqino.dev/api/drafts/{draft_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "specification_identifier": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
    "issue_date": "2024-01-15",
    "due_date": "2024-02-15",
    "type_code": "380",
    "currency_code": "EUR",
    "buyer_reference": "BR-2024-001",
    "purchase_order_reference": "PO-2024-456",
    "seller": {
      "name": "Seqino",
      "postal_address": {
        "street_name": "123 Rue de la République",
        "city_name": "Paris",
        "postal_zone": "75001",
        "country_code": "FR"
      },
      "electronic_address": {
        "scheme_id": "0225",
        "value": "123456789"
      },
      "tax_registrations": [
        {
          "scheme_id": "VAT",
          "value": "FR12345678901"
        }
      ],
      "legal_registration_name": "Seqino",
      "trading_name": "Seqino Corp",
      "seller_identifier": "SELLER123",
      "seller_identifier_scheme": "GLN",
      "seller_vat_identifier": "FR12345678901",
      "seller_tax_registration_identifier": "SIRET12345678901234",
      "seller_additional_legal_information": "Société par actions simplifiée au capital de 100 000 EUR"
    },
    "buyer": {
      "name": "Example BVBA",
      "postal_address": {
        "street_name": "Avenue Louise 123",
        "city_name": "Brussels",
        "postal_zone": "1050",
        "country_code": "BE"
      },
      "electronic_address": {
        "scheme_id": "0208",
        "value": "0987654394"
      },
      "tax_registrations": [
        {
          "scheme_id": "VAT",
          "value": "BE0987654394"
        }
      ],
      "legal_registration_name": "Example BVBA",
      "buyer_identifier": "BUYER456",
      "buyer_identifier_scheme": "GLN",
      "buyer_legal_registration_identifier": "0987654394",
      "buyer_vat_identifier": "BE0987654394"
    },
    "invoice_lines": [
      {
        "line_id": "1",
        "invoiced_quantity": 10,
        "unit_of_measure": "C62",
        "line_net_amount": 1000,
        "item_name": "Software License",
        "item_description": "Enterprise software license for 12 months",
        "item_price": 100,
        "vat_category_code": "S",
        "vat_rate": 20
      },
      {
        "line_id": "2",
        "invoiced_quantity": 5,
        "unit_of_measure": "HUR",
        "line_net_amount": 500,
        "item_name": "Consulting Services",
        "item_description": "Technical consulting and support",
        "item_price": 100,
        "vat_category_code": "S",
        "vat_rate": 20
      }
    ],
    "vat_breakdowns": [
      {
        "category_code": "S",
        "rate": 20,
        "taxable_amount": 1500,
        "tax_amount": 300
      }
    ],
    "document_totals": {
      "sum_of_line_net_amounts": 1500,
      "invoice_total_without_vat": 1500,
      "invoice_total_vat_amount": 300,
      "invoice_total_with_vat": 1800,
      "amount_due_for_payment": 1800
    },
    "payment_terms": {
      "description": "Payment due within 30 days",
      "due_date": "2024-02-15"
    },
    "invoice_note": "Sample draft for demonstration purposes"
  }'

Responses

Draft updated successfully

Bodyapplication/json
any
Response
application/json
null

🗑️ Delete an invoice draft

Request

Delete a draft invoice.

Permanently removes the draft from the system. This action cannot be undone. Once deleted, the draft_id becomes invalid and cannot be reused.

Security
APIKeyHeader
Path
draft_idstring(Draft Id)required
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
curl -i -X DELETE \
  'https://pdp.seqino.dev/api/drafts/{draft_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Response
No content

✅ Validate a draft and submit as invoice

Request

Validate a draft and convert it to a structured invoice in the specified format.

This endpoint performs comprehensive validation and converts the draft into a final invoice that will be submitted to the PPF platform. After successful validation, the draft becomes immutable.

Security
APIKeyHeader
Path
draft_idstring(Draft Id)required
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
Bodyapplication/jsonrequired
formatstring(InvoiceFormat)required
Enum"factur-x""ubl""cii"
curl -i -X POST \
  'https://pdp.seqino.dev/api/drafts/{draft_id}/validate' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "format": "ubl"
  }'

Responses

Successful Response

Bodyapplication/json
invoice_idstring(Invoice Id)required
statusstring(InvoiceStatus)required
Enum"draft""submitted""validated""rejected""processed"
Response
application/json
{
  "invoice_id": "string",
  "status": "draft"
}

🔍 Validate invoice data without creating draft

Request

Validate invoice data against EN16931 requirements without creating a draft.

Returns detailed validation results with specific error messages and suggestions. This endpoint helps identify issues before submitting invoice data.

Use this for:

  • Pre-validation before creating a draft
  • Checking data quality during form input
  • Understanding validation requirements
Security
APIKeyHeader
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
client_abc123
Bodyapplication/jsonrequired
invoice_dataobject(InvoiceDraftModel-Input)required

Invoice data to validate

invoice_data.​specification_identifierstring(Specification Identifier)

Specification identifier (BT-24) - Peppol BIS 3.0 or French CIUS

Default "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
invoice_data.​issue_datestring(date)(Issue Date)required

Invoice issue date (BT-2)

invoice_data.​due_dateDue Date (string) or Due Date (null)(Due Date)

Payment due date (BT-9)

Any of:

Payment due date (BT-9)

string(date)(Due Date)
invoice_data.​type_codestring(InvoiceTypeCode)required

Invoice type code (BT-3)

Enum"380""381""383""384"
invoice_data.​currency_codestring(Currency Code)required

Invoice currency code (BT-5) - ISO 4217

invoice_data.​tax_point_dateTax Point Date (string) or Tax Point Date (null)(Tax Point Date)

Tax point date (BT-7)

Any of:

Tax point date (BT-7)

string(date)(Tax Point Date)
invoice_data.​value_added_tax_point_dateValue Added Tax Point Date (string) or Value Added Tax Point Date (null)(Value Added Tax Point Date)

Value added tax point date (BT-8)

Any of:

Value added tax point date (BT-8)

string(date)(Value Added Tax Point Date)
invoice_data.​business_process_typeBusiness Process Type (string) or Business Process Type (null)(Business Process Type)

Business process type (BT-23)

Any of:

Business process type (BT-23)

string(Business Process Type)
invoice_data.​buyer_referenceBuyer Reference (string) or Buyer Reference (null)(Buyer Reference)

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

Any of:

Buyer reference (BT-10) - An identifier assigned by the buyer used for internal routing. Either buyer_reference or purchase_order_reference must be provided.

string(Buyer Reference)
invoice_data.​purchase_order_referencePurchase Order Reference (string) or Purchase Order Reference (null)(Purchase Order Reference)

Purchase order reference (BT-13)

Any of:

Purchase order reference (BT-13)

string(Purchase Order Reference)
invoice_data.​sales_order_referenceSales Order Reference (string) or Sales Order Reference (null)(Sales Order Reference)

Sales order reference (BT-14)

Any of:

Sales order reference (BT-14)

string(Sales Order Reference)
invoice_data.​receiving_advice_referenceReceiving Advice Reference (string) or Receiving Advice Reference (null)(Receiving Advice Reference)

Receiving advice reference (BT-15)

Any of:

Receiving advice reference (BT-15)

string(Receiving Advice Reference)
invoice_data.​despatch_advice_referenceDespatch Advice Reference (string) or Despatch Advice Reference (null)(Despatch Advice Reference)

Despatch advice reference (BT-16)

Any of:

Despatch advice reference (BT-16)

string(Despatch Advice Reference)
invoice_data.​tender_or_lot_referenceTender Or Lot Reference (string) or Tender Or Lot Reference (null)(Tender Or Lot Reference)

Tender or lot reference (BT-17)

Any of:

Tender or lot reference (BT-17)

string(Tender Or Lot Reference)
invoice_data.​invoice_object_identifierInvoice Object Identifier (string) or Invoice Object Identifier (null)(Invoice Object Identifier)

Invoiced object identifier (BT-18)

Any of:

Invoiced object identifier (BT-18)

string(Invoice Object Identifier)
invoice_data.​buyer_accounting_referenceBuyer Accounting Reference (string) or Buyer Accounting Reference (null)(Buyer Accounting Reference)

Buyer accounting reference (BT-19)

Any of:

Buyer accounting reference (BT-19)

string(Buyer Accounting Reference)
invoice_data.​project_referenceProject Reference (string) or Project Reference (null)(Project Reference)

Project reference (BT-11)

Any of:

Project reference (BT-11)

string(Project Reference)
invoice_data.​contract_referenceContract Reference (string) or Contract Reference (null)(Contract Reference)

Contract reference (BT-12)

Any of:

Contract reference (BT-12)

string(Contract Reference)
invoice_data.​sellerobject(Seller)required

Seller party information (BG-4)

invoice_data.​seller.​namestring(Name)required

Party name

invoice_data.​seller.​postal_addressobject(models__invoicing__Address)required
invoice_data.​seller.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
invoice_data.​seller.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
invoice_data.​seller.​postal_address.​city_namestring(City Name)required
invoice_data.​seller.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
invoice_data.​seller.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
invoice_data.​seller.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

invoice_data.​seller.​electronic_addressElectronicAddress (object) or null
Any of:
invoice_data.​seller.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
invoice_data.​seller.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
invoice_data.​seller.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
invoice_data.​seller.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
invoice_data.​seller.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
invoice_data.​seller.​seller_identifierSeller Identifier (string) or Seller Identifier (null)(Seller Identifier)

Seller identifier (BT-29)

Any of:

Seller identifier (BT-29)

string(Seller Identifier)
invoice_data.​seller.​seller_identifier_schemeSeller Identifier Scheme (string) or Seller Identifier Scheme (null)(Seller Identifier Scheme)

Seller identifier scheme (BT-30)

Any of:

Seller identifier scheme (BT-30)

string(Seller Identifier Scheme)
invoice_data.​seller.​seller_vat_identifierSeller Vat Identifier (string) or Seller Vat Identifier (null)(Seller Vat Identifier)

Seller VAT identifier (BT-31)

Any of:

Seller VAT identifier (BT-31)

string(Seller Vat Identifier)
invoice_data.​seller.​seller_tax_registration_identifierSeller Tax Registration Identifier (string) or Seller Tax Registration Identifier (null)(Seller Tax Registration Identifier)

Seller tax registration identifier (BT-32)

Any of:

Seller tax registration identifier (BT-32)

string(Seller Tax Registration Identifier)
invoice_data.​seller.​seller_additional_legal_informationSeller Additional Legal Information (string) or Seller Additional Legal Information (null)(Seller Additional Legal Information)

Seller additional legal information (BT-33)

Any of:

Seller additional legal information (BT-33)

string(Seller Additional Legal Information)
invoice_data.​buyerobject(Buyer)required

Buyer party information (BG-7)

invoice_data.​buyer.​namestring(Name)required

Party name

invoice_data.​buyer.​postal_addressobject(models__invoicing__Address)required
invoice_data.​buyer.​postal_address.​street_nameStreet Name (string) or Street Name (null)(Street Name)
Any of:
string(Street Name)
invoice_data.​buyer.​postal_address.​additional_street_nameAdditional Street Name (string) or Additional Street Name (null)(Additional Street Name)
Any of:
string(Additional Street Name)
invoice_data.​buyer.​postal_address.​city_namestring(City Name)required
invoice_data.​buyer.​postal_address.​postal_zonePostal Zone (string) or Postal Zone (null)(Postal Zone)
Any of:
string(Postal Zone)
invoice_data.​buyer.​postal_address.​country_subdivisionCountry Subdivision (string) or Country Subdivision (null)(Country Subdivision)
Any of:
string(Country Subdivision)
invoice_data.​buyer.​postal_address.​country_codestring(Country Code)required

ISO 3166-1 alpha-2 country code

invoice_data.​buyer.​electronic_addressElectronicAddress (object) or null
Any of:
invoice_data.​buyer.​tax_registrationsArray of Tax Registrations (objects) or Tax Registrations (null)(Tax Registrations)
Any of:
invoice_data.​buyer.​legal_registration_nameLegal Registration Name (string) or Legal Registration Name (null)(Legal Registration Name)
Any of:
string(Legal Registration Name)
invoice_data.​buyer.​trading_nameTrading Name (string) or Trading Name (null)(Trading Name)
Any of:
string(Trading Name)
invoice_data.​buyer.​party_identifierParty Identifier (string) or Party Identifier (null)(Party Identifier)

Party identifier

Any of:

Party identifier

string(Party Identifier)
invoice_data.​buyer.​party_identifier_schemeParty Identifier Scheme (string) or Party Identifier Scheme (null)(Party Identifier Scheme)

Party identifier scheme

Any of:

Party identifier scheme

string(Party Identifier Scheme)
invoice_data.​buyer.​buyer_identifierBuyer Identifier (string) or Buyer Identifier (null)(Buyer Identifier)

Buyer identifier (BT-46)

Any of:

Buyer identifier (BT-46)

string(Buyer Identifier)
invoice_data.​buyer.​buyer_identifier_schemeBuyer Identifier Scheme (string) or Buyer Identifier Scheme (null)(Buyer Identifier Scheme)

Buyer identifier scheme (BT-47)

Any of:

Buyer identifier scheme (BT-47)

string(Buyer Identifier Scheme)
invoice_data.​buyer.​buyer_legal_registration_identifierBuyer Legal Registration Identifier (string) or Buyer Legal Registration Identifier (null)(Buyer Legal Registration Identifier)

Buyer legal registration identifier (BT-47)

Any of:

Buyer legal registration identifier (BT-47)

string(Buyer Legal Registration Identifier)
invoice_data.​buyer.​buyer_vat_identifierBuyer Vat Identifier (string) or Buyer Vat Identifier (null)(Buyer Vat Identifier)

Buyer VAT identifier (BT-48)

Any of:

Buyer VAT identifier (BT-48)

string(Buyer Vat Identifier)
invoice_data.​invoice_linesArray of objects(Invoice Lines)non-emptyrequired

Invoice lines (BG-25)

invoice_data.​invoice_lines[].​line_idstring(Line Id)required

Invoice line identifier

invoice_data.​invoice_lines[].​invoiced_quantityInvoiced Quantity (number) or Invoiced Quantity (string)(Invoiced Quantity)required

Invoiced quantity

Any of:

Invoiced quantity

number(Invoiced Quantity)
invoice_data.​invoice_lines[].​unit_of_measurestring(Unit Of Measure)required

Unit of measure code (BT-130) - Must be valid UN/ECE Recommendation 20 code (BR-CL-23). Common codes: C62 (unit/piece), HUR (hour), DAY (day), MON (month), MTR (meter), KGM (kilogram), LTR (liter)

invoice_data.​invoice_lines[].​line_net_amountLine Net Amount (number) or Line Net Amount (string)(Line Net Amount)required

Invoice line net amount

Any of:

Invoice line net amount

number(Line Net Amount)
invoice_data.​invoice_lines[].​item_namestring(Item Name)required

Item name

invoice_data.​invoice_lines[].​item_descriptionItem Description (string) or Item Description (null)(Item Description)
Any of:
string(Item Description)
invoice_data.​invoice_lines[].​item_priceItem Price (number) or Item Price (string)(Item Price)required

Item net price

Any of:

Item net price

number(Item Price)
invoice_data.​invoice_lines[].​vat_category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
invoice_data.​invoice_lines[].​vat_rateVat Rate (number) or Vat Rate (string) or Vat Rate (null)(Vat Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Vat Rate)
invoice_data.​vat_breakdownsArray of objects(Vat Breakdowns)required

VAT breakdown (BG-23)

invoice_data.​vat_breakdowns[].​category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
invoice_data.​vat_breakdowns[].​rateRate (number) or Rate (string) or Rate (null)(Rate)

VAT rate as percentage

Any of:

VAT rate as percentage

number(Rate)
invoice_data.​vat_breakdowns[].​taxable_amountTaxable Amount (number) or Taxable Amount (string)(Taxable Amount)required

VAT taxable amount

Any of:

VAT taxable amount

number(Taxable Amount)
invoice_data.​vat_breakdowns[].​tax_amountTax Amount (number) or Tax Amount (string)(Tax Amount)required

VAT amount

Any of:

VAT amount

number(Tax Amount)
invoice_data.​vat_breakdowns[].​exemption_reasonExemption Reason (string) or Exemption Reason (null)(Exemption Reason)
Any of:
string(Exemption Reason)
invoice_data.​document_totalsobject(DocumentTotals-Input)required

Document level totals (BG-22)

invoice_data.​document_totals.​sum_of_line_net_amountsSum Of Line Net Amounts (number) or Sum Of Line Net Amounts (string)(Sum Of Line Net Amounts)required

Sum of Invoice line net amount (BT-106)

Any of:

Sum of Invoice line net amount (BT-106)

number(Sum Of Line Net Amounts)
invoice_data.​document_totals.​sum_of_allowancesSum Of Allowances (number) or Sum Of Allowances (string) or Sum Of Allowances (null)(Sum Of Allowances)

Sum of allowances on document level

Any of:

Sum of allowances on document level

number(Sum Of Allowances)
invoice_data.​document_totals.​sum_of_chargesSum Of Charges (number) or Sum Of Charges (string) or Sum Of Charges (null)(Sum Of Charges)

Sum of charges on document level

Any of:

Sum of charges on document level

number(Sum Of Charges)
invoice_data.​document_totals.​invoice_total_without_vatInvoice Total Without Vat (number) or Invoice Total Without Vat (string)(Invoice Total Without Vat)required

Invoice total amount without VAT (BT-109)

Any of:

Invoice total amount without VAT (BT-109)

number(Invoice Total Without Vat)
invoice_data.​document_totals.​invoice_total_vat_amountInvoice Total Vat Amount (number) or Invoice Total Vat Amount (string)(Invoice Total Vat Amount)required

Invoice total VAT amount (BT-110)

Any of:

Invoice total VAT amount (BT-110)

number(Invoice Total Vat Amount)
invoice_data.​document_totals.​invoice_total_with_vatInvoice Total With Vat (number) or Invoice Total With Vat (string)(Invoice Total With Vat)required

Invoice total amount with VAT (BT-112)

Any of:

Invoice total amount with VAT (BT-112)

number(Invoice Total With Vat)
invoice_data.​document_totals.​paid_amountPaid Amount (number) or Paid Amount (string) or Paid Amount (null)(Paid Amount)

Paid amount

Any of:

Paid amount

number(Paid Amount)
invoice_data.​document_totals.​rounding_amountRounding Amount (number) or Rounding Amount (string) or Rounding Amount (null)(Rounding Amount)

Rounding amount

Any of:

Rounding amount

number(Rounding Amount)
invoice_data.​document_totals.​amount_due_for_paymentAmount Due For Payment (number) or Amount Due For Payment (string)(Amount Due For Payment)required

Amount due for payment (BT-115)

Any of:

Amount due for payment (BT-115)

number(Amount Due For Payment)
invoice_data.​payment_termsPaymentTerms (object) or null

Payment instructions (BG-16)

Any of:

Payment instructions (BG-16)

invoice_data.​notesArray of Notes (objects) or Notes (null)(Notes)

Invoice notes with optional subject codes (BT-22)

Any of:

Invoice notes with optional subject codes (BT-22)

invoice_data.​order_referenceOrder Reference (string) or Order Reference (null)(Order Reference)

Deprecated: use purchase_order_reference instead

Any of:

Deprecated: use purchase_order_reference instead

string(Order Reference)
invoice_data.​invoice_noteInvoice Note (string) or Invoice Note (null)(Invoice Note)

Deprecated: use notes instead. Invoice note (BT-22)

Any of:

Deprecated: use notes instead. Invoice note (BT-22)

string(Invoice Note)
invoice_data.​preceding_invoice_referencePreceding Invoice Reference (string) or Preceding Invoice Reference (null)(Preceding Invoice Reference)

For credit notes - reference to original invoice (BT-25)

Any of:

For credit notes - reference to original invoice (BT-25)

string(Preceding Invoice Reference)
strict_modeboolean(Strict Mode)

Whether to apply strict EN16931 validation

Default true
curl -i -X POST \
  https://pdp.seqino.dev/api/drafts/validate-data \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "invoice_data": {
      "specification_identifier": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1",
      "issue_date": "2024-01-15",
      "due_date": "2024-02-15",
      "type_code": "380",
      "currency_code": "EUR",
      "buyer_reference": "BR-2024-001",
      "purchase_order_reference": "PO-2024-456",
      "seller": {
        "name": "Seqino",
        "postal_address": {
          "street_name": "123 Rue de la République",
          "city_name": "Paris",
          "postal_zone": "75001",
          "country_code": "FR"
        },
        "electronic_address": {
          "scheme_id": "0225",
          "value": "123456789"
        },
        "tax_registrations": [
          {
            "scheme_id": "VAT",
            "value": "FR12345678901"
          }
        ],
        "legal_registration_name": "Seqino",
        "trading_name": "Seqino Corp",
        "seller_identifier": "SELLER123",
        "seller_identifier_scheme": "GLN",
        "seller_vat_identifier": "FR12345678901",
        "seller_tax_registration_identifier": "SIRET12345678901234",
        "seller_additional_legal_information": "Société par actions simplifiée au capital de 100 000 EUR"
      },
      "buyer": {
        "name": "Example BVBA",
        "postal_address": {
          "street_name": "Avenue Louise 123",
          "city_name": "Brussels",
          "postal_zone": "1050",
          "country_code": "BE"
        },
        "electronic_address": {
          "scheme_id": "0208",
          "value": "0987654394"
        },
        "tax_registrations": [
          {
            "scheme_id": "VAT",
            "value": "BE0987654394"
          }
        ],
        "legal_registration_name": "Example BVBA",
        "buyer_identifier": "BUYER456",
        "buyer_identifier_scheme": "GLN",
        "buyer_legal_registration_identifier": "0987654394",
        "buyer_vat_identifier": "BE0987654394"
      },
      "invoice_lines": [
        {
          "line_id": "1",
          "invoiced_quantity": 10,
          "unit_of_measure": "C62",
          "line_net_amount": 1000,
          "item_name": "Software License",
          "item_description": "Enterprise software license for 12 months",
          "item_price": 100,
          "vat_category_code": "S",
          "vat_rate": 20
        },
        {
          "line_id": "2",
          "invoiced_quantity": 5,
          "unit_of_measure": "HUR",
          "line_net_amount": 500,
          "item_name": "Consulting Services",
          "item_description": "Technical consulting and support",
          "item_price": 100,
          "vat_category_code": "S",
          "vat_rate": 20
        }
      ],
      "vat_breakdowns": [
        {
          "category_code": "S",
          "rate": 20,
          "taxable_amount": 1500,
          "tax_amount": 300
        }
      ],
      "document_totals": {
        "sum_of_line_net_amounts": 1500,
        "invoice_total_without_vat": 1500,
        "invoice_total_vat_amount": 300,
        "invoice_total_with_vat": 1800,
        "amount_due_for_payment": 1800
      },
      "payment_terms": {
        "description": "Payment due within 30 days",
        "due_date": "2024-02-15"
      },
      "invoice_note": "Sample draft for demonstration purposes"
    },
    "strict_mode": true
  }'

Responses

Validation completed (may contain errors)

Bodyapplication/json
is_validboolean(Is Valid)required

Whether the invoice data is valid

issuesArray of objects(Issues)required

List of validation issues found

issues[].​field_pathstring(Field Path)required

JSON path to the problematic field (e.g., 'seller.postal_address.country_code')

issues[].​error_codestring(Error Code)required

Machine-readable error code (e.g., 'INVALID_COUNTRY_CODE')

issues[].​error_messagestring(Error Message)required

Human-readable error message

issues[].​severitystring(Severity)required

Issue severity: 'error', 'warning', or 'info'

issues[].​suggested_valueSuggested Value (string) or Suggested Value (null)(Suggested Value)

Suggested correct value if applicable

Any of:

Suggested correct value if applicable

string(Suggested Value)
total_errorsinteger(Total Errors)required

Total number of errors

total_warningsinteger(Total Warnings)required

Total number of warnings

en16931_compliantboolean(En16931 Compliant)required

Whether the invoice meets EN16931 requirements

summarystring(Summary)required

Human-readable validation summary

Response
application/json
{
  "is_valid": true,
  "issues": [
    { … }
  ],
  "total_errors": 0,
  "total_warnings": 0,
  "en16931_compliant": true,
  "summary": "string"
}

📘 Directory

Operations

🧾 Invoicing

Operations

🔄 Lifecycle

Operations

📊 Reporting

Operations

📊 Usage

Operations

⚙️ Settings

Operations

🔔 Webhooks

Operations

Health Check

Request

Health check endpoint.

curl -i -X GET \
  https://pdp.seqino.dev/health

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null