▣ DOCUMENT INTELLIGENCE KIT · VERIFICATION KIT

Validate, Generate & Send Peppol E-Invoice API

What it does

E Invoicing API lets you validate, generate, and track electronic invoices, then submit them to Peppol for delivery. Send an invoice body with seller, buyer, line items, and required references; get back validation results, totals, and, when generating, downloadable UBL or CII documents.

Use it when you need to build compliant invoicing workflows without hand-coding the document rules. The invoice payload supports invoice and credit note documents, profiles such as basic, en16931, and extended, plus billing details like payment terms, delivery, references, VAT breakdowns, discounts, and charges. The generated response includes the invoice id, number, issue date, due date, currency, status, totals, and a validation summary with any rule violations.

If you only need checks, call the validation endpoint and get a boolean valid response plus the validation object and totals. If you already have an invoice id, submit it with sellerEndpoint and buyerEndpoint to Peppol, optionally including a webhookUrl for status callbacks. The status endpoint returns the current sending state for that id, including status history with timestamps and details.

This is a fit for ERP integrations, billing platforms, and back-office automation where invoice structure, validation, and delivery status all need to stay machine-readable.

▣ ENDPOINT 01 / 04

POST

Generate an electronic invoice

https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/v1/invoices

QUICKSTART

GUIDE

Quickstart

Create a generated e-invoice from the required invoice, seller, buyer, and line item details.

curl -X POST "https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/v1/invoices" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "INV-2026-0042",
    "issueDate": "2026-01-15",
    "currency": "EUR",
    "buyerReference": "PO-2026-0150",
    "seller": {
      "name": "Acme Supplies SAS",
      "vatId": "FR12345678901",
      "address": {
        "city": "Paris",
        "postalCode": "75010",
        "countryCode": "FR"
      }
    },
    "buyer": {
      "name": "Bluebird Retail SARL",
      "vatId": "FR10987654321",
      "address": {
        "city": "Lyon",
        "postalCode": "69002",
        "countryCode": "FR"
      }
    },
    "lines": [
      {
        "name": "Consulting services",
        "quantity": 10,
        "unitPrice": "100.00",
        "vatRate": "20"
      }
    ]
  }'

What you'll get back

Returns a JSON object with invoice metadata, generated document files, totals, and validation details. Top-level fields include createdAt, currency, documentType, documents, dueDate, id, issueDate, number, profile, status, totals, and validation.

{
  "createdAt": "2026-01-15T10:30:00Z",
  "currency": "EUR",
  "documentType": "invoice",
  "documents": [],
  "dueDate": "2026-02-14",
  "id": "inv_12345",
  "issueDate": "2026-01-15",
  "number": "INV-2026-0042",
  "profile": "en16931",
  "status": "generated",
  "totals": {},
  "validation": {}
}

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Generates an electronic invoice from the invoice data in the request body and returns the created document metadata, totals, and validation results. The response also includes downloadable document descriptors for the generated invoice files.

Request Body

