Get one client

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "external_reference": "CUST-0001",
  "first_name": "John",
  "last_name": "Doe",
  "name": "Example Company S.A.",
  "function": "Accountant",
  "is_company": true,
  "company_id": "<accounting-company-id>",
  "phone": "+32 2 000 00 00",
  "mobile": "+32 4 000 00 00",
  "email": "john.doe@example.com",
  "language": "en",
  "internal_notes": "Preferred contact: accounts payable team.",
  "website": "https://www.example.com",
  "vat": "BE0000000000",
  "company_number": "0000000000",
  "iban": "BE00000000000000",
  "bank_account": "0000000000",
  "currency": "EUR",
  "active": true,
  "account_number": "<accounting-account-number>",
  "id": "<this-client-id>",
  "last_updated_on": "2026-01-15T10:30:00Z",
  "addresses": [],
  "third_party_account": "<string>",
  "bank_accounts": [
    {
      "is_primary": true,
      "currency": "<string>",
      "iban": "<string>",
      "bic_swift": "<string>",
      "account_number": "<string>",
      "routing_code": {
        "type": "unknown",
        "value": "<string>"
      }
    }
  ]
}

GET

consumers

{consumer_id}

accounting

clients

{client_id}

Get one client

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/accounting/clients/{client_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "external_reference": "CUST-0001",
  "first_name": "John",
  "last_name": "Doe",
  "name": "Example Company S.A.",
  "function": "Accountant",
  "is_company": true,
  "company_id": "<accounting-company-id>",
  "phone": "+32 2 000 00 00",
  "mobile": "+32 4 000 00 00",
  "email": "john.doe@example.com",
  "language": "en",
  "internal_notes": "Preferred contact: accounts payable team.",
  "website": "https://www.example.com",
  "vat": "BE0000000000",
  "company_number": "0000000000",
  "iban": "BE00000000000000",
  "bank_account": "0000000000",
  "currency": "EUR",
  "active": true,
  "account_number": "<accounting-account-number>",
  "id": "<this-client-id>",
  "last_updated_on": "2026-01-15T10:30:00Z",
  "addresses": [],
  "third_party_account": "<string>",
  "bank_accounts": [
    {
      "is_primary": true,
      "currency": "<string>",
      "iban": "<string>",
      "bic_swift": "<string>",
      "account_number": "<string>",
      "routing_code": {
        "type": "unknown",
        "value": "<string>"
      }
    }
  ]
}

Learn more:

What are partners (clients, suppliers, employees)? ↗

Path Parameters

consumer_id

string<uuid>

required

client_id

string

required

Query Parameters

folder_id

string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

Response

Successful Response

external_reference

string | null

External identifier used to link the client in the accounting system with the corresponding client reference in your own system. Normally unique per client/supplier type and can serve as the primary key of the accounting system.

Example:

"CUST-0001"

first_name

string | null

Only used when the client is an individual (is_company=false). Indicates the first name of the client.

Example:

"John"

last_name

string | null

Only used when the client is an individual (is_company=false). Indicates the last name of the client.

Example:

"Doe"

name

string | null

Full name or legal name of the client (individual or company). This is the name displayed in the accounting software.

Example:

"Example Company S.A."

function

string | null

Only used when the client is an individual (is_company=false). Job function/title of the client.

Example:

"Accountant"

is_company

boolean | null

default:true

Indicates if the client is an individual or a company.

company_id

string | null

Only used when the client is an individual (is_company=false). Indicates the id of the company linked to the client.

Example:

"<accounting-company-id>"

phone

string | null

Phone number of the client.

Example:

"+32 2 000 00 00"

mobile

string | null

Mobile phone number of the client.

Example:

"+32 4 000 00 00"

string | null

Email address of the client.

Example:

"john.doe@example.com"

language

string | null

Language of the client. Format: ISO 639-1 codes.

Example:

"en"

internal_notes

string | null

Internal notes about the client.

Example:

"Preferred contact: accounts payable team."

website

string | null

Website of the client.

Example:

"https://www.example.com"

vat

string | null

VAT number of the client.

Example:

"BE0000000000"

company_number

string | null

National identification number of the company.

Example:

"0000000000"

iban

string | null

IBAN account number of the client. DEPRECATED see bank_accounts

Example:

"BE00000000000000"

bank_account

string | null

Bank account number of the client. DEPRECATED see bank_accounts

Example:

"0000000000"

currency

string | null

Indicates the currency of the client (e.g., EUR).

Example:

"EUR"

active

boolean | null

default:true

Indicates if the client is active.

account_number

string | null

General ledger account assigned to the customer in the accounting system as it will appear in the official accounting export file (FEC, SIE, iXBRL, etc.). This is the account used on journal entry lines to debit/credit this partner.

Example:

"<accounting-account-number>"

string | null

Id of the client in the accounting software. This is the unique identifier used to reference the client in the system.

Example:

"<this-client-id>"

last_updated_on

string<date-time> | null

The last time the client has been updated.

Example:

"2026-01-15T10:30:00Z"

addresses

AddressItemOut · object[] | null

List of addresses associated with the client.

Show child attributes

third_party_account

string | null

Third party account number/code representing the client in the accounting software.

bank_accounts

BankAccountsItem · object[] | null

List of bank accounts information associated with the client.

Show child attributes

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get one client

Path Parameters

Query Parameters

Response