Create a contact

API Reference Overview

Overview

Authentication

POST
Get access token

Consumers

Connections

Integrations

Accounting

Folders
Book years
Clients
Suppliers
Invoices
Ledger accounts
Journals
Journal entries
Employees
Analytic plans
Analytic accounts
Miscellaneous operations
Outstandings

Invoicing

Contacts
Invoices
Products
Taxes
Opportunities
Payments
Payment methods

POS

Orders
Payment methods
Payments
Closure info
Locations
Products
Categories
Customers

eCommerce

Orders
Products & variants
Categories
Customers
Payment methods
Locations
Countries
Taxes

PMS

Orders
Invoices
Payment methods
Payments
Closure info
Locations
Categories
Customers

Payment

Payments
Balances
Transactions
Refunds

Banking

Financial institutions
Banking accounts
Transactions

Advanced

Webhooks
Syncs
Issues
Datastores

POST

consumers

{consumer_id}

invoicing

contacts

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
  --header 'Authorization: Bearer <token>' \
  --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",
  "gender": "H",
  "addresses": []
}'

{
  "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",
  "gender": "H",
  "addresses": [],
  "external_reference": "<string>"
}

Authorizations

Authorization

string

header

required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id

string

required

Body

application/json

is_prospect

boolean

Is a prospect?

is_customer

boolean

Is a customer?

is_supplier

boolean

Is a supplier?

is_company

boolean

Is a company?

company_name

string

Name of the company

first_name

string

Firstname

last_name

string

Lastname

string

phone

string

Phone

mobile

string

Mobile

company_id

string

Technical id of the contact' company in Chift

vat

string

VAT number

company_number

string

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

currency

string

Currency matching target sofware name

language

string

Language matching target sofware name

comment

string

Comment

customer_account_number

string

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

supplier_account_number

string

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

birthdate

string

Birthdate

gender

enum<string>

Gender

Available options:

H,

F,

N/A

addresses

object[]

Addresses

Response

200

application/json

Successful Response

string

required

Technical id in Chift

source_ref

object

required

Technical id in the target software

is_prospect

boolean

Is a prospect?

is_customer

boolean

Is a customer?

is_supplier

boolean

Is a supplier?

is_company

boolean

Is a company?

company_name

string

Name of the company

first_name

string

Firstname

last_name

string

Lastname

string

phone

string

Phone

mobile

string

Mobile

company_id

string

Technical id of the contact' company in Chift

vat

string

VAT number

company_number

string

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

currency

string

Currency matching target sofware name

language

string

Language matching target sofware name

comment

string

Comment

customer_account_number

string

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

supplier_account_number

string

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

birthdate

string

Birthdate

gender

enum<string>

Gender

Available options:

H,

F,

N/A

addresses

object[]

Addresses

external_reference

string

External reference of the contact in the invoicing system

Retrieve all contacts Retrieve one invoice

curl --request POST \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
  --header 'Authorization: Bearer <token>' \
  --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",
  "gender": "H",
  "addresses": []
}'

{
  "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",
  "gender": "H",
  "addresses": [],
  "external_reference": "<string>"
}