@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface GetInvoicesQuery

    Query parameters for sb.billing.invoices.list().

    interface GetInvoicesQuery {
        companyRef?: string;
        "createDate[gte]"?: string;
        "createDate[lte]"?: string;
        customerRef?: string;
        "issueDate[gte]"?: string;
        "issueDate[lte]"?: string;
        limit?: number;
        locationRef?: string;
        membershipRef?: string;
        nextPageToken?: string;
        q?: string;
        status?: string;
    }
    Index
    companyRef? createDate[gte]? createDate[lte]? customerRef? issueDate[gte]? issueDate[lte]? limit? locationRef? membershipRef? nextPageToken? q? status?
    companyRef?: string

    Use customerRef instead. UUID of the company whose invoices to list.

    "createDate[gte]"?: string

    Filter invoices created on or after this date (ISO 8601). Use with createDate[lte] for a range.

    "createDate[lte]"?: string

    Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range.

    customerRef?: string

    UUID of the customer whose invoices to list.

    "issueDate[gte]"?: string

    Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range.

    "issueDate[lte]"?: string

    Filter invoices issued on or before this date (ISO 8601). Use with issueDate[gte] for a range.

    limit?: number

    Maximum number of invoices per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

    locationRef?: string

    UUID of the location whose invoices to list.

    membershipRef?: string

    Use customerRef instead. UUID of the membership whose invoices to list.

    nextPageToken?: string

    Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

    q?: string

    Case-insensitive search by invoice code or number. Requires customerRef or locationRef.

    status?: string

    Filter by invoice status. Comma-separated values, e.g. draft,issued.

    Supported values:

    • draft — created but not sent
    • issued — sent to the customer but unpaid
    • paid — fully paid
    • voided — cancelled and no longer valid

    Settings
    Member Visibility

    On This Page
    Properties