Access standardized accounting data from our accounting integrations.
Project description
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
pip install codat-accounting
Example Usage
SDK Example Usage
Example
import codataccounting
from codataccounting.models import operations, shared
s = codataccounting.CodatAccounting(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req)
if res.account_transaction is not None:
# handle response
pass
Available Resources and Operations
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
bank_account_transactions
- create - Create bank account transactions
- get_create_model - Get create bank account transactions model
- list - List bank account transactions
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
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
- 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
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
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
transfers
- create - Create transfer
- get - Get transfer
- get_create_model - Get create transfer model
- list - List transfers
- upload_attachment - Upload invoice attachment
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
accounts
- create - Create account
- get - Get account
- get_create_model - Get create account model
- list - List accounts
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
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
payments
- create - Create payment
- get - Get payment
- get_create_model - Get create payment model
- list - List payments
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
company_info
payment_methods
sales_orders
tax_rates
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 codataccounting.models import operations, shared
from codataccounting.utils import BackoffStrategy, RetryConfig
s = codataccounting.CodatAccounting(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req,
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))
if res.account_transaction is not None:
# handle response
pass
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 codataccounting.models import operations, shared
from codataccounting.utils import BackoffStrategy, RetryConfig
s = codataccounting.CodatAccounting(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req)
if res.account_transaction 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 | 400-600 | / |
Example
import codataccounting
from codataccounting.models import operations, shared
s = codataccounting.CodatAccounting(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = None
try:
res = s.account_transactions.get(req)
except errors.ErrorMessage as e:
print(e) # handle exception
raise(e)
except errors.SDKError as e:
print(e) # handle exception
raise(e)
if res.account_transaction is not None:
# handle response
pass
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
import codataccounting
from codataccounting.models import operations, shared
s = codataccounting.CodatAccounting(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req)
if res.account_transaction 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:
import codataccounting
from codataccounting.models import operations, shared
s = codataccounting.CodatAccounting(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req)
if res.account_transaction is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] 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 requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import codataccounting
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codataccounting.CodatAccounting(client: http_client)
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:
import codataccounting
from codataccounting.models import operations, shared
s = codataccounting.CodatAccounting(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = operations.GetAccountTransactionRequest(
account_transaction_id='string',
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)
res = s.account_transactions.get(req)
if res.account_transaction is not None:
# handle response
pass
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for codat_accounting-0.35.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed3631c01bb37a7888eaff16e05c5d02c308f54f2416284c4d91100713c6441e |
|
MD5 | 5ae635e199493660f3fd5ec95763bc57 |
|
BLAKE2b-256 | 9207e76f021fff5a35ea0f8eab75e47570b632c8a573554bd70219bea07cdf4b |