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

    Interface GetCreditNotesQuery

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

    interface GetCreditNotesQuery {
        "createDate[gte]"?: string;
        "createDate[lte]"?: string;
        invoiceRef?: string;
        limit?: number;
        locationRef?: string;
        nextPageToken?: string;
        status?: string;
    }
    Index
    createDate[gte]? createDate[lte]? invoiceRef? limit? locationRef? nextPageToken? status?
    "createDate[gte]"?: string

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

    "createDate[lte]"?: string

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

    invoiceRef?: string

    UUID of the invoice whose credit notes to list.

    limit?: number

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

    locationRef?: string

    UUID of the location whose credit notes to list.

    nextPageToken?: string

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

    status?: string

    Filter by credit note status. Comma-separated values, e.g. issued,voided.

    Supported values:

    • issued — active credit note
    • voided — cancelled and no longer valid

    Settings
    Member Visibility

    On This Page
    Properties