Parameter	Type	Mandatory	Description
number	String	Yes	Invoice number.
issueDate	String	Yes	Issue date in `date` format.
currency	String	Yes	Invoice currency.
buyerReference	String	Yes	Buyer reference.
seller	Object	Yes	Seller details. Include `name`, `address`, and `vatId`; see nested fields below.
seller.name	String	Yes	Seller name.
seller.taxId	String	No	Seller tax ID.
seller.vatId	String	Yes	Seller VAT ID.
seller.address	Object	Yes	Seller address. Include `city`, `postalCode`, and `countryCode`; see nested fields below.
seller.address.city	String	Yes	City.
seller.address.street	String	No	Street.
seller.address.postalCode	String	Yes	Postal code.
seller.address.countryCode	String	Yes	Country code.
seller.address.additionalStreet	String	No	Additional street line.
seller.address.countrySubdivision	String	No	Country subdivision.
seller.contact	Object	No	Seller contact details.
seller.contact.name	String	No	Contact name.
seller.contact.email	String	No	Contact email.
seller.contact.phone	String	No	Contact phone.
seller.legalId	Object	No	Seller legal identifier. Include `value`; see nested fields below.
seller.legalId.value	String	Yes	Legal identifier value.
seller.legalId.scheme	String	No	Legal identifier scheme.
seller.tradingName	String	No	Seller trading name.
seller.identifications	Object Array	No	Seller identification entries. Each item includes `value` and optional `scheme`.
seller.identifications[].value	String	Yes	Identification value.
seller.identifications[].scheme	String	No	Identification scheme.
seller.electronicAddress	Object	No	Seller electronic address. Include `scheme` and `value`; see nested fields below.
seller.electronicAddress.value	String	Yes	Electronic address value.
seller.electronicAddress.scheme	String	Yes	Electronic address scheme.
buyer	Object	Yes	Buyer details. Include `name`, `address`, and `vatId`; see nested fields below.
buyer.name	String	Yes	Buyer name.
buyer.taxId	String	No	Buyer tax ID.
buyer.vatId	String	Yes	Buyer VAT ID.
buyer.address	Object	Yes	Buyer address. Include `city`, `postalCode`, and `countryCode`; see nested fields below.
buyer.address.city	String	Yes	City.
buyer.address.street	String	No	Street.
buyer.address.postalCode	String	Yes	Postal code.
buyer.address.countryCode	String	Yes	Country code.
buyer.address.additionalStreet	String	No	Additional street line.
buyer.address.countrySubdivision	String	No	Country subdivision.
buyer.contact	Object	No	Buyer contact details.
buyer.contact.name	String	No	Contact name.
buyer.contact.email	String	No	Contact email.
buyer.contact.phone	String	No	Contact phone.
buyer.legalId	Object	No	Buyer legal identifier. Include `value`; see nested fields below.
buyer.legalId.value	String	Yes	Legal identifier value.
buyer.legalId.scheme	String	No	Legal identifier scheme.
buyer.tradingName	String	No	Buyer trading name.
buyer.identifications	Object Array	No	Buyer identification entries. Each item includes `value` and optional `scheme`.
buyer.identifications[].value	String	Yes	Identification value.
buyer.identifications[].scheme	String	No	Identification scheme.
buyer.electronicAddress	Object	No	Buyer electronic address. Include `scheme` and `value`; see nested fields below.
buyer.electronicAddress.value	String	Yes	Electronic address value.
buyer.electronicAddress.scheme	String	Yes	Electronic address scheme.
lines	Object Array	Yes	Invoice line items. At least one item is required. Each item includes `name`, `quantity`, `unitPrice`, and `vatRate`; see nested fields below.
lines[].id	String	No	Line identifier.
lines[].name	String	Yes	Line item name.
lines[].note	String	No	Line note.
lines[].charge	Object	No	Charge details for the line. Include `amount`, `reason`, and `percent` as defined in the schema.
lines[].vatRate	Number/String	Yes	VAT rate.
lines[].discount	Object	No	Discount details for the line. Include `amount`, `reason`, and `percent` as defined in the schema.
lines[].itemCode	Object	No	Item code. Include `value`; see nested fields below.
lines[].itemCode.value	String	Yes	Item code value.
lines[].itemCode.scheme	String	No	Item code scheme.
lines[].quantity	Number/String	Yes	Quantity.
lines[].unitCode	String	No	Unit code. Default: `C62`.
lines[].unitPrice	Number/String	Yes	Unit price.
lines[].description	String	No	Line description.
lines[].vatCategory	ENUM	No	VAT category. Allowed values: `S`, `Z`, `E`, `AE`, `K`, `G`, `O`, `L`, `M`.
lines[].exemptionReason	String	No	VAT exemption reason.
lines[].exemptionReasonCode	String	No	VAT exemption reason code.
note	String	No	Invoice note.
dueDate	String	No	Due date in `date` format.
payment	Object	No	Payment details.
payment.bic	String	No	BIC.
payment.iban	String	No	IBAN.
payment.meansCode	String	No	Payment means code. Default: `30`.
payment.reference	String	No	Payment reference.
payment.accountName	String	No	Account name.
profile	ENUM	No	Invoice profile. Allowed values: `basic`, `en16931`, `extended`.
delivery	Object	No	Delivery details.
delivery.date	String	No	Delivery date in `date` format.
delivery.address	Object	No	Delivery address. Include `city`, `postalCode`, and `countryCode`; see nested fields below.
delivery.address.city	String	No	City.
delivery.address.street	String	No	Street.
delivery.address.postalCode	String	No	Postal code.
delivery.address.countryCode	String	No	Country code.
delivery.address.additionalStreet	String	No	Additional street line.
delivery.address.countrySubdivision	String	No	Country subdivision.
delivery.partyName	String	No	Delivery party name.
documentType	ENUM	No	Document type. Allowed values: `invoice`, `credit_note`.
paymentTerms	String	No	Payment terms.
orderReference	String	No	Order reference.
projectReference	String	No	Project reference.
contractReference	String	No	Contract reference.

