Supplier fields

NameDescriptionData Type
Supplier idThe internal id of supplier

String

Supplier numberSupplier number as shown in Qarma

String

Supplier nameSupplier name as shown in Qarma

String

GroupsList 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

  • Full name - string

  • is_contact - Boolean

Production unitsList of production unit internal id's that are linked with this supplier. List of id's
Is deleted?False if the production has not been deleted, true if it has been deletedBoolean
Custom fieldsFor each custom field defined for suppliers, there will be a field with the value. 

The data format depends on the type of custom field. 

DateTime, String, Number, Array

Production unit fields

NameDescriptionData 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.

DateTime, String, Number, Array

Supplier Documents

NameDescriptionData Type
Type name
The category of document recorded in Qarma, for instance, a BSCI audit report. String
Type codeThe code of the type, for instance BSCI.String
File linkCan be used to view the attached document.Link
Supplier idIf applied to a supplier's custom fields, this section will show the supplier’s id.String
Production unit id
If applied to a production unit's custom fields, this section will display the production unit id.String
Start dateThe date of when the document is active.Date
End dateThe expiry date or end date given for the document.Date
StateThe status of the document such as approved, rejected or file_added.String
ArchivedDisplays true if the document is archived; false otherwise. Boolean
Approved byIf the document has an approval flow, this field will display the approver’s email. String
ExpiryWill display true if there's an expiry date; false if not.
Boolean
Approval or rejection atThe time of when the document was approved or rejected.
DateTime
Last modified atTime of when the document was last modified.
DateTime

If this sounds interesting, don’t hesitate to reach out for a free demo of what we can offer you! If you are already a customer and want to add this inspection type to your portfolio, reach out to support@qarmainspect.com or your contact person. Please contact support@qarmainspect.com for more information.