Name | Value |
---|---|
Platform | Sage 50 UK |
Auth Type | API Keys |
Direction | Bidirectional |
Tap Metrics | Usage: |
Target Metrics | Usage: |
Use the guide below to guide your users on how to configure the Sage 50 connector.
Before installing the connector locally, you will need to gather your credentials:
SageLine50v29
, where 29
is your version of Sage. To confirm your DSN is present and accessible:
ODBC
and Select ODBC Data Sources (64-bit)
System DSN
. You should see a DSN starting with SageLine50
that matches your version. This is the proper DSN name to configure your connector.accdata
. You can find your company file path from inside Sage:
Help
> About
on the top bar.Data Directory
file path. Click that link.accdata
folder.accdata
. You can then select the ribbon at the top, and copy-paste your company file path. It should look something like the below:Once you have these credentials, provide them to support. In return, you will get the connector file, which is an exe
windows program that you will run, and a connector password.
Now you have all you need to run the connector.
.exe
file. This will automatically register the connector as a service and kick off the setup process.That’s it! Your connector is now running and ready to sync your Sage data.
The Sage 50 connector supports writing of several objects out of the box. The expected payloads and mappings are documented below.
In addition to the fields listed below, all objects support the optional externalid
field.
This is used to associate the created record in Sage with your own id. This field is not mapped to Sage 50, and only persists within hotglue.
Payload file: products.json
Field | Description |
---|---|
stock_code | Unique product stock code |
description | Product description |
nominal_code | Nominal code |
unit_of_sale | Unit of sale (e.g. Each ) |
Sample payload
Payload file: vendors.json
Field | Description |
---|---|
account_ref | The unique account ref for this vendor, will be used for referencing this vendor in transactions. Limited to 8 characters. |
name | Name of the vendor |
address_1 | Address line 1 |
address_2 | Address line 2 |
address_3 | Address line 3 |
address_4 | Address line 4 |
address_5 | Address line 5 |
contact_name | Vendor contact name |
telephone | Telephone Number |
fax | Fax Number |
analysis_1 | |
analysis_2 | |
analysis_3 | |
terms | |
def_nom_code | Default nominal code for transactions |
vat_reg_number | Vendor VAT number |
country_code | Country code |
currency | Currency code for this vendor (e.g. GBP ) |
Sample payload
Payload file: customers.json
Field | Description |
---|---|
account_ref | The unique account ref for this customer, will be used for referencing this customer in transactions. Limited to 8 characters. |
name | Name of the customer |
address_1 | Address line 1 |
address_2 | Address line 2 |
address_3 | Address line 3 |
address_4 | Address line 4 |
address_5 | Address line 5 |
contact_name | Customer contact name |
telephone | Telephone Number |
fax | Fax Number |
analysis_1 | |
analysis_2 | |
analysis_3 | |
terms | |
def_nom_code | Default nominal code for transactions |
vat_reg_number | Customer VAT number |
country_code | Country code |
currency | Currency code for this customer (e.g. GBP ) |
Sample payload
Payload file: vendorinvoices.json
Field | Description |
---|---|
account_ref | Account ref of the vendor associated with this invoice |
date | Date of invoice |
posted_date | Posted date of invoice |
date_due | Due date of invoice |
inv_ref | Invoice ref number |
tax_amount | Tax amount |
discount | Discount amount |
discount_nominal_code | Discount nominal code |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Payload file: customerinvoices.json
Field | Description |
---|---|
account_ref | Account ref of the customer associated with this invoice |
date | Date of invoice |
posted_date | Posted date of invoice |
date_due | Due date of invoice |
inv_ref | Invoice ref number |
tax_amount | Tax amount |
discount | Discount amount |
discount_nominal_code | Discount nominal code |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Payload file: customernotes.json
Field | Description |
---|---|
account_ref | Account ref of the customer associated with this credit note |
date | Date of credit note |
posted_date | Posted date of credit note |
inv_ref | Credit note ref number |
tax_amount | Tax amount |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Supported objects for read
AUDIT_HEADER
AUDIT_JOURNAL
AUDIT_SPLIT
AUDIT_USAGE
AUDIT_VAT
AUDIT_HISTORY_HEADER
AUDIT_HISTORY_JOURNAL
AUDIT_HISTORY_SPLIT
AUDIT_HISTORY_USAGE
CLEAR_AUDIT_TRAIL_EVENT
CLEARED_TRAN_RANGE
DELETED_RECORDS
DISPUTE_REASON
BANK
BANK_STATEMENT
BANK_STATEMENT_LINE
RECURRING
REMITTANCE
CALENDAR_EVENT
CALENDAR_EVENT_LABEL
CALENDAR_EVENT_LOCATION
CALENDAR_EVENT_RECURRENCE_PATTERN
CATEGORY
CAT_TITLE
FUND
FUND_TYPE
SOFA_CATEGORY
CIS_RETURN
CIS_RETURN_TRANSACTION
CIS_SETTINGS
CIS_SUBCONTRACTOR
CIS_SUBCONTRACTOR_LEGACY
CIS_SUBCONTRACTOR_RETURN
CIS_SUBCONTRACTOR_TAX_HISTORY
COMPANY
COMPANY_DEL_ADDR
CONTACT_HISTORY
CONTACT_HISTORY_MAJOR_TYPE
CONTACT_HISTORY_CONTACT_OUTCOME
CONTACT_HISTORY_CONTACT_TYPE
ECSALES_FILL
ECSALES_HEADER
ECSALES_SPLIT
EC_VAT_DESCRIPTION
INTRASTAT
INVOICE
INVOICE_ITEM
UPDATE_LEDGER
ACCOUNT_STATUS
COMMUNICATION_ADDRESS
COUNTRY_CODE
CURRENCY
DEPARTMENT
LETTER_TYPE
PRICE
PRICE_LIST
TAX_CODE
ACCRUAL
CHART_LIST
FINANCIAL_BUDGET
FIXED_ASSET
FIXED_ASSET_CAT
NOMINAL_LEDGER
PERIOD
PREPAYMENT
PAYMENT_INFO
PAYMENT_METHOD
PROTX_PAYMENT
SUPPLIER_PAYMENT_INFO
PROJECT
PROJECT_BUDGET
PROJECT_COST_CODE
PROJECT_COST_TYPE
PROJECT_ONLY_TRAN
PROJECT_RELATIONSHIP
PROJECT_RESOURCE
PROJECT_RESOURCE_TYPE
PROJECT_REVENUE_CODE
PROJECT_STATUS
PROJECT_TRAN
GRN_ITEM
PURCHASE_DEL_ADDR
PURCHASE_LEDGER
PURCHASE_ORDER
POP_ITEM
SUPPLIER_PAYMENT_INFO
CREDIT_BUREAU
DIRECT_DEBIT_PAYMENT_REQUESTS
GDN_ITEM
PAYMENT_INFO
SAGEPAY_PAY_BY_LINK
SALES_DEL_ADDR
SALES_LEDGER
SALES_ORDER
SOP_ITEM
STOCK
STOCK_ALLOCATION
STOCK_CAT
STOCK_COMP
STOCK_TRAN
ESUBMISSION_SETTINGS
RTD_SUMMARY
VAT_ADJUSTMENT
VAT_DETAILS
VAT_REV_CHARGE_DETAIL
VAT_REV_CHARGE_HEADER
VAT_REV_CHARGE_RETURN
VAT_SUMMARY
VAT_RETURN
VAT_RETURN_RECEIPT
Name | Value |
---|---|
Platform | Sage 50 UK |
Auth Type | API Keys |
Direction | Bidirectional |
Tap Metrics | Usage: |
Target Metrics | Usage: |
Use the guide below to guide your users on how to configure the Sage 50 connector.
Before installing the connector locally, you will need to gather your credentials:
SageLine50v29
, where 29
is your version of Sage. To confirm your DSN is present and accessible:
ODBC
and Select ODBC Data Sources (64-bit)
System DSN
. You should see a DSN starting with SageLine50
that matches your version. This is the proper DSN name to configure your connector.accdata
. You can find your company file path from inside Sage:
Help
> About
on the top bar.Data Directory
file path. Click that link.accdata
folder.accdata
. You can then select the ribbon at the top, and copy-paste your company file path. It should look something like the below:Once you have these credentials, provide them to support. In return, you will get the connector file, which is an exe
windows program that you will run, and a connector password.
Now you have all you need to run the connector.
.exe
file. This will automatically register the connector as a service and kick off the setup process.That’s it! Your connector is now running and ready to sync your Sage data.
The Sage 50 connector supports writing of several objects out of the box. The expected payloads and mappings are documented below.
In addition to the fields listed below, all objects support the optional externalid
field.
This is used to associate the created record in Sage with your own id. This field is not mapped to Sage 50, and only persists within hotglue.
Payload file: products.json
Field | Description |
---|---|
stock_code | Unique product stock code |
description | Product description |
nominal_code | Nominal code |
unit_of_sale | Unit of sale (e.g. Each ) |
Sample payload
Payload file: vendors.json
Field | Description |
---|---|
account_ref | The unique account ref for this vendor, will be used for referencing this vendor in transactions. Limited to 8 characters. |
name | Name of the vendor |
address_1 | Address line 1 |
address_2 | Address line 2 |
address_3 | Address line 3 |
address_4 | Address line 4 |
address_5 | Address line 5 |
contact_name | Vendor contact name |
telephone | Telephone Number |
fax | Fax Number |
analysis_1 | |
analysis_2 | |
analysis_3 | |
terms | |
def_nom_code | Default nominal code for transactions |
vat_reg_number | Vendor VAT number |
country_code | Country code |
currency | Currency code for this vendor (e.g. GBP ) |
Sample payload
Payload file: customers.json
Field | Description |
---|---|
account_ref | The unique account ref for this customer, will be used for referencing this customer in transactions. Limited to 8 characters. |
name | Name of the customer |
address_1 | Address line 1 |
address_2 | Address line 2 |
address_3 | Address line 3 |
address_4 | Address line 4 |
address_5 | Address line 5 |
contact_name | Customer contact name |
telephone | Telephone Number |
fax | Fax Number |
analysis_1 | |
analysis_2 | |
analysis_3 | |
terms | |
def_nom_code | Default nominal code for transactions |
vat_reg_number | Customer VAT number |
country_code | Country code |
currency | Currency code for this customer (e.g. GBP ) |
Sample payload
Payload file: vendorinvoices.json
Field | Description |
---|---|
account_ref | Account ref of the vendor associated with this invoice |
date | Date of invoice |
posted_date | Posted date of invoice |
date_due | Due date of invoice |
inv_ref | Invoice ref number |
tax_amount | Tax amount |
discount | Discount amount |
discount_nominal_code | Discount nominal code |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Payload file: customerinvoices.json
Field | Description |
---|---|
account_ref | Account ref of the customer associated with this invoice |
date | Date of invoice |
posted_date | Posted date of invoice |
date_due | Due date of invoice |
inv_ref | Invoice ref number |
tax_amount | Tax amount |
discount | Discount amount |
discount_nominal_code | Discount nominal code |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Payload file: customernotes.json
Field | Description |
---|---|
account_ref | Account ref of the customer associated with this credit note |
date | Date of credit note |
posted_date | Posted date of credit note |
inv_ref | Credit note ref number |
tax_amount | Tax amount |
items | Array of line items (see below for line item fields) |
items.nominal_code | Nominal code |
items.tax_code | Tax code |
items.net_amount | Net amount |
items.tax_amount | Tax amount |
items.details | Description of line item |
items.project_id | Project ID |
items.department_id | Department ID |
items.cost_code | Cost Code |
Sample payload
Supported objects for read
AUDIT_HEADER
AUDIT_JOURNAL
AUDIT_SPLIT
AUDIT_USAGE
AUDIT_VAT
AUDIT_HISTORY_HEADER
AUDIT_HISTORY_JOURNAL
AUDIT_HISTORY_SPLIT
AUDIT_HISTORY_USAGE
CLEAR_AUDIT_TRAIL_EVENT
CLEARED_TRAN_RANGE
DELETED_RECORDS
DISPUTE_REASON
BANK
BANK_STATEMENT
BANK_STATEMENT_LINE
RECURRING
REMITTANCE
CALENDAR_EVENT
CALENDAR_EVENT_LABEL
CALENDAR_EVENT_LOCATION
CALENDAR_EVENT_RECURRENCE_PATTERN
CATEGORY
CAT_TITLE
FUND
FUND_TYPE
SOFA_CATEGORY
CIS_RETURN
CIS_RETURN_TRANSACTION
CIS_SETTINGS
CIS_SUBCONTRACTOR
CIS_SUBCONTRACTOR_LEGACY
CIS_SUBCONTRACTOR_RETURN
CIS_SUBCONTRACTOR_TAX_HISTORY
COMPANY
COMPANY_DEL_ADDR
CONTACT_HISTORY
CONTACT_HISTORY_MAJOR_TYPE
CONTACT_HISTORY_CONTACT_OUTCOME
CONTACT_HISTORY_CONTACT_TYPE
ECSALES_FILL
ECSALES_HEADER
ECSALES_SPLIT
EC_VAT_DESCRIPTION
INTRASTAT
INVOICE
INVOICE_ITEM
UPDATE_LEDGER
ACCOUNT_STATUS
COMMUNICATION_ADDRESS
COUNTRY_CODE
CURRENCY
DEPARTMENT
LETTER_TYPE
PRICE
PRICE_LIST
TAX_CODE
ACCRUAL
CHART_LIST
FINANCIAL_BUDGET
FIXED_ASSET
FIXED_ASSET_CAT
NOMINAL_LEDGER
PERIOD
PREPAYMENT
PAYMENT_INFO
PAYMENT_METHOD
PROTX_PAYMENT
SUPPLIER_PAYMENT_INFO
PROJECT
PROJECT_BUDGET
PROJECT_COST_CODE
PROJECT_COST_TYPE
PROJECT_ONLY_TRAN
PROJECT_RELATIONSHIP
PROJECT_RESOURCE
PROJECT_RESOURCE_TYPE
PROJECT_REVENUE_CODE
PROJECT_STATUS
PROJECT_TRAN
GRN_ITEM
PURCHASE_DEL_ADDR
PURCHASE_LEDGER
PURCHASE_ORDER
POP_ITEM
SUPPLIER_PAYMENT_INFO
CREDIT_BUREAU
DIRECT_DEBIT_PAYMENT_REQUESTS
GDN_ITEM
PAYMENT_INFO
SAGEPAY_PAY_BY_LINK
SALES_DEL_ADDR
SALES_LEDGER
SALES_ORDER
SOP_ITEM
STOCK
STOCK_ALLOCATION
STOCK_CAT
STOCK_COMP
STOCK_TRAN
ESUBMISSION_SETTINGS
RTD_SUMMARY
VAT_ADJUSTMENT
VAT_DETAILS
VAT_REV_CHARGE_DETAIL
VAT_REV_CHARGE_HEADER
VAT_REV_CHARGE_RETURN
VAT_SUMMARY
VAT_RETURN
VAT_RETURN_RECEIPT