Customer

Specific rules pertaining to a legislation and/or the Customer’s country.

Creating a Customer record involves multiple variables, including the legislation FR, ES or DE and the country of the Customer :

• Legislation-Specific Fields
  Certain mandatory fields will depend on the legislation you are operating under (FR, ES or DE).

• Country of the Customer
  Understanding the country of the Customer is crucial as it introduces additional variables that can affect the mandatory and optional fields needed for Customer creation.

  • Same as Operating Legislation: If the Customer’s country is the same as your operating legislation.
  • Member of VIES: If the Customer’s country is different from your operating legislation and is a member of the VAT Information Exchange System (VIES).
  • Different from Legislation and VIES: If the Customer’s country doesn’t fall under your operating legislation and is not a member of VIES.

Common rules

• countryIsoCodeAlpha2 is 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.
• code is optional if the automatic numbering option (Sequence number) is enabled for the Customer resource.
  However, it can be set to enforce a specific value instead of requesting the assignment of a new sequential number.
• documentType allows you to define the type of identification document for the Customer.
  It is automatically set by default based on the legislation and country, and, with few exceptions, does not need to be filled in during creation.

Examples of Creation

• Below, for each legislation FR, ES and DE, the specific rules and differences depending on the Customer’s country.

• These examples assume that automatic numbering for the Customer resource is not inactive in Sequence Numbers, otherwise it is a mandatory value.
  So the Code field is not provided. However, you always have the option to assign specific values.

  

• These examples focus on the differences according to legislations and countries, they do not include the addition of contacts or payment conditions.
  You can find more comprehensive examples that include adding contacts and payment conditions in the Postman collection Quick start / 5. Test your first query in Postman.

