/** * Generated by orval v8.5.3 🍺 * Do not edit manually. * Space Invoices API * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking. * OpenAPI spec version: 1.0.0 */ export type GetCreditNotesParams = { /** * Number of results per request. * @minimum 1 * @maximum 100 */ limit?: number; /** * Opaque cursor to fetch the next page of results. Reuse only with the same effective ordering. Use the value from pagination.next_cursor in the previous response. */ next_cursor?: string; /** * Opaque cursor to fetch the previous page of results. Reuse only with the same effective ordering. Use the value from pagination.prev_cursor in the previous response. */ prev_cursor?: string; /** * Whether to include the total count of items in `pagination.total`. Default is `true`. When `false`, `pagination.total` returns -1 for better performance. */ include_total_count?: boolean; /** * Sort by one field or provide a repeated array for multi-column ordering. Prefix a field with `-` for descending order. When paginating, reuse cursors only with the same effective ordering. */ order_by?: 'id' | 'number' | 'date' | 'total' | 'total_with_tax' | 'created_at' | 'updated_at' | '-id' | '-number' | '-date' | '-total' | '-total_with_tax' | '-created_at' | '-updated_at' | ('id' | 'number' | 'date' | 'total' | 'total_with_tax' | 'created_at' | 'updated_at' | '-id' | '-number' | '-date' | '-total' | '-total_with_tax' | '-created_at' | '-updated_at')[]; /** * JSON query object for filtering results. Supports MongoDB-style operators. **Supported operators:** - `equals` or direct value - Exact match (default) - `gte` - Greater than or equal - `lte` - Less than or equal - `gt` - Greater than - `lt` - Less than - `in` - Value in array - `notIn` - Value not in array - `contains` - String contains (case-insensitive) - `startsWith` - String starts with - `endsWith` - String ends with - `between` - Value between two numbers/dates [min, max] **Allowed fields:** id, number, date, customer, customer.name, customer.email, customer.address, customer.city, customer.country, total, total_with_tax, items.name, items.description, payments.type, payments.date, document_relations.relation_type, document_relations.target_type, metadata, created_at, updated_at, paid_in_full, voided_at **Examples:** - `{"total": {"gte": 1000}}` - Invoices over 1000 - `{"customer.name": {"contains": "Acme"}}` - Customer name contains "Acme" - `{"date": {"between": ["2025-01-01", "2025-12-31"]}}` - Date range */ query?: string; /** * Full-text search query to filter results across multiple fields. Searches are case-insensitive and match partial strings. Searches across all text fields including names, descriptions, addresses, and metadata values. */ search?: string; /** * Comma-separated list of relations to include in the response. **Available relations:** - `payments` - Payment records linked to this credit note - `document_relations` - Linked documents (invoices, advance invoices, etc.) **Usage:** `?include=payments` `?include=payments,document_relations` */ include?: string; /** * When true, returns only soft-deleted (trashed) items. Default false excludes deleted items. */ deleted?: boolean; }; //# sourceMappingURL=getCreditNotesParams.d.ts.map