Response

Returns a JSON object with createdAt, currency, documentType, documents, dueDate, id, issueDate, number, profile, status, totals, and validation fields. The status field is generated on success, and documents, totals, and validation contain the generated document metadata, invoice totals, and validation outcome.

Success status code: 200

Attribute	Type	Mandatory	Description
createdAt	String	No	Creation timestamp in `date-time` format.
currency	String	No	Invoice currency.
documentType	ENUM	No	Document type. Allowed values: `invoice`, `credit_note`.
documents	Object Array	No	Generated document descriptors. Each item may include `url`, `kind`, `bytes`, `sha256`, `filename`, and `mediaType`.
documents[].url	String	No	Document URL.
documents[].kind	ENUM	No	Document kind. Allowed values: `ubl`, `cii`.
documents[].bytes	Integer	No	Document size in bytes.
documents[].sha256	String	No	SHA-256 hash.
documents[].filename	String	No	Document filename.
documents[].mediaType	String	No	Media type.
dueDate	String	No	Due date in `date` format.
id	String	No	Generated invoice identifier.
issueDate	String	No	Issue date in `date` format.
number	String	No	Invoice number.
profile	ENUM	No	Invoice profile. Allowed values: `basic`, `en16931`, `extended`.
status	ENUM	No	Generation status. Allowed values: `generated`.
totals	Object	No	Totals summary. Includes `vatBreakdown` and amount fields.
totals.vatBreakdown	Object Array	No	VAT breakdown entries. Each item may include tax, rate, taxable amount, category, and exemption details.
totals.vatBreakdown[].tax	String	No	VAT tax amount.
totals.vatBreakdown[].rate	String	No	VAT rate.
totals.vatBreakdown[].taxable	String	No	Taxable amount.
totals.vatBreakdown[].category	ENUM	No	VAT category. Allowed values: `S`, `Z`, `E`, `AE`, `K`, `G`, `O`, `L`, `M`.
totals.vatBreakdown[].exemptionReason	String	No	VAT exemption reason.
totals.vatBreakdown[].exemptionReasonCode	String	No	VAT exemption reason code.
totals.lineNetAmount	String	No	Line net amount.
totals.payableAmount	String	No	Payable amount.
totals.prepaidAmount	String	No	Prepaid amount.
totals.taxTotalAmount	String	No	Tax total amount.
totals.chargeTotalAmount	String	No	Charge total amount.
totals.taxExclusiveAmount	String	No	Tax exclusive amount.
totals.taxInclusiveAmount	String	No	Tax inclusive amount.
totals.allowanceTotalAmount	String	No	Allowance total amount.
validation	Object	No	Validation result summary.
validation.valid	Boolean	No	Indicates whether validation passed.
validation.ruleset	String	No	Validation ruleset used.
validation.errorCount	Integer	No	Number of validation errors.
validation.violations	Object Array	No	Validation violations. Each item may include path, rule, message, and severity.
validation.violations[].path	String	No	Violation path.
validation.violations[].rule	String	No	Violated rule.
validation.violations[].message	String	No	Violation message.
validation.violations[].severity	ENUM	No	Violation severity. Allowed values: `error`, `warning`.
validation.warningCount	Integer	No	Number of validation warnings.

▣ ENDPOINT 02 / 04

POST

Validate an invoice without generating it

https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices

QUICKSTART

GUIDE

Quickstart

Validate an invoice by sending the required invoice fields as JSON.

curl -X POST "https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "INV-2026-0042",
    "issueDate": "2026-01-15",
    "currency": "EUR",
    "buyerReference": "PO-2026-0150",
    "seller": {
      "name": "Acme Supplies SAS",
      "vatId": "FR12345678901",
      "address": {
        "city": "Paris",
        "postalCode": "75001",
        "countryCode": "FR"
      }
    },
    "buyer": {
      "name": "Northwind Trading Ltd",
      "vatId": "FR12345678901",
      "address": {
        "city": "Lyon",
        "postalCode": "69002",
        "countryCode": "FR"
      }
    },
    "lines": [
      {
        "name": "Consulting services",
        "quantity": 10,
        "unitPrice": "100.00",
        "vatRate": "20"
      }
    ]
  }'

What you'll get back

Returns a JSON object with valid and validation fields, plus an optional totals object. valid is a boolean; validation is an object with its own valid, ruleset, errorCount, violations, and warningCount fields; totals contains invoice amount breakdown fields such as lineNetAmount, taxTotalAmount, and payableAmount.

