accounting

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.

Summary

Accounting API: > ### New to Codat?

Our Accounting API reference is relevant only to our existing clients. Please reach out to your Codat contact so that we can find the right product for you.

A flexible API for pulling accounting data, normalized and aggregated from 20 accounting integrations.

Standardize how you connect to your customers’ accounting software. View, create, update, and delete data in the same way for all the leading accounting software.

Endpoints

Endpoints	Description
Accounts	Access standardized Accounts from linked accounting software.
Account transactions	Access standardized Account transactions from linked accounting software.
Bank accounts	Access standardized Bank accounts from linked accounting software.
Bank account transactions	Access standardized Bank transactions for bank accounts from linked accounting software.
Bills	Access standardized Bills from linked accounting software.
Bill credit notes	Access standardized Bill credit notes from linked accounting software.
Bill payments	Access standardized Bill payments from linked accounting software.
Credit notes	Access standardized Credit notes from linked accounting software.
Customers	Access standardized Customers from linked accounting software.
Direct costs	Access standardized Direct costs from linked accounting software.
Direct incomes	Access standardized Direct incomes from linked accounting software.
Company info	Access standardized Company info from linked accounting software.
Invoices	Access standardized Invoices from linked accounting software.
Item receipts	Access standardized Item receipts from linked accounting software.
Items	Access standardized Items from linked accounting software.
Journals	Access standardized Journals from linked accounting software.
Journal entries	Access standardized Journal entries from linked accounting software.
Payments	Access standardized Payments from linked accounting software.
Payment methods	Access standardized Payment methods from linked accounting software.
Purchase orders	Access standardized Purchase orders from linked accounting software.
Sales orders	Access standardized Sales orders from linked accounting software.
Suppliers	Access standardized Suppliers from linked accounting software.
Tax rates	Access standardized Tax rates from linked accounting software.
Tracking categories	Access standardized Tracking categories from linked accounting software.
Transfers	Access standardized Transfers from linked accounting software.
Reports	Access standardized Reports from linked accounting software.

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install codat-accounting

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add codat-accounting

Example Usage

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from codat_accounting import CodatAccounting
from codat_accounting.models import shared

