Rechercher des mandats

curl --request POST \
  --url https://api.codaclean.io/v1/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "includeFinished": true
}
'

{
  "records": [
    {
      "id": "693a84bf3cb53bcdedaa2874",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "payrollProviderCode": "twinntax",
      "payrollProviderName": "TwinnTax",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "nl",
      "createdOn": "2025-12-11T08:45:50.751Z",
      "updatedOn": "2025-12-11T08:51:05.745Z"
    },
    {
      "id": "690b10c44fe2b68ba789d1a3",
      "product": "CODB",
      "status": "waitingForSigner",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "payrollProviderCode": "twinntax",
      "payrollProviderName": "TwinnTax",
      "signerName": "Jan Peeters",
      "signerEmail": "jan.peeters@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-05T08:54:25.891Z",
      "updatedOn": "2025-11-05T08:55:01.808Z"
    },
    {
      "id": "690881038cb515752f8d7f64",
      "product": "CODA",
      "status": "waitingForSigner",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "iban": "BE59732578835326",
      "bic": "CREG BE BB",
      "bankName": "CBC Banque et Assurances",
      "signerName": "Jan Peeters",
      "signerEmail": "accounting@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-03T10:16:35.410Z",
      "updatedOn": "2025-11-03T10:17:00.208Z"
    },
    {
      "id": "69087f138cb515752f8d7f61",
      "product": "CODA",
      "status": "waitingForSigner",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "iban": "BE49001163522171",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-03T10:08:18.810Z",
      "updatedOn": "2025-11-03T10:08:54.607Z"
    },
    {
      "id": "68f39cb74f9e0ff0611fde75",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "payrollProviderCode": "sdworx",
      "payrollProviderName": "SD Worx",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-10-18T13:57:11.305Z",
      "updatedOn": "2025-10-18T13:57:11.305Z"
    },
    {
      "id": "68f39cb7b3431c9f9f8819c7",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "payrollProviderCode": "partena_professional",
      "payrollProviderName": "Partena Professional",
      "signerName": "Jan Peeters",
      "signerEmail": "jan.peeters@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-10-18T13:57:11.016Z",
      "updatedOn": "2025-10-18T13:57:11.016Z"
    }
  ],
  "recordsTotal": 6,
  "recordsFiltered": 6
}

POST

mandates

curl --request POST \
  --url https://api.codaclean.io/v1/mandates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "includeFinished": true
}
'

{
  "records": [
    {
      "id": "693a84bf3cb53bcdedaa2874",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "payrollProviderCode": "twinntax",
      "payrollProviderName": "TwinnTax",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "nl",
      "createdOn": "2025-12-11T08:45:50.751Z",
      "updatedOn": "2025-12-11T08:51:05.745Z"
    },
    {
      "id": "690b10c44fe2b68ba789d1a3",
      "product": "CODB",
      "status": "waitingForSigner",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "payrollProviderCode": "twinntax",
      "payrollProviderName": "TwinnTax",
      "signerName": "Jan Peeters",
      "signerEmail": "jan.peeters@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-05T08:54:25.891Z",
      "updatedOn": "2025-11-05T08:55:01.808Z"
    },
    {
      "id": "690881038cb515752f8d7f64",
      "product": "CODA",
      "status": "waitingForSigner",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "iban": "BE59732578835326",
      "bic": "CREG BE BB",
      "bankName": "CBC Banque et Assurances",
      "signerName": "Jan Peeters",
      "signerEmail": "accounting@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-03T10:16:35.410Z",
      "updatedOn": "2025-11-03T10:17:00.208Z"
    },
    {
      "id": "69087f138cb515752f8d7f61",
      "product": "CODA",
      "status": "waitingForSigner",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "iban": "BE49001163522171",
      "bic": "GEBA BE BB",
      "bankName": "BNP Paribas Fortis",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-11-03T10:08:18.810Z",
      "updatedOn": "2025-11-03T10:08:54.607Z"
    },
    {
      "id": "68f39cb74f9e0ff0611fde75",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b4183d350b74dad2f46ec",
      "enterpriseNumber": "0764.042.472",
      "customerName": "Boulangerie Dupont SRL",
      "payrollProviderCode": "sdworx",
      "payrollProviderName": "SD Worx",
      "signerName": "Marie Dupont",
      "signerEmail": "marie.dupont@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-10-18T13:57:11.305Z",
      "updatedOn": "2025-10-18T13:57:11.305Z"
    },
    {
      "id": "68f39cb7b3431c9f9f8819c7",
      "product": "CODB",
      "status": "finished",
      "customerId": "675b41d6d350b74dad2f46ed",
      "enterpriseNumber": "0755.556.457",
      "customerName": "Garage Peeters BV",
      "payrollProviderCode": "partena_professional",
      "payrollProviderName": "Partena Professional",
      "signerName": "Jan Peeters",
      "signerEmail": "jan.peeters@example.com",
      "signerLanguage": "en",
      "createdOn": "2025-10-18T13:57:11.016Z",
      "updatedOn": "2025-10-18T13:57:11.016Z"
    }
  ],
  "recordsTotal": 6,
  "recordsFiltered": 6
}

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.

Corps

application/json

customerId

string

enterpriseNumber

string

Belgian enterprise number, formatted 0123.456.789.

iban

string

Spaces are ignored.

payrollProviderCode

string

product

enum<string>

Options disponibles:

CODA,

CODB

status

One status or a list of statuses.

Options disponibles:

created,

waitingForSigner,

expired,

rejectedBySigner,

waitingForBank,

confirmedByBank,

rejectedByBank,

unsupportedBank,

waitingForPayrollProvider,

rejectedByPayrollProvider,

unsupportedPayrollProvider,

finished,

renewalRequired,

error

includeFinished

boolean

défaut:false

Mandates with status finished are excluded unless this is true.

updatedSince

string<date-time>

Only mandates created or updated at or after this ISO 8601 timestamp. Use it to poll for changes.

sort

enum<string>

défaut:createdOn

Options disponibles:

createdOn,

updatedOn,

customerName,

customerEnterpriseNumber,

ibanNumber,

status,

bankName,

payrollProviderCode

sortDirection

enum<string>

défaut:desc

Any value other than asc sorts in descending order.

Options disponibles:

asc,

desc

limit

integer

défaut:50

Plage requise: x <= 200

offset

integer

défaut:0

Réponse

Matching mandates.

records

object[]

Show child attributes

recordsTotal

integer

Number of mandates visible to the user, before filters.

recordsFiltered

integer

Number of mandates matching the filters.

Prise en main

Concepts

Guides

Authentification

Utilitaires

Clients

Comptes bancaires

Secrétariats sociaux du client

Mandats

Données de référence

Fichiers CODA

Fichiers CODB

Autorisations

Corps

Réponse