--- title: "CreditWorks Integration (ITM) - Implementation Guide" canonical: "https://kb.myframeworks.com.au/space/FRAM/28400228/CreditWorks%20Integration%20(ITM)%20-%20Implementation%20Guide" format: markdown --- The CreditWorks integration enables a scheduled data extract of customer credit information from Frameworks. The integration generates two CSV files and uploads them to the CreditWorks SFTP server on a recurring schedule: - **Debtor Details file** contains a list of your debtors along with their contact and credit details. - **Aged Balance file** contains the most up-to-date financial information available for those debtors. Once configured, the integration runs automatically on a daily schedule, keeping CreditWorks synchronised with your Frameworks debtor data without manual intervention. The export includes both standard debtor accounts and shareholder accounts. > 📝 **Who performs this:** System Administrator. **Prerequisites:** > 📝 > 📝 - System Administrator access to **System Settings - General** and the **Export Customer Credit Info** scheduled task. > 📝 - Request SFTP details for the site by emailing [datamanager@creditworks.co.nz](mailto:datamanager@creditworks.co.nz) > 📝 - SFTP connection details provided by CreditWorks (hostname, username, password, port, host directory). > 📝 - For on-premise environments: access to the Frameworks server file system for creating upload and archive directories. Hosted environments have pre-configured directories. ## Implementation Sequence This guide walks you through the complete implementation in the correct order: 1. [Create Server Directories (On-Premise Only)](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28400228/CreditWorks+Integration+ITM+-+Implementation+Guide#Create-Server-Directories-(On-Premise-Only)) 2. [Configure SFTP Settings](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28400228/CreditWorks+Integration+ITM+-+Implementation+Guide#Configure-SFTP-Settings) 3. [Configure the Export Customer Credit Info Scheduled Task](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28400228/CreditWorks+Integration+ITM+-+Implementation+Guide#Configure-the-Export-Customer-Credit-Info-Scheduled-Task) --- ## Create Server Directories (On-Premise Only) Hosted Frameworks environments have pre-configured upload and archive directories for CreditWorks integration. No manual directory creation is required for hosted sites. Skip to the Configure SFTP Settings step if you are on a hosted environment. On-premise environments require manual directory creation on the Frameworks server before configuring the SFTP settings in Frameworks. ### Configuration Steps 1. Click the **Frameworks Menu** and navigate to **Utilities** > **File Upload** from the navigation tree to open the **File Upload** popup window. ![image-20260803-062019.png](media://4af65253-d2a5-429a-b00c-3ba4c9b7fa91) 2. Click **New Folder** to add the following folders: 1. Create an **out** folder for staging upload files (for example the directory will be, `/frameworks/dmp/customer/out/`). 2. Create an **Archive **folder for archiving uploaded files (for example the directory will be, `/frameworks/dmp/customer/archive/`). > ✅ Refer to [File Upload](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28404710/File+Upload#3.-Creating-a-New-Folder) for more information about creating folders in the /dmp/ directory. ### Result The upload and archive directories are ready for use by the CreditWorks SFTP upload process. The upload directory stores the generated CSV files before they are sent to CreditWorks. The archive directory retains copies of previously uploaded files for reference. > ⚠️ ### Important Notes > ⚠️ > ⚠️ - Record the full file paths for both directories. You will need these paths when configuring the SFTP directory path codes in the Configure SFTP Settings step. > ⚠️ - The suggested directory paths are recommendations. Your server environment may require different paths. Confirm the appropriate directory structure with your system administrator or [DMSi support](https://kb.myframeworks.com.au/page/support). --- ## Configure SFTP Settings The SFTP settings control how Frameworks connects to the CreditWorks SFTP server and where export files are stored locally. All settings are stored as CC_SFTP codes in **System Settings - General**. In hosted environments, the upload script path, upload source directory and archive directory are pre-configured and cannot be edited. In on-premise environments, all codes are editable and must be configured manually. ### Configuration Steps 1. Click the **Frameworks Menu** and navigate to **System Administration > System Setup > Configuration > System Settings - General**. 2. Enter **CC_SFTP** in the **Code** filter field to locate the CreditWorks SFTP codes. ![image-20260803-062403.png](media://c56ad651-c06c-4b46-8baa-77f706caede5) 3. Configure the following codes: **Connection settings (all environments):** | Code | Setting Purpose | Value | | --- | --- | --- | | **CC_SFTP_Site** | Customer Credit SFTP Site | Enter the SFTP hostname provided by CreditWorks (for example, `ftp.creditworks.co.nz`). | | **CC_SFTP_Host_DIR** | Customer Credit SFTP Host Directory | Enter the directory on the CreditWorks SFTP server where files are uploaded to (for example, `/`). | | **CC_SFTP_Port** | Customer Credit SFTP Port | Enter the SFTP port number (typically `22`). | | **CC_SFTP_UserName** | Customer Credit SFTP Username | Enter the SFTP username provided by CreditWorks. | | **CC_SFTP_UserPass** | Customer Credit SFTP User Password | Enter the SFTP password provided by CreditWorks. | **Pre-configured in hosted environments (on-premise only):** The following codes are pre-configured and uneditable in hosted environments. On-premise environments must configure these manually. | Code | Setting Purpose | Value | | --- | --- | --- | | **CC_SFTP_Script** | Customer Credit SFTP Upload Script | Enter the Frameworks server location of the upload script (for example, `/frameworks/tenants/feature/deploy/scripts/fw_sftp_upload.sh`). | | **CC_SFTP_Upload_DIR** | Customer Credit SFTP Upload Source Directory | Enter the Frameworks server file path for the upload staging directory (for example, `/frameworks/dmp/customer/out/`). | | **CC_SFTP_Archive_DIR** | Customer Credit SFTP Archive Directory | Enter the Frameworks server file path for the archive directory (for example, `/frameworks/dmp/customer/archive/`). | 4. Click **Save** to apply the settings. ### Result Frameworks stores the SFTP parameters required for the upload script to connect to the CreditWorks SFTP server and manage export files. The settings are not active until the Export Customer Credit Info scheduled task is configured and submitted. > ⚠️ ### Important Notes > ⚠️ > ⚠️ - All editable CC_SFTP codes must be configured before the scheduled task can successfully upload files. > ⚠️ - The SFTP credentials (username, password, hostname and port) are provided by CreditWorks during onboarding. Contact CreditWorks support if you do not have these details. > ⚠️ - For on-premise environments, the **CC_SFTP_Script** path must point to the `fw_sftp_upload.sh` script on the Frameworks server. Confirm this path with your system administrator or DMSi support if the default path does not apply to your environment. > ⚠️ - For on-premise environments, the **CC_SFTP_Upload_DIR** and **CC_SFTP_Archive_DIR** paths must match the directories created in the Create Server Directories step exactly, including trailing slashes. --- ## Configure the Export Customer Credit Info Scheduled Task The **Export Customer Credit Info** scheduled task generates the Debtor Details and Aged Balance CSV files for a specific company and uploads them to CreditWorks using the SFTP settings configured in the Configure SFTP Settings step. This task must be configured separately for each company that requires CreditWorks integration. ### Configuration Steps 1. Click the **Frameworks Menu** and navigate to **System Administration > Task Scheduler > Schedulable Tasks > Export Customer Credit Info**. 2. On the **Report Criteria** tab, configure the following: - **Company:** From the drop-down menu, select the company to export debtor data for. - **Company Code:** Enter the unique vendor code for the selected company as assigned by CreditWorks. 3. Click the **Schedule** tab. 4. Select the **Daily** option. 5. In the **Start** field, enter the start date and time for the first run, or use the date finder icon to select a date and time. 6. In the **Recur every** field, enter **1** to run the scheduled task every day at the specified time. 7. On the **Output** tab, select the notification preference: **Send a notification** or **Send an email** to receive confirmation when the task completes. 8. Click **Submit** to schedule the task. An information box confirms the task has been submitted. Click **OK** to acknowledge. ### Result The scheduled task runs daily at the configured time. Each run generates two CSV files (Debtor Details and Aged Balance) for the selected company, uploads them to the CreditWorks SFTP server and archives the files locally. Reports are available on the **Output** tab under the **Generated Reports** section for review after each run. > ⚠️ ### Important Notes > ⚠️ > ⚠️ - Repeat the configuration steps in the Configure the Export Customer Credit Info Scheduled Task section for each company that requires CreditWorks integration. Each company requires its own scheduled task instance with the correct **Company Code** assigned by CreditWorks. > ⚠️ - The recommended schedule is daily. Running the task daily ensures CreditWorks has current debtor and balance information. > ⚠️ - Review the generated reports after the first run to confirm the export completed successfully and the data is accurate. > ⚠️ - The following customers are excluded from the export: > ⚠️ - Customers with a Charge Account type. > ⚠️ - Customers linked to another account via the **Charge To Acct** field on the **More Data** tab in **Customer Maintenance**. > ⚠️ - Customers with a closed account. > ⚠️ - Customers with the **Exclude from Creditworks** flag enabled on the **Flags** tab in **Customer Maintenance**. > ⚠️ - Shareholder accounts are not excluded from the export. > ✅ ## Related Information > ✅ > ✅ - [Export Customer Credit Info](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256) - Scheduling and output options for the Export Customer Credit Info task. > ✅ - [Customer Dashboard](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28377802) - View customer credit and balance information. > ✅ - [Customer Maintenance - More Data](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894/Customer+Maintenance#More-Data) - **Charge To Acct** field used to link a customer to another account for billing. > ✅ - [Customer Maintenance - Flags](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894/Customer+Maintenance#Flags) - **Exclude from Creditworks** flag to exclude individual customers from the export. --- ## Additional Information The Export Customer Credit Info scheduled task generates two CSV files per run. The sections below describe the data fields included in each file. ### Debtor Details File The Debtor Details file contains customer identification, contact and credit information. CreditWorks uses this file to maintain an up-to-date record of your debtors. | Field | Description | | --- | --- | | Customer ID | The unique customer identifier from Frameworks. | | Customer Name | The customer's name as recorded in **Customer Maintenance**. | | Contact Name | The primary contact name for the customer. | | Billing Address | The customer's billing address, including postcode. | | Ship-To Address | The customer's delivery address, including postcode. | | Phone (Home) | The customer's home phone number. | | Phone (Mobile) | The customer's mobile phone number. | | Phone (Business) | The customer's business phone number. | | Fax | The customer's fax number. | | Email Address | The customer's email address. | | Company Number | The customer's ABN or company number. | | Credit Limit | The customer's credit limit value from **Customer Maintenance**. | | Stop Credit | Indicates whether the customer's credit is stopped. Set to true when the customer's credit status is not active. | | Bad Debts | Indicates whether the customer is flagged as a bad debt account. | | Sales Rep ID | The sales representative assigned to the customer. | ### Aged Balance File The Aged Balance file contains the customer's current financial position, broken down by aging period. CreditWorks uses this file to assess debtor risk and payment behaviour. | Field | Description | | --- | --- | | Customer ID | The unique customer identifier from Frameworks (matches the Debtor Details file). | | Balance Due | The total outstanding balance across all aging periods. | | Current | The balance for the current period (0-30 days). | | 30 Days | The balance aged 30 days. | | 60 Days | The balance aged 60 days. | | 90 Days | The balance aged 90 days. | | 120+ Days | The balance aged 120 days or older. | | Unallocated Cash | The total unallocated cash amount for the customer. |