Home > API > Clients > Get the timeline of an invoice.

Get the timeline of an invoice.

Retrieves the events that have occured on an invoice.

Events are sorted in descending order from the time they occured at (ie: from newest to oldest).

PATH:

/v1/clients/{clientId}/invoices/{invoiceNumber}/timeline

PATH PARAMETERS:

clientId
required

integer

Your assigned clientId.
invoiceNumber
required

string

The invoice number.

HYPERMEDIA CONTROL

AVAILABLE IN:

    RESPONSES:

    200 Returned when the timeline data is retrieved successfully.

    RESPONSE SCHEMA:

    timeline

    array of timeline

    List of events on an invoice.
    Array () [
    eventType

    string <= 32 characters

    The type of invoice event.
    recordedAt

    string date-time

    Date and time of when the event was recorded.
    payload

    undefined

    Additional data provided.
    _links

    array of _links

    Related API endpoints for the event.
    Array () [
    method

    string

    HTTP Method.
    href

    string

    API Endpoint URL.
    rel

    string

    Name of endpoint.
    target

    string

    Enum: api browser

    no description in swagger file

    ]

    ]
    _links

    array of _links

    Other related API Endpoints.
    Array () [
    method

    string

    HTTP Method.
    href

    string

    API Endpoint URL.
    rel

    string

    Name of endpoint.
    target

    string

    Enum: api browser

    no description in swagger file

    ]
    401 Returned when the request has a missing or invalid "Authorization" header.

    RESPONSE SCHEMA:

    type

    string

    no description in swagger file
    category

    string

    Enum: BusinessError TechnicalError

    no description in swagger file
    title

    string

    no description in swagger file
    message

    string

    no description in swagger file
    detail

    string

    There is an error message.
    customerFacingMessage

    string

    no description in swagger file
    403 Returned when the requester is lacking permissions.

    RESPONSE SCHEMA:

    type

    string

    no description in swagger file
    category

    string

    Enum: BusinessError TechnicalError

    no description in swagger file
    title

    string

    no description in swagger file
    message

    string

    no description in swagger file
    detail

    string

    There is an error message.
    customerFacingMessage

    string

    no description in swagger file
    404 Returned when the invoice is not found.

    RESPONSE SCHEMA:

    type

    string

    no description in swagger file
    category

    string

    Enum: BusinessError TechnicalError

    no description in swagger file
    title

    string

    no description in swagger file
    message

    string

    no description in swagger file
    detail

    string

    There is an error message.
    customerFacingMessage

    string

    no description in swagger file
    500 Returned when some internal error happens.

    RESPONSE SCHEMA:

    type

    string

    no description in swagger file
    category

    string

    Enum: BusinessError TechnicalError

    no description in swagger file
    title

    string

    no description in swagger file
    message

    string

    no description in swagger file
    detail

    string

    There is an error message.
    customerFacingMessage

    string

    no description in swagger file

    Path

    get

    /v1/clients/{clientId}/invoices/{invoiceNumber}/timeline

    Response samples

    200401403404500
    • {
      • "timeline": [ ...
        • {
          • "eventType": "string",
          • "recordedAt": "string",
          • "payload": X,
          • "_links": [ ...
            • {
              • "method": "string",
              • "href": "string",
              • "rel": "string",
              • "target": "string"
              }
            ]
          }
        ],
      • "_links": [ ...
        • {
          • "method": "string",
          • "href": "string",
          • "rel": "string",
          • "target": "string"
          }
        ]
      }
    • {
      • "type": "string",
      • "category": "string",
      • "title": "string",
      • "message": "string",
      • "detail": "string",
      • "customerFacingMessage": "string"
      }
    • {
      • "type": "string",
      • "category": "string",
      • "title": "string",
      • "message": "string",
      • "detail": "string",
      • "customerFacingMessage": "string"
      }
    • {
      • "type": "string",
      • "category": "string",
      • "title": "string",
      • "message": "string",
      • "detail": "string",
      • "customerFacingMessage": "string"
      }
    • {
      • "type": "string",
      • "category": "string",
      • "title": "string",
      • "message": "string",
      • "detail": "string",
      • "customerFacingMessage": "string"
      }