Related articles

DevelopersAPI guides

Automatically importing payment allocation data

Payment allocations can be uploaded automatically to Enable via SFTP data feeds to manage payments for your rebate earnings.

This article will guide you through:

  1. How to download the payment allocation template
  2. How to populate the payment allocation template
  3. How to save the payments file
  4. Checking the universal requirements for the file
  5. How to upload payments

Looking for something else?

How to download the payment allocation template

Users with access to the Finance app will have access to the Finance area and payment allocation upload template within Enable. If you require additional help, please reach out to our support team here.

To download the payment allocation template:

Step 1: Click on Finance in the green banner at the top of the page.

Step 2: Click on Uploads in the drop-down menu.

Step 3: Within the Payment uploads tab, click the Upload button in the bottom left of the page. You will automatically be navigated to the payment uploads wizard.

Step 4: Click on Download import template to save the Payments Template CSV file to your computer’s downloads folder.

How to populate the payment allocation template

Once the payments template has been downloaded, you will need to populate each row with the following column data for your payment allocations. Column headers must not be changed or renamed in the file.

  • Trading partner name: The name of the trading partner the payment is attached to. If you populate the Trading partner reference column below, leave the Trading partner name column blank.
  • Trading partner reference: The reference of the trading partner the payment is attached to.
  • (Mandatory) Currency: The currency used for the payment (e.g. USD, GBP, CAD etc.).
  • (Mandatory) Payment value: The total value of the payment being made or the payment received.  Do not use commas to separate thousands, "-" to denote zero, or parentheses to denote negatives; simply use the number without these, using a leading negative sign if required.
  • (Mandatory) Tax: The tax value that should not be allocated to the payment lines. If there is no tax, populate it with 0.
  • (Mandatory) Payment method: The payment method of the payment. The list of valid payment methods is displayed on the Instructions page after downloading the template.
  • (Mandatory) Date of payment: The date of the payment in the format YYYY-MM-DD.
  • (Mandatory) External reference: The text set in the external reference section of the payment that the row corresponds to. This must be unique for the trading partner.
  • (Optional) Notes: Any additional notes or information for each payment.
  • (Optional) Reason code: Required if the sum of Allocated value columns does not equal the Payment value column, i.e. if the payment is being left unallocated or partially allocated. Please reach out to our support team here to confirm the Reason Codes that have been set up in your channel.
  • Allocated value: The proportion of the total payment value that is allocated to a given payment line. This payment line will be determined by the payment line ID.  Do not use commas to separate thousands, "-" to denote zero, or parentheses to denote negatives; simply use the number without these, using a leading negative sign if required.
  • Payment line ID: The ID of the payment line that the proportion of the total payment value is allocated to. The payment line IDs can be found on the Debtors report. By default, there are three pairs of Allocated value and Payment line IDs. If you have more than 3 payment allocations to make, please add more columns to the template (i.e. Allocated value 4, Payment line ID 4, Allocated value 5, Payment line ID 5, etc.). If you have less than 3 payment allocations to make, you do not need to delete the unused columns.

If required by your implementation team:

  • (Optional) Add the row count in the final row in the form “ROWCOUNT IS X”, where X is the total number of transactions you are uploading. In the CSV file, this will be the total row count - 2. This must all be in uppercase.

How to save the payments file

Save your CSV file and rename the file to the format “PAYMENTUPLOAD-TIMESTAMP”, where:

  • TIMESTAMP is replaced by a 14-digit number in the format yyyyMMddhhmmss made up of the creation date, e.g. PAYMENTUPLOAD-20240417030422.csv.

Checking the universal requirements for the file

The following criteria must be satisfied for each file imported via the SFTP:

  • The dataset to be imported must be a CSV file within an encrypted ZIP file.
  • The name of the ZIP file must be the same as the CSV file.
  • AES-256 encryption must be used.
  • The compression method must be either 0x08 (deflate) or 0x00 (store).
  • The CSV file must use UTF-8 encoding and rows delimited by CRLF.

The CSV file must have:

  • A first row consisting of correctly named labels for each column/field.
  • Comma delimited fields in each row.
  • If commas are used in text fields within the CSV file, double-quote characters should be used for the text fields.
  • If double-quote characters are used in text fields within the CSV file, these should be represented by two double-quote characters.

How to upload payments

Step 1: Connect to your SFTP location using the SFTP credentials provided by your implementation team.

Step 2: Navigate to the Imports folder.

Step 3: Upload the Payments CSV file into the Imports folder.

Step 4: Create an empty file with the same name as the Payments CSV file with an additional appended “.ok” (e.g. PAYMENTUPLOAD-20240417030422.csv.ok). This will begin the import process into your channel.

Step 5: Check to see if the file was received by Enable once the file has finished processing. If the Payments CSV file is in the Succeeded folder, this indicates that the transaction data is now in the Enable platform. If the Payments CSV file is in the Failed folder, this indicates that the file has failed and a corresponding Error.txt file will be generated describing the error.

What’s next?

Need help resolving SFTP errors? Learn how to understand SFTP errors here.

Not useful
1
2
3
4
5
Very useful
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.

Still have questions?
Raise a ticket or contact our support team.