Welcome to Codat's API Documentation

Develop against the Codat API.

Guides    API Explorer

Transformation

Commerce data must be transformed (mapped) into an accounting format, ready for insertion into accounting software.

Variance in accounting software

Differences in functionality between accounting packages means that the synchronisation below might differ across the range of software supported. Codat works with each accounting software vendor to ensure data is synchronised in the correct format for each package.

Sales

Invoices are created to represent merchants sale transactions.

The invoice is raised against the Sales Customer set in the merchants configuration.

Grouping

The number of invoices created and the breakdown of line items will depend on the Grouping Configuration set by the merchant.

Grouping can be configured on an invoice or line item basis by variables such as currency, tax rate, store location, product type or department.

Gratuities

Tips / gratuities are recorded separately on invoices so they can be linked to a dedicated account for gratuities in the merchants accounting software.

Payments

Payments are grouped by payment type and recorded as payments against the corresponding invoices of the sale transaction.

Refunds

Credit notes are created to record refunds made by merchants, with corresponding linked payments of the type refunded.

Fees

Some commerce or payments providers charge a processing fee which is subtracted from any monies before they are sent to the merchant. These fees are recorded in two possible ways, depending on the accounting software support and the type of accounts configured by the merchant.

Fees recorded as bills

A bill (purchase invoice) is raised to reflect any fees collected. A payment is recorded against the bill which debits the fee account configured by the merchant and credits the payment account for which the fee has been charged.

Fees recorded as transactions

A transaction is recorded which debits the fee account configured by the merchant and credits the payment account for which the fee has been charged.

Updated 9 months ago

Transformation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.