Create a contact

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_prospect": true,
  "is_customer": true,
  "is_supplier": true,
  "is_company": true,
  "company_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "company_id": "<string>",
  "vat": "<string>",
  "company_number": "<string>",
  "currency": "<string>",
  "language": "<string>",
  "comment": "<string>",
  "customer_account_number": "<string>",
  "supplier_account_number": "<string>",
  "birthdate": "2023-12-25",
  "addresses": []
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts"

payload = {
    "is_prospect": True,
    "is_customer": True,
    "is_supplier": True,
    "is_company": True,
    "company_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "mobile": "<string>",
    "company_id": "<string>",
    "vat": "<string>",
    "company_number": "<string>",
    "currency": "<string>",
    "language": "<string>",
    "comment": "<string>",
    "customer_account_number": "<string>",
    "supplier_account_number": "<string>",
    "birthdate": "2023-12-25",
    "addresses": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_prospect: true,
    is_customer: true,
    is_supplier: true,
    is_company: true,
    company_name: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>',
    phone: '<string>',
    mobile: '<string>',
    company_id: '<string>',
    vat: '<string>',
    company_number: '<string>',
    currency: '<string>',
    language: '<string>',
    comment: '<string>',
    customer_account_number: '<string>',
    supplier_account_number: '<string>',
    birthdate: '2023-12-25',
    addresses: []
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts', 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}/invoicing/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'is_prospect' => true,
    'is_customer' => true,
    'is_supplier' => true,
    'is_company' => true,
    'company_name' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'mobile' => '<string>',
    'company_id' => '<string>',
    'vat' => '<string>',
    'company_number' => '<string>',
    'currency' => '<string>',
    'language' => '<string>',
    'comment' => '<string>',
    'customer_account_number' => '<string>',
    'supplier_account_number' => '<string>',
    'birthdate' => '2023-12-25',
    'addresses' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts"

	payload := strings.NewReader("{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}"

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

{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "is_prospect": true,
  "is_customer": true,
  "is_supplier": true,
  "is_company": true,
  "company_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "company_id": "<string>",
  "vat": "<string>",
  "company_number": "<string>",
  "currency": "<string>",
  "language": "<string>",
  "comment": "<string>",
  "customer_account_number": "<string>",
  "supplier_account_number": "<string>",
  "birthdate": "2023-12-25",
  "addresses": [],
  "external_reference": "<string>"
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

consumers

{consumer_id}

invoicing

contacts

Create a contact

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_prospect": true,
  "is_customer": true,
  "is_supplier": true,
  "is_company": true,
  "company_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "company_id": "<string>",
  "vat": "<string>",
  "company_number": "<string>",
  "currency": "<string>",
  "language": "<string>",
  "comment": "<string>",
  "customer_account_number": "<string>",
  "supplier_account_number": "<string>",
  "birthdate": "2023-12-25",
  "addresses": []
}
'

import requests

url = "https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts"

payload = {
    "is_prospect": True,
    "is_customer": True,
    "is_supplier": True,
    "is_company": True,
    "company_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "mobile": "<string>",
    "company_id": "<string>",
    "vat": "<string>",
    "company_number": "<string>",
    "currency": "<string>",
    "language": "<string>",
    "comment": "<string>",
    "customer_account_number": "<string>",
    "supplier_account_number": "<string>",
    "birthdate": "2023-12-25",
    "addresses": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_prospect: true,
    is_customer: true,
    is_supplier: true,
    is_company: true,
    company_name: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>',
    phone: '<string>',
    mobile: '<string>',
    company_id: '<string>',
    vat: '<string>',
    company_number: '<string>',
    currency: '<string>',
    language: '<string>',
    comment: '<string>',
    customer_account_number: '<string>',
    supplier_account_number: '<string>',
    birthdate: '2023-12-25',
    addresses: []
  })
};

