Ctrlk
Site officielStatusRoadmap
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Clients

Nous gérons deux types de clients :

  • Clients particuliers (contact)

  • Clients professionnels (ou entreprise)

Les entreprises peuvent avoir différents contacts pour gérer divers services ou fonctions au sein d'une même entreprise.

Clients professionnels

post
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Corps
namestringRequis

The official name of the organization

Example: Acme Corporation
commercialNamestringOptionnel

The commercial or trading name of the organization

Example: Acme Corp
emailsstring[]Optionnel
siretstringOptionnel

The SIRET number (required for French organizations)

Example: 12345678901234
vatNumberstringOptionnel

The VAT number of the organization

Example: FR12345678901
notesstringOptionnel

Additional notes about the organization

Example: Preferred supplier for anvils and TNT
Réponses
201Succès
application/json
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
idstringRequis
namestringRequis
commercialNamestringRequis
emailsstring[]Requis
siretstringRequis
vatNumberstringRequis
countContactsnumberRequis
notesstringRequis
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberRequis

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis
testbooleanRequis
post/organization
POST /organization HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 618

{
  "name": "Acme Corporation",
  "commercialName": "Acme Corp",
  "emails": [
    "text"
  ],
  "siret": "12345678901234",
  "vatNumber": "FR12345678901",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "notes": "Preferred supplier for anvils and TNT",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "preferences": {
    "language": "en",
    "currency": "USD",
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}
201Succès
{
  "language": "en",
  "currency": "USD",
  "paymentMethods": [
    "cheque",
    "stripe"
  ],
  "id": "text",
  "name": "text",
  "commercialName": "text",
  "emails": [
    "text"
  ],
  "siret": "text",
  "vatNumber": "text",
  "countContacts": 1,
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "notes": "text",
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": true
}
put
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Corps
namestringRequis
commercialNamestringOptionnel
emailsstring[]Optionnel
siretstringOptionnel
vatNumberstringOptionnel
notesstringOptionnel
Réponses
200Succès
application/json
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
idstringRequis
namestringRequis
commercialNamestringRequis
emailsstring[]Requis
siretstringRequis
vatNumberstringRequis
countContactsnumberRequis
notesstringRequis
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberRequis

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis
testbooleanRequis
put/organization/{id}
PUT /organization/{id} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 549

{
  "name": "text",
  "commercialName": "text",
  "emails": [
    "text"
  ],
  "siret": "text",
  "vatNumber": "text",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "notes": "text",
  "preferences": {
    "language": "en",
    "currency": "USD",
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}
200Succès
{
  "language": "en",
  "currency": "USD",
  "paymentMethods": [
    "cheque",
    "stripe"
  ],
  "id": "text",
  "name": "text",
  "commercialName": "text",
  "emails": [
    "text"
  ],
  "siret": "text",
  "vatNumber": "text",
  "countContacts": 1,
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "notes": "text",
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": true
}
get
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de requête
pagenumberRequis
limitnumberRequis
searchstringOptionnel
orderBystring · enumOptionnelValeurs possibles:
orderDirectionstring · enumOptionnelValeurs possibles:
archivedbooleanOptionnel
Réponses
200Succès
application/json
countWithoutFiltersnumberRequis
totalDocsnumberRequis
limitnumberRequis
totalPagesnumberRequis
hasNextPagebooleanRequis
hasPrevPagebooleanRequis
nextPagenumberRequis
pagenumberRequis
prevPagenumberRequis
get/organizations
GET /organizations?page=1&limit=1 HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Succès
{
  "countWithoutFilters": 1,
  "totalDocs": 1,
  "limit": 1,
  "totalPages": 1,
  "hasNextPage": true,
  "hasPrevPage": true,
  "nextPage": 1,
  "page": 1,
  "prevPage": 1,
  "docs": [
    {
      "language": "en",
      "currency": "USD",
      "paymentMethods": [
        "cheque",
        "stripe"
      ],
      "id": "text",
      "name": "text",
      "commercialName": "text",
      "emails": [
        "text"
      ],
      "siret": "text",
      "vatNumber": "text",
      "countContacts": 1,
      "billingAddress": {
        "address": "123 Main Street",
        "complement": "Apt 4B",
        "city": "New York",
        "zipCode": "10001",
        "state": "NY",
        "country": "FR"
      },
      "deliveryAddress": {
        "address": "123 Main Street",
        "complement": "Apt 4B",
        "city": "New York",
        "zipCode": "10001",
        "state": "NY",
        "country": "FR"
      },
      "bankInformations": {
        "iban": "DE89370400440532013000",
        "bic": "DEUTDEFF",
        "holder": "John Doe"
      },
      "notes": "text",
      "createdAt": 1617187200,
      "archivedAt": 1617187200,
      "hasBillings": true,
      "test": true
    }
  ]
}
delete
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
organizationIdstringRequis
Réponses
200Succès
Aucun contenu
delete/organization/{organizationId}
DELETE /organization/{organizationId} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Succès
Aucun contenu

Clients particuliers

Dans le cas où vous souhaitez enregister un client particulier, vous pouvez créer un contact.

Create a new contact

post
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Corps
firstnamestringRequis

The first name of the contact

Example: John
lastnamestringRequis

The last name of the contact

Example: Doe
phonestringOptionnel

The phone number of the contact

Example: +1234567890
jobTitlestringOptionnel

The job title of the contact

Example: Software Engineer
emailsstring[]Optionnel

The email addresses of the contact

Example: ["john.doe@example.com","johnd@work.com"]
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
Réponses
201

The contact has been successfully created.

application/json
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
testbooleanRequis

Whether this is a test contact

Example: false
phonestringOptionnel

Contact phone number

Example: +33123456789
firstnamestringRequis

Contact first name

Example: John
lastnamestringRequis

Contact last name

Example: Doe
jobTitlestringOptionnel

Contact job title

Example: Software Engineer
hasTiersPrestationbooleanRequis

Whether the contact has third-party services

Example: false
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
post/contact
POST /contact HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 622

{
  "firstname": "John",
  "lastname": "Doe",
  "phone": "+1234567890",
  "jobTitle": "Software Engineer",
  "emails": [
    "john.doe@example.com",
    "johnd@work.com"
  ],
  "notes": "Prefers email communication",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "preferences": {
    "language": "en",
    "currency": "USD",
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": false,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "hasTiersPrestation": false,
  "notes": "Prefers email communication",
  "language": "en",
  "currency": "EUR",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}

Retrieve contacts

get

Get a paginated list of contacts for the current company

Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de requête
pagenumberOptionnel
limitnumberOptionnel
searchstringOptionnel
orderBystring · enumOptionnelValeurs possibles:
orderDirectionstring · enumOptionnelValeurs possibles:
archivedbooleanOptionnel
forCertificatebooleanOptionnel
Réponses
200

Successfully retrieved contacts

application/json
countWithoutFiltersnumberRequis
totalDocsnumberRequis
limitnumberRequis
totalPagesnumberRequis
hasNextPagebooleanRequis
hasPrevPagebooleanRequis
nextPagenumberRequis
pagenumberRequis
prevPagenumberRequis
get/contacts
GET /contacts HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countWithoutFilters": 1,
  "totalDocs": 1,
  "limit": 1,
  "totalPages": 1,
  "hasNextPage": true,
  "hasPrevPage": true,
  "nextPage": 1,
  "page": 1,
  "prevPage": 1,
  "docs": [
    {
      "archivedAt": 1617187200,
      "createdAt": 1617187200,
      "test": false,
      "defaultContact": true,
      "emails": [
        "john@example.com",
        "johndoe@company.com"
      ],
      "hasBillings": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullname": "John Doe",
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Acme Corp",
        "archivedAt": 1617187200
      },
      "tiersPrestation": {
        "state": "synced"
      }
    }
  ]
}

Get a contact by ID

get
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Réponses
200

The contact has been successfully retrieved.

application/json
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
testbooleanRequis

Whether this is a test contact

Example: false
phonestringOptionnel

Contact phone number

Example: +33123456789
firstnamestringRequis

Contact first name

Example: John
lastnamestringRequis

Contact last name

Example: Doe
jobTitlestringOptionnel

Contact job title

Example: Software Engineer
hasTiersPrestationbooleanRequis

Whether the contact has third-party services

Example: false
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
get/contact/{id}
GET /contact/{id} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": false,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "hasTiersPrestation": false,
  "notes": "Prefers email communication",
  "language": "en",
  "currency": "EUR",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}

