Sync for Payables

Streamline your customers' accounts payable workflow.

Summary

Sync for Payables: The API for asynchronous Bill Pay solution.

Asynchronous Bill Pay solution 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 solution | 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

• Sync for Payables
  • Endpoints
  • SDK Installation
  • Example Usage
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • File uploads
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Debugging
  • Support

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

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({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  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
• replace - Replace 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

• list - List payment methods
• get - Get payment method

pushOperations

• list - List push operations
• get - Get push operation

suppliers

• list - List suppliers
• get - Get supplier
• getCreateUpdateModel - Get create/update supplier model
• create - Create supplier
• update - Update supplier

taxRates

• list - List all tax rates
• get - Get tax rate

trackingCategories

• list - List tracking categories
• get - Get tracking categories

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 - Create account
• accountsGet - Get account
• accountsGetCreateModel - Get create account model
• accountsList - List accounts
• bankAccountsCreate - Create bank account
• bankAccountsGetCreateModel - Get create/update bank account model
• billCreditNotesCreate - Create bill credit note
• billCreditNotesGet - Get bill credit note
• billCreditNotesGetCreateUpdateModel - Get create/update bill credit note model
• billCreditNotesList - List bill credit notes
• billCreditNotesUpdate - Update bill credit note
• billPaymentsCreate - Create bill payments
• billPaymentsDelete - Delete bill payment
• billPaymentsGet - Get bill payment
• billPaymentsGetCreateModel - Get create bill payment model
• billPaymentsList - List bill payments
• billsCreate - Create bill
• billsDelete - Delete bill
• billsDeleteAttachment - Delete bill attachment
• billsDownloadAttachment - Download bill attachment
• billsGet - Get bill
• billsGetAttachment - Get bill attachment
• billsGetCreateUpdateModel - Get create/update bill model
• billsList - List bills
• billsListAttachments - List bill attachments
• billsUpdate - Update bill
• billsUploadAttachment - Upload bill attachment
• companiesCreate - Create company
• companiesDelete - Delete a company
• companiesGet - Get company
• companiesList - List companies
• companiesReplace - Replace company
• companiesUpdate - Update company
• companyInfoGetAccountingProfile - Get company accounting profile
• connectionsCreate - Create connection
• connectionsDelete - Delete connection
• connectionsGet - Get connection
• connectionsList - List connections
• connectionsUnlink - Unlink connection
• journalEntriesCreate - Create journal entry
• journalEntriesGetCreateModel - Get create journal entry model
• journalsCreate - Create journal
• journalsGet - Get journal
• journalsGetCreateModel - Get create journal model
• journalsList - List journals
• manageDataGet - Get data status
• manageDataGetPullOperation - Get pull operation
• manageDataListPullOperations - List pull operations
• manageDataRefreshAllDataTypes - Refresh all data
• manageDataRefreshDataType - Refresh data type
• paymentMethodsGet - Get payment method
• paymentMethodsList - List payment methods
• pushOperationsGet - Get push operation
• pushOperationsList - List push operations
• suppliersCreate - Create supplier
• suppliersGet - Get supplier
• suppliersGetCreateUpdateModel - Get create/update supplier model
• suppliersList - List suppliers
• suppliersUpdate - Update supplier
• taxRatesGet - Get tax rate
• taxRatesList - List all tax rates
• trackingCategoriesGet - Get tracking categories
• trackingCategoriesList - List tracking categories

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 in node: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 from fetch-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: "13d946f0-c5d5-42bc-b092-97ece17923ab",
  });
}

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({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Error Handling

CodatSyncPayablesError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { CodatSyncPayables } from "@codat/sync-for-payables-version-1";
import * as errors from "@codat/sync-for-payables-version-1/sdk/models/errors";

const codatSyncPayables = new CodatSyncPayables({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  try {
    const result = await codatSyncPayables.companies.list({
      query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
      orderBy: "-modifiedDate",
      tags: "region=uk && team=invoice-finance",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.CodatSyncPayablesError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorMessage) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.service); // string
        console.log(error.data$.error); // string
        console.log(error.data$.correlationId); // string
        console.log(error.data$.validation); // shared.ErrorValidation
      }
    }
  }
}

run();

Error Classes

Primary errors:

• CodatSyncPayablesError: The base class for HTTP error responses.
  • ErrorMessage: Your query parameter was not correctly formed.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from CodatSyncPayablesError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string 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({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  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: 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({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  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.

Library generated by Speakeasy