Skip to content

List payments

Request

Retrieve payments for the location using cursor pagination. Optional filters: posted-on date range (startDate, endDate on postedOn), invoice ID, purchase order ID, and patient ID.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
invoiceIdinteger, (int64)

Filter by invoice ID

Example:invoiceId=1234
orderIdinteger, (int64)

Filter by purchase order ID linked to the invoice

Example:orderId=1234
patientIdinteger, (int64)

Filter by patient ID

Example:patientId=1234
startDatestring

Start of date range filter on posted time (postedOn). ISO 8601 format.

Example:startDate=2025-01-01T00:00:00Z
endDatestring

End of date range filter on posted time (postedOn). ISO 8601 format.

Example:endDate=2025-01-31T00:00:00Z
sortBystring(?i)POSTED_ON|AMOUNT

Sort by field

Default:"POSTED_ON"
Enum:"POSTED_ON""AMOUNT"
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}/payment?invoiceId=1234&orderId=1234&patientId=1234&startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-31T00%3A00%3A00Z&sortBy=POSTED_ON&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Payments retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for the next page. Null if no more results.

paymentsArray of objects(PaymentDTO)

Payments in this page

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