Delete a contact

delete
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Réponses
401

Unauthorized

Aucun contenu
delete/contact/{id}
DELETE /contact/{id} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Aucun contenu

Update a contact

put
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Corps
firstnamestringRequis
lastnamestringRequis
phonestringOptionnel
jobTitlestringOptionnel
emailsstring[]Optionnel
Réponses
200

The contact has been successfully updated.

application/json
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
testbooleanRequis

Whether this is a test contact

Example: false
phonestringOptionnel

Contact phone number

Example: +33123456789
firstnamestringRequis

Contact first name

Example: John
lastnamestringRequis

Contact last name

Example: Doe
jobTitlestringOptionnel

Contact job title

Example: Software Engineer
hasTiersPrestationbooleanRequis

Whether the contact has third-party services

Example: false
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
put/contact/{id}
PUT /contact/{id} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "firstname": "text",
  "lastname": "text",
  "phone": "text",
  "jobTitle": "text",
  "emails": [
    "text"
  ],
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "preferences": {
    "language": "en",
    "currency": "USD",
    "paymentMethods": [
      "cheque",
      "stripe"
    ]
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": false,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "hasTiersPrestation": false,
  "notes": "Prefers email communication",
  "language": "en",
  "currency": "EUR",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}

Les contacts d'entreprise

