BETA

BETA

Operation Type Object Dto
Mutation createSuppliers SuppliersCreateGLDtoInput
Mutation updateSuppliers SuppliersUpdateGLDtoInput
Query supplierById SuppliersGLDto
Query suppliers SuppliersGLDto

Description

Suppliers management

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

suppliers

Fields Type Description Length
id UUID Id  
modificationDate datetime Modification date  
creationDate datetime Creation date  
countryAcronym string Country 2
documentTypeId UUID DocumentType Id  
documentId string Identification number 25
code string Code supplier 17
socialName string supplier Name 70
tradeName string Trade Name 70
disabled boolean Inactive  
disabledDate datetime Inactive date  
status
  • 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  
thirdCollectorName string Name of third Collector  
thirdCollectorId UUID Id of third Collector  
businessAreaId UUID Business areas Id  
addresses[] Array List of addresses  
contacts[] Array List of contacts  
paymentTermLines[] Array List of payement terms lines  
Info
  • countryAcronym : ISO2 country code, is mandatory.
    For the particular case of Northern Ireland should contain XI and not GB.
  • documentTypeId : Id of an allowed document type, values may be different depending on legislationCode.
    France (FR)
    Spain (ES)
    Germany (DE)
    CountryAcronym Allowed document types (code name)
    FR 01 SIRET
    VIES 02 TVA Intracommunautaire
    Other 06 Autre document justificatif
    CountryAcronym Allowed document types (code name)
    DE 01 Steur-IdN
    VIES 02 USt-IdNr
    Other 06 Another supporting document
    CountryAcronym Allowed document types (code name)
    ES 01 NIF/DNI
    VIES 02 NIF/IVA
    Other 03 Pasaporte
    Other 04 Documento oficial emitido en el país de residencia
    Other 05 Certificado de residencia
    Other 06 Otro documento probatorio
  • documentId : Identification number, value formats may differ depending on legislationCode.
    France (FR)
    Spain (ES)
    Germany (DE)

    For your tests :

  • disabled : If true the third can no longer be used, but will remain in the existing information.
  • tradeName : Can be used to fill in a shorter name than socialName


suppliers/addresses

Attention, only one address is authorized, even if the representation is an array of addresses

Fields Type Description Length
id UUID Id  
countryId UUID Id Country  
countryName 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

suppliers/contacts

Fields Type Description Length
id 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  
suppliers/contacts/emails
Fields Type Description Length
id UUID Id  
emailAddress string Email address 70
usage
  • NOT_SET
  • EMPTY
  • INVOICES
  • PAYMENTS
  • OTHERS
Type  
isDefault boolean Main mail  
suppliers/contacts/phones
Fields Type Description Length
id UUID Id  
number string Phone 20
type
  • NOT_SET
  • EMPTY
  • LANDLINE
  • MOBILE
  • FAX
  • SKYPE
  • WHATS_APP
Type  
isDefault boolean Main phone  
suppliers/contacts/socialMedias
Fields Type Description Length
id UUID UUID  
name string Name 30
link string Link 100

suppliers/paymentTermLines

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

Fields Type Description
id UUID Id
order 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 decimal Value
condition
  • NONE
  • DAY_OF_PAYMENT
  • END_OF_MONTH
To calculate due date
day int Number of days
payDays[] Array optional due days
Info
  • order : If REMAINING_AMOUNT, must always be last with the code 9999.
  • payDays : Array of optional due days. The day contained in the array closest to the number of days defined in day will be used to calculate the Due Date.