Create a reference

PUT 
/companies/:company-id/references

Create a reference

Request

application/json

Body

required

companyId uuidrequired

The company in which the reference is part of.

tag stringnullable

The tag of the reference.

entities

object[]

required

Possible values: >= 1

Array [

general

object

nullable

entryDateIntoRelationship

object

anyOf

MOD1

string

MOD2

string

originCustomerRelationship stringnullable

contactCustomerRelationship stringnullable

remoteOpening booleannullable

dateLastMeeting

object

anyOf

MOD1

string

MOD2

string

entryIntoRelationshipNote stringnullable

gender stringnullable

Possible values: [male, female]

Default value: male

name stringnullable

lastName stringnullable

firstName stringnullable

birthDate

object

anyOf

MOD1

string

MOD2

string

birthZipCode stringnullable

birthRegion stringnullable

birthCity stringnullable

birthCountry stringnullable

birthName stringnullable

deathDate

object

anyOf

MOD1

string

MOD2

string

familySituation stringnullable

Possible values: [none, inARelationship, civilUnion, remarried, pendingDivorce, single, deceased, widowed, married, freeUnion, domesticPartnership, divorced, cohabitation, separated]

marriageDate

object

anyOf

MOD1

string

MOD2

string

nationality stringnullable

matrimonialRegime stringnullable

studiesLevel stringnullable

Possible values: [none, certificate, highSchool, bachelor, master, doctorate]

occupation stringnullable

occupationWording stringnullable

retirementAge numbernullable

annualIncome

object

anyOf

MOD1

string

MOD2

number

heritageOrigin stringnullable

sectorOfActivity stringnullable

dateEntryRelationship

object

anyOf

MOD1

string

MOD2

string

idCard stringnullable

idNumber stringnullable

issueDate

object

anyOf

MOD1

string

MOD2

string

authority stringnullable

expirationDate

object

anyOf

MOD1

string

MOD2

string

idNIF stringnullable

idMIF stringnullable

taxResidence stringnullable

customerClassificationMIF stringnullable

classificationDate

object

anyOf

MOD1

string

MOD2

string

pep booleannullable

usPerson booleannullable

legalCapacity stringnullable

tag stringnullable

referencesType stringnullable

Possible values: [customer, prospect, relation]

updated

object

anyOf

MOD1

string

MOD2

string

homeAdress stringnullable

complement stringnullable

postalCode stringnullable

note stringnullable

city stringnullable

secondaryNationality stringnullable

country stringnullable

professionalCategory stringnullable

information

object

nullable

socialReason stringnullable

Possible values: non-empty

contact stringnullable

firstAddress stringnullable

secondAddress stringnullable

postalCode stringnullable

city stringnullable

country stringnullable

phone stringnullable

fax stringnullable

email emailnullable

Possible values: non-empty

website stringnullable

holdingId stringnullable

siren stringnullable

siret stringnullable

ape stringnullable

creationDate stringnullable

legalForm stringnullable

socialCapital numbernullable

headOfficeAddress stringnullable

managers

object[]

nullable

Array [

managerID stringrequired

primary booleanrequired

]

seniorAdvisor stringnullable

secondaryAdvisor stringnullable

entryDateIntoRelationship stringnullable

originCustomerRelationship stringnullable

contactCustomerRelationship stringnullable

remoteOpening booleannullable

dateLastMeeting stringnullable

entryIntoRelationshipNote stringnullable

ownership numbernullable

valuation numbernullable

managers

object

nullable

lastNameFirstName string

function string

birthDate stringnullable

nationality string

personalAddress string

personalPhoneNumber string

personalEmailAddress email

Possible values: non-empty

shareholderInformation string

idCard string

idNumber string

nbManagers

object

nullable

lastNameFirstName string

function string

birthDate stringnullable

nationality string

personalAddress string

personalPhoneNumber string

personalEmailAddress email

Possible values: non-empty

shareholderInformation string

idCard string

idNumber string

bankAccounts

object

nullable

banks string

iban string

bankAccountNumbers string

bic string

activities

object

nullable

mainActivities string

secondaryActivities string

clients string

suppliers string

competitors string

details

object

nullable

street stringnullable

zipCode stringnullable

city stringnullable

addressSupplement stringnullable

workStreet stringnullable

workZipCode stringnullable

workCity stringnullable

workAddressSupplement stringnullable

otherStreet stringnullable

otherZipCode stringnullable

otherCity stringnullable

otherAddressSupplement stringnullable

firstPhoneNumber stringnullable

secondPhoneNumber stringnullable

personalEmail emailnullable

Possible values: non-empty

otherEmail emailnullable

Possible values: non-empty

fiscalAddress stringnullable

country stringnullable

otherCountry stringnullable

workCountry stringnullable

type stringnullable

Possible values: [person, company]

referenceType string

Possible values: [customer, prospect, relation]

Default value: customer

The type of the aggregation entity.

]

access

object[]

nullable

Array [

managerId uuidrequired

primary boolean

]

Responses

200

success - a reference information

application/json

Schema

Schema

id uuidrequired

The references ID.

companyId uuidrequired

The company in which the reference is part of.

created stringnullablerequired

The date of creation of the reference.

tag stringnullable

The tag of the reference.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2024-01-01T00:00:00.000Z",
  "tag": "VIP"
}

Loading...