This table lists the fields that can be included in a customer file, which can be provided in xls, csv, json, txt, or xml format. Each row represents a field and includes the following information:
Name: The name of the field.
Type: The data type of the field, such as
string,boolean, ordate.Required: Whether the field is required or optional.
Value example: An example of a valid value for the field.
Description: A brief description of the field and its purpose.
Please note that some fields, such as customFields_[fieldName], can have different data types depending on the specific field being used. These variations are listed in separate rows in the table.
Name | Type | Required | Value example | Description |
id | string | Yes | "012172986-2018-JDoe" | This is a unique number for each customer. If you have multiple invoices for the same customer, use the same value. |
displayId | string | No | "Some display ID" | A human-readable id. |
displayName | string | No | "Big Company" | The name of the customer. |
emailsLevel_[X] | string | No | To contact a customer with multiple email addresses and organize them through workflows, use the many levels emails field. This can be set up by contacting Gaviti Support. Note that emails are case-insensitive and are stored in lowercase. By default, the first level is <emailsLevel_1>. | |
phone | string | No | "13235551234" | This field can include the international code with the + sign, as well as dots and spaces. However, it is recommended to keep it simple and generic. |
contactName | string | No | "Faye Donaway" | The name of the customer's point of contact. |
workflowEnabled | boolean | No | true | This field can only have the values true or false. If set to true, the workflow will be enabled for the customer regardless of the number of invoices. It should be in lowercase. Valid values include true, 'true', 'TRUE', '1', and 1. |
workflow | string | No | "bb0602ae-d560-45cc-9e8f-d841d8ae0ec1" | The id of a workflow. |
userCustomerRelations_[type] | string | No | The email of the user associated with the customer with this type. The type defines the relationship with the customer. This can be set up by contacting Gaviti Support. | |
customFields_[fieldName] | string | No | "USA" | A custom field, such as a country field, can be added to the customer record. |
customFields_[fieldName] | number | No | 123000 | A numeric custom field can be added to the customer record. |
customFields_[fieldName] | string | No | A custom field of type 'email' can be added to the customer record. Multiple emails can be added, separated only by a comma (no semi-colon). | |
customFields_[fieldName] | date | No | "2022-07-11" | A custom field of type date can be added to the customer record. |
flag | number | No | 0 | Flag the customer by 0: Red, 1: Blue, 2: Green, 3: Yellow, 4: Orange. The labels and colors can be changed and customized. |
tags | string | No | "VIP","email" | A way to classify or mark the customers. |