How to create a Supplier

๐Ÿ“˜

Suppliers are mandatory to create Products and Purchase Orders as they need one associated with them. They are also used in KPIs within the system.

Suppliers can be created through our Entity endpoint, the request should look something like this:

[
  {
    "name": "The coca-cola company", // Person or Company's name
    "tradeName": "Coca-cola", // Company's trade name.
    "personType": 1, // Person type (0 = Person, 1 = Company)
    "entityTypeId": 2, // Entity type
    "relationalEntityCode": "8504", // Entity's Id on the origin system.
    "situationCode": 1, // Entity status (3 = In registration, 01 = Active, 02 = Inactive).
  }
]

These are the mandatory fields to create an Supplier.

๐Ÿšง

Suppliers always have the entityTypeId property set to 2.

๐Ÿ“˜

Multiple Suppliers can be created within the same request.

Optional fields

NameDescriptionDefault Value
subTypeAny subtype you want to add to this Entity
entityNoteAny notes you want to add to an Entity
streetStreet address
typeAddressCode(Ver com Marcelo)
districtAddress district
zipCodeAddress zipCode
complementAddress complement
cityAddress city
initialsStateAddress state initials
flagFlags are used to group entitys
stateRegistrationCompany's State Registration Number (Brazil only)
routeIdWMS route Id to be associated with this entity
routeWMS route description to be associated with this entity
glnSupplier Global Location Number

For more information about the required properties please refer to our API Reference here.