Skip to main content

Client Contract

PropertyTypeDescriptionInformation
idintIdentifierUnique for single Client contract.
namestringName of the contract
descriptionstring/nullContract description
client_idintUnique for single Client.
file_idint/nullUnique for single File.File must be of type PDF/DOC/DOCX.
project_idint/nullUnique for single Project.
responsible_person_idint/nullUnique for single User.If null, value is set to be same as responsible person for Client.
amount_of_moneyMonetary (array<string, Decimal>)Amount of money per invoice.
billings_frequencyint (enum)Frequency of new invoices.Value must be from enum. Enum values are described here: client-contracts
billings_atint (enum)If invoice is generated at the start/end of given period.Value must be from enum. Enum values are described here: client-contracts
valid_fromdateContract valid from
valid_todate/nullContract valid to
created_atdateClient creation dateDate of Client creation
updated_atdateClient latest update dateDate of latest Client update

Example:

{
"id": 6,
"name": "Kaitrade Smlouva",
"description": null,
"client_id": 2,
"file_id": 1,
"project_id": null,
"responsible_person_id": 39,
"amount_of_money": {
"CZK": {
"value": 120.22,
"formatted": "120,22 Kč"
}
},
"billings_frequency": "1",
"billings_at": "2",
"valid_from": "2023-12-31T23:00:00.000000Z",
"valid_to": null,
"created_at": "2024-01-30T10:37:35+0100",
"updated_at": "2024-01-30T10:37:35+0100",
"_links": [
{
"href": "/api/v0/client-contracts/6",
"rel": "self",
"type": "GET"
}
]
}