KOkolek
Contracts

GET /contracts/client

Request

  • Base URL
    https://api.kolek.com.br (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

business_idstring

Filter receivables by business ID.

client_idstring

Filter receivables by client ID.

pageinteger

The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.

limitinteger

The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.

order_bystring

Field name to order the results by, e.g., "due_date". Defaults to descending "issued_date" if not provided.

sort_order'asc' | 'desc'

Sort order, can be either "asc" for ascending or "desc" for descending. Defaults to "desc" if not provided.

status'ACTIVE' | 'INACTIVE' | 'COMPLETED' | 'DELETED' | 'SUSPENDED'

Filter by status. Valid values are defined by the ContractStatus enum.

with_clientboolean

Boolean flag to include client details associated with this contract. Valid values are "true" or "false".

with_receivablesboolean

Boolean flag to include receivables details associated with this contract. Valid values are "true" or "false".

date_type'issue' | 'billing' | 'termination'

Type of date to filter by. Valid values are "issue" (first_bill_date), "billing" (next due date), or "termination" (end date).

date_filter'today' | 'this week' | 'this month' | 'this year' | 'custom' | 'indeterminate' | 'all'

Date period filter. Valid values are "today", "this week", "this month", "this year", "custom", "indeterminate", or "all".

date_fromstring

Start date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is "custom".

date_tostring

End date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is "custom".

Changes

No recorded changes to this operation across all 1 revision of this API.