Documentation Index

Fetch the complete documentation index at: https://support.keypro.fi/llms.txt

Use this file to discover all available pages before exploring further.

2025-11-06 14.00 UTC - There are currently no active events. All systems operational.

Get customer contract details

Prev Next
Get
/customer-contracts/{id}/

Operation retrieves full details of a customer contract by given id.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of the customer contract

Responses
200

CustomerContract

Expand All
object
Contract_type
object (SnConstants)
groupname
string

Group name of constant. Group name must contain only uppercase letters separated by underscores.

id
integer

Primary key

num_value
integer

Numerical value of the constant

orderno
integer

Order number

txt
string

Human readable textual representation

txt_2
string

Human readable textual representation

value
string

Logical textual value

CustCons
object

Consumer point-customer link

CP_id
integer

Primary key of the consumer point

Customer_id
integer

Primary key of the customer

customer_number
string

Customer number

id
integer

Primary key of the consumer point-customer link

attached_doc_id
integer

Attached document id

contract_number
string

Contract number

end_date
string (date)

Contract end date

id
integer

Primary key

joining_payement
number

Joining payment amount

refund_date
string (date)

Date of refund

refundable
boolean

Whether the joining payment is refundable

start_date
string (date)

Contract start date

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object

Standard error response payload

details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object

Standard error response payload

details
string

Detailed description of error