@codat/accounting v0.42.0

Accounting

Codat's Accounting API is a flexible API for pulling and pushing up-to-date accounting data to your customer's accounting software. It gives you a simple way to view, create, update adn delete data without having to worry about each platform's specific complexities.

SDK Installation

NPM

npm add @codat/accounting

Yarn

yarn add @codat/accounting

Example Usage

SDK Example Usage

Example

import { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get({
        accountTransactionId: "string",
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Available Resources and Operations

accountTransactions

• get - Get account transaction
• list - List account transactions

bankAccounts

• create - Create bank account
• get - Get bank account
• getCreateUpdateModel - Get create/update bank account model
• list - List bank accounts
• update - Update bank account

bankAccountTransactions

• create - Create bank account transactions
• getCreateModel - Get create bank account transactions model
• list - List bank account transactions

bills

• create - Create bill
• delete - Delete bill
• downloadAttachment - Download bill attachment
• get - Get bill
• getAttachment - Get bill attachment
• getCreateUpdateModel - Get create/update bill model
• list - List bills
• listAttachments - List bill attachments
• update - Update bill
• uploadAttachment - Upload bill attachment

customers

• create - Create customer
• downloadAttachment - Download customer attachment
• get - Get customer
• getAttachment - Get customer attachment
• getCreateUpdateModel - Get create/update customer model
• list - List customers
• listAttachments - List customer attachments
• update - Update customer

directCosts

• create - Create direct cost
• downloadAttachment - Download direct cost attachment
• get - Get direct cost
• getAttachment - Get direct cost attachment
• getCreateModel - Get create direct cost model
• list - List direct costs
• listAttachments - List direct cost attachments
• uploadAttachment - Upload direct cost attachment

directIncomes

• create - Create direct income
• downloadAttachment - Download direct income attachment
• get - Get direct income
• getAttachment - Get direct income attachment
• getCreateModel - Get create direct income model
• list - List direct incomes
• listAttachments - List direct income attachments
• uploadAttachment - Create direct income attachment

invoices

• create - Create invoice
• delete - Delete invoice
• downloadAttachment - Download invoice attachment
• downloadPdf - Get invoice as PDF
• get - Get invoice
• getAttachment - Get invoice attachment
• getCreateUpdateModel - Get create/update invoice model
• list - List invoices
• listAttachments - List invoice attachments
• update - Update invoice
• uploadAttachment - Upload invoice attachment

itemReceipts

• get - Get item receipt
• list - List item receipts

purchaseOrders

• create - Create purchase order
• downloadAttachment - Download purchase order attachment
• downloadPurchaseOrderPdf - Download purchase order as PDF
• get - Get purchase order
• getAttachment - Get purchase order attachment
• getCreateUpdateModel - Get create/update purchase order model
• list - List purchase orders
• listAttachments - List purchase order attachments
• update - Update purchase order

suppliers

• create - Create supplier
• downloadAttachment - Download supplier attachment
• get - Get supplier
• getAttachment - Get supplier attachment
• getCreateUpdateModel - Get create/update supplier model
• list - List suppliers
• listAttachments - List supplier attachments
• update - Update supplier

transfers

• create - Create transfer
• get - Get transfer
• getCreateModel - Get create transfer model
• list - List transfers
• uploadAttachment - Upload invoice attachment

billCreditNotes

• create - Create bill credit note
• get - Get bill credit note
• getCreateUpdateModel - Get create/update bill credit note model
• list - List bill credit notes
• update - Update bill credit note
• uploadAttachment - Upload bill credit note attachment

billPayments

• create - Create bill payments
• delete - Delete bill payment
• get - Get bill payment
• getCreateModel - Get create bill payment model
• list - List bill payments

accounts

• create - Create account
• get - Get account
• getCreateModel - Get create account model
• list - List accounts

creditNotes

• create - Create credit note
• get - Get credit note
• getCreateUpdateModel - Get create/update credit note model
• list - List credit notes
• update - Update credit note

items

• create - Create item
• get - Get item
• getCreateModel - Get create item model
• list - List items

journalEntries

• create - Create journal entry
• delete - Delete journal entry
• get - Get journal entry
• getCreateModel - Get create journal entry model
• list - List journal entries

journals

• create - Create journal
• get - Get journal
• getCreateModel - Get create journal model
• list - List journals

payments

• create - Create payment
• get - Get payment
• getCreateModel - Get create payment model
• list - List payments

reports

• getAgedCreditorsReport - Aged creditors report
• getAgedDebtorsReport - Aged debtors report
• getBalanceSheet - Get balance sheet
• getCashFlowStatement - Get cash flow statement
• getProfitAndLoss - Get profit and loss
• isAgedCreditorsReportAvailable - Aged creditors report available
• isAgedDebtorReportAvailable - Aged debtors report available

companyInfo

• get - Get company info
• refresh - Refresh company info

paymentMethods

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

salesOrders

• get - Get sales order
• list - List sales orders

taxRates

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

trackingCategories

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

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 { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get(
        {
            accountTransactionId: "string",
            companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
            connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
        },
        {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        }
    );

    if (res.statusCode == 200) {
        // handle response
    }
}

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 { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        retry_config: {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        },
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get({
        accountTransactionId: "string",
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Error Handling

Handling errors in this SDK should largely match your expectations. All operations 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.

Example

import { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    let res;
    try {
        res = await sdk.accountTransactions.get({
            accountTransactionId: "string",
            companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
            connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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:

Example

import { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        serverIdx: 0,
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get({
        accountTransactionId: "string",
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

import { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        serverURL: "https://api.codat.io",
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get({
        accountTransactionId: "string",
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { @codat/accounting } from "CodatAccounting";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new CodatAccounting({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { CodatAccounting } from "@codat/accounting";

async function run() {
    const sdk = new CodatAccounting({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountTransactions.get({
        accountTransactionId: "string",
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

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