Get all supplier types
  • 07 Aug 2024
  • 1 Minute to read
  • Dark
    Light

Get all supplier types

  • Dark
    Light

Article summary

Get
/api/v1/relations/supplierTypes

Get all supplier types in the system.

Description

Returns the list of all available supplier types. This is a standard list, however it can be configured to the preferences of the user. Configuration is performed in the Bloxs application and cannot be conducted through the API. SupplierTypes refers to the 'supplierTypeName' field in the supplier endpoints. In order to enter a valid option in 'supplierTypeName', the endpoint 'Get SupplierTypes' can be used to retrieve the full list of available options. A supplier encompasses all entities from which you receive invoices. For example, the tax authorities or a cleaning company. Also, for instance, the company from which you purchase office supplies.

Use Case

The Bloxs user wants to add a supplier. One of the fields is the supplierTypeName. However, the user does not know which options are available. By calling the Get SupplierTypes endpoint a full list will be returned of available options. Subsequently this can be used as input for adding a supplier.

Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

Success

Array of string
string