Customizing the Sync configuration flow

🚧

This section includes instructions on how to update the text values in the Sync Flow and change visibility of feature categories (accounts).

If you're looking to disable a feature (e.g., Fees), contact your Account Manager.

The Sync configuration flow is a white-labelled solution that can be tailored to fit the needs of your clients.

To create a branded experience, you can:

  • Set up your company name, logo, and icon via the branding settings in the Portal.
  • Update the text fields of the flow
    Updating the text fields helps ensure that your users clearly understand what they are sharing via the Sync for Commerce flow and which accounts they should choose to ensure it works correctly.

Updating the text

You can customize every bit of text in the Sync configuration flow.

  1. Main title
Main title section of the Sync configuration flowMain title section of the Sync configuration flow
  1. Checkbox captions
Checkbox section section of the Sync configuration flowCheckbox section section of the Sync configuration flow
  1. Text on the Previous and Next buttons
Move buttons section of the Sync configuration flowMove buttons section of the Sync configuration flow
  1. Feature title, feature description, and required field indicator description (Sales, Fees, Payments)
Feature text section of the Sync configuration flowFeature text section of the Sync configuration flow
  1. Feature categories title, feature categories title description, and feature categories (Sales, Fees, Payments)
Feature categories text section of the Sync configuration flowFeature categories text section of the Sync configuration flow

Keep in mind that this update will only affect the UI.

To get a complete list of all the customizable text fields and their values perform the following request:

GET sync/commerce/config/ui/text

To update, remove or reset a text value, use the following request:

PATCH sync/commerce/config/ui/text

Request body:

// Update the text value to the specified string
{
   "data-textkey": "A new value"
}

// Display an empty string
{
   "data-textkey": ""
}

// Use the default value
{
   "data-textkey": null
}

In the request above, the data-textkey is the key of the field that you want to configure.

You can find the data-textkey values in the tables below.

🚧

Update the text fields consistently

We recommend grouping your updates to ensure that related values are updated consistently. A feature name (e.g., Sales) appears as a check box item in the left pane (Set up sales) and as the main title on the right side of the window (Sales), so it is important to update both configure-setupSidebar-checkboxes-sales and configure-content-sales-title.

Default text and text keys

Main title
Default valuedata-textkey value
Set up Sync to {platform name}configure-setupSidebar-title
Checkbox captions
Default valuedata-textkey value
Connect to {Commerce platform name}configure-setupSidebar-checkboxes-connectToCommerce
Connect to {Accounting platform name}configure-setupSidebar-checkboxes-connectToAccounting
Set up salesconfigure-setupSidebar-checkboxes-sales
Set up feesconfigure-setupSidebar-checkboxes-fees
Set up paymentsconfigure-setupSidebar-checkboxes-payments
Set up sync scheduleconfigure-setupSidebar=checkboxes-syncSchedule
Buttons
Default valuedata-textkey value
Previousconfigure-misc-previousButton
Nextconfigure-misc-nextButton
Required field indicator description
Default valuedata-textkey value
Indicates a required fieldconfigure-required-indicator
Sales title and description

Default value

data-textkey value

Sales

configure-content-sales-title

Sales title description:
no value by default.

configure-content-sales-description

Sales feature categories title and description

Default value

data-textkey value

Accounts

configure-content-sales-accounts-title

Configure accounts mapping from
{commerce platform name} to
{accounting platform name}.

configure-content-sales-accounts-description

Tax rates

configure-content-sales-taxRates-title

Configure tax rates mapping from
{commerce platform name} to
{accounting platform name}.

configure-content-sales-taxRates-description

Other

configure-content-sales-other-title

Other title description: no value by default.

configure-content-sales-other-description

Sales feature categories
Default valuedata-textkey value
Salesconfigure-content-sales-accounts-entries-sales
Refundsconfigure-content-sales-accounts-entries-refund
Gratuityconfigure-content-sales-accounts-entries-gratuity
Prepaidconfigure-content-sales-accounts-entries-prepaid
0% tax rateconfigure-content-sales-accounts-taxRates-entries-0
5% tax rateconfigure-content-sales-accounts-taxRates-entries-10
10% tax rateconfigure-content-sales-accounts-taxRates-entries-15
20% tax rateconfigure-content-sales-accounts-taxRates-entries-20
Invoice statusconfigure-content-sales-other-entries-invoiceStatus
Grouping periodconfigure-content-sales-other-entries-groupingPeriod
Fees title and description

