Skip to main content

Configure the Yokoy connector in Business Central

In the Yokoy Integration Setup page in Business Central, you configure the how the integration with Yokoy behaves.

Yokoy Team avatar
Written by Yokoy Team
Updated over 8 months ago

In Business Central, you need to configure the settings for the Yokoy connector. The settings are divided into five sections: General, Authorization, Expenses, Invoices, and Paths.

🚧 Prerequisite

The user you use in Business Central must have the permission set PERMISSIONSET YKY to perform changes in this page. If you don’t have this role, go to Users and assign this permission set.

General settings

Field

Description

Base URL

Required. URL to access Yokoy’s API. It must not contain any spaces.

Token URL

Required. URL of Yokoy’s authorization server used to get the bearer token. It must not contain any spaces.

Yokoy Organization ID

Required. Yokoy ID of the organization. It must not contain any spaces.

Yokoy Legal Entity ID

Required. Yokoy ID of the company (legal entity). It must not contain any spaces.

If you have more than one tenant/company in Business Central, you must set up the integration for each tenant/company.

Local Currency

Currency of the legal entity. ISO 4217 three-letter code. It should correspond to the local currency (LCY).

VAT Business Posting Group Custom Field

Enter the Name of the custom field in the VAT/Tax rates form created for collecting the Business Posting Group. See Tax rate handling.

VAT Product Posting Group Custom Field

Enter the Name of the custom field in the VAT/Tax rates form created for collecting the Product Posting Group. See Tax rate handling.

Cost Object Dimension

Code (ERP) of the Yokoy tag dimension if you plan to sync a financial dimension as a cost object.

Authorization

Credentials used to access the Yokoy API. See Get access credentials for Yokoy API.

Field

Description

Client ID

Required. Public identifier used to identify the app when authenticating with the Yokoy authorization server.

Client Secret

Required. Secret known only to the application and the Yokoy authorization server. Used to generate the bearer token.

Expense settings

If you plan to implement Yokoy Expense, you need to determine the configuration of the Yokoy connector for processing expenses.

Field

Description

General Journal Template

Choose the journal template to be used for posting expenses.

General Journal Batch

Choose the journal batch to be used for posting expenses.

Gen. Journal Automatic Posting

Automatically post expenses imported from Yokoy to the corresponding general journal.

Import Incoming Documents

Choose which documents to store in Business Central.

You can choose:

  • No import

  • Import Receipts

  • Import Receipts & Attachments

Bear in mind, Business Central sets a limit of 350 MB for incoming documents. Storing receipts in Business Central contribute to your data storage capacity.

Invoice settings

If you plan to implement Yokoy Invoice, you need to determine the configuration of the Yokoy connector for processing invoices.

Field

Description

Automatic Posting

Select this checkbox if you want to automatically update Purchase Orders in Yokoy (for PO invoices) and/or create Purchase Invoices (for non-PO invoices) and post them as Posted Purchase Invoices in Business Central when an invoice is approved or submitted in Yokoy.

If you want to post invoices manually, do not select this checkbox.

Post with Status Approved

Determines that invoices should only be posted in Posted Purchase Invoices and in the Vendor Ledger when it has been approved in Yokoy. Otherwise, invoices are posted with a payment block until approval is received from Yokoy.

Default Location code

Set the default location code (warehouse) to be used for purchase orders.

A location code is required for posting a purchase invoice associated with a purchase order in Business Central. If the location code is not included on a purchase order, this default location is used.

Item Charge Tag Dimension

/ Item Charge Tag ID

If you plan to use item charges in purchase orders and invoices, you need to enter the Code (ERP) and the ID of the tag dimension for item charges you set up previously.

Fixed Assets Tag Dimension / Fixed Asset Tag ID

If you plan to use fixed assets in purchase orders and invoices, you need to enter the Code (ERP) and the ID of the tag dimension for fixed assets you set up previously.

Paths

In the Paths section, you specify the Yokoy API resource paths used to synchronize data between Business Central and Yokoy. It is important that these paths are specified correctly; otherwise, it will break data synchronization between the two systems.

🚧 Caution

You must paste these paths as is. Don‘t replace any of the placeholders in curly brackets. The integration automatically replaces these placeholders using the information in the General settings section.

General

Field

Description

Users Path

Yokoy API resource for managing users. It must not contain any spaces.

/v1/organizations/{organizationId}/users

Tags Path for legal entity

API resource for managing tags. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/tags

Cost Object Path for Legal Entity

API resource for managing cost objects. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/cost-centers

Tax Rate Path for Legal Entity

API resource for managing tax rates. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/tax-rates

Expense

Field

Expense paths

Expense Category Path for Legal Entity

API resource for managing expense categories. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/categories

Expense Attachment PDF Path

API resource for managing expense attachments. It must not contain any spaces.
/v1/organizations/{organizationId}/expenses/{expenseId}/attachments-base64/{attachmentName}

Expense Receipt Path

API resource for managing expense receipts. It must not contain any spaces.
/v1/organizations/{organizationId}/expenses/{expenseId}/receipt-base64

Invoice

Field

Invoice paths

Supplier Path for Organization

Yokoy API resource for managing organization suppliers. It must not contain any spaces.

/v1/organizations/{organizationId}/suppliers

Supplier Path for legal entity

API resource for managing legal entity suppliers. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/suppliers

Invoice Category Path for legal entity

API resource for managing legal entity invoice categories. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/invoice-categories

Purchase Order Path For Legal Entity

API resource for managing purchase orders. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/invoice-purchase-orders

Invoice Path for Legal Entity

API resource for managing invoices. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/invoices

Invoice PDF Path for Legal Entity

API resource for managing invoice attachments. It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/invoices/{invoiceId}/base64

Purchase Receipts Path for Legal Entity

API resource for managing purchase receipts (goods receipts). It must not contain any spaces.

/v1/organizations/{organizationId}/legal-entities/{legalEntityId}/invoice-goods-receipts

💡 Tip

Next: Set up the expense and invoice export settings in Yokoy depending on your edition: Cloud or On-premise.

Did this answer your question?