# Get list of billing information filtered

Endpoint: GET /billing-information
Version: 1.0
Security: bearer

## Query parameters:

  - `withPaymentMethod` (boolean)
    Pass true or false (1 or 0) to filter by whether the billing information has a payment method (credit card or bank account)

  - `page` (number)
    Page number (0-based)

  - `pageSize` (number)
    Number of items per page
    Example: 10

  - `sortBy[0][field]` (string)
    First sort field
    Enum: "id", "clientAccountId", "createdAt", "updatedAt"

  - `sortBy[0][dir]` (string)
    First sort direction
    Enum: "asc", "desc"

  - `sortBy[1][field]` (string)
    Second sort field
    Enum: "id", "clientAccountId", "createdAt", "updatedAt"

  - `sortBy[1][dir]` (string)
    Second sort direction
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `data` (array, required)
    Array of billing information

  - `data.id` (number, required)
    ID of the billing information
    Example: 1

  - `data.clientAccountId` (number, required)
    ID of the client account
    Example: 1

  - `data.costPerLocation` (number, required)
    Cost per location
    Example: 100

  - `data.minimumBillingLocations` (number, required)
    Minimum number of billing locations
    Example: 5

  - `data.isAutoRenew` (boolean, required)
    Whether auto-renewal is enabled
    Example: true

  - `data.billingStartDate` (string, required)
    Start date for billing
    Example: "2024-03-17T00:00:00Z"

  - `data.billingFrequency` (string, required)
    Billing frequency
    Enum: "MONTHLY", "QUARTERLY", "ANNUALLY"

  - `data.stripeCustomerId` (string,null)
    Stripe customer ID
    Example: "cus_123456789"

  - `data.createdAt` (string, required)
    Creation date
    Example: "2024-01-01T00:00:00Z"

  - `data.stripeSubscriptionId` (string,null)
    Stripe subscription ID (once a subscription exists)
    Example: "sub_1RFBYKHGcS3PmRZjUcjG4rYN"

  - `data.updatedAt` (string, required)
    Last update date
    Example: "2024-01-01T00:00:00Z"

  - `data.billingManagerUser` (object, required)

  - `data.billingManagerUser.user` (object, required)

  - `data.billingManagerUser.user.id` (number, required)
    Unique identifier for the user
    Example: 1

  - `data.billingManagerUser.user.email` (string, required)
    Email address of the user
    Example: "admin@admin.com"

  - `data.billingManagerUser.user.firstName` (string, required)
    First name of the user
    Example: "John"

  - `data.billingManagerUser.user.lastName` (string, required)
    Last name of the user
    Example: "Doe"

  - `data.billingManagerUser.user.role` (string, required)
    Role of the user
    Enum: "ADMIN", "ORGANIZATION_USER", "BRAND_USER", "SITE_USER", "CLIENT_ACCOUNT_USER", "SITE_MANAGER_USER"

  - `data.billingManagerUser.user.isEnabled` (boolean, required)
    Is the user enabled
    Example: true

  - `data.billingManagerUser.user.createdAt` (string, required)
    Creation date of the user
    Example: "2024-01-01T00:00:00.000Z"

  - `data.billingManagerUser.user.updatedAt` (string, required)
    Last update date of the user
    Example: "2024-01-02T00:00:00.000Z"

  - `data.billingManagerUser.user.userOrganizations` (array)
    Organizations associated with the user

  - `data.billingManagerUser.user.userBrands` (array)
    Brands associated with the user

  - `data.billingManagerUser.user.userSites` (array)
    Sites associated with the user

  - `data.billingManagerUser.user.userClientAccounts` (array)
    Client accounts associated with the user

  - `data.billingManagerUser.user.clientAccountSiteManagers` (array)
    Client account site management permissions

  - `data.billingManagerUser.user.tosAcceptedAt` (string, required)
    Time stamp of the Terms of Services acceptance
    Example: "2024-01-02T00:00:00.000Z"

  - `data.clientAccount` (object, required)

  - `data.clientAccount.id` (number, required)
    Example: 1

  - `data.clientAccount.title` (string, required)
    Example: "Downtown Clinic"

  - `meta` (object, required)
    Pagination metadata

  - `meta.page` (number, required)
    Current page number (0-based)

  - `meta.pageSize` (number, required)
    Number of items per page
    Example: 10

  - `meta.total` (number, required)
    Total number of items
    Example: 150

  - `meta.totalPages` (number, required)
    Total number of pages
    Example: 15

  - `meta.hasNext` (boolean, required)
    Whether there is a next page
    Example: true

  - `meta.hasPrevious` (boolean, required)
    Whether there is a previous page

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401