Pour une meilleure organisation, vous avez la possibilité d'enregistrer différents contacts affiliés à une entreprise spécifique.

post
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Corps
firstnamestringRequis
lastnamestringRequis
phonestringOptionnel
jobTitlestringOptionnel
emailsstring[]Optionnel
notesstringOptionnel
Réponses
201Succès
application/json
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
testbooleanRequis

Whether this is a test contact

Example: false
phonestringOptionnel

Contact phone number

Example: +33123456789
firstnamestringRequis

Contact first name

Example: John
lastnamestringRequis

Contact last name

Example: Doe
jobTitlestringOptionnel

Contact job title

Example: Software Engineer
hasTiersPrestationbooleanRequis

Whether the contact has third-party services

Example: false
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
post/organization/{id}/contact
POST /organization/{id}/contact HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "firstname": "text",
  "lastname": "text",
  "phone": "text",
  "jobTitle": "text",
  "emails": [
    "text"
  ],
  "notes": "text"
}
201Succès
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": false,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "hasTiersPrestation": false,
  "notes": "Prefers email communication",
  "language": "en",
  "currency": "EUR",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}
put
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Corps
firstnamestringRequis
lastnamestringRequis
phonestringOptionnel
jobTitlestringOptionnel
emailsstring[]Optionnel
notesstringOptionnel
defaultContactbooleanOptionnel
Réponses
200Succès
application/json
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
testbooleanRequis

Whether this is a test contact

Example: false
phonestringOptionnel

Contact phone number

Example: +33123456789
firstnamestringRequis

Contact first name

Example: John
lastnamestringRequis

Contact last name

Example: Doe
jobTitlestringOptionnel

Contact job title

Example: Software Engineer
hasTiersPrestationbooleanRequis

Whether the contact has third-party services

Example: false
notesstringOptionnel

Additional notes about the contact

Example: Prefers email communication
languagestring · enumOptionnelValeurs possibles:
currencystring · enumOptionnel

Preferred currency of the customer

Valeurs possibles:
put/organization/contact/{id}
PUT /organization/contact/{id} HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "firstname": "text",
  "lastname": "text",
  "phone": "text",
  "jobTitle": "text",
  "emails": [
    "text"
  ],
  "notes": "text",
  "defaultContact": true
}
200Succès
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "emails": [
    "john@example.com",
    "johndoe@company.com"
  ],
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "archivedAt": 1617187200
  },
  "defaultContact": true,
  "createdAt": 1617187200,
  "archivedAt": 1617187200,
  "hasBillings": true,
  "test": false,
  "phone": "+33123456789",
  "firstname": "John",
  "lastname": "Doe",
  "billingAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "deliveryAddress": {
    "address": "123 Main Street",
    "complement": "Apt 4B",
    "city": "New York",
    "zipCode": "10001",
    "state": "NY",
    "country": "FR"
  },
  "jobTitle": "Software Engineer",
  "bankInformations": {
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFF",
    "holder": "John Doe"
  },
  "hasTiersPrestation": false,
  "notes": "Prefers email communication",
  "language": "en",
  "currency": "EUR",
  "paymentMethods": [
    "cash",
    "credit_card"
  ]
}
get
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
idstringRequis
Réponses
200Succès
application/json
archivedAtnumberOptionnel

Contact archival timestamp

Example: 1617187200
createdAtnumberRequis

Contact creation timestamp

Example: 1617187200
testbooleanRequis

Whether this is a test contact

Example: false
defaultContactbooleanOptionnel

Whether this is the default contact

Example: true
emailsstring[]Optionnel

Contact email addresses

Example: ["john@example.com","johndoe@company.com"]
hasBillingsbooleanRequis

Whether the contact has billings

Example: true
idstringRequis

Contact ID

Example: 123e4567-e89b-12d3-a456-426614174000
fullnamestringRequis

Contact full name

Example: John Doe
get/organization/{id}/contacts
GET /organization/{id}/contacts HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Succès
[
  {
    "archivedAt": 1617187200,
    "createdAt": 1617187200,
    "test": false,
    "defaultContact": true,
    "emails": [
      "john@example.com",
      "johndoe@company.com"
    ],
    "hasBillings": true,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fullname": "John Doe",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Acme Corp",
      "archivedAt": 1617187200
    },
    "tiersPrestation": {
      "state": "synced"
    }
  }
]

Changer le contact par défaut d'une entreprise

patch
Autorisations
AuthorizationstringRequis

API key authentication. Pass your API key as a Bearer token.

Paramètres de chemin
organizationIdstringRequis
Corps
defaultContactIdstringRequis
Réponses
200Succès
Aucun contenu
patch/organization/{organizationId}/default-contact
PATCH /organization/{organizationId}/default-contact HTTP/1.1
Host: api.abby.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "defaultContactId": "text"
}
200Succès
Aucun contenu
PrécédentAuthentification
SuivantFactures

Mis à jour

Ce contenu vous a-t-il été utile ?