Organization
BETA
| Operation | Type | Object | Dto |
|---|---|---|---|
| Mutation | createOrganization |
OrganizationCreateGLDtoInput |
|
| Query | organizationById |
OrganizationGLDto |
|
| Query | organizations |
OrganizationGLDto |
|
| Query | organizationAccountingSetupByOrgId |
Description
Organizations in a tenant.
Header
| Key | Value |
|---|---|
Authorization |
Bearer Current access Token |
X-TenantId |
Current tenant id obtained from userProfile |
x-api-key |
Primary or secondary subscription key of your app |
organizations
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| 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 | |
| allowBlankOrDuplicatedIdentificationNumbers |
boolean | always True |
Info
- legislationCode:
FR,ES, orDE. 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. - allowBlankOrDuplicatedIdentificationNumbers: This field is deprecated, and it is replaced by allowBlankIdentificationNumbers
- documentTypeId : Id of an allowed document type, values are different depending on legislationCode
France (FR)Spain (ES)Germany (DE)
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 must have a unique value.
France (FR)Spain (ES)Germany (DE)
- You can fill any SIREN of 9 characters or any SIRET of 14 characters.
- You can fill any Steur-Idn of 11 characters
- You need to fill a valid NIF number.
For your tests :
organizations/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 |
organizations/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 |
|
Type | |
| surname | string | Family name | 35 |
| 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 |
|
Type | |
| isDefault | boolean | Main mail |
organizations/contacts/phones
| Fields | Type | Description | Length |
|---|---|---|---|
| id |
UUID | Id | |
| number | string | Phone | 20 |
| type |
|
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 | |
| taxOfficilaModelId | UUID | Id taxOfficialModel | |
| periodicity |
|
Periodicity | |
| territory |
|
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 |
|
Tax regime |