{
  "valid": true,
  "validation": {
    "valid": true,
    "ruleset": "en16931",
    "errorCount": 0,
    "violations": [],
    "warningCount": 0
  },
  "totals": {
    "lineNetAmount": "1000.00",
    "taxTotalAmount": "200.00",
    "payableAmount": "1200.00"
  }
}

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Validates an invoice payload without generating the invoice. It accepts the invoice details in the request body and returns validation outcome data plus calculated totals.

Request Body

Parameter	Type	Mandatory	Description
number	String	Yes	Invoice number.
issueDate	String	Yes	Issue date in `date` format.
currency	String	Yes	Invoice currency code.
buyerReference	String	Yes	Buyer reference.
seller	Object	Yes	Seller details; see nested fields below.
seller.name	String	Yes	Seller name.
seller.taxId	String	No	Seller tax identifier.
seller.vatId	String	Yes	Seller VAT ID.
seller.address	Object	Yes	Seller address; see nested fields below.
seller.address.city	String	Yes	City.
seller.address.street	String	No	Street.
seller.address.postalCode	String	Yes	Postal code.
seller.address.countryCode	String	Yes	Country code.
seller.address.additionalStreet	String	No	Additional street line.
seller.address.countrySubdivision	String	No	Country subdivision.
seller.contact	Object	No	Seller contact details; see nested fields below.
seller.contact.name	String	No	Contact name.
seller.contact.email	String	No	Contact email.
seller.contact.phone	String	No	Contact phone.
seller.legalId	Object	No	Seller legal identifier; see nested fields below.
seller.legalId.value	String	Yes	Legal identifier value.
seller.legalId.scheme	String	No	Legal identifier scheme.
seller.tradingName	String	No	Seller trading name.
seller.identifications	Object Array	No	Seller identifications; each item contains `value` and optionally `scheme`.
seller.identifications[].value	String	Yes	Identification value.
seller.identifications[].scheme	String	No	Identification scheme.
seller.electronicAddress	Object	No	Seller electronic address; see nested fields below.
seller.electronicAddress.value	String	Yes	Electronic address value.
seller.electronicAddress.scheme	String	Yes	Electronic address scheme.
buyer	Object	Yes	Buyer details; see nested fields below.
buyer.name	String	Yes	Buyer name.
buyer.taxId	String	No	Buyer tax identifier.
buyer.vatId	String	Yes	Buyer VAT ID.
buyer.address	Object	Yes	Buyer address; see nested fields below.
buyer.address.city	String	Yes	City.
buyer.address.street	String	No	Street.
buyer.address.postalCode	String	Yes	Postal code.
buyer.address.countryCode	String	Yes	Country code.
buyer.address.additionalStreet	String	No	Additional street line.
buyer.address.countrySubdivision	String	No	Country subdivision.
buyer.contact	Object	No	Buyer contact details; see nested fields below.
buyer.contact.name	String	No	Contact name.
buyer.contact.email	String	No	Contact email.
buyer.contact.phone	String	No	Contact phone.
buyer.legalId	Object	No	Buyer legal identifier; see nested fields below.
buyer.legalId.value	String	Yes	Legal identifier value.
buyer.legalId.scheme	String	No	Legal identifier scheme.
buyer.tradingName	String	No	Buyer trading name.
buyer.identifications	Object Array	No	Buyer identifications; each item contains `value` and optionally `scheme`.
buyer.identifications[].value	String	Yes	Identification value.
buyer.identifications[].scheme	String	No	Identification scheme.
buyer.electronicAddress	Object	No	Buyer electronic address; see nested fields below.
buyer.electronicAddress.value	String	Yes	Electronic address value.
buyer.electronicAddress.scheme	String	Yes	Electronic address scheme.
lines	Object Array	Yes	Invoice lines; at least one line is required.
lines[].id	String	No	Line identifier.
lines[].name	String	Yes	Line name.
lines[].note	String	No	Line note.
lines[].charge	Object	No	Charge details; see nested fields below.
lines[].charge.amount	Number	No	Charge amount.
lines[].charge.reason	String	No	Charge reason.
lines[].charge.percent	Number	No	Charge percentage.
lines[].vatRate	Number	Yes	VAT rate.
lines[].discount	Object	No	Discount details; see nested fields below.
lines[].discount.amount	Number	No	Discount amount.
lines[].discount.reason	String	No	Discount reason.
lines[].discount.percent	Number	No	Discount percentage.
lines[].itemCode	Object	No	Item code; see nested fields below.
lines[].itemCode.value	String	Yes	Item code value.
lines[].itemCode.scheme	String	No	Item code scheme.
lines[].quantity	Number	Yes	Quantity.
lines[].unitCode	String	No	Unit code; default `C62`.
lines[].unitPrice	Number	Yes	Unit price.
lines[].description	String	No	Line description.
lines[].vatCategory	ENUM	No	VAT category. Allowed values: `S`, `Z`, `E`, `AE`, `K`, `G`, `O`, `L`, `M`.
lines[].exemptionReason	String	No	VAT exemption reason.
lines[].exemptionReasonCode	String	No	VAT exemption reason code.
note	String	No	Invoice note.
dueDate	String	No	Due date in `date` format.
payment	Object	No	Payment details; see nested fields below.
payment.bic	String	No	BIC.
payment.iban	String	No	IBAN.
payment.meansCode	String	No	Payment means code; default `30`.
payment.reference	String	No	Payment reference.
payment.accountName	String	No	Account name.
profile	ENUM	No	Invoice profile. Allowed values: `basic`, `en16931`, `extended`.
delivery	Object	No	Delivery details; see nested fields below.
delivery.date	String	No	Delivery date in `date` format.
delivery.address	Object	No	Delivery address; see nested fields below.
delivery.address.city	String	Yes	City.
delivery.address.street	String	No	Street.
delivery.address.postalCode	String	Yes	Postal code.
delivery.address.countryCode	String	Yes	Country code.
delivery.address.additionalStreet	String	No	Additional street line.
delivery.address.countrySubdivision	String	No	Country subdivision.
delivery.partyName	String	No	Delivery party name.
documentType	ENUM	No	Document type. Allowed values: `invoice`, `credit_note`.
paymentTerms	String	No	Payment terms.
orderReference	String	No	Order reference.
projectReference	String	No	Project reference.
contractReference	String	No	Contract reference.

Response

Returns a JSON object with totals, valid, and validation fields. totals is an object containing calculated amount fields and a vatBreakdown array, valid is a boolean indicating whether the invoice is valid, and validation is an object with rule-check details.

Parameter	Type	Mandatory	Description
totals	Object	Yes	Calculated totals for the invoice, including `vatBreakdown` and amount fields.
totals.vatBreakdown	Object Array	No	VAT breakdown entries.
totals.vatBreakdown[].tax	String	No	Tax amount.
totals.vatBreakdown[].rate	String	No	VAT rate.
totals.vatBreakdown[].taxable	String	No	Taxable amount.
totals.vatBreakdown[].category	ENUM	No	VAT category. Allowed values: `S`, `Z`, `E`, `AE`, `K`, `G`, `O`, `L`, `M`.
totals.vatBreakdown[].exemptionReason	String	No	VAT exemption reason.
totals.vatBreakdown[].exemptionReasonCode	String	No	VAT exemption reason code.
totals.lineNetAmount	String	No	Line net amount.
totals.payableAmount	String	No	Payable amount.
totals.prepaidAmount	String	No	Prepaid amount.
totals.taxTotalAmount	String	No	Total tax amount.
totals.chargeTotalAmount	String	No	Total charge amount.
totals.taxExclusiveAmount	String	No	Tax-exclusive amount.
totals.taxInclusiveAmount	String	No	Tax-inclusive amount.
totals.allowanceTotalAmount	String	No	Total allowance amount.
valid	Boolean	Yes	`true` when the invoice is valid, `false` otherwise.
validation	Object	Yes	Validation details, including rule set, counts, and violations.
validation.valid	Boolean	No	Validation result at the validation-object level.
validation.ruleset	String	No	Ruleset used for validation.
validation.errorCount	Integer	No	Number of validation errors.
validation.violations	Object Array	No	Validation violations.
validation.violations[].path	String	No	Field path related to the violation.
validation.violations[].rule	String	No	Rule identifier.
validation.violations[].message	String	No	Violation message.
validation.violations[].severity	ENUM	No	Severity of the violation. Allowed values: `error`, `warning`.
validation.warningCount	Integer	No	Number of validation warnings.

▣ ENDPOINT 03 / 04

POST

Submit an invoice to Peppol

https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/send

QUICKSTART

GUIDE

Quickstart

Send an invoice dispatch request with the invoice ID in the path and the required invoice details in the JSON body.

