@codat/sync-for-payables-version-1
v2.3.0
Published
<!-- Start Codat Library Description --> Streamline your customers' accounts payable workflow. <!-- End Codat Library Description -->
Downloads
2
Readme
Sync for Payables
Streamline your customers' accounts payable workflow.
Summary
Sync for Payables: The API for Sync for Payables.
Sync for Payables is an API and a set of supporting tools built to help integrate with your customers' accounting software, and keep their supplier information, invoices, and payments in sync.
Explore product | See OpenAPI spec
Endpoints
| Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | | Accounts | Get, create, and update Accounts. | | Bank accounts | Get, create, and update Bank accounts. | | Bills | Get, create, and update Bills. | | Bill credit notes | Get, create, and update Bill credit notes. | | Bill payments | Get, create, and update Bill payments. | | Journals | Get, create, and update Journals. | | Journal entries | Get, create, and update Journal entries. | | Payment methods | Get, create, and update Payment methods. | | Suppliers | Get, create, and update Suppliers. | | Tax rates | Get, create, and update Tax rates. | | Tracking categories | Get, create, and update Tracking categories. | | Company info | View company profile from the source platform. | | Push operations | View historic push operations. | | Manage data | Control how data is retrieved from an integration. |
Table of Contents
- SDK Installation
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @codat/sync-for-payables-version-1
PNPM
pnpm add @codat/sync-for-payables-version-1
Bun
bun add @codat/sync-for-payables-version-1
Yarn
yarn add @codat/sync-for-payables-version-1 zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
Example Usage
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
accounts
- list - List accounts
- get - Get account
- getCreateModel - Get create account model
- create - Create account
bankAccounts
- getCreateModel - Get create/update bank account model
- create - Create bank account
billCreditNotes
- list - List bill credit notes
- get - Get bill credit note
- getCreateUpdateModel - Get create/update bill credit note model
- create - Create bill credit note
- update - Update bill credit note
billPayments
- list - List bill payments
- get - Get bill payment
- delete - Delete bill payment
- getCreateModel - Get create bill payment model
- create - Create bill payments
bills
- list - List bills
- get - Get bill
- getCreateUpdateModel - Get create/update bill model
- create - Create bill
- update - Update bill
- delete - Delete bill
- listAttachments - List bill attachments
- getAttachment - Get bill attachment
- deleteAttachment - Delete bill attachment
- downloadAttachment - Download bill attachment
- uploadAttachment - Upload bill attachment
companies
- list - List companies
- create - Create company
- update - Update company
- delete - Delete a company
- get - Get company
companyInfo
- getAccountingProfile - Get company accounting profile
connections
- list - List connections
- create - Create connection
- get - Get connection
- delete - Delete connection
- unlink - Unlink connection
journalEntries
- getCreateModel - Get create journal entry model
- create - Create journal entry
journals
- list - List journals
- get - Get journal
- getCreateModel - Get create journal model
- create - Create journal
manageData
- refreshAllDataTypes - Refresh all data
- get - Get data status
- refreshDataType - Refresh data type
- listPullOperations - List pull operations
- getPullOperation - Get pull operation
paymentMethods
pushOperations
suppliers
- list - List suppliers
- get - Get supplier
- getCreateUpdateModel - Get create/update supplier model
- create - Create supplier
- update - Update supplier
taxRates
trackingCategories
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
- accountsCreate
- accountsGetCreateModel
- accountsGet
- accountsList
- bankAccountsCreate
- bankAccountsGetCreateModel
- billCreditNotesCreate
- billCreditNotesGetCreateUpdateModel
- billCreditNotesGet
- billCreditNotesList
- billCreditNotesUpdate
- billPaymentsCreate
- billPaymentsDelete
- billPaymentsGetCreateModel
- billPaymentsGet
- billPaymentsList
- billsCreate
- billsDeleteAttachment
- billsDelete
- billsDownloadAttachment
- billsGetAttachment
- billsGetCreateUpdateModel
- billsGet
- billsListAttachments
- billsList
- billsUpdate
- billsUploadAttachment
- companiesCreate
- companiesDelete
- companiesGet
- companiesList
- companiesUpdate
- companyInfoGetAccountingProfile
- connectionsCreate
- connectionsDelete
- connectionsGet
- connectionsList
- connectionsUnlink
- journalEntriesCreate
- journalEntriesGetCreateModel
- journalsCreate
- journalsGetCreateModel
- journalsGet
- journalsList
- manageDataGetPullOperation
- manageDataGet
- manageDataListPullOperations
- manageDataRefreshAllDataTypes
- manageDataRefreshDataType
- paymentMethodsGet
- paymentMethodsList
- pushOperationsGet
- pushOperationsList
- suppliersCreate
- suppliersGetCreateUpdateModel
- suppliersGet
- suppliersList
- suppliersUpdate
- taxRatesGet
- taxRatesList
- trackingCategoriesGet
- trackingCategoriesList
File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlob
function innode:fs
.- Bun: The native
Bun.file
function produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
File
when reading the value from an<input type="file">
element.- Node.js v18: A file stream can be created using the
fileFrom
helper fromfetch-blob/from.js
.
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
await codatSyncPayables.bills.uploadAttachment({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
billId: "EILBDVJVNUAGVKRQ",
});
}
run();
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 retryConfig object to the call:
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type | | ------------------------------- | ------------------------------- | ------------------------------- | | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
import {
ErrorMessage,
SDKValidationError,
} from "@codat/sync-for-payables-version-1/sdk/models/errors";
const codatSyncPayables = new CodatSyncPayables({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
let result;
try {
result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorMessage): {
// Handle err.data$: ErrorMessageData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx
optional parameter 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 |
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
serverIdx: 0,
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
serverURL: "https://api.codat.io",
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
import { HTTPClient } from "@codat/sync-for-payables-version-1/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new CodatSyncPayables({ httpClient });
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| authHeader
| apiKey | API key |
To authenticate with the API the authHeader
parameter must be set when initializing the SDK client instance. For example:
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const codatSyncPayables = new CodatSyncPayables({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatSyncPayables.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
const sdk = new CodatSyncPayables({ debugLogger: console });
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.