Skip to content

Seqino PDP API (1.0.0)

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

Download OpenAPI description
Languages
Servers
Current server

https://pdp-api-v250704-iron.seqino.dev/

Local development server

http://localhost:8052/

Production server

https://pdp.seqino.com/api/

👥 Clients

Operations

📋 Mandates

Operations

📝 Drafts

Operations

📘 Directory

Operations

🧾 Invoicing

Operations

🔄 Lifecycle

Operations

📊 Reporting

Operations

🌍 Submit exempt invoice (international B2B/B2C)

Request

Submit an exempt invoice for international B2B/B2C transactions.

This endpoint is used for e-reporting individual international invoices that are exempt from mandatory electronic invoice exchange but still require reporting to the government system via F10 flow.

The returned invoice_id can be used with /lifecycle-events to track lifecycle updates.

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

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
Bodyapplication/jsonrequired
directionstring(Direction)required

Whether this is a purchase (incoming) or sales (outgoing) invoice

Enum"incoming""outgoing"
country_codestring(Country Code)required

ISO country code of the counterparty

modelobject(InvoiceDraftModel-Input)required

Invoice draft model - invoice number will be generated when finalized.

model.​specification_identifierstring(Specification Identifier)

Specification identifier (BT-24)

Default "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
model.​issue_datestring(date)(Issue Date)required

Invoice issue date (BT-2)

model.​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)

Payment due date (BT-9)

model.​type_codestring(InvoiceTypeCode)required

Invoice type code (BT-3)

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

Invoice currency code (BT-5) - ISO 4217

model.​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)

Tax point date (BT-7)

model.​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)

Value added tax point date (BT-8)

model.​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)

Business process type (BT-23)

model.​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)

Purchase order reference (BT-13)

model.​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)

Sales order reference (BT-14)

model.​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)

Receiving advice reference (BT-15)

model.​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)

Despatch advice reference (BT-16)

model.​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)

Tender or lot reference (BT-17)

model.​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)

Invoiced object identifier (BT-18)

model.​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)

Buyer accounting reference (BT-19)

model.​project_referenceProject Reference (string) or Project Reference (null)(Project Reference)

Project reference (BT-11)

Any of:

Project reference (BT-11)

string(Project Reference)

Project reference (BT-11)

model.​contract_referenceContract Reference (string) or Contract Reference (null)(Contract Reference)

Contract reference (BT-12)

Any of:

Contract reference (BT-12)

string(Contract Reference)

Contract reference (BT-12)

model.​sellerobject(Seller)required

Seller party information (BG-4).

model.​seller.​namestring(Name)required

Party name

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

ISO 3166-1 alpha-2 country code

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

Party identifier

Any of:

Party identifier

string(Party Identifier)

Party identifier

model.​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)

Party identifier scheme

model.​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 identifier (BT-29)

model.​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 identifier scheme (BT-30)

model.​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 VAT identifier (BT-31)

model.​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 tax registration identifier (BT-32)

model.​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)

Seller additional legal information (BT-33)

model.​buyerobject(Buyer)required

Buyer party information (BG-7).

model.​buyer.​namestring(Name)required

Party name

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

ISO 3166-1 alpha-2 country code

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

Party identifier

Any of:

Party identifier

string(Party Identifier)

Party identifier

model.​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)

Party identifier scheme

model.​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 identifier (BT-46)

model.​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 identifier scheme (BT-47)

model.​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 legal registration identifier (BT-47)

model.​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)

Buyer VAT identifier (BT-48)

model.​invoice_linesArray of objects(Invoice Lines)non-emptyrequired

Invoice lines (BG-25)

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

Invoice line identifier

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

Invoiced quantity

Any of:

Invoiced quantity

number(Invoiced Quantity)

Invoiced quantity

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

Unit of measure code

model.​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 line net amount

model.​invoice_lines[].​item_namestring(Item Name)required

Item name

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

Item net price

Any of:

Item net price

number(Item Price)

Item net price

model.​invoice_lines[].​vat_category_codestring(VATCategoryCode)required
Enum"S""Z""E""AE""K""O"
model.​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 rate as percentage

model.​vat_breakdownsArray of objects(Vat Breakdowns)required

VAT breakdown (BG-23)

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

VAT rate as percentage

Any of:

VAT rate as percentage

number(Rate)

VAT rate as percentage

model.​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 taxable amount

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

VAT amount

Any of:

VAT amount

number(Tax Amount)

VAT amount

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

