Troubleshooting
Resolve some common errors that you may encounter with Sync for Commerce.
Beta testing
Sync for Commerce is in beta. If you are interested in building with Sync for Commerce, please get in touch.
Status codes
Code | Reason |
---|---|
1000 | In Progress |
1010 | In Progress (Long running - over ten minutes) |
2000 | Success (Data pushed) |
2040 | Success (No data pushed) |
4000 | Configuration Error |
4040 | Company deleted/de-authorized |
4220 | Company deleted/de-authorized |
4260 | Accounting platform billing expiry |
5000 | Generic Server error |
5080 | Duplication protection |
5120 | Data processing error |
5130 | Data push error |
Error messages
This section describes the errors that are related to Sync for Commerce configuration. Some of them can be avoided by following this set of best practices:
- Ensure that the Codat company that you create for your merchant has both accounting and commerce data connections and they are linked correctly.
- If you are re-linking the company, make sure that the previous one is deleted.
- Ensure that the invoice status for Payments is set to
submitted
. - Avoid using payout/prepaid accounts for Payments.
- Make sure to configure the grouping for all the features.
- When choosing configuration options, only use the options provided by Codat.
How to resolve configuration errors
Error message | Error resolution |
---|---|
Company needs to have two valid data connections. | This error surfaces if a company does not have 2 valid data connections OR both data connections do not have the _ Ensure that the Codat company created for the merchant has 2 valid data connections. 1 commerce and 1 accounting connection are required. _ Ensure that the Codat company has both data connection statuses set to |
To sync fees:
| The Fees feature cannot be used until the Payment feature is configured. * The merchant should complete the configuration of Payments in order to sync Fees. |
Payments config invalid. Accounts config invalid. Prepaid account in Sales should not match | The prepaid account and the payment account should not be the same. * Reconfigure the selected accounts for prepaid and prepaid payments. |
Payments config invalid. | This error surfaces if the account selected for Payments matches the payout account. * Reconfigure the selected accounts for payments and payouts. |
No sales customer has been configured. | This error surfaces if the sales customer is missing from the configuration. * Configure the sales customer from the available options on the config options. |
Selected customer not present in customer options. | This error surfaces if the configured sales customer does not match a valid Note: The During the onfiguration, select from the available options under the |
Selected Account is not a valid option. | The During the configuration, only select from the available options under |
No grouping period selected. Grouping period selected not from options. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders. Note: At the time of writing, the only time-based grouping option available is daily. This means all orders of a day would be grouped into a daily invoice. During the configuration, the grouping object in the config API has If in the grouping object in the config API the If the grouping object is set to any value that is not from the * Update the configuration on the Codat configuration API with a valid grouping period option. |
Invalid invoice level grouping selected. | Merchants should be able to configure grouping for their invoices. In Sync for Commerce, grouping is done by time (daily) and by country/location of orders. This error surfaces for the locations-based grouping where During the configuration, the grouping object in the config API has * Update the configuration on the Codat configuration API with a valid invoice-level grouping option. |
Invalid invoice line level grouping selected. | This error surfaces for invalid groupings on During the configuration, the grouping object in the config API that has * Update the configuration on the Codat configuration API with a valid line-level grouping option. |
Payments cannot be enabled if invoice status is set to 'draft'. | Payments cannot be enabled for synchronization if the invoices are not Active and are set to the Draft status. * A draft invoice cannot have any associated payments. The merchant should change the preferred invoice status for Payments to Submitted. |
Config contains required accounts without selections. | Configuration requires accounts to be selected. This error surfaces if any of the required accounts is not selected (e.g., Sales). SMB has not selected a required nominal account for pushing sales/commerce data against. * Make sure that the merchant cannot complete the configuration without selecting the accounts for required features that can be found here. |
No Sales Account Present. | This error surfaces if the merchant's accounting package has no nominal account categorized as a Sales account. You can build a feature to create a nominal account in the merchant’s accounting package, leveraging Codat’s Sync or public Core API resources. |
No schedule selected frequency. | This error surfaces if no schedule was configured during the configuration stage. * Configure the data synchronization schedule. |
Selected schedule frequency not present in options. | This error surfaces if the configured schedule does not conform to the set of options surfaced by the configuration API. * Configure a valid syncing schedule from the available scheduler options. |
No selected invoice status. | This error surfaces if invoice status is was not selected. * During the configuration, select the preferred invoice status (Submitted or Draft). Note: Payments cannot be synchronized if their Invoice status is set to Draft. |
Invalid invoice status selected (must be submitted or draft). | The invoice status to be selected must be Submitted or Draft. Any other value will lead to this error being surfaced. * During the configuration, select the preferred invoice status (Submitted or Draft). |
Tax rate is missing selected tax rate id. | This exception surfaces if the tax rate was not set during the configuration. * Reconfigure the tax rate on the Codat configuration API using the provided options. |
Selected tax rate id for | This errors surfaces if the selected tax rate is not available or is not from the list of supported tax rates. Reconfigure the tax rate on the Codat configuration API using the provided options. |
No fees supplier has been configured. Selected supplier not present in supplier options. | These error surfaces if no fees supplier has been provided or it does not match any of the options provided by Codat. * During the configuration, select the fees provider from the options available on the config API. |
Post-configuration errors
After the commerce data is delivered into the merchant's accounting platform, there are still some things to keep in mind to ensure that Sync for Commerce performs well:
- Advise your merchants to not update, deactivate or delete the accounts they selected to use with Sync for Commerce.
- Advise your merchants not to change the settings on the selected accounts (for example, tax rates) as this will result in a synchronization error.
How to resolve post-configuration errors
Error message | Error description and resolution |
---|---|
Accounts are not found. | During the scheduled data sync, validation verifies that the data in the selected nominal accounts is consistent and no accounts have been changed or deleted. This error surfaces in case any such accounts are detected. * To resolve, reconfigure selected accounts on the Codat configuration API. |
Account Id is not in an Active state. | During the first stage of the sync, validation checks to verify that the data in the selected nominal accounts is consistent and no accounts have status other than To resolve, reconfigure the selected accounts on the Codat configuration API. |
Customer is not in an Active state. | During the first stage of the sync, validation checks to verify that no To resolve, reconfigure |
Customer | During the first stage of the sync, validation checks to verify that * To resolve, reconfigure selected accounts on the Codat configuration API. |
Supplier does not exist. | During the first stage of the sync, validation checks to verify that supplier data is consistent and no customer data has changed or been deleted. This error is surfaced in case any such changes are detected. * To resolve, reconfigure supplier on the Codat configuration API. |
Supplier is not in an Active state. | During the first stage of the sync, validation checks to verify that no supplier data is set to any other state except for Active. This error is surfaced in case any inactive suppliers are detected. To resolve, reconfigure the supplier on the config API. |
Tax Rate {taxRateId} does not exist. The following Tax Rates are invalid: | During the first stage of the sync, validation checks to verify that the tax rate data is consistent and no tax rate data has been changed or deleted. This error is surfaced in case any updated tax data is detected. To resolve, reconfigure the tax rate on the config API. |
Errors resolved by Codat
To resolve these errors, contact your Codat representative.
Error message | Error description and resolution |
---|---|
No company was found with ID. | This exception is thrown when a company record does not exist. It may have previously existed and been |
Date overlaps with a previous sync date range. | This error surfaces when a scheduled daily sync overlaps or conflicts with a manually triggered sync. |
Updated 3 months ago