Default value

data-textkey value

Fees

configure-content-fees-title

Fees title description:
no value by default.

configure-content-fees-description

Fees feature categories title and description

Default value

data-textkey value

Accounts

configure-content-fees-accounts-title

Configure accounts mapping from
{commerce platform name} to
{accounting platform name}.

configure-content-fees-accounts-description

Fees feature categories
Default valuedata-textkey value
Payment feeconfigure-content-fees-accounts-entries-paymentFee
Payment fee refundconfigure-content-fees-accounts-entries-paymentFeeRefund
Loanconfigure-content-fees-accounts-entries-loan
Loan paymentconfigure-content-fees-accounts-entries-loanPayment
Loan feeconfigure-content-fees-accounts-entries-loanFee
Cashbackconfigure-content-fees-accounts-entries-cashback
Payments title and description

Default value

data-textkey value

Payments

configure-content-payments-title

Payments title description:
no value by default.

configure-content-payments-description

Payments feature categories
Default valuedata-textkey value
Cardconfigure-content-payments-accounts-entries-card
Cashconfigure-content-payments-accounts-entries-cash
Invoiceconfigure-content-payments-accounts-entries-invoice
Online cardconfigure-content-payments-accounts-entries-onlineCard
Payoutconfigure-content-payments-accounts-entries-payout
Customconfigure-content-payments-accounts-entries-custom
Store creditconfigure-content-payments-accounts-entries-storeCredit
Paypalconfigure-content-payments-accounts-entries-paypal
Paypal qrconfigure-content-payments-accounts-entries-paypalQr
Mobileconfigure-content-payments-accounts-entries-mobile
Vippsconfigure-content-payments-accounts-entries-vipps
Swishconfigure-content-payments-accounts-entries-swish
Prepaid pymentconfigure-content-payments-accounts-entries-prepaidPayment
Manualconfigure-content-payments-accounts-entries-manual

How to change the visibility of feature categories (accounts)

To update the visibility of feature categories for a commerce platform, perform the following request:

POST sync/commerce/config/ui/accounts/platform/{commerceKey}

//Request body:
//To update the visible feature categories to the ones provided in the request body:
{
    "visibleAccounts": [
         "account-key-1",
         "account-key-2"
    ]
}

//To revert to the default settings and show all feature categories:
{}

//To show only the fields that are required:
{
  "visibleAccounts": []
}

In the request above, the commerceKey is the Codat platform key of the selected commerce platform. You can find a list of keys for the supported platforms in the Accounting platform selection section.
To find the account-key, consult the tables below. Note that fields marked with an '*' cannot be removed.

Sales feature categories

Default valueaccount-key
Sales*sales-accounts-sales
Refund*sales-accounts-refund
Gratuitysales-accounts-gratuity
Prepaidsales-accounts-prepaid
0% tax rate*sales-taxRates-0
5% tax rate*sales-taxRates-5
10% tax rate*sales-taxRates-10
20% tax rate*sales-taxRates-20
Invoice status*sales-other-invoiceStatus
Grouping period*sales-other-groupingPeriod

Fees feature categories

Default valueaccount-key
Payment feefees-accounts-paymentFee
Payment fee refundfees-accounts-paymentFeeRefund
Loanfees-accounts-loan
Loan paymentfees-accounts-loanPayment
Loan feefees-accounts-loanFee
Cashbackfees-accounts-cashback

Payments feature categories

Default valueaccount-key
Card*payments-accounts-card
Cashpayments-accounts-cash
Invoicepayments-accounts-invoice
Online cardpayments-accounts-onlineCard
Payoutpayments-accounts-payout
Custompayments-accounts-custom
Store creditpayments-accounts-storeCredit
Paypalpayments-accounts-paypal
Paypal qrpayments-accounts-paypalQr
Mobilepayments-accounts-mobile
Vippspayments-accounts-vipps
Swishpayments-accounts-swish
Prepaid paymentpayments-accounts-prepaidPayment
Manualpayments-accounts-manual