Document level totals (BG-22)

model.​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)

Sum of Invoice line net amount (BT-106)

model.​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)

Sum of allowances on document level

model.​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)

Sum of charges on document level

model.​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 total amount without VAT (BT-109)

model.​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 total VAT amount (BT-110)

model.​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 total amount with VAT (BT-112)

model.​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)

Paid amount

model.​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)

Rounding amount

model.​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)

Amount due for payment (BT-115)

model.​payment_termsPaymentTerms (object) or null

Payment instructions (BG-16)

Any of:

Payment instructions (BG-16)

model.​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)

Deprecated: use purchase_order_reference instead

model.​invoice_noteInvoice Note (string) or Invoice Note (null)(Invoice Note)

Invoice note (BT-22)

Any of:

Invoice note (BT-22)

string(Invoice Note)

Invoice note (BT-22)

model.​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)

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

curl -i -X POST \
  https://pdp-api-v250704-iron.seqino.dev/api/reporting/exempt-invoices \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "direction": "outgoing",
    "country_code": "DE",
    "model": {
      "specification_identifier": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:01:1.0",
      "issue_date": "2024-01-15",
      "type_code": "380",
      "currency_code": "EUR",
      "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": 88,
          "value": "1234567890123"
        },
        "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": "Beispiel GmbH",
        "postal_address": {
          "street_name": "Musterstraße 42",
          "city_name": "Berlin",
          "postal_zone": "10115",
          "country_code": "DE"
        },
        "tax_registrations": [
          {
            "scheme_id": "VAT",
            "value": "DE123456789"
          }
        ],
        "legal_registration_name": "Beispiel GmbH",
        "buyer_identifier": "BUYER456",
        "buyer_identifier_scheme": "GLN",
        "buyer_legal_registration_identifier": "HRB12345",
        "buyer_vat_identifier": "DE123456789"
      },
      "invoice_lines": [
        {
          "line_id": "1",
          "invoiced_quantity": 10,
          "unit_of_measure": "PCE",
          "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"
      },
      "order_reference": "PO-2024-456",
      "invoice_note": "Sample draft for demonstration purposes"
    }
  }'

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" }

📊 Submit B2C transaction data (daily aggregate)

Request

Submit aggregated B2C transaction data for a specific date.

This endpoint collects daily B2C transaction summaries that will be processed into F10 format for government e-reporting. Data should be aggregated by category (goods vs services) and VAT rate.

Required for domestic B2C operations under French e-invoicing regulation. Data is reported as daily totals rather than individual transactions.

Args: transaction_date: Date of the transactions (YYYY-MM-DD) currency: Transaction currency (typically EUR) store_location: Optional store/location identifier goods_sales: Aggregated data for goods sales (TLB1 category) services: Aggregated data for services (TPS1 category)

Returns: Confirmation of submission with reference ID for tracking

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

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
Bodyapplication/jsonrequired
object(Request)
curl -i -X POST \
  https://pdp-api-v250704-iron.seqino.dev/api/reporting/b2c-transactions \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "transaction_date": "2024-01-15",
    "currency": "EUR",
    "store_location": "Paris - Champs Elysées",
    "goods_sales": {
      "tax_exclusive_amount": 5000,
      "tax_amount": 1000,
      "tax_rate": 20,
      "transaction_count": 150,
      "payment_data": {
        "cash_amount": 1500,
        "card_amount": 4500,
        "payment_date": "2024-01-15"
      }
    },
    "services": {
      "tax_exclusive_amount": 2000,
      "tax_amount": 400,
      "tax_rate": 20,
      "transaction_count": 75,
      "payment_data": {
        "cash_amount": 500,
        "card_amount": 1900,
        "payment_date": "2024-01-15"
      }
    }
  }'

Responses

Successful Response

Bodyapplication/json
object(Response Submit B2C Transactions Api Reporting B2C Transactions Post)
Response
application/json
{}

💰 Record payment received

Request

Record a payment received by the client.

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

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
Bodyapplication/jsonrequired
client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

payment_datestring(date)(Payment Date)required

Date payment was received

amountAmount (number) or Amount (string)(Amount)required

Payment amount

Any of:

Payment amount

> 0
number(Amount)> 0

Payment amount

currencystring(Currency)

Currency code

Default "EUR"
invoice_numberInvoice Number (string) or Invoice Number (null)(Invoice Number)

Related invoice number (if applicable)

Any of:

Related invoice number (if applicable)

string(Invoice Number)

Related invoice number (if applicable)

