API Docs

Peppol Transmission Status

After a document is created, Marmin transmits it over the Peppol network and tracks validation by the Oman Tax Authority (OTA). Transmission metadata is available on every document response and through dedicated status endpoints.

Overview

Concept	Description
Peppol transmission	Delivery of the UBL document from sender to receiver via the Peppol Access Point network
`uuid`	Internal Peppol network document identifier (distinct from `id` and `seller_uuid`)
`meta_info`	Summary object returned on create/retrieve responses
Get Peppol status	Single current snapshot with C3 (billing) and C5 (tax reporting) legs
Retrieve Peppol status log	Chronological event log of transmission milestones

Message direction:

Sales documents (invoices, credit notes, debit notes) use sent messages.
Purchase documents (invoices, credit notes) use received messages.

Response meta_info object

Every document create and retrieve response may include a meta_info object:

Field	Type	Required	Description	Validation
`peppol_status`	object	Optional	Peppol participant/OTA processing status.	Response-only; see Peppol status object below.

Peppol status object

The meta_info.peppol_status field is an object with the following attributes:

Field	Type	Required	Description	Validation
`participant_status`	string	Optional	Participant-level processing status.	May be `null` in early or failed stages.
`ota_status`	string	Optional	OTA submission/processing status.	May be `null` in early or failed stages.
`overall_status`	string	Optional	Overall Peppol processing status.	Must be one of the status values listed below.
`validation_results`	array	Optional	Validation details/errors returned during processing.	Response-only list; empty when there are no validation issues. Items use `text`, `flag`, `reasonCode`, `location`, and `test`.

Status values

Value	Meaning
`VALIDATION_FAILED`	The received document failed validation checks.
`PENDING`	Processing is in progress.
`APPROVED`	The document is accepted.
`REJECTED`	The document is processed but rejected.

Client processing guidance

Treat overall_status as the primary state for workflow decisions.
Use participant_status and ota_status as stage-specific diagnostics for UI and support logs.
If overall_status is PENDING, keep the document in a processing state and re-fetch the document later.
If overall_status is APPROVED, mark the Peppol flow as successful and continue normal downstream actions.
If overall_status is REJECTED or VALIDATION_FAILED, stop submission-dependent actions and surface the failure to users.
When validation_results is not empty, display user-friendly error summaries from text, and retain flag, reasonCode, location, and test for troubleshooting.
participant_status or ota_status can be null in early or failed validation stages; do not treat null alone as success or failure.

Dedicated status endpoints

In addition to meta_info on the document object, each document type exposes:

Endpoint	Returns
`GET /api/{document-type}/{id}/peppol-status`	Single current snapshot with C3 and C5 legs
`GET /api/{document-type}/{id}/peppol-status-logs`	Time-ordered list of transmission events

{id} is the document's Marmin ID (same as retrieve). Both endpoints resolve the document's internal uuid under the hood.

When to use which

Use case	Recommended approach
Display status badge / drive ERP workflow	Read `meta_info.peppol_status.overall_status` from create or retrieve
Poll until transmission completes	Re-fetch the document and parse `overall_status`
Inspect C3/C5 transmission legs	Call Get Peppol status for the current snapshot
Troubleshoot a failed transmission	Call Retrieve Peppol status log for the event timeline

Polling guidance

Prefer re-fetching the document (GET /api/{document-type}/{id}) and reading meta_info.peppol_status.overall_status.
Stop polling once overall_status reaches a terminal state (APPROVED, REJECTED, or VALIDATION_FAILED).
GET .../peppol-status returns {} when transmission has not started yet — this is not an error.

Get Peppol status response fields

Returns a single current snapshot (camelCase), unlike the chronological status log.

Root fields

Field	Type	Description
`documentType`	string	Document type (e.g. `INVOICE`).
`documentUuid`	string	UUID of the document.
`documentXML`	string	Base64-encoded document XML.
`id`	string	Internal identifier for this Peppol status record.
`issuedBy`	string	Peppol participant id of the sender (e.g. `0248:OM1100537271`).
`issuedTo`	string	Peppol participant id of the receiver for the billing leg.
`lastUpdated`	number	Unix timestamp in milliseconds when this status was last updated.
`uuid`	string	Status record UUID (distinct from `documentUuid`).
`validationResults`	array	Validation results; empty when there are no validation errors.
`toC3`	object	Billing / PINT OM transmission leg (see below).
`toC5`	object	Tax reporting (OTA / tax data) transmission leg (see below).

`toC3` object (billing / PINT)

Field	Type	Description
`country`	string or null	Country code for this leg (e.g. `OM`).
`docTypeId`	string	Peppol document type identifier (e.g. PINT billing URN).
`documentXml`	string	Base64-encoded document XML payload for this leg.
`lastUpdated`	number	Last update time for this leg (milliseconds).
`mlsResponse`	object or null	MLS response payload when applicable.
`processId`	string	Peppol process identifier (e.g. `urn:peppol:bis:billing`).
`receiverId`	string	Receiver participant id for this leg.
`senderId`	string	Sender participant id for this leg.
`status`	string	Leg-specific status (e.g. `SUBMITTED`, `MLS_C3_TRANSMISSION_ERROR`; exact values depend on backend).
`transmissionUuid`	string	UUID for this transmission attempt.
`transmissionResponse`	object	Low-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.

Field	Type	Description
`conversationId`	string or null	Peppol / phase conversation identifier when available.
`messageId`	string or null	Message identifier when available.
`overallDurationToTransmit`	number	Duration of the transmission in milliseconds.
`transmissionError`	boolean	Whether a transmission error flag was set.
`transmissionErrors`	array or null	Detailed errors when present.
`transmissionResult`	string	High-level result (e.g. `SUCCESS`).

Peppol status log response fields

Returns a time-ordered list of events (snake_case). Each entry includes:

Field	Type	Description
`id`	string	Unique identifier for the log entry.
`sent_message_id`	string or null	Peppol message ID when sent.
`document_uuid`	string	UUID of the document.
`document_type`	string	Document type (e.g. `INVOICE`).
`sender_id`	string or null	Sender identifier.
`receiver_id`	string or null	Receiver identifier.
`doc_type_id`	string or null	Document type identifier.
`process_id`	string or null	Process identifier.
`country_c1`	string or null	Country code.
`document_xml`	string or null	Document XML when applicable.
`message`	string	Human-readable status message.
`timestamp`	number	Unix timestamp (milliseconds).
`event`	string	Event type (e.g. `DOCUMENT_CREATED`, `DOCUMENT_SUBMITTED`, `VALIDATION_SUCCESS`).

Credit note documents use the same event log shape as invoices and debit notes.

Invoice QR Code and Seller UUID — explains seller_uuid vs uuid
Get Peppol status and Retrieve Peppol status log under each document type in the sidebar