---
title: "Triumph REST API Configuration"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28410168/Triumph%20REST%20API%20Configuration"
format: markdown
---
# Overview

## Acquire's credit rules will be confined to the following: 

- Account balances for account customers that are stored within Frameworks are completely ignored
- If an account is over its credit limit, then the user will be warned. All counter staff are currently able to override this state and proceed with the sale.  See assumption below.
- If an account is on hold, then the sale cannot proceed at all.
- If the API cannot be called or returns an error, a warning will display indicating this, but the sale can proceed.
- If the account is a Cash Customer, then the API is not called and regular Cash Customer credit rules are followed. For cash accounts, the balances stored in Frameworks are solely adhered to

## Process Flows

> ⚠️ **NOTE**: The Triumph customer should be set to active and let the API determine the status during SOP/POS. If the account is on hold in Frameworks then it will not allow further checking.

The process flow of Triumph customers is as follows:

### 1. Customer within Credit Limit and not On Hold

1. Customer selected at the start of POS/SOP sale (Anywhere Frameworks does a credit check)
2. Transaction proceeds

### 2. Customer over Credit Limit and not On Hold

1. Customer selected at the start of POS/SOP sale (Anywhere Frameworks does a credit check)
2. Operator receives warning that the account is over the limit
3. Operator authorises the sale
4. Credit authorisation recorded in Frameworks

### 3. Customer within Credit Limit but On Hold

1. Customer selected at the start of POS/SOP sale (Anywhere Frameworks does a credit check)
2. The operator receives a message that the account is on hold, the sale cannot proceed

# Triumph REST API Configuration

> ⚠️ Please note that certificates will need to be installed on site by before the connection to the Triumph API will work.

## Access to the Triumph REST API Configuration

To add the **Triumph REST API Configuration **option to the **My Shortcuts** menu, perform the following:

1. Under the **My Shortcuts **section on the home dashboard click **Add.**
2. Close the **Select an activity to add to your shortcuts **window, and in the lookup field type **triumphConfigMain** and click **Finish**.
3. This will then add the **Triumph REST API Configuration **option to the list of your shortcuts.

## Configure and Activate the Triumph REST API

To activate the Triumph REST API, perform the following:

1. Click **Triumph REST API Configuration **from the **My Shortcuts **menu.
2. On the **Defaults **tab of the **Triumph REST API Configuration **screen, enter the required information from Triumph

> ℹ️ Enable **Triumph REST API Active **to activate the API

> ❌ DO NOT tick the **Cache the Session Key** checkbox as this is for experimentation only. Further information is required regarding the implementation of this.

![image](media://d2f7bb0f-06fc-485d-b02f-7375c2406c4b)

> ⚠️ Contact [Sterland Support](https://kb.myframeworks.com.au/page/support) for any assistance.

# User Configurations

> ⚠️ All Frameworks user logins will need to be made **Credit Managers**, for all counter staff to be able to override accounts that are over their limit.

To define a user as a **Credit Manager, navigate** to **System Administration > System Tables > User Maintenance, then** select the user, and under the <span style="color: #333333">**Accounts Receivable **</span><span style="color: #333333">section,</span> enable <span style="color: #333333">**Credit Manager.**</span>

> ✅ Refer to the **Accounts Receivable **section in the [User Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378032) User Manual for additional information

# Customer Configuration 

A Triumph REST API Customer can be identified as a customer as follows:

The customer is allocated to the customer group, which has been defined under **Miscellaneous Table Maintenance >** **System Settings - General > ExtCustGrp**

![image](media://0170b77c-4b3d-45a3-9c02-2fa3b540ae72)

> ✅ Refer to the [Customer Groups](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405190) User Manual for additional information on defining customer groups.

To link a customer on the Triumph site, Frameworks will use the **External Reference **value in [Customer Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894) and if this is not defined, then it will use the **Customer ID.**

> ✅ Refer to the **More Details **section in the [Customer Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894) User Maintenance for more information.