Customer contracts

View as Markdown
What your customer has contracted with the source. A generic view of what the person or company has signed with that institution: contract number and name, the date it was signed, the address it is attached to. It is what a utility, a supplier portal or a service provider exposes as *your services with us*. <Warning> **A contract `id` belongs to this execution**, not to the contract. It is not stable across runs — match contracts by their number or their name, never by the id of a previous execution. </Warning> <Note title="Requires the `source_contracts_read` feature"> Features are chosen when the execution **starts**, not here. An execution that did not ask for `source_contracts_read` answers `204`, and the only way to get the data is to run another one. </Note> | Status | Meaning | | :--- | :--- | | `200` | The contracts. | | `202` | `feature_not_ready` — `source_contracts_read` is still running. **Only this family waits**: the ones that already closed answer now. | | `204` | The execution never asked for `source_contracts_read`. No body. | | `404` | No execution with that id for your application, or it has been deleted. | <Note> **Server to server only.** This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read. </Note>

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
The relationships your customer holds with the source — the products they have signed for, with the identifiers and dates the institution keeps them under.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"

Contract ID for the current execution. Note: it may change between executions.

product"source_contract"
sub_family"source_contract:generic_contract"
fetch_datestringformat: "datetime"
Date this product was fetched
contract_numberstringOptional
Contract number
contract_namestringOptional
Contract name
contract_descriptionstringOptional
Contract description
contract_datedateOptional
Contract date
contract_addressobjectOptional
Contract address

Errors

404
Not Found Error
422
Unprocessable Entity Error