BETA

BETA

Operation	Type	Object	Dto
Create	Mutation	createCustomers	CustomersCreateGLDtoInput
Update	Mutation	updateCustomers	CustomersUpdateGLDtoInput
Read	Query	customerById	CustomersGLDto
List	Query	customers	CustomersGLDto

Description

Customers management

Header

Key	Value
Authorization	Bearer Current access Token
X-TenantId	Current tenant id obtained from userProfile
X-OrganizationId	Current organization Id
x-api-key	Primary or secondary subscription key of your app

customers

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
modificationDateSSystem field that cannot be assigned	datetime	Modification date
creationDateSSystem field that cannot be assigned	datetime	Creation date
countryAcronym NThe value of this field cannot be modified after the record is created *The value of the field or object is mandatory	string	Country See InfoAdditional information is available in the Info block below	2
documentTypeIdNThe value of this field cannot be modified after the record is created *The value of the field or object is mandatory	UUID	DocumentType Id See InfoAdditional information is available in the Info block below
documentId	string	Identification number See InfoAdditional information is available in the Info block below	25
code *The value of the field or object is mandatory NThe value of this field cannot be modified after the record is created	string	Code customer	17
socialName *The value of the field or object is mandatory	string	customer Name	70
tradeName	string	Trade Name See InfoAdditional information is available in the Info block below	70
disabled	boolean	Inactive See InfoAdditional information is available in the Info block below
disabledDate	datetime	Inactive date
status RThis field is read-only, its value cannot be assigned	NONE DISABLED ENABLED GDPR_APPLIED	Status
defaultAccountingAccountId	UUID	Main account
comments	string	Comments	2000
vatNumber	string	VAT Number intracommunity	25
nafApeCode	string	Code NAF/APE	7
gdprApplied	boolean	GDPR action
gdprAppliedDate	datetime	GDPR date action
thirdPayerName RThis field is read-only, its value cannot be assigned	string	Name of third Payer
thirdPayerId	UUID	Id of third Payer
businessAreaId	UUID	Business areas Id
addresses[]	Array	List of addresses
contacts[]	Array	List of contacts
paymentTermLines[]	Array	List of payement terms lines

customers/addresses

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
countryId	UUID	Id Country
countryNameRThis field is read-only, its value cannot be assigned	string	CountryName
name	string	Code	50
firstLine	string	First Line	35
secondLine	string	Second Line	35
city	string	Town	35
zipCode	string	Postal Code	9
province	string	Province	25

customers/contacts

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
isDefault	boolean	Main contact
jobAreaId	UUID	Job areas Id
jobName	string	Job name	35
name	string	First name	35
courtesy	NONE MR MISS	Type
surname	string	Family name	35
emails[]	Array	List of emails
phones[]	Array	List of phones
socialMedias[]	Array	List Social Networking

customers/contacts/emails

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
emailAddress	string	Email address	70
usage	NOT_SET EMPTY INVOICES PAYMENTS OTHERS	Type
isDefault	boolean	Main mail

customers/contacts/phones

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
number	string	Phone	20
type	NOT_SET EMPTY LANDLINE MOBILE FAX SKYPE WHATS_APP	Type
isDefault	boolean	Main phone

customers/contacts/socialMedias

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	UUID
name	string	Name	30
link	string	Link	100

customers/paymentTermLines

Payment terms, used to define the list of payment terms for Customers
Example :

• Advance payment by check 30%
• 30% by transfer at 30 days net
• the balance of 40% by bank transfer at 60 days end of month

Fields	Type	Description
idSSystem field that cannot be assigned	UUID	Id
order *The value of the field or object is mandatory	int	classification of lines from 0 to n.
paymentMeanId	UUID	Id of the payment mean
Type	NONE LINEAL PERCENTAGE FIXED_AMOUNT REMAINING_AMOUNT	Type of calculation
value *The value of the field or object is mandatory	decimal	Value
condition	NONE DAY_OF_PAYMENT END_OF_MONTH	To calculate due date
day	int	Number of days
payDays[]	Array	optional due days