Skip to main content

Get exportable invoice ids

GET 
/invoices/exportable

Gets a page of invoice IDs for invoices that are ready to be exported.

By default, invoice IDs are returned in ascending order by the date the invoice was received into Lightyear.

The returned invoice IDs can be used in subsequent calls to the Get Invoice Detail endpoint.

The response is paginated (default page size: 100) using a continuationKey.

Pagination using continuationKey:

  • First request: do not provide a continuationKey.
  • If a non-null continuationKey is returned, there are more results. Use it in the next request.
  • Always use the continuationKey from the immediately previous response (it may change between calls).
  • If continuationKey is null, there are no more results. On the next polling run, start again without specifying a continuationKey.

Example:

  var response = GET /invoices/exportable
  var key
  do {
  key = response.continuationKey
  completeOrReject(response.items)
  if (key != null)
  response = GET /invoices/exportable?continuationKey=key
  } while (key != null)

Request​

Responses​

Success