Replace a contract
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Body Parameters
The counterparty, as free text.
Your contract number.
P pending, A approved, R rejected, AC active, IA inactive. Defaults to P.
PARACIAU unit, S supplier, HR hr, SE service, M maintenance, FR framework, WK work, SC service contract, PR purchase, RT rental. Defaults to U. A S (supplier) contract is the one whose DELETE deactivates the linked supplier.
USHRSEMFRWKSCPRRTWith startDate and endDate set, the server computes cancellationDate from this.
Show child attributes
Overwritten by the server whenever startDate, endDate and noticePeriod are all set, send it only when they are not.
Whether to remind before the cancellation date.
Days of lead time; pulled forward off the computed cancellation date.
Price per payment iteration, as a decimal string.
Decimal string.
Decimal string.
VAT as a decimal string.
Decimal string.
Server-computed on every save (licenseAmount × netAmount + additionalCostNetAmount); a sent value does not stick.
Number of paid licenses.
Alert when license usage crosses licenseThreshold.
Must be an active member of this company.
Must belong to this company.
Must belong to this company.
Must belong to this company.
How the contract recurs. Written inline with the contract; on update, include the id to change the existing row rather than replace it.
Show child attributes
Response
The updated contract, in the read shape.
Response Attributes
The counterparty, as free text.
Your contract number.
P pending, A approved, R rejected, AC active, IA inactive. Defaults to P.
PARACIAU unit, S supplier, HR hr, SE service, M maintenance, FR framework, WK work, SC service contract, PR purchase, RT rental. Defaults to U. A S (supplier) contract is the one whose DELETE deactivates the linked supplier.
USHRSEMFRWKSCPRRTWith startDate and endDate set, the server computes cancellationDate from this.
Show child attributes
Overwritten by the server whenever startDate, endDate and noticePeriod are all set, send it only when they are not.
Whether to remind before the cancellation date.
Days of lead time; pulled forward off the computed cancellation date.
Price per payment iteration, as a decimal string.
Decimal string.
Decimal string.
VAT as a decimal string.
Decimal string.
Server-computed on every save (licenseAmount × netAmount + additionalCostNetAmount); a sent value does not stick.
Number of paid licenses.
Alert when license usage crosses licenseThreshold.
Must be an active member of this company.
Must belong to this company.
Must belong to this company.
Must belong to this company.
How the contract recurs. Written inline with the contract; on update, include the id to change the existing row rather than replace it.
Show child attributes
Currency of contractPrice. Read-only, the company currency.
Currency of netAmount. Read-only, the company currency.
Currency of grossAmount. Read-only, the company currency.
Currency of additionalCostNetAmount. Read-only, the company currency.
Currency of totalLicenseAmount. Read-only, the company currency.
Read-only: contractPrice × the recurrence's payment iterations.
Currency of totalContractPrice. Read-only, the company currency.
Show child attributes
Validation failed. attr names the field, in snake_case.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError