Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

procurify/codat-python-sdk

BranchesTags

Repository files navigation

swagger-client

What's changed in our Swagger

This Python package is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/procurify/codat-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/procurify/codat-python-sdk.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
connection_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
account_id = 'account_id_example' # str | 

try:
    api_response = api_instance.companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_get(company_id, connection_id, account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_get: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
connection_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
account_id = 'account_id_example' # str | 
body = swagger_client.CodatPublicApiModelsMetadataPatchSingleAccountCategoryModel() # CodatPublicApiModelsMetadataPatchSingleAccountCategoryModel |  (optional)

try:
    api_response = api_instance.companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_patch(company_id, connection_id, account_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_patch: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
connection_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
page = 1 # int |  (default to 1)
page_size = 100 # int |  (optional) (default to 100)
query = 'query_example' # str |  (optional)
order_by = 'order_by_example' # str |  (optional)

try:
    api_response = api_instance.companies_company_id_connections_connection_id_metadata_accounts_categories_get(company_id, connection_id, page, page_size=page_size, query=query, order_by=order_by)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_connections_connection_id_metadata_accounts_categories_get: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
connection_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = swagger_client.CodatPublicApiModelsMetadataPatchAccountCategoriesModel() # CodatPublicApiModelsMetadataPatchAccountCategoriesModel |  (optional)

try:
    api_response = api_instance.companies_company_id_connections_connection_id_metadata_accounts_categories_patch(company_id, connection_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_connections_connection_id_metadata_accounts_categories_patch: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
connection_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
body = swagger_client.CodatDataContractsDatasetsAccount() # CodatDataContractsDatasetsAccount |  (optional)
timeout_in_minutes = 56 # int |  (optional)

try:
    # Posts an individual account for a given company.
    api_response = api_instance.companies_company_id_connections_connection_id_push_accounts_post(company_id, connection_id, body=body, timeout_in_minutes=timeout_in_minutes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_connections_connection_id_push_accounts_post: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
account_id = 'account_id_example' # str | 

try:
    # Gets a single account corresponding to the supplied Id
    api_response = api_instance.companies_company_id_data_accounts_account_id_get(company_id, account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_data_accounts_account_id_get: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
company_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
page = 1 # int |  (default to 1)
page_size = 100 # int |  (optional) (default to 100)
query = 'query_example' # str |  (optional)
order_by = 'order_by_example' # str |  (optional)

try:
    # Gets the latest chart of accounts for a company
    api_response = api_instance.companies_company_id_data_accounts_get(company_id, page, page_size=page_size, query=query, order_by=order_by)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->companies_company_id_data_accounts_get: %s\n" % e)

# Configure API key authorization: API Key Auth
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))

try:
    api_response = api_instance.metadata_accounts_categories_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->metadata_accounts_categories_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
AccountsApi companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_get GET /companies/{companyId}/connections/{connectionId}/metadata/accounts/{accountId}/categories
AccountsApi companies_company_id_connections_connection_id_metadata_accounts_account_id_categories_patch PATCH /companies/{companyId}/connections/{connectionId}/metadata/accounts/{accountId}/categories
AccountsApi companies_company_id_connections_connection_id_metadata_accounts_categories_get GET /companies/{companyId}/connections/{connectionId}/metadata/accounts/categories
AccountsApi companies_company_id_connections_connection_id_metadata_accounts_categories_patch PATCH /companies/{companyId}/connections/{connectionId}/metadata/accounts/categories
AccountsApi companies_company_id_connections_connection_id_push_accounts_post POST /companies/{companyId}/connections/{connectionId}/push/accounts Posts an individual account for a given company.
AccountsApi companies_company_id_data_accounts_account_id_get GET /companies/{companyId}/data/accounts/{accountId} Gets a single account corresponding to the supplied Id
AccountsApi companies_company_id_data_accounts_get GET /companies/{companyId}/data/accounts Gets the latest chart of accounts for a company
AccountsApi metadata_accounts_categories_get GET /metadata/accounts/categories
BankAccountsApi companies_company_id_connections_connection_id_data_bank_accounts_account_id_bank_transactions_get GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions Gets bank transactions for a given bank account ID
BankAccountsApi companies_company_id_connections_connection_id_data_bank_accounts_account_id_get GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId} Gets the bank account with a given ID
BankAccountsApi companies_company_id_connections_connection_id_data_bank_accounts_get GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts Gets the list of bank accounts for a given connection
BankAccountsApi companies_company_id_connections_connection_id_options_bank_accounts_account_id_bank_transactions_get GET /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions Gets the options of pushing bank account transactions.
BankAccountsApi companies_company_id_connections_connection_id_push_bank_accounts_account_id_bank_transactions_post POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions Posts bank transactions to the accounting package for a given company.
BankAccountsApi companies_company_id_connections_connection_id_push_bank_accounts_post POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts Posts a new bank account to the accounting package for a given company.
BankAccountsApi companies_company_id_data_bank_accounts_account_id_get GET /companies/{companyId}/data/bankAccounts/{accountId} Gets the bank account for given account ID.
BankAccountsApi companies_company_id_data_bank_accounts_account_id_transactions_get GET /companies/{companyId}/data/bankAccounts/{accountId}/transactions Gets the latest bank transactions for given account ID and company.
BankStatementsApi companies_company_id_data_bank_statements_accounts_get GET /companies/{companyId}/data/bankStatements/accounts Gets the latest bank statements for a company, with pagination
BankStatementsApi companies_company_id_data_bank_statements_get GET /companies/{companyId}/data/bankStatements Gets the latest bank statements for a company, with pagination
BillCreditNotesApi companies_company_id_connections_connection_id_push_bill_credit_notes_post POST /companies/{companyId}/connections/{connectionId}/push/billCreditNotes Posts a new billCreditNote to the accounting package for a given company.
BillCreditNotesApi companies_company_id_data_bill_credit_notes_bill_credit_note_id_get GET /companies/{companyId}/data/billCreditNotes/{billCreditNoteId} Gets a single billCreditNote corresponding to the supplied Id
BillCreditNotesApi companies_company_id_data_bill_credit_notes_get GET /companies/{companyId}/data/billCreditNotes Gets a list of all bill credit notes for a company, with pagination
BillPaymentsApi companies_company_id_connections_connection_id_push_bill_payments_post POST /companies/{companyId}/connections/{connectionId}/push/billPayments Posts a new bill payment to the accounting package for a given company.
BillPaymentsApi companies_company_id_data_bill_payments_bill_payment_id_get GET /companies/{companyId}/data/billPayments/{billPaymentId}
BillPaymentsApi companies_company_id_data_bill_payments_get GET /companies/{companyId}/data/billPayments Gets the latest billPayments for a company, with pagination
BillsApi companies_company_id_connections_connection_id_data_bills_bill_id_attachments_attachment_id_download_get GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download
BillsApi companies_company_id_connections_connection_id_data_bills_bill_id_attachments_attachment_id_get GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}
BillsApi companies_company_id_connections_connection_id_data_bills_bill_id_attachments_get GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments
BillsApi companies_company_id_connections_connection_id_push_bills_bill_id_attachments_post POST /companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments
BillsApi companies_company_id_connections_connection_id_push_bills_bill_id_put PUT /companies/{companyId}/connections/{connectionId}/push/bills/{billId} Posts an updated bill to the accounting package for a given company.
BillsApi companies_company_id_connections_connection_id_push_bills_post POST /companies/{companyId}/connections/{connectionId}/push/bills Posts a new bill to the accounting package for a given company.
BillsApi companies_company_id_data_bills_bill_id_get GET /companies/{companyId}/data/bills/{billId}
BillsApi companies_company_id_data_bills_get GET /companies/{companyId}/data/bills Gets the latest bills for a company, with pagination
CommerceCustomersApi companies_company_id_connections_connection_id_data_commerce_customers_customer_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId} Gets the specified commerce customer for a given company
CommerceCustomersApi companies_company_id_connections_connection_id_data_commerce_customers_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers Gets the latest commerce customers for a company, with pagination
CommerceDisputesApi companies_company_id_connections_connection_id_data_commerce_disputes_dispute_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId} Gets the specified commerce dispute for a given company
CommerceDisputesApi companies_company_id_connections_connection_id_data_commerce_disputes_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes Gets the latest commerce disputes for a company, with pagination
CommerceInfoApi companies_company_id_connections_connection_id_data_commerce_info_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-info Gets the latest basic info for a commerce company.
CommerceOrdersApi companies_company_id_connections_connection_id_data_commerce_orders_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders Gets the latest commerce orders for a company, with pagination
CommerceOrdersApi companies_company_id_connections_connection_id_data_commerce_orders_order_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId} Gets the specified commerce order for a given company
CommercePaymentsApi companies_company_id_connections_connection_id_data_commerce_payments_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-payments Gets the latest commerce payments for a company, with pagination
CommercePaymentsApi companies_company_id_connections_connection_id_data_commerce_payments_payment_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId} Gets the specified commerce payment for a given company
CommerceProductsApi companies_company_id_connections_connection_id_data_commerce_products_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-products Gets the latest commerce products for a company, with pagination
CommerceProductsApi companies_company_id_connections_connection_id_data_commerce_products_product_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId} Gets the specified commerce product for a given company
CommerceTransactionsApi companies_company_id_connections_connection_id_data_commerce_transactions_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-transactions Gets the latest commerce transactions for a company, with pagination
CommerceTransactionsApi companies_company_id_connections_connection_id_data_commerce_transactions_transaction_id_get GET /companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId} Gets the specified commerce transaction for a given company
CompaniesApi companies_company_id_delete DELETE /companies/{companyId} Deletes a company, this is not reversible.
CompaniesApi companies_company_id_get GET /companies/{companyId} Fetch metadata on a single company.
CompaniesApi companies_company_id_put PUT /companies/{companyId} Update a company with a new name
CompaniesApi companies_company_id_settings_get GET /companies/{companyId}/settings Fetch settings on a single company.
CompaniesApi companies_company_id_settings_put PUT /companies/{companyId}/settings Update settings on a single company.
CompaniesApi companies_company_id_sync_settings_get GET /companies/{companyId}/syncSettings
CompaniesApi companies_company_id_sync_settings_post POST /companies/{companyId}/syncSettings
CompaniesApi companies_get GET /companies Fetch a list of all companies metadata with accounting links on the Codat platform
CompaniesApi companies_post POST /companies Initiate the process of onboarding a new company on the Codat platform
ConnectionApi companies_company_id_connections_connection_id_delete DELETE /companies/{companyId}/connections/{connectionId} Disconnect and delete a data source from a company
ConnectionApi companies_company_id_connections_connection_id_get GET /companies/{companyId}/connections/{connectionId} Retrieve a single data source connected to a single company, including its connection status
ConnectionApi companies_company_id_connections_connection_id_patch PATCH /companies/{companyId}/connections/{connectionId} Disconnect a data source from a company
ConnectionApi companies_company_id_connections_get GET /companies/{companyId}/connections Retrieve all data sources connected to a single company, including their connection statuses
ConnectionApi companies_company_id_connections_post POST /companies/{companyId}/connections Connect a data source to a company
CreditNotesApi companies_company_id_connections_connection_id_push_credit_notes_credit_note_id_put PUT /companies/{companyId}/connections/{connectionId}/push/creditNotes/{creditNoteId} Posts an updated credit note to the accounting package for a given company.
CreditNotesApi companies_company_id_connections_connection_id_push_credit_notes_post POST /companies/{companyId}/connections/{connectionId}/push/creditNotes
CreditNotesApi companies_company_id_data_credit_notes_credit_note_id_get GET /companies/{companyId}/data/creditNotes/{creditNoteId} Gets a single creditNote corresponding to the supplied Id
CreditNotesApi companies_company_id_data_credit_notes_get GET /companies/{companyId}/data/creditNotes Gets a list of all credit notes for a company, with pagination
CustomersApi companies_company_id_connections_connection_id_data_customers_customer_id_attachments_attachment_id_download_get GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download
CustomersApi companies_company_id_connections_connection_id_data_customers_customer_id_attachments_attachment_id_get GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}
CustomersApi companies_company_id_connections_connection_id_data_customers_customer_id_attachments_get GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments
CustomersApi companies_company_id_connections_connection_id_push_customers_customer_id_put PUT /companies/{companyId}/connections/{connectionId}/push/customers/{customerId} Posts an updated customer for a given company.
CustomersApi companies_company_id_connections_connection_id_push_customers_post POST /companies/{companyId}/connections/{connectionId}/push/customers Posts an individual customer for a given company.
CustomersApi companies_company_id_data_customers_customer_id_get GET /companies/{companyId}/data/customers/{customerId} Gets a single customer corresponding to the supplied Id
CustomersApi companies_company_id_data_customers_get GET /companies/{companyId}/data/customers Gets the latest customers for a company, with pagination
DataApi companies_company_id_data_all_post POST /companies/{companyId}/data/all Initiates the process of capturing a new data snapshot for a company
DataApi companies_company_id_data_history_dataset_id_get GET /companies/{companyId}/data/history/{datasetId} Fetch metadata on a single data synchronisation
DataApi companies_company_id_data_history_get GET /companies/{companyId}/data/history Fetch a list of all data snapshots captured for a company
DataApi companies_company_id_data_queue_data_type_post POST /companies/{companyId}/data/queue/{dataType} Initiates the process of capturing a data snapshot of a specified type for a company
DataStatusApi companies_company_id_data_status_get GET /companies/{companyId}/dataStatus
DataTypesApi companies_company_id_connections_connection_id_data_types_data_type_options_get GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options Gets all available push options for the given data type
DataTypesApi companies_company_id_connections_connection_id_data_types_data_type_options_post_get GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options/POST Gets the POST push options for the given data type
DataTypesApi companies_company_id_connections_connection_id_data_types_data_type_options_put_get GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options/PUT Gets the PUT push options for the given data type
DirectCostsApi companies_company_id_connections_connection_id_data_direct_costs_direct_cost_id_get GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId} Gets the specified direct cost for a given company.
DirectCostsApi companies_company_id_connections_connection_id_data_direct_costs_get GET /companies/{companyId}/connections/{connectionId}/data/directCosts Gets the direct costs for the company.
DirectCostsApi companies_company_id_connections_connection_id_push_direct_costs_post POST /companies/{companyId}/connections/{connectionId}/push/directCosts Posts a new direct cost to the accounting package for a given company.
DirectIncomesApi companies_company_id_connections_connection_id_data_direct_incomes_direct_income_id_get GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId} Gets the specified direct income for a given company and connection.
DirectIncomesApi companies_company_id_connections_connection_id_data_direct_incomes_get GET /companies/{companyId}/connections/{connectionId}/data/directIncomes Gets the direct incomes for a given company.
DirectIncomesApi companies_company_id_connections_connection_id_push_direct_incomes_post POST /companies/{companyId}/connections/{connectionId}/push/directIncomes Posts a new direct income to the accounting package for a given company.
FinancialsApi companies_company_id_data_financials_balance_sheet_get GET /companies/{companyId}/data/financials/balanceSheet Gets the latest balance sheet for a company.
FinancialsApi companies_company_id_data_financials_cash_flow_statement_get GET /companies/{companyId}/data/financials/cashFlowStatement Gets the latest balance sheet for a company.
FinancialsApi companies_company_id_data_financials_profit_and_loss_get GET /companies/{companyId}/data/financials/profitAndLoss Gets the latest profit and loss for a company.
InfoApi companies_company_id_data_info_get GET /companies/{companyId}/data/info Gets the latest basic info for a company.
InfoApi companies_company_id_data_info_post POST /companies/{companyId}/data/info Initiates the process of synchronising basic info for a company
IntegrationsApi integrations_bank_settings_get GET /integrations/bankSettings
IntegrationsApi integrations_bank_settings_put PUT /integrations/bankSettings
IntegrationsApi integrations_credentials_platform_key_delete DELETE /integrations/credentials/{platformKey} Delete credentials used to authenticate with an accounting platform
IntegrationsApi integrations_credentials_platform_key_get GET /integrations/credentials/{platformKey} Fetch credentials required to authenticate with an accounting platform.
IntegrationsApi integrations_credentials_platform_key_put PUT /integrations/credentials/{platformKey} Update credentials required to authenticate with an accounting platform
IntegrationsApi integrations_get GET /integrations
IntegrationsApi integrations_platform_key_branding_get GET /integrations/{platformKey}/branding
IntegrationsApi integrations_platform_key_enabled_put PUT /integrations/{platformKey}/enabled
IntegrationsApi integrations_platform_key_get GET /integrations/{platformKey}
InvoicesApi companies_company_id_connections_connection_id_data_invoices_invoice_id_attachments_attachment_id_download_get GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download
InvoicesApi companies_company_id_connections_connection_id_data_invoices_invoice_id_attachments_attachment_id_get GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}
InvoicesApi companies_company_id_connections_connection_id_data_invoices_invoice_id_attachments_get GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments
InvoicesApi companies_company_id_connections_connection_id_push_invoices_invoice_id_attachment_post POST /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}/attachment
InvoicesApi companies_company_id_connections_connection_id_push_invoices_invoice_id_put PUT /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId} Posts an updated invoice to the accounting package for a given company.
InvoicesApi companies_company_id_connections_connection_id_push_invoices_post POST /companies/{companyId}/connections/{connectionId}/push/invoices Posts a new invoice to the accounting package for a given company.
InvoicesApi companies_company_id_data_invoices_get GET /companies/{companyId}/data/invoices Gets the latest invoices for a company, with pagination
InvoicesApi companies_company_id_data_invoices_invoice_id_get GET /companies/{companyId}/data/invoices/{invoiceId}
InvoicesApi companies_company_id_data_invoices_invoice_id_pdf_get GET /companies/{companyId}/data/invoices/{invoiceId}/pdf
ItemsApi companies_company_id_connections_connection_id_push_items_post POST /companies/{companyId}/connections/{connectionId}/push/items Posts a new item to the accounting package for a given company.
ItemsApi companies_company_id_data_items_get GET /companies/{companyId}/data/items Gets the items for a given company.
ItemsApi companies_company_id_data_items_item_id_get GET /companies/{companyId}/data/items/{itemId} Gets the specified item for a given company.
JournalsApi companies_company_id_connections_connection_id_push_journal_entries_post POST /companies/{companyId}/connections/{connectionId}/push/journalEntries Posts a new journalEntry to the accounting package for a given company.
JournalsApi companies_company_id_data_journal_entries_get GET /companies/{companyId}/data/journalEntries Gets the latest journal entries for a company, with pagination
JournalsApi companies_company_id_data_journal_entries_journal_entry_id_get GET /companies/{companyId}/data/journalEntries/{journalEntryId} Gets a single JournalEntry corresponding to the supplied Id
MetricsApi metrics_companies_get GET /metrics/companies
PaymentsApi companies_company_id_connections_connection_id_push_payments_post POST /companies/{companyId}/connections/{connectionId}/push/payments Posts a new payment to the accounting package for a given company.
PaymentsApi companies_company_id_data_payments_get GET /companies/{companyId}/data/payments Gets the latest payments for a company, with pagination
PaymentsApi companies_company_id_data_payments_payment_id_get GET /companies/{companyId}/data/payments/{paymentId}
ProfileApi profile_api_key_put PUT /profile/apiKey Refresh the existing API key for your clients.
ProfileApi profile_get GET /profile Fetch your organisations company profile
ProfileApi profile_put PUT /profile Update your organisations company profile
ProfileApi profile_sync_settings_get GET /profile/syncSettings
ProfileApi profile_sync_settings_post POST /profile/syncSettings
PurchaseOrdersApi companies_company_id_connections_connection_id_push_purchase_orders_post POST /companies/{companyId}/connections/{connectionId}/push/purchaseOrders Posts a new purchase order to the accounting package for a given company.
PurchaseOrdersApi companies_company_id_connections_connection_id_push_purchase_orders_purchase_order_id_put PUT /companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId} Posts an updated purchase order to the accounting package for a given company.
PurchaseOrdersApi companies_company_id_data_purchase_orders_get GET /companies/{companyId}/data/purchaseOrders
PurchaseOrdersApi companies_company_id_data_purchase_orders_purchase_order_id_get GET /companies/{companyId}/data/purchaseOrders/{purchaseOrderId}
PushApi companies_company_id_connections_connection_id_options_data_type_get GET /companies/{companyId}/connections/{connectionId}/options/{dataType} Gets the push options for the given data type
PushApi companies_company_id_push_get GET /companies/{companyId}/push Gets paged push operation records
PushApi companies_company_id_push_push_operation_key_get GET /companies/{companyId}/push/{pushOperationKey} Gets a single push operation record
ReportsApi companies_company_id_reports_aged_creditor_available_get GET /companies/{companyId}/reports/agedCreditor/available
ReportsApi companies_company_id_reports_aged_creditor_get GET /companies/{companyId}/reports/agedCreditor Gets the aged creditor report for a company.
ReportsApi companies_company_id_reports_aged_debtor_available_get GET /companies/{companyId}/reports/agedDebtor/available
ReportsApi companies_company_id_reports_aged_debtor_get GET /companies/{companyId}/reports/agedDebtor Gets the aged debtor report for a company.
ReportsApi companies_company_id_reports_events_get GET /companies/{companyId}/reports/events
RulesApi rules_alerts_alert_id_get GET /rules/alerts/{alertId}
RulesApi rules_alerts_alert_id_resolve_post POST /rules/alerts/{alertId}/resolve
RulesApi rules_alerts_get GET /rules/alerts
RulesApi rules_get GET /rules Fetch a list of rules a company is subscribed to
RulesApi rules_post POST /rules Subscribe to a rule
RulesApi rules_rule_id_alerts_get GET /rules/{ruleId}/alerts
RulesApi rules_rule_id_delete DELETE /rules/{ruleId}
RulesApi rules_rule_id_get GET /rules/{ruleId}
RulesApi rules_rule_id_put PUT /rules/{ruleId}
SettingsApi settings_get GET /settings Fetch your settings
SettingsApi settings_integrations_integration_id_get GET /settings/integrations/{integrationId} Fetch your organisations integration settings
SettingsApi settings_integrations_integration_id_patch PATCH /settings/integrations/{integrationId} Update your organisations integration settings
SettingsApi settings_patch PATCH /settings Update your settings
SuppliersApi companies_company_id_connections_connection_id_data_suppliers_supplier_id_attachments_attachment_id_download_get GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download
SuppliersApi companies_company_id_connections_connection_id_data_suppliers_supplier_id_attachments_attachment_id_get GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}
SuppliersApi companies_company_id_connections_connection_id_data_suppliers_supplier_id_attachments_get GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments
SuppliersApi companies_company_id_connections_connection_id_push_suppliers_post POST /companies/{companyId}/connections/{connectionId}/push/suppliers
SuppliersApi companies_company_id_data_suppliers_get GET /companies/{companyId}/data/suppliers Gets the latest suppliers for a company, with pagination
SuppliersApi companies_company_id_data_suppliers_supplier_id_get GET /companies/{companyId}/data/suppliers/{supplierId} Gets a single supplier corresponding to the supplied Id
TaxRatesApi companies_company_id_data_tax_rates_get GET /companies/{companyId}/data/taxRates Gets the latest tax rates for a given company.
TaxRatesApi companies_company_id_data_tax_rates_tax_rate_id_get GET /companies/{companyId}/data/taxRates/{taxRateId} Gets the specified tax rate for a given company.
TrackingCategoriesApi companies_company_id_data_tracking_categories_get GET /companies/{companyId}/data/trackingCategories Gets the latest tracking categories for a given company.
TrackingCategoriesApi companies_company_id_data_tracking_categories_tracking_category_id_get GET /companies/{companyId}/data/trackingCategories/{trackingCategoryId} Gets the specified tracking categories for a given company.
TransfersApi companies_company_id_connections_connection_id_data_transfers_get GET /companies/{companyId}/connections/{connectionId}/data/transfers Gets the transfers for a given company.
TransfersApi companies_company_id_connections_connection_id_data_transfers_transfer_id_get GET /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId} Gets the specified transfer for a given company.
TransfersApi companies_company_id_connections_connection_id_push_transfers_post POST /companies/{companyId}/connections/{connectionId}/push/transfers Posts a new transfer to the accounting package for a given company.

Documentation For Models

Documentation For Authorization

API Key Auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

18 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages