JSR Tax Advisors logoAPI
Developer APIsReference documentation

Get Peppol status

Returns the current aggregated Peppol transmission status for a sale invoice, including billing (C3 / PINT) and tax reporting (C5) legs. This is a single snapshot object, unlike the chronological Peppol status log endpoint.

This endpoint returns the sent message record from the Peppol integration service.

For workflow decisions, prefer meta_info.peppol_status.overall_status on document retrieve. See Peppol Transmission Status for the full field reference and client processing guidance.

See the right panel for request and response examples.

Rate limit

See Rate limiting for response headers (X-RateLimit-*) and retry guidance.

Path parameters
ParameterTypeRequiredDescription
idstring
Required
ID of the sale invoice.
Response

Status code: 200 OK (application/json)

Returns {} when Peppol transmission has not started yet. This is not an error.

Root fields
FieldTypeDescription
documentTypestringDocument type (e.g. INVOICE).
documentUuidstringUUID of the document.
documentXMLstringBase64-encoded document XML.
idstringInternal identifier for this Peppol status record.
issuedBystringPeppol participant id of the sender (e.g. 0248:OM1100537271).
issuedTostringPeppol participant id of the receiver for the billing leg.
lastUpdatednumberUnix timestamp in milliseconds when this status was last updated.
uuidstringStatus record UUID (distinct from documentUuid).
validationResultsarrayValidation results; empty when there are no validation errors.
toC3objectBilling / PINT OM transmission leg (see below).
toC5objectTax reporting (OTA / tax data) transmission leg (see below).
`toC3` object (billing / PINT)
FieldTypeDescription
countrystring or nullCountry code for this leg (e.g. OM).
docTypeIdstringPeppol document type identifier (e.g. PINT billing URN).
documentXmlstringBase64-encoded document XML payload for this leg.
lastUpdatednumberLast update time for this leg (milliseconds).
mlsResponseobject or nullMLS response payload when applicable.
processIdstringPeppol process identifier (e.g. urn:peppol:bis:billing).
receiverIdstringReceiver participant id for this leg.
senderIdstringSender participant id for this leg.
statusstringLeg-specific status (e.g. SUBMITTED, MLS_C3_TRANSMISSION_ERROR; exact values depend on backend).
transmissionUuidstringUUID for this transmission attempt.
transmissionResponseobjectLow-level transmission result (see below).
`toC5` object (tax reporting)

Same shape as toC3 in general: country, docTypeId, documentXml, lastUpdated, mlsResponse, processId, receiverId, senderId, status, transmissionUuid, transmissionResponse. The docTypeId and processId values reflect the tax reporting profile (e.g. urn:peppol:taxreporting).

`transmissionResponse` object

Present under toC3 and toC5 when the API returns transmission metadata.

FieldTypeDescription
conversationIdstring or nullPeppol / phase conversation identifier when available.
messageIdstring or nullMessage identifier when available.
overallDurationToTransmitnumberDuration of the transmission in milliseconds.
transmissionErrorbooleanWhether a transmission error flag was set.
transmissionErrorsarray or nullDetailed errors when present.
transmissionResultstringHigh-level result (e.g. SUCCESS).
Relationship to other endpoints

  • [Retrieve Peppol status log](./retrieve-peppol-status-log) — GET /api/sales-invoices/{id}/peppol-status-logs returns a time-ordered list of events.

  • Get Peppol status (this page) — GET /api/sales-invoices/{id}/peppol-status returns a single current snapshot with C3 and C5 legs.

Error responses
StatusDescription
401 UnauthorizedAuthentication required or invalid token.
403 ForbiddenUser not authorized to access this sale invoice.
404 Not FoundDocument or Peppol status not found.
500 Internal Server ErrorAn error occurred while processing the request.