read

Peppol e-invoice messages of one entity, with their status and validation report.

The status is the one fin.einvoice.status_changed carries. The document bytes are not returned here: payload_sha256 and payload_bytes identify them, and the validation report names the hash it was produced for. Keyset-paged: pass page.next_cursor back as cursor while page.has_more is true. page.truncated is true only when a server-side bound cut this page short of what was asked; it is never a silent cut.

The GET form of finance_einvoice_messages_list: the same arguments as query parameters.

get/api/v1/finance/einvoice-messages

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/einvoice-messages
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Query parameters

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

message_idstring uuid

Only this message.

sales_invoice_idstring uuid

Only the messages of this invoice.

cursorstring

The next_cursor of the previous page. Opaque.

limitinteger

Items per page.

entitystring uuid

Alias of entity_id; give one of the two.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.