Operation retrieves list of customer contracts.
Data can be filtered by querystring parameters, e.g. ?CustCons__Customer_id=<pk> or ?CustCons__customer_number=<value>.
Token issued for API consumer.
Offset to start returning results.
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:
- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
- For numerics: gt, lt, gte, lte, isnull
- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby
Examples:
+++usage_state__txt__istartswith=in+++,+++plan__state__txt__startswith=In+++,+++creation_date__gte=2019-01-02T15:32:01+++,+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++Supports exclusive queries by field value using a not-operator preceding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
Selects the object field to order the returned objects by.
Can be used to sort in reverse order with '-' prefix.
Can have several ordering rules separated by comma.
Can be used only for object own fields and does not support structured queries.
Example: orderby=creator,-creation_date
A result response object
Url to next page of the list if applicable
Url to previous page if applicable, otherwise null
List of fetched customer contracts
Group name of constant. Group name must contain only uppercase letters separated by underscores.
Primary key
Numerical value of the constant
Order number
Human readable textual representation
Human readable textual representation
Logical textual value
Consumer point-customer link
Primary key of the consumer point
Primary key of the customer
Customer number
Primary key of the consumer point-customer link
Attached document id
Contract number
Contract end date
Primary key
Joining payment amount
Date of refund
Whether the joining payment is refundable
Contract start date
Total number of CustomerContract objects
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Standard error response payload
Detailed description of error