Pennylane API Client
    Preparing search index...

    Interface GetJournalsQueryParams

    Query parameters for listing journals.

    Supports the v2026 pagination system and query options.

    interface GetJournalsQueryParams {
        cursor?: string;
        filter?: readonly JournalFilter[];
        limit?: number;
        sort?: string;
    }

    Hierarchy

    • CursorPaginationQueryParams
      • GetJournalsQueryParams
    Index

    Properties

    cursor?: string

    Cursor for pagination. Use this to fetch the next set of results.

    filter?: readonly JournalFilter[]

    Filter journals by specific fields. Format expected by API: JSON array serialized into a query string. Example item: { field: "type", operator: "eq", value: "payroll" }

    Available fields and operators:

    • type: eq, not_eq, in, not_in
    limit?: number

    Number of items to return per request (between 1 and 100).

    sort?: string

    Sort results by specific attributes. Prefix with - for descending order (e.g., -id sorts by id in descending order).

    Available fields:

    • id (default: ascending)