curl -X POST "https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/send" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceNumber": "FAC-2026-0042",
    "sellerEndpoint": "0192:55210854117",
    "buyerEndpoint": "0002:DE999999999"
  }'

What you'll get back

Returns a JSON object with dispatchedAt, invoiceId, messageId, mode, and status fields. dispatchedAt is a date-time string, invoiceId and messageId are strings, mode is a string, and status is either "pending" or "sent".

{
  "dispatchedAt": "2026-01-15T10:30:00Z",
  "invoiceId": "inv_12345",
  "messageId": "msg_67890",
  "mode": "production",
  "status": "sent"
}

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Submits an invoice to Peppol for dispatch. It takes a path id and a request body containing the invoice and endpoint details, then returns dispatch metadata for the submitted invoice.

Path Parameter(s)

Attribute	Type	Mandatory	Description
id	String	Yes	Identifies the target resource for the submission.

Request Body

Parameter	Type	Mandatory	Description
invoiceNumber	String	Yes	Invoice number.
sellerEndpoint	String	Yes	Seller endpoint identifier.
buyerEndpoint	String	Yes	Buyer endpoint identifier.
webhookUrl	String	No	Optional outbound webhook URL for status callbacks.

Response

Returns a JSON object with dispatchedAt, invoiceId, messageId, mode, and status fields. dispatchedAt is a date-time string; the remaining fields are strings, and status is limited to pending or sent.

Parameter	Type	Mandatory	Description
dispatchedAt	String	No	Dispatch timestamp in date-time format.
invoiceId	String	No	Invoice identifier returned by the service.
messageId	String	No	Message identifier returned by the service.
mode	String	No	Dispatch mode returned by the service.
status	ENUM	No	Dispatch status. Allowed values: `pending`, `sent`.

▣ ENDPOINT 04 / 04

GET

Retrieve the sending status

https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/status

QUICKSTART

GUIDE

Quickstart

Fetch the status for a specific invoice by replacing the path parameter value in the URL.

curl -X GET "https://api.eu.apyhub.com/corsair96/validate-generate-send-peppol-e-invoices/status" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with these top-level fields: createdAt, id, invoiceNumber, status, statusHistory, and updatedAt.

createdAt, updatedAt: date-time strings
id, invoiceNumber: strings
status: one of pending, sent, delivered, accepted, or rejected
statusHistory: an array of objects with at, detail, and status fields

{
  "createdAt": "2026-10-29T12:00:00Z",
  "id": "inv_12345",
  "invoiceNumber": "INV-1001",
  "status": "sent",
  "statusHistory": [
    {
      "at": "2026-10-29T12:05:00Z",
      "detail": "Invoice sent to recipient",
      "status": "sent"
    }
  ],
  "updatedAt": "2026-10-29T12:05:00Z"
}

TRY ITLIVE · 1 ATOM

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves the sending status for a specific invoice sending resource identified by id. The response returns the current status plus timestamp and history fields for that resource.

Path Parameter(s)

Attribute	Type	Mandatory	Description
id	String	Yes	Identifies the sending status resource in the `/status` path.

Response

Returns a JSON object with createdAt, id, invoiceNumber, status, statusHistory, and updatedAt fields. The status field indicates the current sending state, and statusHistory provides an array of past status entries.

Attribute	Type	Mandatory	Description
createdAt	String	No	Date-time when the resource was created.
id	String	No	Resource identifier.
invoiceNumber	String	No	Invoice number associated with the sending record.
status	ENUM	No	Current sending status. Allowed values: `pending`, `sent`, `delivered`, `accepted`, `rejected`.
statusHistory	Object Array	No	History of status changes. Each item contains `at`, `detail`, and `status`.
updatedAt	String	No	Date-time when the resource was last updated.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.

Similar APIs

Closest matches in the catalog based on this service.

CALLCreate, Validate & Parse E-Invoice APICallable Labs CALLGenerate Invoice Document from JSON APICallable Labs CALLInvoice Parsing APISharpAPI CALLValidate Payment & Generate QR APICallable Labs

From the blog

Reads that touch this API.

Invoice Generator API: Create Invoice PDFs from JSON with PythonOct 25, 2026 Automate Invoice Processing with SharpAPI’s Invoice Parsing API on ApyHubJul 9, 2026 AI Document Invoice Data Extraction API: Automate Invoice Processing with AIJul 9, 2026 Advanced Email Validation using ApyHub’s API in NodeJSJul 9, 2026