Skip to content

List invoices

Request

Retrieve invoices for the location using cursor pagination. Optional filters: purchase order ID, status, patient ID, subscription ID.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
orderIdinteger, (int64)

Filter by purchase order ID linked to the invoice

Example:orderId=1234
statusstring(?i)DRAFT|OPEN|PAID|VOID|UNCOLLECTIBLE

Filter by invoice status

Enum:"DRAFT""OPEN""PAID""VOID""UNCOLLECTIBLE"
Example:status=OPEN
patientIdinteger, (int64)

Filter by patient ID

Example:patientId=1234
subscriptionIdinteger, (int64)

Filter by subscription ID

Example:subscriptionId=99
sortBystring(?i)CREATED_DATE|TOTAL_AMOUNT|DUE_DATE

Sort by field

Default:"CREATED_DATE"
Enum:"CREATED_DATE""TOTAL_AMOUNT""DUE_DATE"
sortDirstring(?i)ASC|DESC

Sort direction

Default:"DESC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/invoice?orderId=1234&status=OPEN&patientId=1234&subscriptionId=99&sortBy=CREATED_DATE&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Invoices retrieved successfully

Bodyapplication/json
invoicesArray of objects(InvoiceDTO)

List of invoices

nextCursorstring

Opaque cursor for fetching the next page

Response
{
  "invoices": [
    { … }
  ],
  "nextCursor": "string"
}