This table lists the fields that can be included in a invoice data 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.
The invoice the file must include all the open invoices.
Including all open invoices in the file is important for tracking and managing outstanding debts. It allows for proper follow-up and payment collection, and helps to ensure that all outstanding balances are accounted for.
Invoices that won't be in the file will be considered as closed.
Name | Type | Required? | Value example | Description |
| string | Yes | "2019062600987" | This is a unique number per Invoice. There are no duplicate values through the file. |
| string | No | "Some display ID" | human-readable id |
| string | Yes | "bb0602ae-d560-45cc-9e8f-d841d8ae0ec1" | Same key as in customer.id |
| datetime
OR
number | Yes | "2012-04-23"
OR
"2012-04-23T18:25:43.511Z"
OR
1558700956433
|
|
| number | Yes | 25000 | This is the amount the client has to pay or to be credited with. |
| number | Yes | 30000 | The total amount is the invoice’s total to pay (positive value) or the credit’s total to use (negative value).
|
| number | No | 10000 | If you choose not to use Gaviti's rate conversion service, you have the option to provide your own converted value. To enable this feature, please contact customer support to enable |
| number | No | 15000 | See |
| datetime
OR
number | No | "2020-04-23"
OR
"2020-04-23T18:25:43.511Z"
OR
1558700956433
| This is the date the invoice was created. However, if empty, this field is filled with the date the invoice appears for the first time in the Gaviti Database. YYY-MM-DD |
| string | No | "USD" | Use the ISO list. If empty, Company currency will be used. |
| boolean | No | true | true or false, are the only value for that field. If true, the workflow is enabled for that Invoice. Usually, you stop the whole process due to a disputed invoice or for any other reason you don't want the Customer to be to settle its debt. The value can be either true , 'true', 'TRUE', '1', 1 |
| string | No |
| Enter a valid url to hyperlink the invoice to a cloud document. e.g. linking an invoice to the PDF file generated by the ERP. |
| string | No | "Net30" | A custom field can be added to the invoice record.
e.g. payment terms field |
| Number | No | 123 | A numeric custom field can be added to the invoice record. |
| 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) | |
| Date | No | "2022-07-11" | A custom field of type date’ can be added to the invoice record. |
| Number | No | 0 | Flag the invoice by
0: Red
1: Blue 2: Green 3: Yellow 4: Orange The labels, as well as the colors can be changed and customized. |
| string | No | “Urgent”,”send to collector agency” | A way to classify or mark the invoices. |