Fetch contract
This endpoint allows fetching a contract by id.
Authorizations
API Key Authentication.
Path Parameters
Unique identifier for the contract.
Response
Schema defining a contract.
Unique identifier for the contract.
Human-readable contract identifier, sequential per customer (e.g. ACMEX-CTR-01). Generated by the server on creation.
ID of the customer associated with this contract.
Date when the contract becomes active.
Optional date when the contract expires. If null, the contract has no end date.
Optional retroactive date to apply contract changes from a past date.
Current status of the contract.
active, canceled, completed, draft Reference index (e.g. IPCA) used to filter contracts when applying a mass adjustment on contracts.
none, igpm, ipca, other, null Custom fields that can be associated with the entity. The fields must be previously created in the system before they can be used.
Invoice allocation strategy configured for the contract.
single, percent_split, subsidiary_usage_split Whether future subsidiaries are automatically included in usage scope.
Customers that compose the usage scope for this contract.
1Payment account allocation configuration.
1Schema defining billing schedule for a contract.
ID of the legal entity associated with this contract. Optional on create; defaults to the tenant's default legal entity when absent.
Legal entity summary embedded on contract responses.
ID of the tax regime applied to invoices generated from this contract. Null when no regime is attached.
When true, invoices produced at billing-cycle close are issued automatically instead of waiting in review. Defaults to false when omitted; omitting it on update leaves the current value unchanged.
Schema defining billing settings for a contract.
Schema defining payment gateway settings for a contract.