Send Document

POST 
/api/v1/documents

Send a UBL document to a Peppol participant. The document is queued for async delivery.

Request

Responses

202

Successful Response

400

INVALID_REQUEST: the document failed GoRoute's checks (up to five [code] message items in message; for an Omani PINT OM invoice this includes a cbc:UUID that is not the Solution Architecture §10.2.3 derivation, with the expected value), no sender could be found, or the sender is not an active participant of your organisation. INVALID_IDEMPOTENCY_KEY: the Idempotency-Key header is longer than 255 characters. Nothing is created; correct and send again.

401

MISSING_API_KEY, INVALID_API_KEY or EXPIRED_API_KEY.

402

PLAN_LIMIT_REACHED: the organisation's plan allows no more documents this month.

403

INSUFFICIENT_PERMISSION / INSUFFICIENT_SCOPE: the key cannot send.

409

duplicate_invoice_number (in error, with existing_transaction_id): the same invoice number was already sent with different content. SAME_DOCUMENT_EXISTS / SAME_DOCUMENT_FAILED: this document was already sent under another Idempotency-Key. SAME_DOCUMENT_IN_FLIGHT: another send of it is still running (Retry-After: 60).

422

The request body is incomplete (FastAPI detail array: empty document, missing receiver, document_type or process_id not a URN), or IDEMPOTENCY_KEY_REUSED, IDEMPOTENCY_KEY_IN_BODY_NOT_SUPPORTED, PLATFORM_ONLY_DOCUMENT_TYPE, SANDBOX_RECEIVER_NOT_ALLOWED, DOCUMENT_TYPE_MISMATCH (the declared document_type does not name the XML's root element and exact cbc:CustomizationID; expected_document_type is the identifier to send); where the estate enforces them, DOCUMENT_INVALID and OMAN_PINT_OM_REQUIRED.

429

RATE_LIMIT_MINUTE / RATE_LIMIT_DAY: wait for Retry-After.

503

SEND_RULES_UNAVAILABLE: validation could not run where it is enforced; send again later.