Supplier and Production units export API

Supplier fields

Name

Description

Data type

Name

Description

Data type

Supplier id

The internal id of supplier

String

Supplier number

Supplier number as shown in Qarma

String

Supplier name

Supplier name as shown in Qarma

String

Groups

List of Qarma groups (relating to access control)

Groups - group names as JSON array

List of strings

Users

List of Qarma users (registered users in Qarma for this supplier).

Users - a list of structs with full name and email, is a contact person

List of user objects:

  • email - string

  • Fullname - string

  • is_contact - Boolean

Production units

List of production unit internal ids that are linked with this supplier.

List of ids

Is deleted?

False if the production has not been deleted, true if it has been deleted

boolean

Custom fields

For each custom field defined for suppliers, there will be a field with the value.

The data format depends on the type of custom field.

 

Production unit fields

Name

Description

Data type

Name

Description

Data type

Production unit id

The internal id of the production unit

String

Production unit number

Production unit as shown in Qarma

String

Production unit name

Production unit as shown in Qarma

String

Address

Address of production unit (is empty if custom fields are enabled)

List of strings

Contact person

Empty if custom fields are enabled

String

Groups

List of Qarma groups (relating to access control)

List of strings

Users

List of Qarma users (registered users in Qarma for this production unit)

Will be added later

 

Upstream production units

List of production unit internal ids that are linked as upstream.

List of ids

Downstream production units

List of production unit internal ids that are linked as downstream.

List of ids

Latitude

Location added on the production unit

Float

Longitude

Location added on the production unit

Float

Status

Status string of the production unit.

String

Is deleted?

False if the production has not been deleted, true if it has been deleted

Boolean

Custom fields

For each custom field defined for production units, there will be a field with the value.

The data format depends on the type of custom field.