Debtor Accounts
This file is typically an extract from your CRM system, it consists of accounts that you would like Credit Clear to treat.
File type
- Delimited file format such as CSV
- Excel format (*.xlsx)
Standard fields
Column headers
Please note that the column headers in your file may differ and that is ok. For example, your file may have AmountDue instead of OutstandingAmount, this is perfectly fine. We can map the fields to the standard fields below as long as they represent the same thing.
| Name | Description | Required |
|---|---|---|
| ClientReference | The unique reference for this account. This field is used to link the account in Credit Clear and your CRM system for the exchange of data. | Yes |
| Brand | This field can be used to segment the data into different Credit Clear portals or into different campaigns | No |
| Portfolio | This field can be used to segment the data into different Credit Clear portals or into different campaigns | No |
| Status | The status of the account. This determines how Credit Clear will treat the account in the platform. It has to be one of the following values: Active: This means the account is eligible for appropriate treatment on the platform and the customer can view the link and interact with the portal. Hold: Some activities of the platform will be paused for this customer (eg: communications and payment plans). Closed: No activity can be performed by the customer on the platform and this account will not be treated in any campaign by Credit Clear. | No. The default value "Active" is assumed. |
| InvoiceNumber | This is the invoice or account number that your customer recognizes. This is usually the same as ClientReference above. Only required if it is different. | Yes |
| Reference | Additional reference number that can be included in the communications to your customers. Only required if it is different to InvoiceNumber or ClientReference | No |
| PaymentReconciliationReference | This reference number is what Credit Clear will use to process the transaction through the payment gateway. If not supplied, ClientReference will be used. | No |
| BPayReference | The BPay reference number that the customer can use if paying through BPay | No |
| DueDate | Invoice or account due date. Any standard ISO date format will work. | Yes |
| OutstandingAmount | Decimal value rounded to 2 places | Yes |
| MaxDiscountPercentage | This is an override to any Discount Plans that are offered as part of a campaign to customers. The customer will be offered the minimum of a discount plan or MaxDiscountPercentage. Rounded to 2 decimal places | No |
| DaysPastDue | No | |
| FloorPrice | Only applicable if utilizing the "Make an offer" feature. If the customer offers to pay less than this, then FloorPrice will be offered back to the customer to settle the account. Rounded to 2 decimal places | No |
| CompanyName | Only applicable if the customer is a business. Only required if FirstName, LastName and FullName are not available. | No |
| FirstName | First name of the customer | No |
| LastName | Last name of the customer | No |
| FullName | Only required if FirstName, LastName and CompanyName are not available separately above. | No |
| MobilePhone | Either MobilePhone or EmailAddress is mandatory.Format: 04xxxxxxxx or 614xxxxxxxx | No |
| EmailAddress | Either MobilePhone or EmailAddress is mandatory | No |
| CommunicationPreference | This field specifies the customer’s communication preference, also referred to as the preferred method of contact. It’s important to note that the system may still use other provided methods for communication. The supported values are: Mobile | No |
| CallbackPhoneNumber | When provided, this will be shown to the customer if they want to call and discuss their account. This is only applicable if you have a different phone number for different cohorts of customers. If there is a single phone number for your company for all customers to call, then this is not required. | No |
| CurrencyCode | The default is AUD. Only applicable if your payment gateway is configured to support multiple currencies and your customers reside in those currency locations | No |
| StreetNumber | Customer's address street number | No |
| StreetName | Customer's address street name | No |
| CityOrSuburb | Customer's address City | No |
| State | This is important for regulatory reasons and allows us to stop communications when certain States have their public holidays. | No |
| PostalCode | This is important for regulatory reasons and allows us to stop communications when certain postcodes are affected by natural disasters or special events. | No |
| Country | No | |
| FullAddress | Only applicable if the above address fields are not available separately. | No |
| SendInstantMessages | This field enables you to send instant messages to customers using pre-configured message templates. These templates can be set up in the client portal. The supported instant message types are: Sms The value must be a string that includes the desired instant message types, separated by your chosen delimiter. For instance, to send both SMS and Email messages, the value should be formatted as Sms:Email, with the colon serving as the separator | No |
Non-standard fields
Apart from the fields above, if there is data in your file that you feel is relevant for collections and campaigns, then please include them in your upload. The Credit Clear system can map all non-standard fields from your file and lets you use them in workflows and campaigns for the best results.
Please let your digital solutions consultant know of non-standard fields so we can map them appropriately in the Credit Clear platform.
Updated 23 days ago