Skip to main content
GET
Get a mandate

Autorisations

x-api-key
string
header
requis

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Authorization
string
header
requis

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

mandateId
string
requis

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.

id
string
product
enum<string>

CODAlight consents are reported as CODA; they carry a validUntil date.

Options disponibles:
CODA,
CODB
status
enum<string>

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

Options disponibles:
created,
waitingForSigner,
expired,
rejectedBySigner,
waitingForBank,
confirmedByBank,
rejectedByBank,
unsupportedBank,
waitingForPayrollProvider,
rejectedByPayrollProvider,
unsupportedPayrollProvider,
finished,
renewalRequired,
error
customerId
string
enterpriseNumber
string

Belgian enterprise number, formatted 0123.456.789.

customerName
string
iban
string
bic
string
bankName
string
payrollProviderCode
string
payrollProviderName
string
signerName
string
signerEmail
string
signerLanguage
string
validUntil
string

End of a CODAlight consent. After this date, the mandate moves to renewalRequired.

createdOn
string<date-time>
updatedOn
string<date-time>
error
any

Error details when status is error.