Streamline your customers' accounts payable workflow.
Project description
Sync for Payables
Streamline your customers' accounts payable workflow.
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-sync-for-payables
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-sync-for-payables
Example Usage
SDK Example Usage
Example
# Synchronous Example
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
async def main():
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = await s.companies.list_async(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
if res is not None:
# handle response
pass
asyncio.run(main())
Available Resources and Operations
Available methods
bank_accounts
- create - Create bank account
bill_payments
- get_payment_options - Get payment mapping options
- create - Create bill payment
bills
- get_bill_options - Get bill mapping options
- list - List bills
- create - Create bill
- upload_attachment - Upload bill attachment
- list_attachments - List bill attachments
- download_attachment - Download bill attachment
companies
- list - List companies
- create - Create company
- update - Update company
- delete - Delete a company
- get - Get company
company_information
- get - Get company information
connections
- list - List connections
- create - Create connection
- get - Get connection
- delete - Delete connection
- unlink - Unlink connection
suppliers
Summary
Bill pay kit: The API reference for the Bill Pay kit.
The bill pay kit is an API and a set of supporting tools designed to integrate a bill pay flow into your app as quickly as possible. It's ideal for facilitating essential bill payment processes within your SMB's accounting software.
Explore product | See OpenAPI spec
Supported Integrations
Integration | Supported |
---|---|
FreeAgent | Yes |
QuickBooks Online | Yes |
Oracle NetSuite | Yes |
Xero | Yes |
Endpoints
Endpoints | Description |
---|---|
Companies | Create and manage your SMB users' companies. |
Connections | Create new and manage existing data connections for a company. |
Company information | View company profile from the source platform. |
Bills | Get, create, and update Bills. |
Bill payments | Get, create, and update Bill payments. |
Suppliers | Get, create, and update Suppliers. |
Bank accounts | Create a bank account for a given company's connection. |
Table of Contents
- SDK Installation
- IDE Support
- SDK Example Usage
- Available Resources and Operations
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
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.
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.bills.upload_attachment(request={
"company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
"connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
"bill_id": "EILBDVJVNUAGVKRQ",
})
if res is not None:
# handle response
pass
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
from codatsyncpayables.utils import BackoffStrategy, RetryConfig
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
},
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
from codatsyncpayables.utils import BackoffStrategy, RetryConfig
s = CodatSyncPayables(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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 exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
Property | Type | Description |
---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list_async
method may raise the following exceptions:
Error Type | Status Code | Content Type |
---|---|---|
errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json |
errors.SDKError | 4XX, 5XX | */* |
Example
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import errors, shared
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = None
try:
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
s = CodatSyncPayables(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
s = CodatSyncPayables(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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_sync_for_payables import CodatSyncPayables
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CodatSyncPayables(client=http_client)
or you could wrap the client with your own custom logic:
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.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 = CodatSyncPayables(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_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
s = CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.companies.list(request={
"page": 1,
"page_size": 100,
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
})
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_sync_for_payables import CodatSyncPayables
import logging
logging.basicConfig(level=logging.DEBUG)
s = CodatSyncPayables(debug_logger=logging.getLogger("codat_sync_for_payables"))
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
File details
Details for the file codat_sync_for_payables-7.0.0.tar.gz
.
File metadata
- Download URL: codat_sync_for_payables-7.0.0.tar.gz
- Upload date:
- Size: 58.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d5e296ddf33fe7522a53de8aee34993b1172f51e1429ae96e9bb0c219da60ec |
|
MD5 | 381fd6a41ef2983a2c0d9556e4fee04a |
|
BLAKE2b-256 | a70e26c6ebd2a314b65517ba1c75f14a5927f20af9c5b168b496e117beddb8f1 |
File details
Details for the file codat_sync_for_payables-7.0.0-py3-none-any.whl
.
File metadata
- Download URL: codat_sync_for_payables-7.0.0-py3-none-any.whl
- Upload date:
- Size: 123.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.8.18 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | edf4afb179e2857ca3fd7e745d54a0d2a5c8588b79f7a0981292844c62ce4a04 |
|
MD5 | 3264dcbfb1419bed1b1ae7bc949f0ede |
|
BLAKE2b-256 | 6b00eaffe152d9c044ea16c447066703984a4cc919bb28a98248304f065d1f3d |