Process of Connecting Acumatica through RedTeam Flex
Note: The values in our connection screenshots are for reference only.
RedTeam Flex’s Apps Menu lists available API integrations, including Acumatica. The API connection requires details from Acumatica to complete the connection. Within Acumatica, certain steps will also need to be taken to enable the connection. This document will cover the information required to configure Acumatica’s settings, and collect the details needed to connect the integration.
Part 1: Connection Configuration
STEP ONE: Go to the URL of the Acumatica database and log in with the account credentials.
(MY-COMPANY substituted for the Acumatica database to be integrated)
User: ********
Pass: ********
STEP TWO: In the main menu on the left, we select the “Integration” Menu. If it doesn’t appear, click the More Menu or type “Integration into the search box at the top. When you’re in the Integration menu, click on the Preferences option and select “Connected Applications.”
STEP THREE: In the Client Name field, we give our app configuration a name. In this example we will enter “REDTEAM APP”. Then in the OAuth 2.0 flow field dropdown, we select the value “Authorization Code”.
We click the “ADD SHARED SECRET” next and a new pop-up window will open in which we will enter a “RedTeam secret” description. IMPORTANT NOTE: It will also show us a “value” field with a value string. We must save that shared secret value because it will only appear once and we will need to enter that value into RedTeam later.
Next we click the “REDIRECT URIS” tab and we will click the “+” icon. That will create a new field where we will enter the authentication URL used by RedTeam. That URL can be found on the Acumatica App card within RedTeam Flex (see screenshot below).
After adding the RedTeam URL to the Redirect URIS field, we click the save icon. This will generate the value of the "Client ID.” Save this client ID. We will need to enter this Client ID into RedTeam later.
STEP FOUR: We are going to create our Web Service Endpoint based on a Default Endpoint.
We next go to Web Service Endpoints. You can find it in the Integration menu, or by searching “web service endpoints” in the search bar.
Click to go into the Default Endpoint. IMPORTANT: Choose the Default Endpoint considering the version we will be using.
Click the EXTEND ENDPOINT button in the top row of buttons for the Default endpoint.
In the Endpoint Name field, give this RedTeam Flex entry a recognisable name without any spaces (spaces are disallowed by the data field’s formatting). Also, copy over the current “Base Endpoint Version” number and paste into the Endpoint Version field. Save these values because we will need to enter into RedTeam Flex later.
Click on OK.
Verify that the Corporate Card and Credit Terms entities exist; otherwise, we add them by following these steps:
a. For Corporate Card: Click on INSERT.
b. Fill the Entity Name in the Object Name textbox: CorporateCard.
c. In the Screen Name Field, search for “Corporate Cards” and choose the one with the Screen ID: CA.20.25.00, then click on Select and then on OK.
d. Search for the created entity CorporateCards and click on its name.
e. Click on the FIELDS tab and then on the Add (+) button.
f. Enter the Field Name: CorporateCardID, search for the value 'Credit Cards' in Mapped Object, and select it. Then, search for the corresponding value in Mapped Field and select the Field Type based on the following values:
g. Make sure to add all the fields shown in the screenshot below with the following Field Names / Mapped Object / Mapped Field / Field Type :
CorporateCardID | Credit Cards | Corporate Card ID | StringValue |
CorporateCardName | Credit Cards | Corporate Card ID > Name | StringValue |
CashAccount | Credit Cards | Corporate Card ID > Cash Account | StringValue |
CashNumber | Credit Cards | Corporate Card ID > Card Number | StringValue |
Status | Credit Cards | Active | BooleanValue |
h. Click on the VALIDATE ENTITY button in the Fields tab in the middle of the page, and then click the Save button in the top left under the endpoint name.
i. For Credit Terms: Click on INSERT under the Endpoint name (which should be the name of the RedTeam endpoint you’re setting up..
j. Fill the Entity Name in the Object Name textbox: CreditTerms.
k. Search for Credit Terms and choose the one with the Screen ID: CS.20.65.00 and Workspaces: Receivables and Payables, then click on Select and then on OK.
l. Search for the created entity and click on its name.
m. Click on the FIELDS tab and then on the Add (+) button.
n. Enter the Field Name TermsID, search for the value 'General Settings' in Mapped Object, and select it. Then, search for the corresponding value in Mapped Field and select the Field Type based on the following values:
o. Make sure to add all the fields shown in the screenshot below with the following Field Names / Mapped Object / Mapped Field / Field Type :
TermsID | General Settings | Terms ID | StringValue |
Description | General Settings | Description | StringValue |
DueDateType | Due Day Settings | Due Date Type | StringValue |
DueDay1 | Due Day Settings | Due Day 1 | StringValue |
DueDay2 | Due Day Settings | Due Day 2 | StringValue |
DiscountType | Cash Discount Settings | Discount Type | StringValue |
DiscountDay | Cash Discount Settings | Discount Day | StringValue |
DiscountPercent | Cash Discount Settings | Discount % | DecimalValue |
p. Click on the VALIDATE ENTITY button and Save button.
STEP FIVE: Return to RedTeam Flex’s Apps Menu, click the Acumatica app card and enter the previously collected details, then click the Connect button.
Click on the “Yes, Allow” button.
The connection is successful.
Part 2: Configuring Webhooks
Webhooks help us send and receive notifications when an event occurs (create, update, delete).
Webhooks are available from version 2021 R2 in Acumatica.
This is the list of files used next as Generic Inquiry uploads, and the addresses they will need for Push Notifications.
Generic Inquiry File | Push Notification Address |
RTS-WH-VENDORS | |
RTS-WH-CHECKS-PAYMENTS | |
RTS-WH-INVOICE-MEMOS | |
RTS-WH-PAYMENT-APPLICATION | |
RTS-WH-CORPORATE-CARD | |
RTS-WH-EMPLOYEES | |
RTS-WH-EXPENSE-RECEIPT | n/a (doesn’t use a push notification) |
You can find more information about Webhooks and Push Notifications at the following hyperlink: Information
STEP ONE: Vendor (RTS-WH-VENDORS).
Go to the Customization menu and select Generic Inquiry .
Click on the clipboard icon and select “Import from XML”.
Click on “Choose File”.
To import the Vendor Configuration, select the file RTS-WH-VENDORS.xml located in the Generic Inquiry folder.
Click on “Upload”.
After the import is completed, the following configuration will be displayed.
In the Acumatica Integration menu, we next go to Push Notifications.
We recommend naming the following field with the prefix RTS-WH-VENDORS. Enter the Destination Name and press Tab.
Choose “Webhook” for Destination Type:
Enter the Address: https://api.acumatica.flex.redteam.com/webhook?source=vendor
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
In 'Generic Inquiries' Tab, add a new record and search for the one imported in the previous step.
As an example, after completing the configuration, it will look like this:
STEP TWO: Vendor Payment (RTS-WH-CHECKS-PAYMENTS).
Go to the Customization menu and select Generic Inquiry .
Click on the clipboard icon and select “Import from XML”.
Click on “Choose File”.
To import the Vendor Payment Configuration, select the file RTS-WH-CHECKS-PAYMENTS.xml located in the Generic Inquiry folder.
Click on “Upload”.
After the import is completed, the following configuration will be displayed.
In the Acumatica Integration menu, we next go to Push Notifications.
We recommend naming the following field with the prefix RTS-WH-CHECKS-PAYMENTS. Enter the Destination Name and press Tab.
Choose “Webhook” for Destination Type:
Enter the Address:
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
In 'Generic Inquiries' Tab, add a new record and search for the one imported in the previous step.
As an example, after completing the configuration, it will look like this:
STEP THREE: Customer Billing (RTS-WH-INVOICE-MEMOS).
Configure Generic Inquiry and Push Notification like the previous objects.
Enter the Address:
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
STEP FOUR: Customer Payment (RTS-WH-PAYMENT-APPLICATION).
Configure Generic Inquiry and Push Notification like the previous objects.
Enter the Address:
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
STEP FIVE: Credit Card (RTS-WH-CORPORATE-CARD).
Configure Generic Inquiry and Push Notification like the previous objects.
Enter the Address:
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
STEP SIX: Employee (RTS-WH-EMPLOYEES).
Configure Generic Inquiry and Push Notification like the previous objects.
Enter the Address:
Enter the Header Name: It should have the value 'companyID'.
Enter the Header Value: This should be the ID of the company on the Acumatica App Card in the RedTeam Flex.
Example:
Part 3: Additional settings
STEP ONE: Disable Auto Numbering in Projects.
Go to the Configuration menu and select Segmented Keys.
In the Segmented Key ID, search for “Project”.
Uncheck the Auto Number checkbox in the column and save.
STEP TWO: Accounts Payable Preferences Configuration (Required).
Go to the Payables menu and select Accounts Payable Preferences.
In the General Tab, on Data Entry Settings, check “Require Single Project per Document” option.
STEP THREE: Vendor Invoice (Bills and Adjustments).
Go to the Finance menu and select Chart of Accounts.
Verify that the A.PAYABLE and V.RETAINAG accounts are created by default as they will be used when sending a vendor invoice from RedTeam Flex.
AP Account: A.PAYABLE
Retainage Payable Account: V.RETAINAG
Example of both accounts used in a vendor invoice (bill).
STEP FOUR: Expenses.
Go to the Finance menu and select Chart of Accounts.
Verify that the D.MATERIAL account is created by default as they will be used when sending a Employee Expense from RedTeam Flex.
STEP FIVE: Customer Billing (Invoices and Memos).
Go to the System Management menu and select Enable/Disable Features.
Click on Modify.
Verify that the 'Business Account Locations' checkbox is enabled, otherwise enable it. This preference is used to activate Retainage.
Click on Enable.
.
STEP SIX: Projects.
Go to the System Management menu and select Enable/Disable Features.
Click on Modify.
Verify that the 'Projects' checkbox is enabled, otherwise enable it. This preference is used to enable project creation in Acumatica (cost codes, etc).
Click on Enable.