Skip to content

Get invoice by ID

Request

Retrieve a single invoice for the location, including line items.

Security
PartnerApiKey and PartnerOAuth
Path
invoiceIdinteger, (int64)required

Invoice ID

Example:1234
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/invoice/1234' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Invoice retrieved successfully

Bodyapplication/json
appointmentIdinteger, (int64)

Appointment ID when applicable

Example:700
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
currencystring

ISO 4217 currency code. May be null for legacy invoices without a resolved currency.

Example:"USD"
discountobject(Money)

Monetary amount

dueOnstring, (date-time)

Due date (UTC)

Example:"2025-01-15T14:00:00Z"
externalIdstring

External identifier from the processor or integrator

Example:"ext_inv_001"
idinteger, (int64)

Invoice ID

Example:1234
lineItemsArray of objects(InvoiceLineItemDTO)

Line items (present on single-invoice responses only)

locationIdinteger, (int64)

Location ID

Example:200
notestring

Invoice note

Example:"Balance due at checkout"
patientIdinteger, (int64)

Patient ID

Example:300
paymentCustomerIdinteger, (int64)

Payment customer ID. May be null for legacy invoices without a resolved payment customer.

Example:400
purchaseOrderIdinteger, (int64)

Purchase order ID when the invoice is tied to an order

Example:500
statusstring

Invoice status

Enum:"DRAFT""OPEN""PAID""VOID""UNCOLLECTIBLE"
Example:"OPEN"
subscriptionIdinteger, (int64)

Subscription ID when the invoice is subscription-based

Example:600
subtotalobject(Money)

Monetary amount

taxobject(Money)

Monetary amount

totalAmountobject(Money)

Monetary amount

updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "appointmentId": 700,
  "createdAt": "2025-01-15T14:00:00Z",
  "currency": "USD",
  "discount": {
    "amount": 50,
    "currency": "USD"
  },
  "dueOn": "2025-01-15T14:00:00Z",
  "externalId": "ext_inv_001",
  "id": 1234,
  "lineItems": [
    { … }
  ],
  "locationId": 200,
  "note": "Balance due at checkout",
  "patientId": 300,
  "paymentCustomerId": 400,
  "purchaseOrderId": 500,
  "status": "OPEN",
  "subscriptionId": 600,
  "subtotal": {
    "amount": 50,
    "currency": "USD"
  },
  "tax": {
    "amount": 50,
    "currency": "USD"
  },
  "totalAmount": {
    "amount": 50,
    "currency": "USD"
  },
  "updatedAt": "2025-01-15T14:00:00Z"
}