codat-sync-for-payables 3.1.0

Streamline your customers' accounts payable workflow.

Sync for Payables

Streamline your customers' accounts payable workflow.

SDK Installation

pip install codat-sync-for-payables

Example Usage

SDK Example Usage

Example

import codatsyncpayables
from codatsyncpayables.models import shared

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req)

if res.company is not None:
    # handle response
    pass

Available Resources and Operations

companies

• create - Create company
• delete - Delete a company
• get - Get company
• list - List companies
• update - Update company

connections

• create - Create connection
• delete - Delete connection
• get - Get connection
• list - List connections
• unlink - Unlink connection

bills

• create - Create bill
• delete - Delete bill
• delete_attachment - Delete bill attachment
• 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

bank_accounts

• create - Create bank account
• get_create_model - Get create/update bank account model

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

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

journal_entries

• create - Create journal entry
• get_create_model - Get create journal entry model

journals

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

suppliers

• create - Create supplier
• get - Get supplier
• get_create_update_model - Get create/update supplier model
• list - List suppliers
• update - Update supplier

manage_data

• get - Get data status
• get_pull_operation - Get pull operation
• list_pull_operations - List pull operations
• refresh_all_data_types - Refresh all data
• refresh_data_type - Refresh data type

company_info

• get_accounting_profile - Get company accounting profile

payment_methods

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

tax_rates

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

tracking_categories

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

push_operations

• get - Get push operation
• list - List push operations

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 codatsyncpayables
from codatsyncpayables.models import shared
from codatsyncpayables.utils import BackoffStrategy, RetryConfig

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req,
    RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))

if res.company 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 codatsyncpayables
from codatsyncpayables.models import shared
from codatsyncpayables.utils import BackoffStrategy, RetryConfig

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req)

if res.company 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	400,401,402,403,429,500,503	application/json
errors.SDKError	400-600	/

Example

import codatsyncpayables
from codatsyncpayables.models import shared

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = None
try:
    res = s.companies.create(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.company 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 codatsyncpayables
from codatsyncpayables.models import shared

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req)

if res.company 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 codatsyncpayables
from codatsyncpayables.models import shared

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req)

if res.company 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 codatsyncpayables
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatsyncpayables.CodatSyncPayables(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 codatsyncpayables
from codatsyncpayables.models import shared

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

req = shared.CompanyRequestBody(
    description='Requested early access to the new financing scheme.',
    name='Bank of Dave',
)

res = s.companies.create(req)

if res.company 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