Embedded accounting integrations for POS and eCommerce platforms.
Sync for Commerce (v1): The API for Sync for Commerce V1.
Sync for Commerce automatically replicates and reconciles sales data from a merchant’s source PoS, Payments, and eCommerce systems into their accounting software. This eliminates manual processing by merchants and transforms their ability to run and grow their business.
| Endpoints | Description |
|---|---|
| Company management | Create new and manage existing Sync for Commerce companies. |
| Configuration | Expressively configure preferences for any given Sync for Commerce company. |
| Sync flow preferences | Configure preferences for any given Sync for Commerce company using sync flow. |
| Sync | Initiate a sync of Sync for Commerce company data into their respective accounting software. |
| Integrations | View useful information about codat's integrations. |
| Companies | Create and manage your Codat companies. |
| Connections | Manage your companies' data connections. |
| Refresh data | Asynchronously retrieve data from an integration to refresh data in Codat. |
| Push data | View push options and get push statuses. |
| Accounting accounts | Retrieve standardized Accounts from linked accounting software. |
| Accounting credit notes | Retrieve standardized Credit notes from linked accounting software. |
| Accounting customers | Retrieve standardized Customers from linked accounting software. |
| Accounting direct incomes | Retrieve standardized Direct incomes from linked accounting software. |
| Accounting company info | Retrieve standardized Accounting company info from linked accounting software. |
| Accounting invoices | Retrieve standardized Invoices from linked accounting software. |
| Accounting journal entries | Retrieve standardized Journal entries from linked accounting software. |
| Accounting payments | Retrieve standardized Payments from linked accounting software. |
| Accounting bank accounts | Retrieve standardized Bank accounts from linked accounting software. |
| Commerce customers | Retrieve standardized Commerce customers from linked commerce software. |
| Commerce company info | Retrieve standardized Commerce company info from linked commerce software. |
| Commerce locations | Retrieve standardized Commerce locations from linked commerce software. |
| Commerce orders | Retrieve standardized Commerce orders from linked commerce software. |
| Commerce payments | Retrieve standardized Commerce payments from linked commerce software. |
| Commerce products | Retrieve standardized Commerce products from linked commerce software. |
| Commerce transactions | Retrieve standardized Commerce transactions from linked commerce software. |
Not seeing what you expect? See the main Sync for Commerce API.
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Special Types
To add the SDK as a dependency to your project:
go get github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}Available methods
- CreateAccountingAccount - Create account
- GetAccountingAccount - Get account
- ListAccountingAccounts - List accounts
- GetAccountingBankAccount - Get bank account
- ListAccountingBankAccounts - List bank accounts
- GetAccountingCompanyInfo - Get company info
- Refresh - Refresh company info
- CreateAccountingCreditNote - Create credit note
- CreateAccountingCustomer - Create customer
- CreateAccountingDirectIncome - Create direct income
- CreateAccountingInvoice - Create invoice
- CreateAccountingJournalEntry - Create journal entry
- CreateAccountingPayment - Create payment
- GetCommerceCompanyInfo - Get company info
- GetCommerceCustomer - Get customer
- ListCommerceCustomers - List customers
- GetCommerceLocation - Get location
- ListCommerceLocations - List locations
- GetCommerceOrder - Get order
- ListCommerceOrders - List orders
- GetCommercePayment - Get payment
- GetMethod - Get payment method
- ListCommercePayments - List payments
- ListMethods - List payment methods
- GetCommerceProduct - Get product
- ListCommerceProducts - List products
- GetCommerceTransaction - Get transaction
- ListCommerceTransactions - List transactions
- DeleteCompany - Delete a company
- GetCompany - Get company
- UpdateCompany - Update company
- CreateCompany - Create sync for commerce company
- CreateConnection - Create connection
- ListCompanies - List companies
- ListConnections - List data connections
- UpdateConnection - Update data connection
- GetConfiguration - Retrieve config preferences set for a company
- SetConfiguration - Create or update configuration
- DeleteConnection - Delete connection
- GetConnection - Get connection
- Unlink - Unlink connection
- GetIntegrationBranding - Get branding for an integration
- ListIntegrations - List integrations
- GetOperation - Get push operation
- ListOperations - List push operations
- All - Refresh all data
- ByDataType - Refresh data type
- GetCompanyDataStatus - Get data status
- GetPullOperation - Get pull operation
- ListPullOperations - List pull operations
- GetSyncStatus - Get status for a company's syncs
- RequestSync - Sync new
- RequestSyncForDateRange - Sync range
- GetConfigTextSyncFlow - Retrieve preferences for text fields on sync flow
- GetSyncFlowURL - Retrieve sync flow url
- GetVisibleAccounts - List visible accounts
- UpdateConfigTextSyncFlow - Update preferences for text fields on sync flow
- UpdateVisibleAccountsSyncFlow - Update the visible accounts on sync flow
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:
package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/retry"
"log"
"pkg/models/operations"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
}, operations.WithRetries(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}))
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:
package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/retry"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
| Error Object | Status Code | Content Type |
|---|---|---|
| sdkerrors.ErrorMessage | 401,402,403,429,500,503 | application/json |
| sdkerrors.SDKError | 4xx-5xx | / |
package main
import (
"context"
"errors"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/sdkerrors"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
var e *sdkerrors.ErrorMessage
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.codat.io |
None |
package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithServerIndex(0),
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:
package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithServerURL("https://api.codat.io"),
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
AuthHeader |
apiKey | API key |
You can configure it using the WithSecurity option when initializing the SDK client instance. For example:
package main
import (
"context"
syncforcommerceversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/operations"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforcommerceversion1.New(
syncforcommerceversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.SyncFlowPreferences.GetConfigTextSyncFlow(ctx, operations.GetConfigTextSyncFlowRequest{
Locale: shared.LocaleEnUs,
})
if err != nil {
log.Fatal(err)
}
if res.LocalizationInfo != nil {
// handle response
}
}If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.