Sync for Commerce version 1

Embedded accounting integrations for POS and eCommerce platforms.

SDK Installation

pip install codat-sync-for-commerce-version-1

Example Usage

import codatsynccommerce
from codatsynccommerce.models import operations, shared
from decimal import Decimal

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

req = operations.CreateAccountingAccountRequest(
    accounting_account=shared.AccountingAccount(
        currency='GBP',
        current_balance=Decimal('0'),
        description='Invoices the business has issued but has not yet collected payment on.',
        fully_qualified_category='Asset.Current',
        fully_qualified_name='Cash On Hand',
        id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e',
        metadata=shared.AccountingAccountMetadata(),
        modified_date='2022-10-23T00:00:00.000Z',
        name='Accounts Receivable',
        nominal_code='610',
        source_modified_date='2022-10-23T00:00:00.000Z',
        status=shared.AccountStatus.ACTIVE,
        supplemental_data=shared.SupplementalData(
            content={
                "Gasoline": {
                    "Wall": 'Oriental',
                },
            },
        ),
        type=shared.AccountType.ASSET,
        valid_datatype_links=[
            shared.AccountingAccountValidDataTypeLinks(
                links=[
                    'Intranet',
                ],
            ),
        ],
    ),
    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)

res = s.accounting_accounts.create_accounting_account(req)

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

Available Resources and Operations

accounting_accounts

• create_accounting_account - Create account
• get_accounting_account - Get account
• list_accounting_accounts - List accounts

accounting_bank_accounts

• get_accounting_bank_account - Get bank account
• list_accounting_bank_accounts - List bank accounts

accounting_company_info

• get_accounting_company_info - Get company info
• refresh - Refresh company info

accounting_credit_notes

• create_accounting_credit_note - Create credit note

accounting_customers

• create_accounting_customer - Create customer

accounting_direct_incomes

• create_accounting_direct_income - Create direct income

accounting_invoices

• create_accounting_invoice - Create invoice

accounting_journal_entries

• create_accounting_journal_entry - Create journal entry

accounting_payments

• create_accounting_payment - Create payment

commerce_company_info

• get_commerce_company_info - Get company info

commerce_customers

• get_commerce_customer - Get customer
• list_commerce_customers - List customers

commerce_locations

• get_commerce_location - Get location
• list_commerce_locations - List locations

commerce_orders

• get_commerce_order - Get order
• list_commerce_orders - List orders

commerce_payments

• get_commerce_payment - Get payment
• get_method - Get payment method
• list_commerce_payments - List payments
• list_methods - List payment methods

commerce_products

• get_commerce_product - Get product
• list_commerce_products - List products

commerce_transactions

• get_commerce_transaction - Get transaction
• list_commerce_transactions - List transactions

companies

• delete_company - Delete a company
• get_company - Get company
• update_company - Update company

company_management

• create_company - Create sync for commerce company
• create_connection - Create connection
• list_companies - List companies
• list_connections - List data connections
• update_connection - Update data connection

configuration

• get_configuration - Retrieve config preferences set for a company
• set_configuration - Create or update configuration

connections

• delete_connection - Delete connection
• get_connection - Get connection
• unlink - Unlink connection

integrations

• get_integration_branding - Get branding for an integration
• list_integrations - List integrations

push_data

• get_operation - Get push operation
• list_operations - List push operations

refresh_data

• all - Refresh all data
• by_data_type - Refresh data type
• get_company_data_status - Get data status
• get_pull_operation - Get pull operation
• list_pull_operations - List pull operations

sync

• get_sync_status - Get status for a company's syncs
• request_sync - Sync new
• request_sync_for_date_range - Sync range

sync_flow_preferences

• get_config_text_sync_flow - Retrieve preferences for text fields on sync flow
• get_sync_flow_url - Retrieve sync flow url
• get_visible_accounts - List visible accounts
• update_config_text_sync_flow - Update preferences for text fields on sync flow
• update_visible_accounts_sync_flow - Update the visible accounts on sync flow

Library generated by Speakeasy