# README
Sync for Expenses version 1
Push expenses to accounting platforms.
Summary
Sync for Expenses (v1): The API for Sync for Expenses.
Sync for Expenses is an API and a set of supporting tools. It has been built to enable corporate card and expense management platforms to provide high-quality integrations with multiple accounting software through a standardized API.
Endpoints
Endpoints | Description |
---|---|
Connections | Create and manage partner expense connection. |
Configuration | Companies sync configuration. |
Mapping options | Mapping options for a companies expenses. |
Sync | Triggering a new sync of expenses to accounting software. |
Sync status | Check the status of ongoing or previous expense syncs. |
Expenses | Create expense datasets and upload receipts. |
Transaction status | Retrieve the status of transactions within a sync. |
Companies | Create and manage your Codat companies. |
Not seeing what you expect? See the main Sync for Expenses API.
Table of Contents
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Special Types
SDK Installation
To add the SDK as a dependency to your project:
go get github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1
Example Usage
SDK Example Usage
Example
package main
import (
"context"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Available Resources and Operations
Available methods
Companies
- CreateCompany - Create company
- DeleteCompany - Delete a company
- GetCompany - Get company
- ListCompanies - List companies
- UpdateCompany - Update company
Configuration
- GetCompanyConfiguration - Get company configuration
- SaveCompanyConfiguration - Set company configuration
Connections
- CreateConnection - Create connection
- CreatePartnerExpenseConnection - Create partner expense connection
- DeleteConnection - Delete connection
- GetConnection - Get connection
- ListConnections - List connections
- Unlink - Unlink connection
Expenses
- CreateExpenseDataset - Create expense-transactions
- UpdateExpenseDataset - Update expense transactions
- UploadAttachment - Upload attachment
MappingOptions
- GetMappingOptions - Mapping options
Sync
- InitiateSync - Initiate sync
SyncStatus
- GetLastSuccessfulSync - Last successful sync
- GetLatestSync - Latest sync status
- GetSyncByID - Get sync status
- ListSyncs - List sync statuses
TransactionStatus
- GetSyncTransaction - Get sync transaction
- ListSyncTransactions - Get sync transactions
Special Types
Retries
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"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/retry"
"log"
"pkg/models/operations"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
}, 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.Company != 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"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/retry"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithRetryConfig(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
InitialInterval: 1,
MaxInterval: 50,
Exponent: 1.1,
MaxElapsedTime: 100,
},
RetryConnectionErrors: false,
}),
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Error Handling
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 | 400,401,402,403,429,500,503 | application/json |
sdkerrors.SDKError | 4xx-5xx | / |
Example
package main
import (
"context"
"errors"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/sdkerrors"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
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())
}
}
}
Server Selection
Select Server by Index
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 |
Example
package main
import (
"context"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithServerIndex(0),
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Override Server URL Per-Client
The default server can also be overridden globally using the WithServerURL
option when initializing the SDK client instance. For example:
package main
import (
"context"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithServerURL("https://api.codat.io"),
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Custom HTTP Client
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.
Authentication
Per-Client Security Schemes
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"
syncforexpensesversion1 "github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1"
"github.com/codatio/client-sdk-go/previous-versions/sync-for-expenses-version-1/pkg/models/shared"
"log"
)
func main() {
s := syncforexpensesversion1.New(
syncforexpensesversion1.WithSecurity(shared.Security{
AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
}),
)
ctx := context.Background()
res, err := s.Companies.CreateCompany(ctx, &shared.CompanyRequestBody{
Description: syncforexpensesversion1.String("Requested early access to the new financing scheme."),
Groups: []shared.GroupReference{
shared.GroupReference{
ID: syncforexpensesversion1.String("60d2fa12-8a04-11ee-b9d1-0242ac120002"),
},
},
Name: "Technicalium",
})
if err != nil {
log.Fatal(err)
}
if res.Company != nil {
// handle response
}
}
Support
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.