Organization

Attention!

With the ability now to have organizations on different tenants for a same user, the list of organizations no longer requires passing an X-TenantId in the header, and now exposes the tenantId field for each organization returned.

Instead, as in previous versions, of passing an X-TenantId in the header of other queries and mutations obtained from the activeTenantId value of userProfile, assign the tenantId retrieved from the record of the desired organization in X-TenantId.

No longer use activeTenantID !
HTTP Operation Type Object DTO Why-DTOs?
Query organizationById OrganizationGLDto
Query organizations filtered by id Why? OrganizationGLDto
Query organizations OrganizationGLDto
Query organizationAccountingSetupByOrgId  

Description

The application can be used to manage different establishments or subsidiaries, called Organization in the API context and Company or business in the product interface.
Each organization is represented separately within the application, allowing for individualized handling and customization.

The current working organization’s name is displayed in the top right title bar, providing clear context and navigation as you interact with the different aspects of the organization.

img

Key Value
Authorization Bearer Current access Token How to find?
x-api-key Primary or secondary subscription key of your app How to find?

organizations

Fields Type Description Length
id UUID Id  
creationDate Datetime Creation date  
       
tenantId UUID Tenant in which the organization is located  
status
  • UNDEFINED
  • PROVISIONING_IN_PROGRESS
  • READY
  • DELETED
  • ERASED
 Status  
legislationCode String Compliance with the legislation of the organization  
socialName String Company name 50
documentId String Identification number 14
documentTypeId UUID Id document type  
allowBlankIdentificationNumbers Boolean always True  
useCustomerCodes Boolean always True  
nafApeCode String NAF/APE Code 7
vatNumber String Intracommunity VAT number 25
contacts[] Array Contacts organization  
addresses[] Array Addresses organization  
taxOfficialModelsOrganization[] Array List of taxOfficialModel  
Info
  • tenantId: The identifier of the tenant hosting the organization specified by the id. It’s crucial for distinguishing between different tenants in a multi-tenant environment.
  • status: Indicates the current state of an organization within the system. It progresses through several stages: UNDEFINED, PROVISIONING_IN_PROGRESS, READY, DELETED, and ERASED.
    Data related to an organization cannot be addressed or interacted with until its status reaches READY.
  • legislationCode: FR, ES, or DE. This variable can be used if your application needs to work for different legislations, to account for the differences between them. Please note that this cannot be set during the organization creation process as the organization inherits the legislation from the tenant.
  • documentTypeId : Id of an allowed document type, values are different depending on legislationCode
    CountryAcronym Allowed document types (code name)
    FR 01 SIREN / SIRET
    CountryAcronym Allowed document types (code name)
    DE 01 Steur-IdN
    CountryAcronym Allowed document types (code name)
    ES 01 NIF/DNI
  • documentId : Identification number, please note that each organization has a unique value.
    • SIREN of 9 characters or any SIRET of 14 characters.
    • Steur-Idn of 11 characters
    • valid NIF number.

organizations/addresses

Fields Type Description Length
id UUID Id  
       
countryId UUID Country Id  
countryIsoCodeAlpha2 String Country Code  
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
Info
  • countryIsoCodeAlpha2 : ISO2 country code.
    This field is only used for creation and serves as a simple alternative to assign the country of the address by using the ISO2 code directly, rather than the country ID in the Countries resource.

organizations/contacts

Fields Type Description Length
id UUID Id  
       
courtesy
  • NONE
  • MR
  • MISS
 Courtesy  
name String First name (John) 35
surname String Family name (Smith) 35
jobName String Job name 35
jobAreaId UUID Job areas Id  
isDefault Boolean Main contact  
emails[] Array List of emails  
phones[] Array List of phones  
socialMedias[] Array List Social Networking  

organizations/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  

organizations/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  

organizations/contacts/socialMedias

Fields Type Description Length
id UUID UUID  
       
name String Name 30
link String Link 100

organizations/taxOfficialModelsOrganization

Fields Type Description Length
id UUID Id  
       
intialDate Datetime Start date  
finalDate Datetime End date  
periodicity
  • NONE
  • MONTHLY
  • QUARTERLY
  • ANNUAL
  • DAILY
 Periodicity  
territory
  • NONE
  • COMMON
  • STATE
 Territory  
description String Description 200

organizationAccountingSetupByOrgId

Fields Type Description
id UUID Id
     
defaultCustomersAccountId UUID Customer account Id
defaultSuppliersAccountId UUID Supplier account Id
subAccountingLength Decimal Sub accounts max length (max 13)
taxRegime
  • GENERAL
  • BA
  • BNC
 Tax regime