# List invoices

Retrieve a paginated list of invoices for the location. Supports filtering by patient, status, and date range.

Endpoint: GET /partner/v2/account/{accountId}/location/{locationId}/invoice
Version: 2.0
Security: PartnerOAuth

## Query parameters:

  - `patientId` (integer)
    Filter by patient ID

  - `status` (string)
    Filter by status (DRAFT, OPEN, VIEWED, PAID, FAILED, PAST_DUE, REFUNDED, VOID)

  - `startDate` (string)
    Start of date range (ISO 8601)

  - `endDate` (string)
    End of date range (ISO 8601)

  - `cursor` (string)
    Pagination cursor

  - `limit` (integer)
    Number of results per page (max 100)
    Example: 20

## Path parameters:

  - `accountId` (integer, required)
    Account identifier

  - `locationId` (integer, required)
    Location identifier

## Response 200 fields (application/json):

  - `invoices` (array)
    List of invoices

  - `invoices.appointmentId` (integer)
    Associated appointment ID

  - `invoices.createdAt` (string)
    Creation timestamp
    Example: "2025-01-15T10:00:00Z"

  - `invoices.currency` (string)
    Currency code
    Example: "USD"

  - `invoices.dueDate` (string)
    Due date
    Example: "2025-02-01T00:00:00Z"

  - `invoices.id` (integer)
    Unique invoice identifier
    Example: 12345

  - `invoices.invoiceNumber` (string)
    Invoice number (display format)
    Example: "INV-2025-0001"

  - `invoices.lineItems` (array)
    Invoice line items

  - `invoices.lineItems.careResourceId` (integer)
    Reference to care resource/service ID

  - `invoices.lineItems.description` (string)
    Item description
    Example: "Office Visit - New Patient"

  - `invoices.lineItems.id` (integer)
    Line item ID
    Example: 11111

  - `invoices.lineItems.quantity` (integer)
    Quantity
    Example: 1

  - `invoices.lineItems.taxAmount` (number)
    Tax amount for this line item
    Example: 12

  - `invoices.lineItems.total` (number)
    Line total (quantity * unit price)
    Example: 150

  - `invoices.lineItems.type` (string)
    Item type
    Enum: "SERVICE", "PRODUCT", "EQUIPMENT", "OTHER"

  - `invoices.lineItems.unitPrice` (number)
    Unit price
    Example: 150

  - `invoices.locationId` (integer)
    Location ID
    Example: 111

  - `invoices.locationName` (string)
    Location name
    Example: "Main Street Clinic"

  - `invoices.paidAmount` (number)
    Amount paid
    Example: 166.5

  - `invoices.paidAt` (string)
    Date payment was received

  - `invoices.patientId` (integer)
    Patient ID
    Example: 67890

  - `invoices.patientName` (string)
    Patient name
    Example: "John Doe"

  - `invoices.refundedAmount` (number)
    Amount refunded

  - `invoices.status` (string)
    Invoice status
    Enum: "DRAFT", "OPEN", "VIEWED", "PAID", "FAILED", "PAST_DUE", "REFUNDED", "VOID"

  - `invoices.subscriptionId` (integer)
    Associated subscription ID (for recurring invoices)

  - `invoices.subtotal` (number)
    Subtotal amount (before tax and surcharge)
    Example: 150

  - `invoices.surchargeAmount` (number)
    Surcharge amount (processing fee)
    Example: 4.5

  - `invoices.taxAmount` (number)
    Tax amount
    Example: 12

  - `invoices.totalAmount` (number)
    Total amount due
    Example: 166.5

  - `invoices.updatedAt` (string)
    Last update timestamp
    Example: "2025-01-15T14:30:00Z"

  - `nextCursor` (string)
    Opaque cursor for fetching the next page


## Response 400 fields

## Response 401 fields

## Response 403 fields