Skip to main content

InvoiceLifecycleMessagesDeltaResponse

since_utcdate-time

The since value, normalized to UTC. Useful for verifying how the server interpreted a naked timestamp.

tzstring

IANA zone the request was scoped to.

filters object
ext_reference_1stringnullable
ext_reference_2stringnullable
ext_reference_3stringnullable
ext_reference_4stringnullable
ext_reference_5stringnullable
tierstring

Possible values: [1, 2, 3, all]

messages object[]
  • Array [
  • idinteger

    Message id (stable, monotonic per invoice)

    invoice_idinteger

    Internal numeric invoice id

    invoice_tokenuuid

    Public invoice token

    ext_reference_1stringnullable
    ext_reference_2stringnullable
    ext_reference_3stringnullable
    ext_reference_4stringnullable
    ext_reference_5stringnullable
    codestring

    Lifecycle code (RECEIVED, ACKNOWLEDGED, PAID, ...)

    sourcestring

    Possible values: [NUNTIQ, EXTERNAL_API, MANUAL_USER]

    actor_typestringnullable
    actor_idstringnullable
    actor_display_namestringnullable
    occurred_atdate-time

    When the event happened in the source system

    recorded_atdate-time

    When Nuntiq learned of the event — the watermark this endpoint orders by

    clarification_codestringnullable
    note_internalstringnullable

    Only present when caller has LIFECYCLE_READ_INTERNAL AND requested include_internal_notes=true

    note_supplierstringnullable
    reference_typestringnullable

    Possible values: [PO_NUMBER, PAYMENT_REF, CREDIT_NOTE, OTHER, null]

    reference_valuestringnullable
  • ]
  • next_cursorstringnullable

    Opaque token. Pass as cursor on the next request to continue. Null on the final page.

    InvoiceLifecycleMessagesDeltaResponse
    {
    "since_utc": "2024-07-29T15:51:28.071Z",
    "tz": "string",
    "filters": {
    "ext_reference_1": "string",
    "ext_reference_2": "string",
    "ext_reference_3": "string",
    "ext_reference_4": "string",
    "ext_reference_5": "string"
    },
    "tier": "1",
    "messages": [
    {
    "id": 0,
    "invoice_id": 0,
    "invoice_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ext_reference_1": "string",
    "ext_reference_2": "string",
    "ext_reference_3": "string",
    "ext_reference_4": "string",
    "ext_reference_5": "string",
    "code": "string",
    "source": "NUNTIQ",
    "actor_type": "string",
    "actor_id": "string",
    "actor_display_name": "string",
    "occurred_at": "2024-07-29T15:51:28.071Z",
    "recorded_at": "2024-07-29T15:51:28.071Z",
    "clarification_code": "string",
    "note_internal": "string",
    "note_supplier": "string",
    "reference_type": "PO_NUMBER",
    "reference_value": "string"
    }
    ],
    "next_cursor": "string"
    }