Skip to content

sync-for-payables

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

sync-for-payables

README.md

github.com/codatio/client-sdk-go/sync-for-payables

Developer-friendly & type-safe Go SDK specifically catered to leverage github.com/codatio/client-sdk-go/sync-for-payables API.

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

Summary

Bill pay kit: The API reference for the Bill Pay kit.

The bill pay kit is an API and a set of supporting tools designed to integrate a bill pay flow into your app as quickly as possible. It's ideal for facilitating essential bill payment processes within your SMB's accounting software.

Explore product | See OpenAPI spec

Supported Integrations

Integration Supported
FreeAgent Yes
QuickBooks Online Yes
Oracle NetSuite Yes
Xero Yes

Endpoints

Endpoints Description
Companies Create and manage your SMB users' companies.
Connections Create new and manage existing data connections for a company.
Company information View company profile from the source platform.
Bills Get, create, and update Bills.
Bill payments Get, create, and update Bill payments.
Suppliers Get, create, and update Suppliers.
Bank accounts Create a bank account for a given company's connection.

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/codatio/client-sdk-go/sync-for-payables

SDK Example Usage

Example

package main

import (
	"context"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"log"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Companies != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

BankAccounts

  • Create - Create bank account

BillPayments

Bills

Companies

CompanyInformation

  • Get - Get company information

Connections

  • List - List connections
  • Create - Create connection
  • Get - Get connection
  • Delete - Delete connection
  • Unlink - Unlink connection

Suppliers

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"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	}, 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.Companies != 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"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/retry"
	"log"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Companies != 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.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the List function may return the following errors:

Error Type Status Code Content Type
sdkerrors.ErrorMessage 400, 401, 402, 403, 404, 429, 500, 503 application/json
sdkerrors.SDKError 4XX, 5XX */*

Example

package main

import (
	"context"
	"errors"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/sdkerrors"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"log"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	})
	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

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"log"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithServerURL("https://api.codat.io"),
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Companies != 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"
	syncforpayables "github.com/codatio/client-sdk-go/sync-for-payables/v5"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/operations"
	"github.com/codatio/client-sdk-go/sync-for-payables/v5/pkg/models/shared"
	"log"
)

func main() {
	s := syncforpayables.New(
		syncforpayables.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Companies.List(ctx, operations.ListCompaniesRequest{
		Page:     syncforpayables.Int(1),
		PageSize: syncforpayables.Int(100),
		Query:    syncforpayables.String("id=e3334455-1aed-4e71-ab43-6bccf12092ee"),
		OrderBy:  syncforpayables.String("-modifiedDate"),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Companies != nil {
		// handle response
	}
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy