CSV File Format

The CSV file containing payments data to be imported in Billing must meet the following requirements:

The first line

This line has nine or 11 parameters separated by commas or semicolons:

Parameter Name

Description

PaymentID

Identifier of a payment. This position can either be empty or have the PaymentID value specified:

  • If the position is left empty, a new payment object will be created in Billing after the data import.
  • If the value is specified, an already existing Billing payment, for which the identifier is specified, will be closed by this document.

PayToolID

Identifier of the payment method used to process the payment. The possible values:

  • 0 – Check/Cash. If no payment methods are registered for a customer account, a payment can be imported as paid by Check/Cash and later changed.
  • 1 – Redirect
  • Other numbers – Identifiers of other payment methods, if they are registered for a customer account.

Payment method IDs can be found in the PayToolID column of the PayTool table in the Billing DB.

CurrencyID

Alphabetical ID of the currency used for the payment. (The exact ID of the corresponding currency can be found under System > Settings > Internationalization > Configured Currencies, in the Currency ID column.)

Total

The total amount of payment. Use the period sign, "." to separate the decimal part of the sum.

Status

The status that a payment will get after import is completed. The parameter value can be only Open and Hold. Payments having other statuses are not allowed for import.

DocType

This parameter defines the type of the document the number of which is specified as DocumentID. The values can be Order or Invoice. This parameter is used only together with DocumentID.

DocumentID

The referred Order or Invoice ID. This parameter is used only together with DocType.

AccountID

Numerical ID of account the payment will be attached. Can be found under Operations > Customers (or Resellers). See in the Account ID column.

PaymentNote

A free-form comment added to a payment. An optional parameter.

DocumentDate

The date of transferring money to a bank account. This parameter is optional and used only together with ReferenceNumber. This parameter must be formatted as YYYY-MM-DD.

ReferenceNumber

A unique identifier of the payment used in the external system. This parameter is optional and used only together with DocumentDate.

Notes:
• Either both DocType and DocumentID parameters or AccountID are to be specified mandatory.
• All the nine (or 11) parameters must be in the first line of the CSV file.

The second line and all the lines below it:

These lines include values of the parameters specified in the first line, and their order must correspond to the parameters order. Each line contains values for one particular payment, values are separated by commas or semicolons (the same separator that is used in the first line of the file). All separators must be in place, also for empty values, otherwise Billing will fail to parse the file when importing data.

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.