• To assist you in testing creations with valid documentId, you can use the generator for random identification numbers that are consistent with the rules.

  DocumentId generator for your tests in legislation

  FR - France ES - Spain DE - Germany AT - Austria BE - Belgium BG - Bulgaria CY - Cyprus CZ - Czech Republic DK - Denmark EE - Estonia EL - Greece FI - Finland HR - Croatia HU - Hungary IE - Ireland IT - Italy LT - Lithuania LU - Luxembourg LV - Latvia MT - Malta NL - The Netherlands PL - Poland PT - Portugal RO - Romania SE - Sweden SI - Slovenia SK - Slovakia XI - Northern Ireland

  graphQL Mutation

  mutation ($values: CustomerCreateGLDtoInput!) {  
      createCustomer(input: $values) {
      id
      code
    }
  }
  

  Legislation = FR -> Country of Customer = FR

  • The documentId field corresponds to the SIRET or SIREN number. This value is not mandatory.
  • For the qualification of the Customer, it is recommended to assign the VATNumber.

  {
    "values": {
      "socialName": "DUPONT SA",
      "tradeName": "Dupont",
      "documentId": "323456789",
      "vatNumber": "FR33323456789",
      "addresses": [
        {
          "firstLine": "72 rue Joffre",
          "city": "PARIS",
          "zipCode": "75001",
          "countryIsoCodeAlpha2": "FR"
        }
      ]
    }
  }
  

  Legislation = FR -> Country of Customer = member of VIES and not FR

  • The documentId field is not mandatory.
  • For the qualification of the Customer, it is recommended to assign the VATNumber.
  • For the particular case of Northern Ireland countryIsoCodeAlpha2 should contain XI and not GB

  {
    "values": {
      "socialName": "BelgiumCorp SA",
      "tradeName": "BelgiumCorp",
      "vatNumber": "BE1489052515",
      "addresses": [
        {
          "firstLine": "1 Grand Place",
          "city": "BRUXELLES",
          "zipCode": "1000",
          "countryIsoCodeAlpha2": "BE"
        }
      ]
    }
  }
  

  Legislation = FR -> Country of Customer is neither FR nor VIES

  • The documentId field is not mandatory.
  • The VATNumber field is not used.

  {
    "values": {
      "socialName": "Smiths Corporation",
      "tradeName": "Smiths",
      "addresses": [
        {
          "firstLine": "456 Oak S",
          "city": "NEW YORK",
          "zipCode": "10001",
          "countryIsoCodeAlpha2": "US"
        }
      ]
    }
  }
  

  Legislation = ES -> Country of Customer = ES

  • The documentId field corresponds to the NIF or DNI or NIE number. This value is mandatory.
  • For the qualification of the Customer, it is recommended to assign the VATNumber.

  {
    "values": {
      "socialName": "Martinez SA",
      "tradeName": "Martinez",
      "documentId": "Z4660201S",
      "vatNumber": "ESZ4660201S",
      "addresses": [
        {
          "firstLine": "Calle Mayor 10",
          "city": "MADRID",
          "zipCode": "28001",
          "countryIsoCodeAlpha2": "ES"
        }
      ]
    }
  }
  

  Legislation = ES -> Country of Customer = member of VIES and not ES

  • The documentId field is not mandatory.
  • The vatNumber is mandatory.
  • For the particular case of Northern Ireland countryIsoCodeAlpha2 should contain XI and not GB

  {
    "values": {
      "socialName": "BelgiumCorp SA",
      "tradeName": "BelgiumCorp",
      "vatNumber": "BE1489052515",
      "addresses": [
        {
          "firstLine": "1 Grand Place",
          "city": "BRUXELLES",
          "zipCode": "1000",
          "countryIsoCodeAlpha2": "BE"
        }
      ]
    }
  }
  

  Legislation = ES -> Country of Customer is neither ES nor VIES

  • If documentTypeId is not mentioned, the document type Otro documento probatorio will be automatically filled in. Otherwise, you can provide an Id of and authorized document type (Pasaporte, Documento oficial emitido en el país de residencia, Certificado de residencia).
  • The documentId field is not mandatory.
  • The VATNumber field is not used.

  {
    "values": {
      "socialName": "Smiths Corporation",
      "tradeName": "Smiths",
      "addresses": [
        {
          "firstLine": "456 Oak S",
          "city": "NEW YORK",
          "zipCode": "10001",
          "countryIsoCodeAlpha2": "US"
        }
      ]
    }
  }
  

  Legislation = DE -> Country of Customer = DE

  • The documentId field corresponds to an identification number. This value is not mandatory.
  • For the qualification of the Customer, it is recommended to assign the VATNumber.

  {
    "values": {
      "socialName": "Müsller GmbH",
      "tradeName": "Müsller",
      "documentId": "80715887835",
      "vatNumber": "DE807158878",
      "addresses": [
        {
          "firstLine": "Friedrichstraße 501",
          "city": "BERLIN",
          "zipCode": "10117",
          "countryIsoCodeAlpha2": "DE"
        }
      ]
    }
  }
  

  Legislation = DE -> Country of Customer = member of VIES and not DE

  • The documentId field is not mandatory.
  • The vatNumber is mandatory.
  • For the particular case of Northern Ireland countryIsoCodeAlpha2 should contain XI and not GB

  {
    "values": {
      "socialName": "BelgiumCorp SA",
      "tradeName": "BelgiumCorp",
      "vatNumber": "BE1489052515",
      "addresses": [
        {
          "firstLine": "1 Grand Place",
          "city": "BRUXELLES",
          "zipCode": "1000",
          "countryIsoCodeAlpha2": "BE"
        }
      ]
    }
  }
  

  Legislation = DE -> Country of Customer is neither DE nor VIES

  • The value of the documentId field is not necessary.
  • The VATNumber field is not used.

  {
    "values": {
      "socialName": "Smiths Corporation",
      "tradeName": "Smiths",
      "addresses": [
        {
          "firstLine": "456 Oak S",
          "city": "NEW YORK",
          "zipCode": "10001",
          "countryIsoCodeAlpha2": "US"
        }
      ]
    }
  }
  

Example of Response

{
    "data": {
        "createCustomer": {
            "id": "e451aff7-0560-4e72-a6fb-4ea25e9d9c64",
            "code": "3"
        }
    }
}