curl -i -X POST \
  https://pdp-api-v250704-iron.seqino.dev/api/reporting/payments \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "client_siren": "string",
    "payment_date": "2019-08-24",
    "amount": 0,
    "currency": "EUR",
    "invoice_number": "string"
  }'

Responses

Successful Response

Bodyapplication/json
payment_idstring(Payment Id)required

System-generated payment ID

client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

payment_datestring(date)(Payment Date)required

Date payment was received

amountstring(Amount)required

Payment amount

currencystring(Currency)

Currency code

Default "EUR"
invoice_numberInvoice Number (string) or Invoice Number (null)(Invoice Number)

Related invoice number (if applicable)

Any of:

Related invoice number (if applicable)

string(Invoice Number)

Related invoice number (if applicable)

created_atstring(date-time)(Created At)required

Creation timestamp

periodstring(Period)required

Reporting period (YYYY-MM)

Response
application/json
{ "payment_id": "string", "client_siren": "string", "payment_date": "2019-08-24", "amount": "string", "currency": "EUR", "invoice_number": "string", "created_at": "2019-08-24T14:15:22Z", "period": "string" }

💰 Get client payments

Request

Get all payments for a client in a specific period.

Query
client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

periodstring(Period)^\d{4}-\d{2}$required

Period (YYYY-MM)

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

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
curl -i -X GET \
  'https://pdp-api-v250704-iron.seqino.dev/api/reporting/payments?client_siren=string&period=string' \
  -H 'X-PDP-Client-Id: string'

Responses

Successful Response

Bodyapplication/jsonArray [
payment_idstring(Payment Id)required

System-generated payment ID

client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

payment_datestring(date)(Payment Date)required

Date payment was received

amountstring(Amount)required

Payment amount

currencystring(Currency)

Currency code

Default "EUR"
invoice_numberInvoice Number (string) or Invoice Number (null)(Invoice Number)

Related invoice number (if applicable)

Any of:

Related invoice number (if applicable)

string(Invoice Number)

Related invoice number (if applicable)

created_atstring(date-time)(Created At)required

Creation timestamp

periodstring(Period)required

Reporting period (YYYY-MM)

]
Response
application/json
[ { "payment_id": "string", "client_siren": "string", "payment_date": "2019-08-24", "amount": "string", "currency": "EUR", "invoice_number": "string", "created_at": "2019-08-24T14:15:22Z", "period": "string" } ]

✏️ Update payment

Request

Update a payment record.

Path
payment_idstring(Payment Id)required
Headers
X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:
sandbox-client-seqino
Bodyapplication/jsonrequired
client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

payment_datestring(date)(Payment Date)required

Date payment was received

amountAmount (number) or Amount (string)(Amount)required

Payment amount

Any of:

Payment amount

> 0
number(Amount)> 0

Payment amount

currencystring(Currency)

Currency code

Default "EUR"
invoice_numberInvoice Number (string) or Invoice Number (null)(Invoice Number)

Related invoice number (if applicable)

Any of:

Related invoice number (if applicable)

string(Invoice Number)

Related invoice number (if applicable)

curl -i -X PUT \
  'https://pdp-api-v250704-iron.seqino.dev/api/reporting/payments/{payment_id}' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: string' \
  -d '{
    "client_siren": "string",
    "payment_date": "2019-08-24",
    "amount": 0,
    "currency": "EUR",
    "invoice_number": "string"
  }'

Responses

Successful Response

Bodyapplication/json
payment_idstring(Payment Id)required

System-generated payment ID

client_sirenstring(Client Siren)^\d{9}$required

Client's SIREN number

payment_datestring(date)(Payment Date)required

Date payment was received

amountstring(Amount)required

Payment amount

currencystring(Currency)

Currency code

Default "EUR"
invoice_numberInvoice Number (string) or Invoice Number (null)(Invoice Number)

Related invoice number (if applicable)

Any of:

Related invoice number (if applicable)

string(Invoice Number)

Related invoice number (if applicable)

created_atstring(date-time)(Created At)required

Creation timestamp

periodstring(Period)required

Reporting period (YYYY-MM)

Response
application/json
{ "payment_id": "string", "client_siren": "string", "payment_date": "2019-08-24", "amount": "string", "currency": "EUR", "invoice_number": "string", "created_at": "2019-08-24T14:15:22Z", "period": "string" }

📊 Usage

Operations

⚙️ Settings

Operations

Health Check

Request

Health check endpoint.

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null