Create Relation

Create a third party of the company: a business (type: company) or an individual (type: contact).

The body carries the relation and nothing else. type selects which fields it accepts, and cannot be changed afterwards. A company is identified by its name, a contact by its first_name — sending a field the other type owns is refused rather than ignored. address is required, and must at least carry the country_code.

A company whose vat, identifier or electronic_address already belongs to another company of the same company is refused with 409 duplicate_relation; pass ?ignore_duplicate=true to create it anyway.

In sandbox mode the body is validated exactly as in live mode but nothing is stored, so the returned id is not resolvable.

POST /relations

Create Relation

cURL

curl --request POST \
  --url https://api.fidly.be/relations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "country_code": "<string>",
    "street": "<string>",
    "street_number": "<string>",
    "street2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "province": "<string>"
  },
  "type": "company",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "language": "en",
  "vat": "<string>",
  "identifier": "<string>",
  "electronic_address": "<string>",
  "is_customer": true,
  "is_supplier": true
}
'

201

{
  "id": "<string>",
  "type": "company",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "language": "<string>",
  "address": {
    "street": "<string>",
    "street_number": "<string>",
    "street2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country_code": "<string>"
  },
  "vat": "<string>",
  "identifier": "<string>",
  "electronic_address": "<string>",
  "is_customer": true,
  "is_supplier": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ignore_duplicate · boolean | null

Goes through even when the result would give this company the same vat, identifier or electronic_address as another one (otherwise refused with 409 duplicate_relation). Companies only: passing it on a contact is refused, since there is no such check to waive. Never stored.

Body

application/json

CompanyRelationCreate

ContactRelationCreate

A business third party to create. name identifies it and is required.

The contact-only fields (first_name, last_name) are rejected: an individual is a relation of type contact.

address · AddressCreate · object · required

Postal address. Required.

Show child attributes

type · string · required

Selects the company relation type.

Allowed value: "company"

name · string · required

Company name.

Required string length: 1 - 245

email · string | null

Primary email address.

Maximum string length: 245

phone · string | null

Phone number.

Maximum string length: 45

language · string · default: en

Preferred language, one of ['fr', 'en', 'nl', 'de'].

vat · string | null

VAT number, prefixed with the ISO country code.

Maximum string length: 45

identifier · string | null

Legal registration / party identifier.

Maximum string length: 45

electronic_address · string | null

Electronic address used to send invoices over Peppol.

Maximum string length: 60

is_customer · boolean · default: true

Whether this company is a customer.

is_supplier · boolean · default: true

Whether this company is a supplier.

Response

201

application/json

Successful Response

CompanyRelationOut

ContactRelationOut

A business third party. Carries the fields an individual has no equivalent of (vat, identifier, electronic_address, is_customer, is_supplier), and none of the contact-only ones — first_name/last_name are simply absent from the response.

id · string · required

Opaque unique identifier of the relation.

type · string · required

Relation type, always company here.

Allowed value: "company"

name · string | null

Display name. Company name for company, full name for contact.

email · string | null

Primary email address.

phone · string | null

Phone number.

language · string | null

Preferred language, one of ['fr', 'en', 'nl', 'de'].

address · AddressOut · object | null

Postal address, if known.

Show child attributes

vat · string | null

VAT number, prefixed with the ISO country code.

identifier · string | null

Legal registration / party identifier.

electronic_address · string | null

Electronic address used to send invoices over Peppol.

is_customer · boolean | null

true if this company is a customer.

is_supplier · boolean | null

true if this company is a supplier.