get/v1/invoices

List Invoices

Returns Invoices in the authenticated Organization. booking_id and patient_id are optional. When both are supplied, an Invoice must match both filters.

Required API scopes: invoices.read

Parameters

booking_id
query
string
Filter by a Booking in the Organization.
patient_id
query
string
Filter by a Patient with an active connection to the Organization.
limit
query
integer
The maximum number of items to return. Defaults to 25; the maximum is 100.
starting_after
query
string
Return items after this resource ID. You cannot use this with cursor.
cursor
query
string
The next_cursor value from the previous page. You cannot use this with starting_after.

Responses

200

Paginated list of Invoice objects.

dataarrayrequired
- itemsobject
  - booking_idsarrayrequired
    The Bookings associated with the Invoice.
    - itemsstring · uuid
  - clinician_idstring | null · uuidrequired
    The Clinician associated with the Invoice.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - currencystring | nullrequired
    The ISO 4217 currency code.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - invoice_notesstring | nullrequired
    The sanitized HTML notes on the Invoice.
  - invoice_numberstring | nullrequired
    The Invoice number, unique within the Organization.
  - line_itemsarrayrequired
    The charges included on the Invoice.
    - itemsobject
      - booking_idstring | null · uuidrequired
        The Booking associated with the line item.
      - created_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - currencystring | nullrequired
        The ISO 4217 currency code.
      - discount_amountinteger | nullrequired
        The discount in minor currency units.
      - gross_amountinteger | nullrequired
        The gross amount in minor currency units.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - net_amountinteger | nullrequired
        The net amount in minor currency units.
      - objectanyrequired
        Discriminator value emitted at object.
      - quantitynumber | nullrequired
        The quantity charged.
      - service_variant_idstring | null · uuidrequired
        The ServiceVariant associated with the charge.
      - tax_amountinteger | nullrequired
        The tax amount in minor currency units.
      - titlestring | nullrequired
        The line item description.
      - totalinteger | nullrequired
        The line total in minor currency units.
      - unit_priceinteger | nullrequired
        The unit price in minor currency units.
      - updated_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - linksobjectrequired
    URLs to related resources.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring | null · uuidrequired
    The Patient associated with the Invoice.
  - payor_typestring | nullrequired
    The type of party responsible for payment.
  - statusstring | nullrequired
    The Invoice's current status.
    Allowed values: awaiting_patient | being_processed | canceled | credited_error | credited_goodwill | credited_other | credited_overbilled | credited_service_not_delivered | draft | error | no_payment_required | overdue | overpaid | paid | partially_credited | partially_paid | partially_refunded | partially_written_off | payment_scheduled | refunded | scheduled_for_sending | sent_to_debt_collectors | sent_to_insurance_company | sent_to_other_recipient | unpaid | validated | written_off_nonpayer | written_off_other | null
  - subtotalinteger | nullrequired
    The subtotal in minor currency units.
  - supply_datestring | null · daterequired
    The date on which the invoiced services were supplied.
  - tax_amountinteger | nullrequired
    The tax amount in minor currency units.
  - titlestring | nullrequired
    The Invoice title.
  - totalintegerrequired
    The total in minor currency units.
  - total_discount_amountinteger | nullrequired
    The total discount in minor currency units.
  - total_outstandinginteger | nullrequired
    The outstanding amount in minor currency units.
  - total_paidinteger | nullrequired
    The paid amount in minor currency units.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
has_morebooleanrequired
Whether another page is available after next_cursor.
next_cursorstring | nullrequired
The value to pass as cursor for the next page. Null on the last page.
objectanyrequired
Always list.
urlstringrequired
The API path that returned this list.

Example

{
  "object": "list",
  "data":  … ]
     … }
      "id": "2fc3a636-66c0-4677-86be-032dd32125e1",
      "object": "invoice",
      "booking_ids":  … ]
        "92a3b4c5-d6e7-4f01-8234-56789abcdef0"
      ],
      "clinician_id": "2b3c4d5e-6f70-489a-9bcd-ef0123456789",
      "created_at": "2026-01-01T09:00:00Z",
      "currency": "GBP",
      "invoice_notes": "<p>Payment is due within 30 days.</p>",
      "invoice_number": "INV-1001",
      "line_items":  … ]
         … }
          "id": "1bf0a3b9-0974-4fd3-8bf6-817d28071309",
          "object": "invoice_line_item",
          "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
          "created_at": "2026-01-01T09:00:00Z",
          "currency": "GBP",
          "discount_amount": 1,
          "gross_amount": 1,
          "net_amount": 1,
          "quantity": 1.5,
          "service_variant_id": "6f708192-a3b4-4cde-9f01-23456789abcd",
          "tax_amount": 1,
          "title": "Dr",
          "total": 1,
          "unit_price": 1,
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678"
      },
      "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
      "payor_type": "insurance_company",
      "status": "awaiting_patient",
      "subtotal": 1,
      "supply_date": "2026-01-01",
      "tax_amount": 1,
      "title": "Dr",
      "total": 1,
      "total_discount_amount": 1,
      "total_outstanding": 1,
      "total_paid": 1,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/invoices"
}

400

A pagination parameter is invalid.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

401

The access token is missing, invalid, expired, or revoked.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

403

The access token lacks the required scope, or the project is disabled.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

404

The Booking or Patient was not found in the Organization.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

429

Too many requests. Retry after the delay indicated by Retry-After.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

Request

curl -X GET "https://api.carebit.co/v1/invoices" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "object": "list",
  "data":  … ]
     … }
      "id": "2fc3a636-66c0-4677-86be-032dd32125e1",
      "object": "invoice",
      "booking_ids":  … ]
        "92a3b4c5-d6e7-4f01-8234-56789abcdef0"
      ],
      "clinician_id": "2b3c4d5e-6f70-489a-9bcd-ef0123456789",
      "created_at": "2026-01-01T09:00:00Z",
      "currency": "GBP",
      "invoice_notes": "<p>Payment is due within 30 days.</p>",
      "invoice_number": "INV-1001",
      "line_items":  … ]
         … }
          "id": "1bf0a3b9-0974-4fd3-8bf6-817d28071309",
          "object": "invoice_line_item",
          "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
          "created_at": "2026-01-01T09:00:00Z",
          "currency": "GBP",
          "discount_amount": 1,
          "gross_amount": 1,
          "net_amount": 1,
          "quantity": 1.5,
          "service_variant_id": "6f708192-a3b4-4cde-9f01-23456789abcd",
          "tax_amount": 1,
          "title": "Dr",
          "total": 1,
          "unit_price": 1,
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678"
      },
      "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
      "payor_type": "insurance_company",
      "status": "awaiting_patient",
      "subtotal": 1,
      "supply_date": "2026-01-01",
      "tax_amount": 1,
      "title": "Dr",
      "total": 1,
      "total_discount_amount": 1,
      "total_outstanding": 1,
      "total_paid": 1,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/invoices"
}

400 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

401 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

403 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

404 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

429 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

Endpoints

Parameters

Responses