codat-accounting
Readme
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.
pip install codat-accounting
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
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
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 | / |
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
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 |
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
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
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)
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
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.
FAQs
Access standardized accounting data from our accounting integrations.
We found that codat-accounting demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.