Claimlane Integration Documentation

Everything you need to get started and make the most of our app.

Setting up Claimlane

Before you can start using Claimlane Integration, you need to have a Claimlane account. If you don't have one yet, you can sign up for an account at claimlane.com.

Once you have your Claimlane account, you'll need to generate an API key to connect your account to Business Central. You can request one through your Claimlane contact. Your contact can also help you set up Claimlane so the integration works properly.

Internal and Flow tags are used to map data between Business Central and Claimlane. A rule for most of these tags in Claimlane is, that the Technical Label is what is the link between Claimlane and BC. For B2B, you create the tags this way:

  1. In Claimlane, click the icon with the 4 squares to the top right and select "Data Management".
  2. Click the three dots next to the data source you wish to edit and click "Configure".
  3. Click the "General Tags" button in the menu.
  4. Create a flow tag called "Invoice Number" of type "Input". Flow tags are filled in by the end-user. This tag is what is used to find the invoice in BC in order to find correct price, apply entries and more. Click the "Missing translation" link to the right of the name and fill in the technical label with the value "invoice-number". Note: the technical label must have this value.
  5. Go to internal tags and create the following tag:
    • Claim Reason (Required) - type "Single select" - technical label can be whatever you want here. But write it down, you will need it in the BC setup. Click on "Manage options" and add the return reason codes you want to use. Remember to add technical labels: in this case, they need to be the same as the return reason code in BC.Claim Reason
    • Return Reason (Required) - type "Single select" - technical label can be whatever you want, but it must be the same as the one used in Claim Reason. Remember to add technical labels for options.
    • Price Reduction (optional) - type "Single select". Used for doing price reductions, e.g., if you want to be able to give customers a price reduction of the original invoiced price. When adding options, the technical labels must be numbers only.
    • Unit Price (optional) - type "Input". Used for crediting a certain price on the credit memo. This is unit price, not amount.
  6. To enable the tags, you must go to the corresponding Request type rule and click the checkmark in "Enable".

Above tags are for B2B returns and claims. To setup tags for B2C, go to "Manage Company" - "Data Sources", click the 3 dots next to the data source you wish to edit and click "Configure". Click the "General Tags" button in the menu. Create the tags that you need to use. Only claim and return reasons are relevant for this integration.

Product data is used to map products between Business Central and Claimlane. To create a product data blueprint:

  1. In Claimlane, click the icon with the 4 squares to the top right and select "Data Management".
  2. Click the three dots next to the data source you wish to edit and click "Configure".
  3. Click the "Product Data" button in the menu, click on "Product upload" and then on "Data blueprint"
  4. Create a product data blueprint by adding the fields you want to use for mapping products. You can add fields such as "Item", "Color", "Size". An example could be Data Blueprint
  5. The data blueprint is what the user see in the frontend - how they choose which item to return or claim. In Business Central, one field can be a combination of multiple fields from different tables. You can read more below.

Installation

Follow these steps to install Claimlane Integration in Microsoft Dynamics 365 Business Central.

In Business Central, search for Extension Marketplace. Once Marketplace has opened, search for "Claimlane Integration" and follow the on-screen setup guide.

You can also install the extension directly from the Microsoft AppSource.

Configuration

Customize Claimlane Integration to match your business processes and requirements.

We recommend that you use the Assisted Setup wizard to configure Claimlane Integration in less than 10 minutes. To access the wizard, go to Assisted Setup in Business Central and follow the steps. See below for setup field definitions.

General Setup

Claimlane API Key
Your Claimlane API key is required to connect your Claimlane account to Business Central. You can find your API key in your Claimlane account settings or request one through your Claimlane contact.

Company Identifier
The identifier for the company. You can use this to differentiate your tickets between multiple companies, if you do not have a Claimlane instance per company. It is recommended to have one Claimlane instance per company, and therefore separate API keys.

Debug Mode
If set to Yes, the requests and response objects will be saved in the Claimlane Commucation Log. This is useful for debugging purposes.

Create Whse. Documents
If set to Yes, the system will create warehouse documents for return orders, if location requires receipt.

Item Sync Setup

Enable Item Sync
Enables synchronization of items between BC and Claimlane.

Max Product Request Size
The maximum size of product data that can be uploaded to Claimlane per request. This is used to split up large product data sets into multiple requests.

Full Override Next Item Upload
If set to Yes, the system will override all item data in Claimlane in next item synchronization, deletinng all items first. Use this if you want a "clean slate" in Claimlane.

Brand Table No.
If multiple brands are used, this field defines which table is used to map brands to Claimlane.

Brand Item Field No.
If multiple brands are used, choose what field defines the brand on the item table. The field must be related to the table selected in "Brand Table No.". If you only have one brand, you can leave this field empty.

Customer Sync Setup

Enable Customer Sync
Enables synchronization of customers between BC and Claimlane.

Max Invite Request Size
The maximum size of customer invite data that can be uploaded to Claimlane per request. This is used to split up large invite data sets into multiple requests.

B2B Email Field
Select what field on the customer the email address should be copied from when creating Claimlane Retailers. The value can be changed in the Claimlane Retailer list.

Enable Invoice Sync
Enables synchronization of invoices between BC and Claimlane Data Sources.

Use Base Unit
If set to Yes, the system will use the base unit of measure for the item when syncing invoices. If set to No, the system will use the unit of measure on the invoice line.

Max Invoice Request Size
The maximum size of invoice data that can be uploaded to Claimlane per request. This is used to split up large invoice data sets into multiple requests.

Assisted Setup

Enable Item Sync
Enables synchronization of items between BC and Claimlane. See Item Sync Setup for more details.

Enable Customer Sync
Enables synchronization of customers between BC and Claimlane.

B2B Order Missing Action
Defines what should be done if no related invoice can be found in the system.

Find Customer by Name
If set to true, system will attempt to find a customer by name if no customer number is found in data from Claimlane.

B2B Price Application
Defines what should be done if no price can be found from the matching invoice.
First: Uses unit price from the first found invoice line on the customer. Latest: Uses unit price from the latest invoice line.

Invoice No. Tag Label
Defines which tag to use to find item price based on Invoice No. If not set or not filled, the system will fallback to order no. logic.

B2C Setup

Events

There are numerous events throughout the application to help your BC partner customize the extension if needed.

          [EventSubscriber(ObjectType::Codeunit, Codeunit::"TTU Document Handler", 'OnAfterModifyB2BSalesLine', '', false, false)] local procedure OnAfterModifyB2BSalesLineNew(var SalesLine: Record "Sales Line"; var LineNo: Integer) var K3PFSalesDocMgt: Codeunit "K3PF Sales Document Mgt."; SalesLine2: Record "Sales Line"; begin Clear(K3PFSalesDocMgt); SalesLine2 := SalesLine; K3PFSalesDocMgt.AssignToMatrixLine(SalesLine2); LineNo += 10000; end;
        

FAQs

Yes, the app is extendable through Event Publishers and Event Subscribers. Use event subscribers in your app to extend functionality. See the Events section for more info.

You can edit the tags at any time by logging into Claimlane and going to the Data Management section. Internal and flow tags are customizable. Make sure that technical labels match the labels in BC for proper integration.

``` This code includes all the original content, formatting, and improvements such as collapsible sections, search functionality, a sticky table of contents, and more. You can copy and paste this directly into your project. Let me know if you'd like any further adjustments!