s = CodatAccounting(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

if res is not None:
    # handle response
    pass

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from codat_accounting import CodatAccounting
from codat_accounting.models import shared

async def main():
    s = CodatAccounting(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    )
    res = await s.account_transactions.get_async(request={
        "account_transaction_id": "<value>",
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    })
    if res is not None:
        # handle response
        pass

asyncio.run(main())

Available Resources and Operations

Available methods

account_transactions

get - Get account transaction
list - List account transactions

accounts

create - Create account
get - Get account
get_create_model - Get create account model
list - List accounts

bank_account_transactions

create - Create bank account transactions
get_create_model - Get create bank account transactions model
list - List bank account transactions

bank_accounts

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

bill_credit_notes

create - Create bill credit note
get - Get bill credit note
get_create_update_model - Get create/update bill credit note model
list - List bill credit notes
update - Update bill credit note
upload_attachment - Upload bill credit note attachment

bill_payments

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

bills

create - Create bill
delete - Delete bill
download_attachment - Download bill attachment
get - Get bill
get_attachment - Get bill attachment
get_create_update_model - Get create/update bill model
list - List bills
list_attachments - List bill attachments
update - Update bill
upload_attachment - Upload bill attachment

company_info

get - Get company info
refresh - Refresh company info

credit_notes

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

customers

create - Create customer
download_attachment - Download customer attachment
get - Get customer
get_attachment - Get customer attachment
get_create_update_model - Get create/update customer model
list - List customers
list_attachments - List customer attachments
update - Update customer

direct_costs

create - Create direct cost
delete - Delete direct cost
download_attachment - Download direct cost attachment
get - Get direct cost
get_attachment - Get direct cost attachment
get_create_model - Get create direct cost model
list - List direct costs
list_attachments - List direct cost attachments
upload_attachment - Upload direct cost attachment

direct_incomes

create - Create direct income
download_attachment - Download direct income attachment
get - Get direct income
get_attachment - Get direct income attachment
get_create_model - Get create direct income model
list - List direct incomes
list_attachments - List direct income attachments
upload_attachment - Create direct income attachment

invoices

create - Create invoice
delete - Delete invoice
download_attachment - Download invoice attachment
download_pdf - Get invoice as PDF
get - Get invoice
get_attachment - Get invoice attachment
get_create_update_model - Get create/update invoice model
list - List invoices
list_attachments - List invoice attachments
update - Update invoice
upload_attachment - Upload invoice attachment

item_receipts

get - Get item receipt
list - List item receipts

items

create - Create item
get - Get item
get_create_model - Get create item model
list - List items

journal_entries

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

journals

create - Create journal
get - Get journal
get_create_model - Get create journal model
list - List journals

payment_methods

get - Get payment method
list - List payment methods

payments

create - Create payment
get - Get payment
get_create_model - Get create payment model
list - List payments
payments - List payments

purchase_orders

create - Create purchase order
download_attachment - Download purchase order attachment
download_purchase_order_pdf - Download purchase order as PDF
get - Get purchase order
get_attachment - Get purchase order attachment
get_create_update_model - Get create/update purchase order model
list - List purchase orders
list_attachments - List purchase order attachments
update - Update purchase order

reports

get_aged_creditors_report - Aged creditors report
get_aged_debtors_report - Aged debtors report
get_balance_sheet - Get balance sheet
get_cash_flow_statement - Get cash flow statement
get_profit_and_loss - Get profit and loss
is_aged_creditors_report_available - Aged creditors report available
is_aged_debtor_report_available - Aged debtors report available

sales_orders

get - Get sales order
list - List sales orders

suppliers

create - Create supplier
download_attachment - Download supplier attachment
get - Get supplier
get_attachment - Get supplier attachment
get_create_update_model - Get create/update supplier model
list - List suppliers
list_attachments - List supplier attachments
update - Update supplier

tax_rates

get - Get tax rate
list - List all tax rates

tracking_categories

get - Get tracking categories
list - List tracking categories

transfers

create - Create transfer
get - Get transfer
get_create_model - Get create transfer model
list - List transfers
upload_attachment - Upload transfer attachment

File uploads

Certain SDK methods accept file objects as part of a request body or 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

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from codat_accounting import CodatAccounting
from codat_accounting.models import shared

s = CodatAccounting(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

s.bills.upload_attachment(request={
    "bill_id": "EILBDVJVNUAGVKRQ",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

# Use the SDK ...

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:

from codat_accounting import CodatAccounting
from codat_accounting.models import shared
from codataccounting.utils import BackoffStrategy, RetryConfig

s = CodatAccounting(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
},
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from codat_accounting import CodatAccounting
from codat_accounting.models import shared
from codataccounting.utils import BackoffStrategy, RetryConfig

s = CodatAccounting(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

if res is not None:
    # handle response
    pass

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	Status Code	Content Type
errors.ErrorMessage	401,402,403,404,409,429,500,503	application/json
errors.SDKError	4xx-5xx	/

Example

from codat_accounting import CodatAccounting
from codat_accounting.models import errors, shared

s = CodatAccounting(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = None
try:
    res = s.account_transactions.get(request={
        "account_transaction_id": "<value>",
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    })

    if res is not None:
        # handle response
        pass

except errors.ErrorMessage as e:
    # handle e.data: errors.ErrorMessageData
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

Server Selection

Select Server by Index

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

Example

from codat_accounting import CodatAccounting
from codat_accounting.models import shared

s = CodatAccounting(
    server_idx=0,
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

if res is not None:
    # handle response
    pass

Override Server URL Per-Client

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

from codat_accounting import CodatAccounting
from codat_accounting.models import shared

s = CodatAccounting(
    server_url="https://api.codat.io",
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

if res is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the httpx 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 your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

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

from codat_accounting import CodatAccounting
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CodatAccounting(client=http_client)

or you could wrap the client with your own custom logic:

from codat_accounting import CodatAccounting
from codat_accounting.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = CodatAccounting(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`auth_header`	apiKey	API key

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

from codat_accounting import CodatAccounting
from codat_accounting.models import shared

s = CodatAccounting(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = s.account_transactions.get(request={
    "account_transaction_id": "<value>",
    "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
    "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
})

if res is not None:
    # handle response
    pass

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from codat_accounting import CodatAccounting
import logging

logging.basicConfig(level=logging.DEBUG)
s = CodatAccounting(debug_logger=logging.getLogger("codat_accounting"))

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.

Name		Name	Last commit message	Last commit date
parent directory ..
.speakeasy		.speakeasy
.vscode		.vscode
docs		docs
scripts		scripts
src/codat_accounting		src/codat_accounting
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
files.gen		files.gen
poetry.lock		poetry.lock
poetry.toml		poetry.toml
py.typed		py.typed
pylintrc		pylintrc
pyproject.toml		pyproject.toml

FilesExpand file tree

accounting

Directory actions

More options

Directory actions

More options

Latest commit

History

accounting

Folders and files

parent directory

Accounting

Summary

Endpoints

Table of Contents

SDK Installation

PIP

Poetry

Example Usage

IDE Support

PyCharm

SDK Example Usage

Example

Available Resources and Operations

File uploads

Retries

Error Handling

Example

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Debugging

Support

Library generated by Speakeasy