fetch('https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts', 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}/invoicing/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'is_prospect' => true,
    'is_customer' => true,
    'is_supplier' => true,
    'is_company' => true,
    'company_name' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'mobile' => '<string>',
    'company_id' => '<string>',
    'vat' => '<string>',
    'company_number' => '<string>',
    'currency' => '<string>',
    'language' => '<string>',
    'comment' => '<string>',
    'customer_account_number' => '<string>',
    'supplier_account_number' => '<string>',
    'birthdate' => '2023-12-25',
    'addresses' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts"

	payload := strings.NewReader("{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_prospect\": true,\n  \"is_customer\": true,\n  \"is_supplier\": true,\n  \"is_company\": true,\n  \"company_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"company_id\": \"<string>\",\n  \"vat\": \"<string>\",\n  \"company_number\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"customer_account_number\": \"<string>\",\n  \"supplier_account_number\": \"<string>\",\n  \"birthdate\": \"2023-12-25\",\n  \"addresses\": []\n}"

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

{
  "id": "<string>",
  "source_ref": {
    "id": "<string>",
    "model": "<string>"
  },
  "is_prospect": true,
  "is_customer": true,
  "is_supplier": true,
  "is_company": true,
  "company_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "mobile": "<string>",
  "company_id": "<string>",
  "vat": "<string>",
  "company_number": "<string>",
  "currency": "<string>",
  "language": "<string>",
  "comment": "<string>",
  "customer_account_number": "<string>",
  "supplier_account_number": "<string>",
  "birthdate": "2023-12-25",
  "addresses": [],
  "external_reference": "<string>"
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

consumer_id

string<uuid>

required

Body

application/json

is_prospect

boolean | null

Is a prospect?

is_customer

boolean | null

Is a customer?

is_supplier

boolean | null

Is a supplier?

is_company

boolean | null

Is a company?

company_name

string | null

Name of the company

first_name

string | null

Firstname

last_name

string | null

Lastname

string | null

phone

string | null

Phone

mobile

string | null

Mobile

company_id

string | null

Technical id of the contact' company in Chift

vat

string | null

VAT number

company_number

string | null

Company number (identification number different than the VAT (e.g. siret))

currency

string | null

Currency matching target sofware name

language

string | null

Language matching target sofware name

comment

string | null

Comment

customer_account_number

string | null

Number of the accounting account used for sales (e.g. 701000)

supplier_account_number

string | null

Number of the accounting account used for purchases (e.g. 601000)

birthdate

string<date> | null

Birthdate

gender

enum<string> | null

Gender

Available options:

H,

F,

N/A

addresses

AddressItemInInvoicing · object[] | null

Addresses

Show child attributes

Response

Successful Response

string

required

Technical id in Chift

source_ref

Ref · object

required

Technical id in the target software

Show child attributes

is_prospect

boolean | null

Is a prospect?

is_customer

boolean | null

Is a customer?

is_supplier

boolean | null

Is a supplier?

is_company

boolean | null

Is a company?

company_name

string | null

Name of the company

first_name

string | null

Firstname

last_name

string | null

Lastname

string | null

phone

string | null

Phone

mobile

string | null

Mobile

company_id

string | null

Technical id of the contact' company in Chift

vat

string | null

VAT number

company_number

string | null

Company number (identification number different than the VAT (e.g. siret))

currency

string | null

Currency matching target sofware name

language

string | null

Language matching target sofware name

comment

string | null

Comment

customer_account_number

string | null

Number of the accounting account used for sales (e.g. 701000)

supplier_account_number

string | null

Number of the accounting account used for purchases (e.g. 601000)

birthdate

string<date> | null

Birthdate

gender

enum<string> | null

Gender

Available options:

H,

F,

N/A

addresses

AddressItemOutInvoicing · object[] | null

Addresses

Show child attributes

external_reference

string | null

External reference of the contact in the invoicing system

Retrieve all contacts Retrieve one invoice

⌘I

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Create a contact

Path Parameters

Body

Response