Obtenir un mandat
Required scope: mandates:read
Autorisations
Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.
Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.
Paramètres de chemin
Mandate identifier, as returned in id.
Réponse
The mandate.
Fields without a value are omitted. A CODA mandate carries no payroll-provider fields, and vice versa.
CODAlight consents are reported as CODA; they carry a validUntil date.
CODA, CODB CODA: created, waitingForSigner, expired, rejectedBySigner, waitingForBank, confirmedByBank, rejectedByBank, unsupportedBank, finished, renewalRequired (CODAlight), error.
CODB: created, waitingForSigner, expired, rejectedBySigner, waitingForPayrollProvider, rejectedByPayrollProvider, unsupportedPayrollProvider, finished, error.
finished means the mandate is active: signed, and files are being received (shown as "Active" in MyCodaclean).
confirmedByBank means confirmed, but no file received yet.
See also: Onboard a customer
created, waitingForSigner, expired, rejectedBySigner, waitingForBank, confirmedByBank, rejectedByBank, unsupportedBank, waitingForPayrollProvider, rejectedByPayrollProvider, unsupportedPayrollProvider, finished, renewalRequired, error Belgian enterprise number, formatted 0123.456.789.
End of a CODAlight consent. After this date, the mandate moves to renewalRequired.
Error details when status is error.

