diff --git a/lending/README.md b/lending/README.md index 4de23ef39..0bdcd6cd4 100644 --- a/lending/README.md +++ b/lending/README.md @@ -14,8 +14,6 @@ pip install codat-lending ## Example Usage - - ```python import codatlending from codatlending.models import operations, shared @@ -27,19 +25,19 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBankAccountTransactionsRequest( - account_id='corrupti', + account_id='Anchorage Product', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', order_by='-modifiedDate', page=1, page_size=100, - query='provident', ) res = s.accounting_bank_data.list_transactions(req) if res.accounting_bank_transactions is not None: # handle response + pass ``` @@ -47,16 +45,16 @@ if res.accounting_bank_transactions is not None: ## Available Resources and Operations -### [AccountingBankData](docs/sdks/accountingbankdata/README.md) +### [accounting_bank_data](docs/sdks/accountingbankdata/README.md) * [list_transactions](docs/sdks/accountingbankdata/README.md#list_transactions) - List bank account transactions -### [AccountingBankData.Accounts](docs/sdks/accountingbankdataaccounts/README.md) +### [accounting_bank_data.accounts](docs/sdks/accountingbankdataaccounts/README.md) * [get](docs/sdks/accountingbankdataaccounts/README.md#get) - Get bank account * [list](docs/sdks/accountingbankdataaccounts/README.md#list) - List bank accounts -### [Companies](docs/sdks/companies/README.md) +### [companies](docs/sdks/companies/README.md) * [create](docs/sdks/companies/README.md#create) - Create company * [delete](docs/sdks/companies/README.md#delete) - Delete a company @@ -64,12 +62,12 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/companies/README.md#list) - List companies * [update](docs/sdks/companies/README.md#update) - Update company -### [CompanyInfo](docs/sdks/companyinfo/README.md) +### [company_info](docs/sdks/companyinfo/README.md) * [get_accounting_profile](docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile * [get_commerce_profile](docs/sdks/companyinfo/README.md#get_commerce_profile) - Get company commerce profile -### [Connections](docs/sdks/connections/README.md) +### [connections](docs/sdks/connections/README.md) * [create](docs/sdks/connections/README.md#create) - Create connection * [delete](docs/sdks/connections/README.md#delete) - Delete connection @@ -77,41 +75,43 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/connections/README.md#list) - List connections * [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection -### [DataIntegrity](docs/sdks/dataintegrity/README.md) +### [data_integrity](docs/sdks/dataintegrity/README.md) * [details](docs/sdks/dataintegrity/README.md#details) - List data integrity details * [status](docs/sdks/dataintegrity/README.md#status) - Get data integrity status * [summaries](docs/sdks/dataintegrity/README.md#summaries) - Get data integrity summaries -### [ExcelReports](docs/sdks/excelreports/README.md) +### [excel_reports](docs/sdks/excelreports/README.md) * [download](docs/sdks/excelreports/README.md#download) - Download Excel report * [generate](docs/sdks/excelreports/README.md#generate) - Generate Excel report * [get_status](docs/sdks/excelreports/README.md#get_status) - Get Excel report status -### [FileUpload](docs/sdks/fileupload/README.md) +### [file_upload](docs/sdks/fileupload/README.md) * [download](docs/sdks/fileupload/README.md#download) - Download all files for a company * [list_uploaded](docs/sdks/fileupload/README.md#list_uploaded) - List all files uploaded by a company * [upload](docs/sdks/fileupload/README.md#upload) - Upload files for a company -### [Liabilities](docs/sdks/liabilities/README.md) +### [liabilities](docs/sdks/liabilities/README.md) +* [generate_loan_summary](docs/sdks/liabilities/README.md#generate_loan_summary) - Generate loan summaries report +* [generate_loan_transactions](docs/sdks/liabilities/README.md#generate_loan_transactions) - Generate loan transactions report * [get_loan_summary](docs/sdks/liabilities/README.md#get_loan_summary) - Get loan summaries * [list_loan_transactions](docs/sdks/liabilities/README.md#list_loan_transactions) - List loan transactions -### [AccountsPayable.BillCreditNotes](docs/sdks/accountspayablebillcreditnotes/README.md) +### [accounts_payable.bill_credit_notes](docs/sdks/accountspayablebillcreditnotes/README.md) * [get](docs/sdks/accountspayablebillcreditnotes/README.md#get) - Get bill credit note * [list](docs/sdks/accountspayablebillcreditnotes/README.md#list) - List bill credit notes -### [AccountsPayable.BillPayments](docs/sdks/accountspayablebillpayments/README.md) +### [accounts_payable.bill_payments](docs/sdks/accountspayablebillpayments/README.md) * [get](docs/sdks/accountspayablebillpayments/README.md#get) - Get bill payment * [list](docs/sdks/accountspayablebillpayments/README.md#list) - List bill payments -### [AccountsPayable.Bills](docs/sdks/accountspayablebills/README.md) +### [accounts_payable.bills](docs/sdks/accountspayablebills/README.md) * [download_attachment](docs/sdks/accountspayablebills/README.md#download_attachment) - Download bill attachment * [get](docs/sdks/accountspayablebills/README.md#get) - Get bill @@ -119,7 +119,7 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/accountspayablebills/README.md#list) - List bills * [list_attachments](docs/sdks/accountspayablebills/README.md#list_attachments) - List bill attachments -### [AccountsPayable.Suppliers](docs/sdks/accountspayablesuppliers/README.md) +### [accounts_payable.suppliers](docs/sdks/accountspayablesuppliers/README.md) * [download_attachment](docs/sdks/accountspayablesuppliers/README.md#download_attachment) - Download supplier attachment * [get](docs/sdks/accountspayablesuppliers/README.md#get) - Get supplier @@ -128,12 +128,12 @@ if res.accounting_bank_transactions is not None: * [list_attachments](docs/sdks/accountspayablesuppliers/README.md#list_attachments) - List supplier attachments -### [AccountsReceivable.CreditNotes](docs/sdks/accountsreceivablecreditnotes/README.md) +### [accounts_receivable.credit_notes](docs/sdks/accountsreceivablecreditnotes/README.md) * [get](docs/sdks/accountsreceivablecreditnotes/README.md#get) - Get credit note * [list](docs/sdks/accountsreceivablecreditnotes/README.md#list) - List credit notes -### [AccountsReceivable.Customers](docs/sdks/accountsreceivablecustomers/README.md) +### [accounts_receivable.customers](docs/sdks/accountsreceivablecustomers/README.md) * [download_attachment](docs/sdks/accountsreceivablecustomers/README.md#download_attachment) - Download customer attachment * [get](docs/sdks/accountsreceivablecustomers/README.md#get) - Get customer @@ -141,7 +141,7 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/accountsreceivablecustomers/README.md#list) - List customers * [list_attachments](docs/sdks/accountsreceivablecustomers/README.md#list_attachments) - List customer attachments -### [AccountsReceivable.DirectIncomes](docs/sdks/accountsreceivabledirectincomes/README.md) +### [accounts_receivable.direct_incomes](docs/sdks/accountsreceivabledirectincomes/README.md) * [download_attachment](docs/sdks/accountsreceivabledirectincomes/README.md#download_attachment) - Download direct income attachment * [get](docs/sdks/accountsreceivabledirectincomes/README.md#get) - Get direct income @@ -149,7 +149,7 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/accountsreceivabledirectincomes/README.md#list) - List direct incomes * [list_attachments](docs/sdks/accountsreceivabledirectincomes/README.md#list_attachments) - List direct income attachments -### [AccountsReceivable.Invoices](docs/sdks/accountsreceivableinvoices/README.md) +### [accounts_receivable.invoices](docs/sdks/accountsreceivableinvoices/README.md) * [download_attachment](docs/sdks/accountsreceivableinvoices/README.md#download_attachment) - Download invoice attachment * [download_pdf](docs/sdks/accountsreceivableinvoices/README.md#download_pdf) - Get invoice as PDF @@ -159,12 +159,12 @@ if res.accounting_bank_transactions is not None: * [list_attachments](docs/sdks/accountsreceivableinvoices/README.md#list_attachments) - List invoice attachments * [list_reconciled](docs/sdks/accountsreceivableinvoices/README.md#list_reconciled) - List reconciled invoices -### [AccountsReceivable.Payments](docs/sdks/accountsreceivablepayments/README.md) +### [accounts_receivable.payments](docs/sdks/accountsreceivablepayments/README.md) * [get](docs/sdks/accountsreceivablepayments/README.md#get) - Get payment * [list](docs/sdks/accountsreceivablepayments/README.md#list) - List payments -### [AccountsReceivable.Reports](docs/sdks/accountsreceivablereports/README.md) +### [accounts_receivable.reports](docs/sdks/accountsreceivablereports/README.md) * [get_aged_creditors](docs/sdks/accountsreceivablereports/README.md#get_aged_creditors) - Aged creditors report * [get_aged_debtors](docs/sdks/accountsreceivablereports/README.md#get_aged_debtors) - Aged debtors report @@ -172,163 +172,163 @@ if res.accounting_bank_transactions is not None: * [is_aged_debtors_available](docs/sdks/accountsreceivablereports/README.md#is_aged_debtors_available) - Aged debtors report available -### [Banking.AccountBalances](docs/sdks/bankingaccountbalances/README.md) +### [banking.account_balances](docs/sdks/bankingaccountbalances/README.md) * [list](docs/sdks/bankingaccountbalances/README.md#list) - List account balances -### [Banking.Accounts](docs/sdks/bankingaccounts/README.md) +### [banking.accounts](docs/sdks/bankingaccounts/README.md) * [get](docs/sdks/bankingaccounts/README.md#get) - Get account * [list](docs/sdks/bankingaccounts/README.md#list) - List accounts -### [Banking.CategorizedStatement](docs/sdks/bankingcategorizedstatement/README.md) +### [banking.categorized_statement](docs/sdks/bankingcategorizedstatement/README.md) * [get](docs/sdks/bankingcategorizedstatement/README.md#get) - Get categorized bank statement -### [Banking.TransactionCategories](docs/sdks/bankingtransactioncategories/README.md) +### [banking.transaction_categories](docs/sdks/bankingtransactioncategories/README.md) * [get](docs/sdks/bankingtransactioncategories/README.md#get) - Get transaction category * [list](docs/sdks/bankingtransactioncategories/README.md#list) - List transaction categories -### [Banking.Transactions](docs/sdks/bankingtransactions/README.md) +### [banking.transactions](docs/sdks/bankingtransactions/README.md) * [get](docs/sdks/bankingtransactions/README.md#get) - Get bank transaction * [list](docs/sdks/bankingtransactions/README.md#list) - List transactions -### [FinancialStatements.Accounts](docs/sdks/financialstatementsaccounts/README.md) +### [financial_statements.accounts](docs/sdks/financialstatementsaccounts/README.md) * [get](docs/sdks/financialstatementsaccounts/README.md#get) - Get account * [list](docs/sdks/financialstatementsaccounts/README.md#list) - List accounts -### [FinancialStatements.BalanceSheet](docs/sdks/financialstatementsbalancesheet/README.md) +### [financial_statements.balance_sheet](docs/sdks/financialstatementsbalancesheet/README.md) * [get](docs/sdks/financialstatementsbalancesheet/README.md#get) - Get balance sheet * [get_categorized_accounts](docs/sdks/financialstatementsbalancesheet/README.md#get_categorized_accounts) - Get categorized balance sheet statement -### [FinancialStatements.CashFlow](docs/sdks/financialstatementscashflow/README.md) +### [financial_statements.cash_flow](docs/sdks/financialstatementscashflow/README.md) * [get](docs/sdks/financialstatementscashflow/README.md#get) - Get cash flow statement -### [FinancialStatements.ProfitAndLoss](docs/sdks/financialstatementsprofitandloss/README.md) +### [financial_statements.profit_and_loss](docs/sdks/financialstatementsprofitandloss/README.md) * [get](docs/sdks/financialstatementsprofitandloss/README.md#get) - Get profit and loss * [get_categorized_accounts](docs/sdks/financialstatementsprofitandloss/README.md#get_categorized_accounts) - Get categorized profit and loss statement -### [LoanWriteback.Accounts](docs/sdks/loanwritebackaccounts/README.md) +### [loan_writeback.accounts](docs/sdks/loanwritebackaccounts/README.md) * [create](docs/sdks/loanwritebackaccounts/README.md#create) - Create account * [get_create_model](docs/sdks/loanwritebackaccounts/README.md#get_create_model) - Get create account model -### [LoanWriteback.BankAccounts](docs/sdks/loanwritebackbankaccounts/README.md) - -* [create](docs/sdks/loanwritebackbankaccounts/README.md#create) - Create bank account -* [get_create_update_model](docs/sdks/loanwritebackbankaccounts/README.md#get_create_update_model) - Get create/update bank account model - -### [LoanWriteback.BankTransactions](docs/sdks/loanwritebackbanktransactions/README.md) +### [loan_writeback.bank_transactions](docs/sdks/loanwritebackbanktransactions/README.md) * [create](docs/sdks/loanwritebackbanktransactions/README.md#create) - Create bank account transactions * [get_create_model](docs/sdks/loanwritebackbanktransactions/README.md#get_create_model) - Get create bank account transactions model -### [LoanWriteback.CreateOperations](docs/sdks/loanwritebackcreateoperations/README.md) +### [loan_writeback.create_operations](docs/sdks/loanwritebackcreateoperations/README.md) * [get](docs/sdks/loanwritebackcreateoperations/README.md#get) - Get create operation * [list](docs/sdks/loanwritebackcreateoperations/README.md#list) - List create operations -### [LoanWriteback.DirectCosts](docs/sdks/loanwritebackdirectcosts/README.md) +### [loan_writeback.direct_costs](docs/sdks/loanwritebackdirectcosts/README.md) * [create](docs/sdks/loanwritebackdirectcosts/README.md#create) - Create direct cost * [get_create_model](docs/sdks/loanwritebackdirectcosts/README.md#get_create_model) - Get create direct cost model -### [LoanWriteback.Suppliers](docs/sdks/loanwritebacksuppliers/README.md) +### [loan_writeback.payments](docs/sdks/loanwritebackpayments/README.md) + +* [create](docs/sdks/loanwritebackpayments/README.md#create) - Create payment +* [get_create_model](docs/sdks/loanwritebackpayments/README.md#get_create_model) - Get create payment model + +### [loan_writeback.suppliers](docs/sdks/loanwritebacksuppliers/README.md) * [create](docs/sdks/loanwritebacksuppliers/README.md#create) - Create supplier * [get_create_update_model](docs/sdks/loanwritebacksuppliers/README.md#get_create_update_model) - Get create/update supplier model -### [LoanWriteback.Transfers](docs/sdks/loanwritebacktransfers/README.md) +### [loan_writeback.transfers](docs/sdks/loanwritebacktransfers/README.md) * [create](docs/sdks/loanwritebacktransfers/README.md#create) - Create transfer * [get_create_model](docs/sdks/loanwritebacktransfers/README.md#get_create_model) - Get create transfer model -### [ManageData](docs/sdks/managedata/README.md) +### [manage_data](docs/sdks/managedata/README.md) * [get_status](docs/sdks/managedata/README.md#get_status) - Get data status -### [ManageData.PullOperations](docs/sdks/managedatapulloperations/README.md) +### [manage_data.pull_operations](docs/sdks/managedatapulloperations/README.md) * [get](docs/sdks/managedatapulloperations/README.md#get) - Get pull operation * [list](docs/sdks/managedatapulloperations/README.md#list) - List pull operations -### [ManageData.Refresh](docs/sdks/managedatarefresh/README.md) +### [manage_data.refresh](docs/sdks/managedatarefresh/README.md) * [all_data_types](docs/sdks/managedatarefresh/README.md#all_data_types) - Refresh all data * [data_type](docs/sdks/managedatarefresh/README.md#data_type) - Refresh data type -### [Sales.Customers](docs/sdks/salescustomers/README.md) +### [sales.customers](docs/sdks/salescustomers/README.md) * [get](docs/sdks/salescustomers/README.md#get) - Get customer * [list](docs/sdks/salescustomers/README.md#list) - List customers -### [Sales.Disputes](docs/sdks/salesdisputes/README.md) +### [sales.disputes](docs/sdks/salesdisputes/README.md) * [get](docs/sdks/salesdisputes/README.md#get) - Get dispute * [list](docs/sdks/salesdisputes/README.md#list) - List disputes -### [Sales.Locations](docs/sdks/saleslocations/README.md) +### [sales.locations](docs/sdks/saleslocations/README.md) * [get](docs/sdks/saleslocations/README.md#get) - Get location * [list](docs/sdks/saleslocations/README.md#list) - List locations -### [Sales.Metrics](docs/sdks/salesmetrics/README.md) +### [sales.metrics](docs/sdks/salesmetrics/README.md) * [get_customer_retention](docs/sdks/salesmetrics/README.md#get_customer_retention) - Get customer retention metrics * [get_lifetime_value](docs/sdks/salesmetrics/README.md#get_lifetime_value) - Get lifetime value metrics * [get_revenue](docs/sdks/salesmetrics/README.md#get_revenue) - Get commerce revenue metrics -### [Sales.Orders](docs/sdks/salesorders/README.md) +### [sales.orders](docs/sdks/salesorders/README.md) * [get](docs/sdks/salesorders/README.md#get) - Get order * [list](docs/sdks/salesorders/README.md#list) - List orders -### [Sales.PaymentMethods](docs/sdks/salespaymentmethods/README.md) +### [sales.payment_methods](docs/sdks/salespaymentmethods/README.md) * [get](docs/sdks/salespaymentmethods/README.md#get) - Get payment method * [list](docs/sdks/salespaymentmethods/README.md#list) - List payment methods -### [Sales.Payments](docs/sdks/salespayments/README.md) +### [sales.payments](docs/sdks/salespayments/README.md) * [get](docs/sdks/salespayments/README.md#get) - Get payment * [list](docs/sdks/salespayments/README.md#list) - List payments -### [Sales.ProductCategories](docs/sdks/salesproductcategories/README.md) +### [sales.product_categories](docs/sdks/salesproductcategories/README.md) * [get](docs/sdks/salesproductcategories/README.md#get) - Get product category * [list](docs/sdks/salesproductcategories/README.md#list) - List product categories -### [Sales.Products](docs/sdks/salesproducts/README.md) +### [sales.products](docs/sdks/salesproducts/README.md) * [get](docs/sdks/salesproducts/README.md#get) - Get product * [list](docs/sdks/salesproducts/README.md#list) - List products -### [Sales.Reports](docs/sdks/salesreports/README.md) +### [sales.reports](docs/sdks/salesreports/README.md) * [get_orders](docs/sdks/salesreports/README.md#get_orders) - Get orders report * [get_refunds](docs/sdks/salesreports/README.md#get_refunds) - Get refunds report -### [Sales.Transactions](docs/sdks/salestransactions/README.md) +### [sales.transactions](docs/sdks/salestransactions/README.md) * [get](docs/sdks/salestransactions/README.md#get) - Get transaction * [list](docs/sdks/salestransactions/README.md#list) - List transactions -### [Transactions.AccountTransactions](docs/sdks/transactionsaccounttransactions/README.md) +### [transactions.account_transactions](docs/sdks/transactionsaccounttransactions/README.md) * [get](docs/sdks/transactionsaccounttransactions/README.md#get) - Get account transaction * [list](docs/sdks/transactionsaccounttransactions/README.md#list) - List account transactions -### [Transactions.DirectCosts](docs/sdks/transactionsdirectcosts/README.md) +### [transactions.direct_costs](docs/sdks/transactionsdirectcosts/README.md) * [download_attachment](docs/sdks/transactionsdirectcosts/README.md#download_attachment) - Download direct cost attachment * [get](docs/sdks/transactionsdirectcosts/README.md#get) - Get direct cost @@ -336,19 +336,31 @@ if res.accounting_bank_transactions is not None: * [list](docs/sdks/transactionsdirectcosts/README.md#list) - List direct costs * [list_attachments](docs/sdks/transactionsdirectcosts/README.md#list_attachments) - List direct cost attachments -### [Transactions.JournalEntries](docs/sdks/transactionsjournalentries/README.md) +### [transactions.journal_entries](docs/sdks/transactionsjournalentries/README.md) * [get](docs/sdks/transactionsjournalentries/README.md#get) - Get journal entry * [list](docs/sdks/transactionsjournalentries/README.md#list) - List journal entries -### [Transactions.Journals](docs/sdks/transactionsjournals/README.md) +### [transactions.journals](docs/sdks/transactionsjournals/README.md) * [get](docs/sdks/transactionsjournals/README.md#get) - Get journal * [list](docs/sdks/transactionsjournals/README.md#list) - List journals -### [Transactions.Transfers](docs/sdks/transactionstransfers/README.md) +### [transactions.transfers](docs/sdks/transactionstransfers/README.md) * [get](docs/sdks/transactionstransfers/README.md#get) - Get transfer * [list](docs/sdks/transactionstransfers/README.md#list) - List transfers + + + + + + + + + + + + ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) \ No newline at end of file diff --git a/lending/RELEASES.md b/lending/RELEASES.md index 89b7b73e8..2b68547b5 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -48,4 +48,14 @@ Based on: ### Generated - [python v4.2.0] lending ### Releases -- [PyPI v4.2.0] https://pypi.org/project/codat-lending/4.2.0 - lending \ No newline at end of file +- [PyPI v4.2.0] https://pypi.org/project/codat-lending/4.2.0 - lending + +## 2023-10-17 14:48:44 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Lending.yaml +- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v5.0.0] lending +### Releases +- [PyPI v5.0.0] https://pypi.org/project/codat-lending/5.0.0 - lending \ No newline at end of file diff --git a/lending/USAGE.md b/lending/USAGE.md index ffaded713..0399dc88b 100755 --- a/lending/USAGE.md +++ b/lending/USAGE.md @@ -12,18 +12,18 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBankAccountTransactionsRequest( - account_id='corrupti', + account_id='Anchorage Product', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', order_by='-modifiedDate', page=1, page_size=100, - query='provident', ) res = s.accounting_bank_data.list_transactions(req) if res.accounting_bank_transactions is not None: # handle response + pass ``` \ No newline at end of file diff --git a/lending/docs/models/operations/createaccountrequest.md b/lending/docs/models/operations/createaccountrequest.md index 91d3bb8f0..49447fd16 100755 --- a/lending/docs/models/operations/createaccountrequest.md +++ b/lending/docs/models/operations/createaccountrequest.md @@ -3,11 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | N/A | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | N/A | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createaccountresponse.md b/lending/docs/models/operations/createaccountresponse.md index fa1611a2e..6054a88d3 100755 --- a/lending/docs/models/operations/createaccountresponse.md +++ b/lending/docs/models/operations/createaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `accounting_create_account_response` | [Optional[shared.AccountingCreateAccountResponse]](../../models/shared/accountingcreateaccountresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createbankaccountrequest.md b/lending/docs/models/operations/createbankaccountrequest.md deleted file mode 100755 index cae78137d..000000000 --- a/lending/docs/models/operations/createbankaccountrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateBankAccountRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_bank_account` | [Optional[shared.AccountingBankAccount]](../../models/shared/accountingbankaccount.md) | :heavy_minus_sign: | N/A | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/operations/createbankaccountresponse.md b/lending/docs/models/operations/createbankaccountresponse.md deleted file mode 100755 index 6f67bafb6..000000000 --- a/lending/docs/models/operations/createbankaccountresponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateBankAccountResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `accounting_create_bank_account_response` | [Optional[shared.AccountingCreateBankAccountResponse]](../../models/shared/accountingcreatebankaccountresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/operations/createbanktransactionsrequest.md b/lending/docs/models/operations/createbanktransactionsrequest.md index 4f167c028..435667f7e 100755 --- a/lending/docs/models/operations/createbanktransactionsrequest.md +++ b/lending/docs/models/operations/createbanktransactionsrequest.md @@ -3,12 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_create_bank_transactions` | [Optional[shared.AccountingCreateBankTransactions]](../../models/shared/accountingcreatebanktransactions.md) | :heavy_minus_sign: | N/A | | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `accounting_create_bank_transactions` | [Optional[shared.AccountingCreateBankTransactions]](../../models/shared/accountingcreatebanktransactions.md) | :heavy_minus_sign: | N/A | | +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createbanktransactionsresponse.md b/lending/docs/models/operations/createbanktransactionsresponse.md index 42d7c6da7..380f2afe2 100755 --- a/lending/docs/models/operations/createbanktransactionsresponse.md +++ b/lending/docs/models/operations/createbanktransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `accounting_create_bank_transactions_response` | [Optional[shared.AccountingCreateBankTransactionsResponse]](../../models/shared/accountingcreatebanktransactionsresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createcompanyresponse.md b/lending/docs/models/operations/createcompanyresponse.md index ea59de39f..b780d6bc9 100755 --- a/lending/docs/models/operations/createcompanyresponse.md +++ b/lending/docs/models/operations/createcompanyresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createconnectionrequest.md b/lending/docs/models/operations/createconnectionrequest.md index 775111c5e..b315a6d5e 100755 --- a/lending/docs/models/operations/createconnectionrequest.md +++ b/lending/docs/models/operations/createconnectionrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `request_body` | [Optional[CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/createconnectionrequestbody.md b/lending/docs/models/operations/createconnectionrequestbody.md index 510a6b3b0..891314d08 100755 --- a/lending/docs/models/operations/createconnectionrequestbody.md +++ b/lending/docs/models/operations/createconnectionrequestbody.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `platform_key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `platform_key` | *Optional[str]* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/lending/docs/models/operations/createconnectionresponse.md b/lending/docs/models/operations/createconnectionresponse.md index 5aa8726d9..6cf898dc4 100755 --- a/lending/docs/models/operations/createconnectionresponse.md +++ b/lending/docs/models/operations/createconnectionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createdirectcostrequest.md b/lending/docs/models/operations/createdirectcostrequest.md index 66966deda..83c3e4e2b 100755 --- a/lending/docs/models/operations/createdirectcostrequest.md +++ b/lending/docs/models/operations/createdirectcostrequest.md @@ -3,11 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_direct_cost` | [Optional[shared.AccountingDirectCost]](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | N/A | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `accounting_direct_cost` | [Optional[shared.AccountingDirectCost]](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | N/A | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createdirectcostresponse.md b/lending/docs/models/operations/createdirectcostresponse.md index 42a79edf6..188ffc0d9 100755 --- a/lending/docs/models/operations/createdirectcostresponse.md +++ b/lending/docs/models/operations/createdirectcostresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `accounting_create_direct_cost_response` | [Optional[shared.AccountingCreateDirectCostResponse]](../../models/shared/accountingcreatedirectcostresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createpaymentrequest.md b/lending/docs/models/operations/createpaymentrequest.md new file mode 100755 index 000000000..06016af6b --- /dev/null +++ b/lending/docs/models/operations/createpaymentrequest.md @@ -0,0 +1,12 @@ +# CreatePaymentRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `accounting_payment` | [Optional[shared.AccountingPayment]](../../models/shared/accountingpayment.md) | :heavy_minus_sign: | N/A | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createpaymentresponse.md b/lending/docs/models/operations/createpaymentresponse.md new file mode 100755 index 000000000..884118f35 --- /dev/null +++ b/lending/docs/models/operations/createpaymentresponse.md @@ -0,0 +1,12 @@ +# CreatePaymentResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `accounting_create_payment_response` | [Optional[shared.AccountingCreatePaymentResponse]](../../models/shared/accountingcreatepaymentresponse.md) | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createsupplierrequest.md b/lending/docs/models/operations/createsupplierrequest.md index 1aea4559d..692be1f4f 100755 --- a/lending/docs/models/operations/createsupplierrequest.md +++ b/lending/docs/models/operations/createsupplierrequest.md @@ -3,11 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_supplier` | [Optional[shared.AccountingSupplier]](../../models/shared/accountingsupplier.md) | :heavy_minus_sign: | N/A | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `accounting_supplier` | [Optional[shared.AccountingSupplier]](../../models/shared/accountingsupplier.md) | :heavy_minus_sign: | N/A | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createsupplierresponse.md b/lending/docs/models/operations/createsupplierresponse.md index 0b2a135e0..b5e23e0c4 100755 --- a/lending/docs/models/operations/createsupplierresponse.md +++ b/lending/docs/models/operations/createsupplierresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `accounting_create_supplier_response` | [Optional[shared.AccountingCreateSupplierResponse]](../../models/shared/accountingcreatesupplierresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createtransferrequest.md b/lending/docs/models/operations/createtransferrequest.md index d94093e65..0720a7085 100755 --- a/lending/docs/models/operations/createtransferrequest.md +++ b/lending/docs/models/operations/createtransferrequest.md @@ -3,11 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounting_transfer` | [Optional[shared.AccountingTransfer]](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | N/A | | -| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `force_update` | *Optional[bool]* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `accounting_transfer` | [Optional[shared.AccountingTransfer]](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | N/A | | +| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/createtransferresponse.md b/lending/docs/models/operations/createtransferresponse.md index 4d0c8808a..da7042728 100755 --- a/lending/docs/models/operations/createtransferresponse.md +++ b/lending/docs/models/operations/createtransferresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `accounting_create_transfer_response` | [Optional[shared.AccountingCreateTransferResponse]](../../models/shared/accountingcreatetransferresponse.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/deletecompanyrequest.md b/lending/docs/models/operations/deletecompanyrequest.md index 268537e13..338ee40e5 100755 --- a/lending/docs/models/operations/deletecompanyrequest.md +++ b/lending/docs/models/operations/deletecompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/deletecompanyresponse.md b/lending/docs/models/operations/deletecompanyresponse.md index ee9fe7cd3..f3f21c2cb 100755 --- a/lending/docs/models/operations/deletecompanyresponse.md +++ b/lending/docs/models/operations/deletecompanyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/deleteconnectionrequest.md b/lending/docs/models/operations/deleteconnectionrequest.md index 2cab8bf4a..9650dc387 100755 --- a/lending/docs/models/operations/deleteconnectionrequest.md +++ b/lending/docs/models/operations/deleteconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/deleteconnectionresponse.md b/lending/docs/models/operations/deleteconnectionresponse.md index 973be81b3..30889c508 100755 --- a/lending/docs/models/operations/deleteconnectionresponse.md +++ b/lending/docs/models/operations/deleteconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingbillattachmentrequest.md b/lending/docs/models/operations/downloadaccountingbillattachmentrequest.md index 97b996f77..3214aa7d5 100755 --- a/lending/docs/models/operations/downloadaccountingbillattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountingbillattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md b/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md index f75963ef4..644708da9 100755 --- a/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingcustomerattachmentrequest.md b/lending/docs/models/operations/downloadaccountingcustomerattachmentrequest.md index 53b3228a1..049a2755a 100755 --- a/lending/docs/models/operations/downloadaccountingcustomerattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountingcustomerattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `customer_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md b/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md index 4951c2fb9..da44170b9 100755 --- a/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingdirectcostattachmentrequest.md b/lending/docs/models/operations/downloadaccountingdirectcostattachmentrequest.md index 00823344e..23287f843 100755 --- a/lending/docs/models/operations/downloadaccountingdirectcostattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountingdirectcostattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md b/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md index 50cc0abcd..11d6fff49 100755 --- a/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md index b889cb987..ed9c7a4e8 100755 --- a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md index e72f011ae..382354666 100755 --- a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountinginvoiceattachmentrequest.md b/lending/docs/models/operations/downloadaccountinginvoiceattachmentrequest.md index f43d4c498..ef5975cbe 100755 --- a/lending/docs/models/operations/downloadaccountinginvoiceattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountinginvoiceattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md b/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md index 8cd52f9c9..06496c9d6 100755 --- a/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountinginvoicepdfrequest.md b/lending/docs/models/operations/downloadaccountinginvoicepdfrequest.md index 28cedbfa6..cc6b11e31 100755 --- a/lending/docs/models/operations/downloadaccountinginvoicepdfrequest.md +++ b/lending/docs/models/operations/downloadaccountinginvoicepdfrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md b/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md index 73fb384cc..6eea19d5a 100755 --- a/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md +++ b/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingsupplierattachmentrequest.md b/lending/docs/models/operations/downloadaccountingsupplierattachmentrequest.md index b9171f9ff..f7d720373 100755 --- a/lending/docs/models/operations/downloadaccountingsupplierattachmentrequest.md +++ b/lending/docs/models/operations/downloadaccountingsupplierattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md b/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md index 5a42a0f6f..ac8ed815c 100755 --- a/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadexcelreportrequest.md b/lending/docs/models/operations/downloadexcelreportrequest.md index 62a9f2649..d7d7a831b 100755 --- a/lending/docs/models/operations/downloadexcelreportrequest.md +++ b/lending/docs/models/operations/downloadexcelreportrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `report_type` | [shared.ExcelReportTypes](../../models/shared/excelreporttypes.md) | :heavy_check_mark: | The type of report you want to generate and download. | | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadexcelreportresponse.md b/lending/docs/models/operations/downloadexcelreportresponse.md index 2f3a90723..1a7be1331 100755 --- a/lending/docs/models/operations/downloadexcelreportresponse.md +++ b/lending/docs/models/operations/downloadexcelreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `body` | *Optional[bytes]* | :heavy_minus_sign: | N/A | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadfilesrequest.md b/lending/docs/models/operations/downloadfilesrequest.md index 6147e9072..6ac51ea2c 100755 --- a/lending/docs/models/operations/downloadfilesrequest.md +++ b/lending/docs/models/operations/downloadfilesrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `date_` | *Optional[str]* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/operations/downloadfilesresponse.md b/lending/docs/models/operations/downloadfilesresponse.md index 25b0e3818..27c4c1133 100755 --- a/lending/docs/models/operations/downloadfilesresponse.md +++ b/lending/docs/models/operations/downloadfilesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/generateexcelreportrequest.md b/lending/docs/models/operations/generateexcelreportrequest.md index 910be0698..ed38dba33 100755 --- a/lending/docs/models/operations/generateexcelreportrequest.md +++ b/lending/docs/models/operations/generateexcelreportrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `report_type` | [shared.ExcelReportTypes](../../models/shared/excelreporttypes.md) | :heavy_check_mark: | The type of report you want to generate and download. | | \ No newline at end of file diff --git a/lending/docs/models/operations/generateexcelreportresponse.md b/lending/docs/models/operations/generateexcelreportresponse.md index 30d67fe93..0d700555e 100755 --- a/lending/docs/models/operations/generateexcelreportresponse.md +++ b/lending/docs/models/operations/generateexcelreportresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloansummaryrequest.md b/lending/docs/models/operations/generateloansummaryrequest.md new file mode 100755 index 000000000..c5ce041fe --- /dev/null +++ b/lending/docs/models/operations/generateloansummaryrequest.md @@ -0,0 +1,9 @@ +# GenerateLoanSummaryRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [GenerateLoanSummarySourceType](../../models/operations/generateloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloansummaryresponse.md b/lending/docs/models/operations/generateloansummaryresponse.md new file mode 100755 index 000000000..fa984829f --- /dev/null +++ b/lending/docs/models/operations/generateloansummaryresponse.md @@ -0,0 +1,11 @@ +# GenerateLoanSummaryResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloansummarysourcetype.md b/lending/docs/models/operations/generateloansummarysourcetype.md new file mode 100755 index 000000000..1fb8dfad0 --- /dev/null +++ b/lending/docs/models/operations/generateloansummarysourcetype.md @@ -0,0 +1,12 @@ +# GenerateLoanSummarySourceType + +Data source type. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `BANKING` | banking | +| `COMMERCE` | commerce | +| `ACCOUNTING` | accounting | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloantransactionsrequest.md b/lending/docs/models/operations/generateloantransactionsrequest.md new file mode 100755 index 000000000..ad270be24 --- /dev/null +++ b/lending/docs/models/operations/generateloantransactionsrequest.md @@ -0,0 +1,9 @@ +# GenerateLoanTransactionsRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [GenerateLoanTransactionsSourceType](../../models/operations/generateloantransactionssourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloantransactionsresponse.md b/lending/docs/models/operations/generateloantransactionsresponse.md new file mode 100755 index 000000000..7c9dc16a4 --- /dev/null +++ b/lending/docs/models/operations/generateloantransactionsresponse.md @@ -0,0 +1,11 @@ +# GenerateLoanTransactionsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloantransactionssourcetype.md b/lending/docs/models/operations/generateloantransactionssourcetype.md new file mode 100755 index 000000000..95870b04d --- /dev/null +++ b/lending/docs/models/operations/generateloantransactionssourcetype.md @@ -0,0 +1,12 @@ +# GenerateLoanTransactionsSourceType + +Data source type. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `BANKING` | banking | +| `COMMERCE` | commerce | +| `ACCOUNTING` | accounting | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingaccountrequest.md b/lending/docs/models/operations/getaccountingaccountrequest.md index 85df1ba43..35c2fba87 100755 --- a/lending/docs/models/operations/getaccountingaccountrequest.md +++ b/lending/docs/models/operations/getaccountingaccountrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingaccountresponse.md b/lending/docs/models/operations/getaccountingaccountresponse.md index 775510461..21f40fd94 100755 --- a/lending/docs/models/operations/getaccountingaccountresponse.md +++ b/lending/docs/models/operations/getaccountingaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingaccounttransactionrequest.md b/lending/docs/models/operations/getaccountingaccounttransactionrequest.md index dc8d6d5ae..a6482cbc9 100755 --- a/lending/docs/models/operations/getaccountingaccounttransactionrequest.md +++ b/lending/docs/models/operations/getaccountingaccounttransactionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_transaction_id` | *str* | :heavy_check_mark: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `account_transaction_id` | *str* | :heavy_check_mark: | Unique identifier for an account transaction. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingaccounttransactionresponse.md b/lending/docs/models/operations/getaccountingaccounttransactionresponse.md index 5df83bdb8..9f8379e52 100755 --- a/lending/docs/models/operations/getaccountingaccounttransactionresponse.md +++ b/lending/docs/models/operations/getaccountingaccounttransactionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `accounting_account_transaction` | [Optional[shared.AccountingAccountTransaction]](../../models/shared/accountingaccounttransaction.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingagedcreditorsreportrequest.md b/lending/docs/models/operations/getaccountingagedcreditorsreportrequest.md index 0c8b176ab..dc89e57e0 100755 --- a/lending/docs/models/operations/getaccountingagedcreditorsreportrequest.md +++ b/lending/docs/models/operations/getaccountingagedcreditorsreportrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `number_of_periods` | *Optional[int]* | :heavy_minus_sign: | Number of periods to include in the report. | 12 | | `period_length_days` | *Optional[int]* | :heavy_minus_sign: | The length of period in days. | 30 | | `report_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md b/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md index de0bfe7c5..8991b8732 100755 --- a/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md +++ b/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `accounting_aged_creditor_report` | [Optional[shared.AccountingAgedCreditorReport]](../../models/shared/accountingagedcreditorreport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingageddebtorsreportrequest.md b/lending/docs/models/operations/getaccountingageddebtorsreportrequest.md index bd84b5022..5170c763b 100755 --- a/lending/docs/models/operations/getaccountingageddebtorsreportrequest.md +++ b/lending/docs/models/operations/getaccountingageddebtorsreportrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `number_of_periods` | *Optional[int]* | :heavy_minus_sign: | Number of periods to include in the report. | 12 | | `period_length_days` | *Optional[int]* | :heavy_minus_sign: | The length of period in days. | 30 | | `report_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md b/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md index c783225a6..897226e65 100755 --- a/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md +++ b/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `accounting_aged_debtor_report` | [Optional[shared.AccountingAgedDebtorReport]](../../models/shared/accountingageddebtorreport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbalancesheetrequest.md b/lending/docs/models/operations/getaccountingbalancesheetrequest.md index 2b1390818..36c3a34a2 100755 --- a/lending/docs/models/operations/getaccountingbalancesheetrequest.md +++ b/lending/docs/models/operations/getaccountingbalancesheetrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `period_length` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | | `periods_to_compare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `start_month` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `start_month` | *Optional[str]* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbalancesheetresponse.md b/lending/docs/models/operations/getaccountingbalancesheetresponse.md index 25819a460..1e24b7455 100755 --- a/lending/docs/models/operations/getaccountingbalancesheetresponse.md +++ b/lending/docs/models/operations/getaccountingbalancesheetresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_balance_sheet` | [Optional[shared.AccountingBalanceSheet]](../../models/shared/accountingbalancesheet.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbankaccountrequest.md b/lending/docs/models/operations/getaccountingbankaccountrequest.md index 1c09df7ba..6cb306832 100755 --- a/lending/docs/models/operations/getaccountingbankaccountrequest.md +++ b/lending/docs/models/operations/getaccountingbankaccountrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbankaccountresponse.md b/lending/docs/models/operations/getaccountingbankaccountresponse.md index 1590b2552..6f5df92ca 100755 --- a/lending/docs/models/operations/getaccountingbankaccountresponse.md +++ b/lending/docs/models/operations/getaccountingbankaccountresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_bank_account` | [Optional[shared.AccountingBankAccount]](../../models/shared/accountingbankaccount.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillattachmentrequest.md b/lending/docs/models/operations/getaccountingbillattachmentrequest.md index 5348e7b02..ef2a1d2b0 100755 --- a/lending/docs/models/operations/getaccountingbillattachmentrequest.md +++ b/lending/docs/models/operations/getaccountingbillattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillattachmentresponse.md b/lending/docs/models/operations/getaccountingbillattachmentresponse.md index 1df48cc2f..6f588ccc9 100755 --- a/lending/docs/models/operations/getaccountingbillattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingbillattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillcreditnoterequest.md b/lending/docs/models/operations/getaccountingbillcreditnoterequest.md index a36fd2984..1ce0e9c19 100755 --- a/lending/docs/models/operations/getaccountingbillcreditnoterequest.md +++ b/lending/docs/models/operations/getaccountingbillcreditnoterequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `bill_credit_note_id` | *str* | :heavy_check_mark: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | +| `bill_credit_note_id` | *str* | :heavy_check_mark: | Unique identifier for a bill credit note. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md b/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md index 487058710..debad7e33 100755 --- a/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md +++ b/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `accounting_bill_credit_note` | [Optional[shared.AccountingBillCreditNote]](../../models/shared/accountingbillcreditnote.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillpaymentrequest.md b/lending/docs/models/operations/getaccountingbillpaymentrequest.md index 0003a9952..1bc29dc72 100755 --- a/lending/docs/models/operations/getaccountingbillpaymentrequest.md +++ b/lending/docs/models/operations/getaccountingbillpaymentrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `bill_payment_id` | *str* | :heavy_check_mark: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `bill_payment_id` | *str* | :heavy_check_mark: | Unique identifier for a bill payment. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillpaymentresponse.md b/lending/docs/models/operations/getaccountingbillpaymentresponse.md index 64da381f5..6de8c1725 100755 --- a/lending/docs/models/operations/getaccountingbillpaymentresponse.md +++ b/lending/docs/models/operations/getaccountingbillpaymentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_bill_payment` | [Optional[shared.AccountingBillPayment]](../../models/shared/accountingbillpayment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillrequest.md b/lending/docs/models/operations/getaccountingbillrequest.md index cb6519e03..46181d8ff 100755 --- a/lending/docs/models/operations/getaccountingbillrequest.md +++ b/lending/docs/models/operations/getaccountingbillrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingbillresponse.md b/lending/docs/models/operations/getaccountingbillresponse.md index 85b5c13ee..76e174b35 100755 --- a/lending/docs/models/operations/getaccountingbillresponse.md +++ b/lending/docs/models/operations/getaccountingbillresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_bill` | [Optional[shared.AccountingBill]](../../models/shared/accountingbill.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcashflowstatementrequest.md b/lending/docs/models/operations/getaccountingcashflowstatementrequest.md index 091599147..edf9d8fc7 100755 --- a/lending/docs/models/operations/getaccountingcashflowstatementrequest.md +++ b/lending/docs/models/operations/getaccountingcashflowstatementrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `period_length` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | | `periods_to_compare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `start_month` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `start_month` | *Optional[str]* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcashflowstatementresponse.md b/lending/docs/models/operations/getaccountingcashflowstatementresponse.md index 48bfe3223..d1a32f3e5 100755 --- a/lending/docs/models/operations/getaccountingcashflowstatementresponse.md +++ b/lending/docs/models/operations/getaccountingcashflowstatementresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `accounting_cash_flow_statement` | [Optional[shared.AccountingCashFlowStatement]](../../models/shared/accountingcashflowstatement.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcreditnoterequest.md b/lending/docs/models/operations/getaccountingcreditnoterequest.md index 24cc9e78a..ff927e6f1 100755 --- a/lending/docs/models/operations/getaccountingcreditnoterequest.md +++ b/lending/docs/models/operations/getaccountingcreditnoterequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `credit_note_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `credit_note_id` | *str* | :heavy_check_mark: | Unique identifier for a credit note. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcreditnoteresponse.md b/lending/docs/models/operations/getaccountingcreditnoteresponse.md index e03b21cbd..cd045bac3 100755 --- a/lending/docs/models/operations/getaccountingcreditnoteresponse.md +++ b/lending/docs/models/operations/getaccountingcreditnoteresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_credit_note` | [Optional[shared.AccountingCreditNote]](../../models/shared/accountingcreditnote.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcustomerattachmentrequest.md b/lending/docs/models/operations/getaccountingcustomerattachmentrequest.md index 088325b81..9bcc82933 100755 --- a/lending/docs/models/operations/getaccountingcustomerattachmentrequest.md +++ b/lending/docs/models/operations/getaccountingcustomerattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `customer_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md b/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md index 2222520a9..f4dbfbbc7 100755 --- a/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcustomerrequest.md b/lending/docs/models/operations/getaccountingcustomerrequest.md index 69601f4f5..ac33974ba 100755 --- a/lending/docs/models/operations/getaccountingcustomerrequest.md +++ b/lending/docs/models/operations/getaccountingcustomerrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `customer_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingcustomerresponse.md b/lending/docs/models/operations/getaccountingcustomerresponse.md index 5cd361db0..418ea583a 100755 --- a/lending/docs/models/operations/getaccountingcustomerresponse.md +++ b/lending/docs/models/operations/getaccountingcustomerresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_customer` | [Optional[shared.AccountingCustomer]](../../models/shared/accountingcustomer.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectcostattachmentrequest.md b/lending/docs/models/operations/getaccountingdirectcostattachmentrequest.md index e2f643bc1..7e0b952eb 100755 --- a/lending/docs/models/operations/getaccountingdirectcostattachmentrequest.md +++ b/lending/docs/models/operations/getaccountingdirectcostattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md b/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md index 01a103967..700b50e78 100755 --- a/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectcostrequest.md b/lending/docs/models/operations/getaccountingdirectcostrequest.md index 58657cb91..e7691f057 100755 --- a/lending/docs/models/operations/getaccountingdirectcostrequest.md +++ b/lending/docs/models/operations/getaccountingdirectcostrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectcostresponse.md b/lending/docs/models/operations/getaccountingdirectcostresponse.md index d45d6e254..1852ebd86 100755 --- a/lending/docs/models/operations/getaccountingdirectcostresponse.md +++ b/lending/docs/models/operations/getaccountingdirectcostresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_direct_cost` | [Optional[shared.AccountingDirectCost]](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectincomeattachmentrequest.md b/lending/docs/models/operations/getaccountingdirectincomeattachmentrequest.md index 540297aef..f09d764fe 100755 --- a/lending/docs/models/operations/getaccountingdirectincomeattachmentrequest.md +++ b/lending/docs/models/operations/getaccountingdirectincomeattachmentrequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md b/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md index 8fe51e78f..9d782bdf4 100755 --- a/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectincomerequest.md b/lending/docs/models/operations/getaccountingdirectincomerequest.md index afe8a486e..be169acfa 100755 --- a/lending/docs/models/operations/getaccountingdirectincomerequest.md +++ b/lending/docs/models/operations/getaccountingdirectincomerequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_income_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingdirectincomeresponse.md b/lending/docs/models/operations/getaccountingdirectincomeresponse.md index 9513e1295..d2518111b 100755 --- a/lending/docs/models/operations/getaccountingdirectincomeresponse.md +++ b/lending/docs/models/operations/getaccountingdirectincomeresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_direct_income` | [Optional[shared.AccountingDirectIncome]](../../models/shared/accountingdirectincome.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountinginvoiceattachmentrequest.md b/lending/docs/models/operations/getaccountinginvoiceattachmentrequest.md index ce52ce909..b9bf307fd 100755 --- a/lending/docs/models/operations/getaccountinginvoiceattachmentrequest.md +++ b/lending/docs/models/operations/getaccountinginvoiceattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md b/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md index 5662687fb..b2954f405 100755 --- a/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md +++ b/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountinginvoicerequest.md b/lending/docs/models/operations/getaccountinginvoicerequest.md index 3282abb87..c6b592a7e 100755 --- a/lending/docs/models/operations/getaccountinginvoicerequest.md +++ b/lending/docs/models/operations/getaccountinginvoicerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountinginvoiceresponse.md b/lending/docs/models/operations/getaccountinginvoiceresponse.md index 62ab9335c..9fd142d0e 100755 --- a/lending/docs/models/operations/getaccountinginvoiceresponse.md +++ b/lending/docs/models/operations/getaccountinginvoiceresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_invoice` | [Optional[shared.AccountingInvoice]](../../models/shared/accountinginvoice.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingjournalentryrequest.md b/lending/docs/models/operations/getaccountingjournalentryrequest.md index 7e120d66a..85f5f8e62 100755 --- a/lending/docs/models/operations/getaccountingjournalentryrequest.md +++ b/lending/docs/models/operations/getaccountingjournalentryrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `journal_entry_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `journal_entry_id` | *str* | :heavy_check_mark: | Unique identifier for a journal entry. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingjournalentryresponse.md b/lending/docs/models/operations/getaccountingjournalentryresponse.md index 7ee1ef5bb..264b25924 100755 --- a/lending/docs/models/operations/getaccountingjournalentryresponse.md +++ b/lending/docs/models/operations/getaccountingjournalentryresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_journal_entry` | [Optional[shared.AccountingJournalEntry]](../../models/shared/accountingjournalentry.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingjournalrequest.md b/lending/docs/models/operations/getaccountingjournalrequest.md index d5d38d6cd..1561926a1 100755 --- a/lending/docs/models/operations/getaccountingjournalrequest.md +++ b/lending/docs/models/operations/getaccountingjournalrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `journal_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `journal_id` | *str* | :heavy_check_mark: | Unique identifier for a journal. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingjournalresponse.md b/lending/docs/models/operations/getaccountingjournalresponse.md index 01a26361a..38bd57e12 100755 --- a/lending/docs/models/operations/getaccountingjournalresponse.md +++ b/lending/docs/models/operations/getaccountingjournalresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_journal` | [Optional[shared.AccountingJournal]](../../models/shared/accountingjournal.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingpaymentrequest.md b/lending/docs/models/operations/getaccountingpaymentrequest.md index d91c2f322..2f420ca1b 100755 --- a/lending/docs/models/operations/getaccountingpaymentrequest.md +++ b/lending/docs/models/operations/getaccountingpaymentrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `payment_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `payment_id` | *str* | :heavy_check_mark: | Unique identifier for a payment. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingpaymentresponse.md b/lending/docs/models/operations/getaccountingpaymentresponse.md index 81521e330..5b970083c 100755 --- a/lending/docs/models/operations/getaccountingpaymentresponse.md +++ b/lending/docs/models/operations/getaccountingpaymentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_payment` | [Optional[shared.AccountingPayment]](../../models/shared/accountingpayment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingprofilerequest.md b/lending/docs/models/operations/getaccountingprofilerequest.md index 563353fc3..00f7adceb 100755 --- a/lending/docs/models/operations/getaccountingprofilerequest.md +++ b/lending/docs/models/operations/getaccountingprofilerequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingprofileresponse.md b/lending/docs/models/operations/getaccountingprofileresponse.md index 5189029f3..9c66314d3 100755 --- a/lending/docs/models/operations/getaccountingprofileresponse.md +++ b/lending/docs/models/operations/getaccountingprofileresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_company_info` | [Optional[shared.AccountingCompanyInfo]](../../models/shared/accountingcompanyinfo.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingprofitandlossrequest.md b/lending/docs/models/operations/getaccountingprofitandlossrequest.md index d37eb142a..a3bc66208 100755 --- a/lending/docs/models/operations/getaccountingprofitandlossrequest.md +++ b/lending/docs/models/operations/getaccountingprofitandlossrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `period_length` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | | `periods_to_compare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `start_month` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `start_month` | *Optional[str]* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingprofitandlossresponse.md b/lending/docs/models/operations/getaccountingprofitandlossresponse.md index 5fb958edb..a9085798d 100755 --- a/lending/docs/models/operations/getaccountingprofitandlossresponse.md +++ b/lending/docs/models/operations/getaccountingprofitandlossresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `accounting_profit_and_loss_report` | [Optional[shared.AccountingProfitAndLossReport]](../../models/shared/accountingprofitandlossreport.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingsupplierattachmentrequest.md b/lending/docs/models/operations/getaccountingsupplierattachmentrequest.md index 0d6b1353b..0fde1bc54 100755 --- a/lending/docs/models/operations/getaccountingsupplierattachmentrequest.md +++ b/lending/docs/models/operations/getaccountingsupplierattachmentrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier | | \ No newline at end of file +| `attachment_id` | *str* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md b/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md index 4f9337eee..57b3e78d9 100755 --- a/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingsupplierrequest.md b/lending/docs/models/operations/getaccountingsupplierrequest.md index 737527db5..e4271fc79 100755 --- a/lending/docs/models/operations/getaccountingsupplierrequest.md +++ b/lending/docs/models/operations/getaccountingsupplierrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingsupplierresponse.md b/lending/docs/models/operations/getaccountingsupplierresponse.md index 6173c863e..25222ce39 100755 --- a/lending/docs/models/operations/getaccountingsupplierresponse.md +++ b/lending/docs/models/operations/getaccountingsupplierresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_supplier` | [Optional[shared.AccountingSupplier]](../../models/shared/accountingsupplier.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingtransferrequest.md b/lending/docs/models/operations/getaccountingtransferrequest.md index c9efb3629..6a0b4dc68 100755 --- a/lending/docs/models/operations/getaccountingtransferrequest.md +++ b/lending/docs/models/operations/getaccountingtransferrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `transfer_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `transfer_id` | *str* | :heavy_check_mark: | Unique identifier for a transfer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingtransferresponse.md b/lending/docs/models/operations/getaccountingtransferresponse.md index b77c9f2f2..3edde3921 100755 --- a/lending/docs/models/operations/getaccountingtransferresponse.md +++ b/lending/docs/models/operations/getaccountingtransferresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_transfer` | [Optional[shared.AccountingTransfer]](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingaccountrequest.md b/lending/docs/models/operations/getbankingaccountrequest.md index 801fb3296..f158f57eb 100755 --- a/lending/docs/models/operations/getbankingaccountrequest.md +++ b/lending/docs/models/operations/getbankingaccountrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingaccountresponse.md b/lending/docs/models/operations/getbankingaccountresponse.md index 2b451d9c1..f4344d841 100755 --- a/lending/docs/models/operations/getbankingaccountresponse.md +++ b/lending/docs/models/operations/getbankingaccountresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_account` | [Optional[shared.BankingAccount]](../../models/shared/bankingaccount.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingtransactioncategoryrequest.md b/lending/docs/models/operations/getbankingtransactioncategoryrequest.md index 65b23dc92..80b2b1207 100755 --- a/lending/docs/models/operations/getbankingtransactioncategoryrequest.md +++ b/lending/docs/models/operations/getbankingtransactioncategoryrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `transaction_category_id` | *str* | :heavy_check_mark: | The unique identifier for a banking transaction category | | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingtransactioncategoryresponse.md b/lending/docs/models/operations/getbankingtransactioncategoryresponse.md index 363fb0f34..2e12a27cb 100755 --- a/lending/docs/models/operations/getbankingtransactioncategoryresponse.md +++ b/lending/docs/models/operations/getbankingtransactioncategoryresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `banking_transaction_category` | [Optional[shared.BankingTransactionCategory]](../../models/shared/bankingtransactioncategory.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingtransactionrequest.md b/lending/docs/models/operations/getbankingtransactionrequest.md index 5e6988c86..76bdedc4c 100755 --- a/lending/docs/models/operations/getbankingtransactionrequest.md +++ b/lending/docs/models/operations/getbankingtransactionrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `transaction_id` | *str* | :heavy_check_mark: | The unique identifier for a transaction | | \ No newline at end of file diff --git a/lending/docs/models/operations/getbankingtransactionresponse.md b/lending/docs/models/operations/getbankingtransactionresponse.md index 74eafef28..11b63206f 100755 --- a/lending/docs/models/operations/getbankingtransactionresponse.md +++ b/lending/docs/models/operations/getbankingtransactionresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_transaction` | [Optional[shared.BankingTransaction]](../../models/shared/bankingtransaction.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedbalancesheetstatementrequest.md b/lending/docs/models/operations/getcategorizedbalancesheetstatementrequest.md index 7d27bd9da..a655adbb1 100755 --- a/lending/docs/models/operations/getcategorizedbalancesheetstatementrequest.md +++ b/lending/docs/models/operations/getcategorizedbalancesheetstatementrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `number_of_periods` | *Optional[int]* | :heavy_minus_sign: | The number of periods to return. If not provided, 12 periods will be used as the default value. | | | `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md b/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md index f36bea11f..8a5ee2e75 100755 --- a/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `enhanced_financial_report` | [Optional[shared.EnhancedFinancialReport]](../../models/shared/enhancedfinancialreport.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedbankstatementrequest.md b/lending/docs/models/operations/getcategorizedbankstatementrequest.md index d6cc93a50..e9510c5c8 100755 --- a/lending/docs/models/operations/getcategorizedbankstatementrequest.md +++ b/lending/docs/models/operations/getcategorizedbankstatementrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | | `query` | *Optional[str]* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedbankstatementresponse.md b/lending/docs/models/operations/getcategorizedbankstatementresponse.md index 10e3fe092..9e7f7a850 100755 --- a/lending/docs/models/operations/getcategorizedbankstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedbankstatementresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `enhanced_cash_flow_transactions` | [Optional[shared.EnhancedCashFlowTransactions]](../../models/shared/enhancedcashflowtransactions.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedprofitandlossstatementrequest.md b/lending/docs/models/operations/getcategorizedprofitandlossstatementrequest.md index 4b71bbac0..af6bb51be 100755 --- a/lending/docs/models/operations/getcategorizedprofitandlossstatementrequest.md +++ b/lending/docs/models/operations/getcategorizedprofitandlossstatementrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `number_of_periods` | *Optional[int]* | :heavy_minus_sign: | The number of periods to return. If not provided, 12 periods will be used as the default value. | | -| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | \ No newline at end of file +| `report_date` | *Optional[str]* | :heavy_minus_sign: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md b/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md index afff7c520..822bf822f 100755 --- a/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `enhanced_financial_report` | [Optional[shared.EnhancedFinancialReport]](../../models/shared/enhancedfinancialreport.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercecustomerrequest.md b/lending/docs/models/operations/getcommercecustomerrequest.md index 7362c77cf..9fcdaf94b 100755 --- a/lending/docs/models/operations/getcommercecustomerrequest.md +++ b/lending/docs/models/operations/getcommercecustomerrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercecustomerresponse.md b/lending/docs/models/operations/getcommercecustomerresponse.md index 73f0c94c5..08c14c6e7 100755 --- a/lending/docs/models/operations/getcommercecustomerresponse.md +++ b/lending/docs/models/operations/getcommercecustomerresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customer` | [Optional[shared.CommerceCustomer]](../../models/shared/commercecustomer.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercecustomerretentionmetricsrequest.md b/lending/docs/models/operations/getcommercecustomerretentionmetricsrequest.md index afce992a0..af30fa0c5 100755 --- a/lending/docs/models/operations/getcommercecustomerretentionmetricsrequest.md +++ b/lending/docs/models/operations/getcommercecustomerretentionmetricsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | | `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | | `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | diff --git a/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md b/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md index 0d50bea1a..da408428c 100755 --- a/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md +++ b/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercedisputerequest.md b/lending/docs/models/operations/getcommercedisputerequest.md index 593ed45f2..e79ae1a25 100755 --- a/lending/docs/models/operations/getcommercedisputerequest.md +++ b/lending/docs/models/operations/getcommercedisputerequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `dispute_id` | *str* | :heavy_check_mark: | Unique identifier for a dispute. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercedisputeresponse.md b/lending/docs/models/operations/getcommercedisputeresponse.md index 47c813e77..3526bfe2f 100755 --- a/lending/docs/models/operations/getcommercedisputeresponse.md +++ b/lending/docs/models/operations/getcommercedisputeresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_dispute` | [Optional[shared.CommerceDispute]](../../models/shared/commercedispute.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercelifetimevaluemetricsrequest.md b/lending/docs/models/operations/getcommercelifetimevaluemetricsrequest.md index f0708286b..0872d8bc9 100755 --- a/lending/docs/models/operations/getcommercelifetimevaluemetricsrequest.md +++ b/lending/docs/models/operations/getcommercelifetimevaluemetricsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | | `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | | `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | diff --git a/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md b/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md index 07a6607a7..ef6ebd238 100755 --- a/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md +++ b/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercelocationrequest.md b/lending/docs/models/operations/getcommercelocationrequest.md index 1afc9673d..36d6bb5b3 100755 --- a/lending/docs/models/operations/getcommercelocationrequest.md +++ b/lending/docs/models/operations/getcommercelocationrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `location_id` | *str* | :heavy_check_mark: | Unique identifier for a location. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercelocationresponse.md b/lending/docs/models/operations/getcommercelocationresponse.md index a6e102cf1..b798ae049 100755 --- a/lending/docs/models/operations/getcommercelocationresponse.md +++ b/lending/docs/models/operations/getcommercelocationresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_location` | [Optional[shared.CommerceLocation]](../../models/shared/commercelocation.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceorderrequest.md b/lending/docs/models/operations/getcommerceorderrequest.md index 918361a15..31ea882ff 100755 --- a/lending/docs/models/operations/getcommerceorderrequest.md +++ b/lending/docs/models/operations/getcommerceorderrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_id` | *str* | :heavy_check_mark: | Unique identifier for an order. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceorderresponse.md b/lending/docs/models/operations/getcommerceorderresponse.md index 0f678299e..48fdadff9 100755 --- a/lending/docs/models/operations/getcommerceorderresponse.md +++ b/lending/docs/models/operations/getcommerceorderresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_order` | [Optional[shared.CommerceOrder]](../../models/shared/commerceorder.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceordersreportrequest.md b/lending/docs/models/operations/getcommerceordersreportrequest.md index ca3afba67..4ddaae582 100755 --- a/lending/docs/models/operations/getcommerceordersreportrequest.md +++ b/lending/docs/models/operations/getcommerceordersreportrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | | `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | | `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | diff --git a/lending/docs/models/operations/getcommerceordersreportresponse.md b/lending/docs/models/operations/getcommerceordersreportresponse.md index fd84073fe..f7c628a69 100755 --- a/lending/docs/models/operations/getcommerceordersreportresponse.md +++ b/lending/docs/models/operations/getcommerceordersreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercepaymentmethodrequest.md b/lending/docs/models/operations/getcommercepaymentmethodrequest.md index e9c247e6a..b8a9f58d2 100755 --- a/lending/docs/models/operations/getcommercepaymentmethodrequest.md +++ b/lending/docs/models/operations/getcommercepaymentmethodrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `payment_method_id` | *str* | :heavy_check_mark: | Unique identifier for a payment method. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercepaymentmethodresponse.md b/lending/docs/models/operations/getcommercepaymentmethodresponse.md index 716bb74db..0917904b0 100755 --- a/lending/docs/models/operations/getcommercepaymentmethodresponse.md +++ b/lending/docs/models/operations/getcommercepaymentmethodresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `commerce_payment_method` | [Optional[shared.CommercePaymentMethod]](../../models/shared/commercepaymentmethod.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercepaymentrequest.md b/lending/docs/models/operations/getcommercepaymentrequest.md index b62069c23..4e0808209 100755 --- a/lending/docs/models/operations/getcommercepaymentrequest.md +++ b/lending/docs/models/operations/getcommercepaymentrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `payment_id` | *str* | :heavy_check_mark: | Unique identifier for a payment. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercepaymentresponse.md b/lending/docs/models/operations/getcommercepaymentresponse.md index db311f3f3..53e4f188b 100755 --- a/lending/docs/models/operations/getcommercepaymentresponse.md +++ b/lending/docs/models/operations/getcommercepaymentresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payment` | [Optional[shared.CommercePayment]](../../models/shared/commercepayment.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceproductcategoryrequest.md b/lending/docs/models/operations/getcommerceproductcategoryrequest.md index 1be4d5f0a..02c9e500f 100755 --- a/lending/docs/models/operations/getcommerceproductcategoryrequest.md +++ b/lending/docs/models/operations/getcommerceproductcategoryrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `product_id` | *str* | :heavy_check_mark: | Unique identifier for a product. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceproductcategoryresponse.md b/lending/docs/models/operations/getcommerceproductcategoryresponse.md index 1599f4f4f..40ffc3d5a 100755 --- a/lending/docs/models/operations/getcommerceproductcategoryresponse.md +++ b/lending/docs/models/operations/getcommerceproductcategoryresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `commerce_product_category` | [Optional[shared.CommerceProductCategory]](../../models/shared/commerceproductcategory.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceproductrequest.md b/lending/docs/models/operations/getcommerceproductrequest.md index d0d962234..8fdff797e 100755 --- a/lending/docs/models/operations/getcommerceproductrequest.md +++ b/lending/docs/models/operations/getcommerceproductrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `product_id` | *str* | :heavy_check_mark: | Unique identifier for a product. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceproductresponse.md b/lending/docs/models/operations/getcommerceproductresponse.md index 2fc0026b6..c45a8463b 100755 --- a/lending/docs/models/operations/getcommerceproductresponse.md +++ b/lending/docs/models/operations/getcommerceproductresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_product` | [Optional[shared.CommerceProduct]](../../models/shared/commerceproduct.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceprofilerequest.md b/lending/docs/models/operations/getcommerceprofilerequest.md index f7ab39f99..a37ccd8c8 100755 --- a/lending/docs/models/operations/getcommerceprofilerequest.md +++ b/lending/docs/models/operations/getcommerceprofilerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommerceprofileresponse.md b/lending/docs/models/operations/getcommerceprofileresponse.md index 31ae8b8ba..460ba6730 100755 --- a/lending/docs/models/operations/getcommerceprofileresponse.md +++ b/lending/docs/models/operations/getcommerceprofileresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_company_info` | [Optional[shared.CommerceCompanyInfo]](../../models/shared/commercecompanyinfo.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercerefundsreportrequest.md b/lending/docs/models/operations/getcommercerefundsreportrequest.md index 005f24be3..f98116a0f 100755 --- a/lending/docs/models/operations/getcommercerefundsreportrequest.md +++ b/lending/docs/models/operations/getcommercerefundsreportrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | | `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | | `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | diff --git a/lending/docs/models/operations/getcommercerefundsreportresponse.md b/lending/docs/models/operations/getcommercerefundsreportresponse.md index bdf9755d5..13ecda6aa 100755 --- a/lending/docs/models/operations/getcommercerefundsreportresponse.md +++ b/lending/docs/models/operations/getcommercerefundsreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercerevenuemetricsrequest.md b/lending/docs/models/operations/getcommercerevenuemetricsrequest.md index 87b37095c..44c5f5d67 100755 --- a/lending/docs/models/operations/getcommercerevenuemetricsrequest.md +++ b/lending/docs/models/operations/getcommercerevenuemetricsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | | `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | | `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | diff --git a/lending/docs/models/operations/getcommercerevenuemetricsresponse.md b/lending/docs/models/operations/getcommercerevenuemetricsresponse.md index 59691e4ad..2f0636fb4 100755 --- a/lending/docs/models/operations/getcommercerevenuemetricsresponse.md +++ b/lending/docs/models/operations/getcommercerevenuemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercetransactionrequest.md b/lending/docs/models/operations/getcommercetransactionrequest.md index 32bd837f0..77c693889 100755 --- a/lending/docs/models/operations/getcommercetransactionrequest.md +++ b/lending/docs/models/operations/getcommercetransactionrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `transaction_id` | *str* | :heavy_check_mark: | Unique identifier for a transaction. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcommercetransactionresponse.md b/lending/docs/models/operations/getcommercetransactionresponse.md index 550fc854c..a9ac47847 100755 --- a/lending/docs/models/operations/getcommercetransactionresponse.md +++ b/lending/docs/models/operations/getcommercetransactionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transaction` | [Optional[shared.CommerceTransaction]](../../models/shared/commercetransaction.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcompanyrequest.md b/lending/docs/models/operations/getcompanyrequest.md index 4c9629ab6..240b811b6 100755 --- a/lending/docs/models/operations/getcompanyrequest.md +++ b/lending/docs/models/operations/getcompanyrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcompanyresponse.md b/lending/docs/models/operations/getcompanyresponse.md index a0c0a41b1..2f82e6ca0 100755 --- a/lending/docs/models/operations/getcompanyresponse.md +++ b/lending/docs/models/operations/getcompanyresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getconnectionrequest.md b/lending/docs/models/operations/getconnectionrequest.md index d9d6f6c13..6e9f3d18b 100755 --- a/lending/docs/models/operations/getconnectionrequest.md +++ b/lending/docs/models/operations/getconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getconnectionresponse.md b/lending/docs/models/operations/getconnectionresponse.md index 32fb66433..c308aece1 100755 --- a/lending/docs/models/operations/getconnectionresponse.md +++ b/lending/docs/models/operations/getconnectionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatebanktransactionsmodelrequest.md b/lending/docs/models/operations/getcreatebanktransactionsmodelrequest.md index bd53569cd..d575a5cd7 100755 --- a/lending/docs/models/operations/getcreatebanktransactionsmodelrequest.md +++ b/lending/docs/models/operations/getcreatebanktransactionsmodelrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md b/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md index 75f704cd8..fcf97c882 100755 --- a/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md +++ b/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatechartofaccountsmodelrequest.md b/lending/docs/models/operations/getcreatechartofaccountsmodelrequest.md index e2971298e..11af40316 100755 --- a/lending/docs/models/operations/getcreatechartofaccountsmodelrequest.md +++ b/lending/docs/models/operations/getcreatechartofaccountsmodelrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md b/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md index 9bb2dc1bd..fa5a05fa4 100755 --- a/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md +++ b/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatedirectcostsmodelrequest.md b/lending/docs/models/operations/getcreatedirectcostsmodelrequest.md index 48e19d207..3815b4c7d 100755 --- a/lending/docs/models/operations/getcreatedirectcostsmodelrequest.md +++ b/lending/docs/models/operations/getcreatedirectcostsmodelrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md b/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md index e7985814c..a429645ff 100755 --- a/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md +++ b/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateoperationrequest.md b/lending/docs/models/operations/getcreateoperationrequest.md index 4f3f282b1..82b4db6ad 100755 --- a/lending/docs/models/operations/getcreateoperationrequest.md +++ b/lending/docs/models/operations/getcreateoperationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `push_operation_key` | *str* | :heavy_check_mark: | Push operation key. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateoperationresponse.md b/lending/docs/models/operations/getcreateoperationresponse.md index e38875dfd..9bcc91f06 100755 --- a/lending/docs/models/operations/getcreateoperationresponse.md +++ b/lending/docs/models/operations/getcreateoperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_operation` | [Optional[shared.PushOperation]](../../models/shared/pushoperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md b/lending/docs/models/operations/getcreatepaymentsmodelrequest.md similarity index 64% rename from lending/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md rename to lending/docs/models/operations/getcreatepaymentsmodelrequest.md index d5c5de692..8faf65f28 100755 --- a/lending/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md +++ b/lending/docs/models/operations/getcreatepaymentsmodelrequest.md @@ -1,9 +1,9 @@ -# GetCreateUpdateBankAccountsModelRequest +# GetCreatePaymentsModelRequest ## Fields | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md b/lending/docs/models/operations/getcreatepaymentsmodelresponse.md similarity index 89% rename from lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md rename to lending/docs/models/operations/getcreatepaymentsmodelresponse.md index ed4d32bfd..9556e6f57 100755 --- a/lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md +++ b/lending/docs/models/operations/getcreatepaymentsmodelresponse.md @@ -1,12 +1,12 @@ -# GetCreateUpdateBankAccountsModelResponse +# GetCreatePaymentsModelResponse ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatetransfersmodelrequest.md b/lending/docs/models/operations/getcreatetransfersmodelrequest.md index 1ec233fd7..4a3d73915 100755 --- a/lending/docs/models/operations/getcreatetransfersmodelrequest.md +++ b/lending/docs/models/operations/getcreatetransfersmodelrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatetransfersmodelresponse.md b/lending/docs/models/operations/getcreatetransfersmodelresponse.md index 6140d47c0..a397fd038 100755 --- a/lending/docs/models/operations/getcreatetransfersmodelresponse.md +++ b/lending/docs/models/operations/getcreatetransfersmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateupdatesuppliersmodelrequest.md b/lending/docs/models/operations/getcreateupdatesuppliersmodelrequest.md index a80d93742..85ca250bd 100755 --- a/lending/docs/models/operations/getcreateupdatesuppliersmodelrequest.md +++ b/lending/docs/models/operations/getcreateupdatesuppliersmodelrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md b/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md index cf4f8940f..42a840c64 100755 --- a/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md +++ b/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getdataintegritystatusrequest.md b/lending/docs/models/operations/getdataintegritystatusrequest.md index 108258bf4..5946caef7 100755 --- a/lending/docs/models/operations/getdataintegritystatusrequest.md +++ b/lending/docs/models/operations/getdataintegritystatusrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data_type` | [shared.DataIntegrityDataType](../../models/shared/dataintegritydatatype.md) | :heavy_check_mark: | A key for a Codat data type. | banking-accounts | \ No newline at end of file diff --git a/lending/docs/models/operations/getdataintegritystatusresponse.md b/lending/docs/models/operations/getdataintegritystatusresponse.md index 4bb88e14c..511b309c6 100755 --- a/lending/docs/models/operations/getdataintegritystatusresponse.md +++ b/lending/docs/models/operations/getdataintegritystatusresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `data_integrity_statuses` | [Optional[shared.DataIntegrityStatuses]](../../models/shared/dataintegritystatuses.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getdataintegritysummariesrequest.md b/lending/docs/models/operations/getdataintegritysummariesrequest.md index f749c6b20..8c5b5e0da 100755 --- a/lending/docs/models/operations/getdataintegritysummariesrequest.md +++ b/lending/docs/models/operations/getdataintegritysummariesrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data_type` | [shared.DataIntegrityDataType](../../models/shared/dataintegritydatatype.md) | :heavy_check_mark: | A key for a Codat data type. | banking-accounts | | `query` | *Optional[str]* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | | \ No newline at end of file diff --git a/lending/docs/models/operations/getdataintegritysummariesresponse.md b/lending/docs/models/operations/getdataintegritysummariesresponse.md index 1200ff0ee..e46ca3ff2 100755 --- a/lending/docs/models/operations/getdataintegritysummariesresponse.md +++ b/lending/docs/models/operations/getdataintegritysummariesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `data_integrity_summaries` | [Optional[shared.DataIntegritySummaries]](../../models/shared/dataintegritysummaries.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getdatastatusrequest.md b/lending/docs/models/operations/getdatastatusrequest.md index 8ee7b2510..12c2e50b6 100755 --- a/lending/docs/models/operations/getdatastatusrequest.md +++ b/lending/docs/models/operations/getdatastatusrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/getdatastatusresponse.md b/lending/docs/models/operations/getdatastatusresponse.md index 9ffc60fec..18bcc12b7 100755 --- a/lending/docs/models/operations/getdatastatusresponse.md +++ b/lending/docs/models/operations/getdatastatusresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `data_status_response` | dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `data_status_response` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getexcelreportgenerationstatusrequest.md b/lending/docs/models/operations/getexcelreportgenerationstatusrequest.md index 65480dbb9..42752ea85 100755 --- a/lending/docs/models/operations/getexcelreportgenerationstatusrequest.md +++ b/lending/docs/models/operations/getexcelreportgenerationstatusrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `report_type` | [shared.ExcelReportTypes](../../models/shared/excelreporttypes.md) | :heavy_check_mark: | The type of report you want to generate and download. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md b/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md index 60768049a..ba144607b 100755 --- a/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md +++ b/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getloansummaryrequest.md b/lending/docs/models/operations/getloansummaryrequest.md index ea396051e..655f0cca8 100755 --- a/lending/docs/models/operations/getloansummaryrequest.md +++ b/lending/docs/models/operations/getloansummaryrequest.md @@ -3,6 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [GetLoanSummarySourceType](../../models/operations/getloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getloansummaryresponse.md b/lending/docs/models/operations/getloansummaryresponse.md index 5d06031f5..b007d1c19 100755 --- a/lending/docs/models/operations/getloansummaryresponse.md +++ b/lending/docs/models/operations/getloansummaryresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `loan_summary` | [Optional[shared.LoanSummary]](../../models/shared/loansummary.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getloansummarysourcetype.md b/lending/docs/models/operations/getloansummarysourcetype.md new file mode 100755 index 000000000..f6681e59c --- /dev/null +++ b/lending/docs/models/operations/getloansummarysourcetype.md @@ -0,0 +1,12 @@ +# GetLoanSummarySourceType + +Data source type. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `BANKING` | banking | +| `COMMERCE` | commerce | +| `ACCOUNTING` | accounting | \ No newline at end of file diff --git a/lending/docs/models/operations/getpulloperationrequest.md b/lending/docs/models/operations/getpulloperationrequest.md index a965477f9..d2382bd6c 100755 --- a/lending/docs/models/operations/getpulloperationrequest.md +++ b/lending/docs/models/operations/getpulloperationrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `dataset_id` | *str* | :heavy_check_mark: | Unique ID of a dataset or pull operation. | eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `dataset_id` | *str* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/lending/docs/models/operations/getpulloperationresponse.md b/lending/docs/models/operations/getpulloperationresponse.md index 1527d9f32..41674afa9 100755 --- a/lending/docs/models/operations/getpulloperationresponse.md +++ b/lending/docs/models/operations/getpulloperationresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/isagedcreditorsreportavailablerequest.md b/lending/docs/models/operations/isagedcreditorsreportavailablerequest.md index cc9964e74..b91effb0f 100755 --- a/lending/docs/models/operations/isagedcreditorsreportavailablerequest.md +++ b/lending/docs/models/operations/isagedcreditorsreportavailablerequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md b/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md index 7563dfb27..66957e137 100755 --- a/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md +++ b/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `is_aged_creditors_report_available_200_application_json_boolean` | *Optional[bool]* | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/lending/docs/models/operations/isageddebtorsreportavailablerequest.md b/lending/docs/models/operations/isageddebtorsreportavailablerequest.md index 90273d09b..6113466ca 100755 --- a/lending/docs/models/operations/isageddebtorsreportavailablerequest.md +++ b/lending/docs/models/operations/isageddebtorsreportavailablerequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/isageddebtorsreportavailableresponse.md b/lending/docs/models/operations/isageddebtorsreportavailableresponse.md index e5f82bc66..41db2ecf6 100755 --- a/lending/docs/models/operations/isageddebtorsreportavailableresponse.md +++ b/lending/docs/models/operations/isageddebtorsreportavailableresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `is_aged_debtors_report_available_200_application_json_boolean` | *Optional[bool]* | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingaccountsrequest.md b/lending/docs/models/operations/listaccountingaccountsrequest.md index beaeb974d..cf0856de4 100755 --- a/lending/docs/models/operations/listaccountingaccountsrequest.md +++ b/lending/docs/models/operations/listaccountingaccountsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingaccountsresponse.md b/lending/docs/models/operations/listaccountingaccountsresponse.md index 31cc04db9..191e47635 100755 --- a/lending/docs/models/operations/listaccountingaccountsresponse.md +++ b/lending/docs/models/operations/listaccountingaccountsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_accounts` | [Optional[shared.AccountingAccounts]](../../models/shared/accountingaccounts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingaccounttransactionsrequest.md b/lending/docs/models/operations/listaccountingaccounttransactionsrequest.md index 6c0cace8b..24227d059 100755 --- a/lending/docs/models/operations/listaccountingaccounttransactionsrequest.md +++ b/lending/docs/models/operations/listaccountingaccounttransactionsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md b/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md index 88fdc627e..d7456a285 100755 --- a/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md +++ b/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `accounting_account_transactions` | [Optional[shared.AccountingAccountTransactions]](../../models/shared/accountingaccounttransactions.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbankaccountsrequest.md b/lending/docs/models/operations/listaccountingbankaccountsrequest.md index 58ea43fed..06b0c52bd 100755 --- a/lending/docs/models/operations/listaccountingbankaccountsrequest.md +++ b/lending/docs/models/operations/listaccountingbankaccountsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingbankaccountsresponse.md b/lending/docs/models/operations/listaccountingbankaccountsresponse.md index e92df5c5a..d895a812f 100755 --- a/lending/docs/models/operations/listaccountingbankaccountsresponse.md +++ b/lending/docs/models/operations/listaccountingbankaccountsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_bank_accounts` | [Optional[shared.AccountingBankAccounts]](../../models/shared/accountingbankaccounts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbankaccounttransactionsrequest.md b/lending/docs/models/operations/listaccountingbankaccounttransactionsrequest.md index a312b2639..2ba04671e 100755 --- a/lending/docs/models/operations/listaccountingbankaccounttransactionsrequest.md +++ b/lending/docs/models/operations/listaccountingbankaccounttransactionsrequest.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `account_id` | *str* | :heavy_check_mark: | Unique identifier for an account. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md b/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md index 071688c7e..d2e5668ed 100755 --- a/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md +++ b/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `accounting_bank_transactions` | [Optional[shared.AccountingBankTransactions]](../../models/shared/accountingbanktransactions.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbillattachmentsrequest.md b/lending/docs/models/operations/listaccountingbillattachmentsrequest.md index d5b674f30..d60589ea5 100755 --- a/lending/docs/models/operations/listaccountingbillattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountingbillattachmentsrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `bill_id` | *str* | :heavy_check_mark: | Unique identifier for a bill. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbillattachmentsresponse.md b/lending/docs/models/operations/listaccountingbillattachmentsresponse.md index 1463ef20a..9f4183fbb 100755 --- a/lending/docs/models/operations/listaccountingbillattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingbillattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbillcreditnotesrequest.md b/lending/docs/models/operations/listaccountingbillcreditnotesrequest.md index 79f010f96..cb44b1980 100755 --- a/lending/docs/models/operations/listaccountingbillcreditnotesrequest.md +++ b/lending/docs/models/operations/listaccountingbillcreditnotesrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md b/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md index cd1da11d1..8381de169 100755 --- a/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md +++ b/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `accounting_bill_credit_notes` | [Optional[shared.AccountingBillCreditNotes]](../../models/shared/accountingbillcreditnotes.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbillpaymentsrequest.md b/lending/docs/models/operations/listaccountingbillpaymentsrequest.md index ccb25bd20..d4a46d862 100755 --- a/lending/docs/models/operations/listaccountingbillpaymentsrequest.md +++ b/lending/docs/models/operations/listaccountingbillpaymentsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingbillpaymentsresponse.md b/lending/docs/models/operations/listaccountingbillpaymentsresponse.md index 9bc419749..bf93b9f5a 100755 --- a/lending/docs/models/operations/listaccountingbillpaymentsresponse.md +++ b/lending/docs/models/operations/listaccountingbillpaymentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_bill_payments` | [Optional[shared.AccountingBillPayments]](../../models/shared/accountingbillpayments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingbillsrequest.md b/lending/docs/models/operations/listaccountingbillsrequest.md index e254737df..1176c9edd 100755 --- a/lending/docs/models/operations/listaccountingbillsrequest.md +++ b/lending/docs/models/operations/listaccountingbillsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingbillsresponse.md b/lending/docs/models/operations/listaccountingbillsresponse.md index 8e7e791af..90c5c8257 100755 --- a/lending/docs/models/operations/listaccountingbillsresponse.md +++ b/lending/docs/models/operations/listaccountingbillsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_bills` | [Optional[shared.AccountingBills]](../../models/shared/accountingbills.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingcreditnotesrequest.md b/lending/docs/models/operations/listaccountingcreditnotesrequest.md index e6cddf1c7..f1417f926 100755 --- a/lending/docs/models/operations/listaccountingcreditnotesrequest.md +++ b/lending/docs/models/operations/listaccountingcreditnotesrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingcreditnotesresponse.md b/lending/docs/models/operations/listaccountingcreditnotesresponse.md index 474f7522c..a056a8d4e 100755 --- a/lending/docs/models/operations/listaccountingcreditnotesresponse.md +++ b/lending/docs/models/operations/listaccountingcreditnotesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_credit_notes` | [Optional[shared.AccountingCreditNotes]](../../models/shared/accountingcreditnotes.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingcustomerattachmentsrequest.md b/lending/docs/models/operations/listaccountingcustomerattachmentsrequest.md index 33b053ef7..9021f8274 100755 --- a/lending/docs/models/operations/listaccountingcustomerattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountingcustomerattachmentsrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `customer_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `customer_id` | *str* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md b/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md index abcf29d99..7fa1dbc7d 100755 --- a/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingcustomersrequest.md b/lending/docs/models/operations/listaccountingcustomersrequest.md index 99ab23d0e..af6bbf9d7 100755 --- a/lending/docs/models/operations/listaccountingcustomersrequest.md +++ b/lending/docs/models/operations/listaccountingcustomersrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingcustomersresponse.md b/lending/docs/models/operations/listaccountingcustomersresponse.md index 5c8f7e695..cfe47f7c2 100755 --- a/lending/docs/models/operations/listaccountingcustomersresponse.md +++ b/lending/docs/models/operations/listaccountingcustomersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_customers` | [Optional[shared.AccountingCustomers]](../../models/shared/accountingcustomers.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectcostattachmentsrequest.md b/lending/docs/models/operations/listaccountingdirectcostattachmentsrequest.md index d18fc71e7..55e027cfa 100755 --- a/lending/docs/models/operations/listaccountingdirectcostattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountingdirectcostattachmentsrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_cost_id` | *str* | :heavy_check_mark: | Unique identifier for a direct cost. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md b/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md index d11b2774b..b75e29f96 100755 --- a/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectcostsrequest.md b/lending/docs/models/operations/listaccountingdirectcostsrequest.md index 9badb0936..f4256c9e9 100755 --- a/lending/docs/models/operations/listaccountingdirectcostsrequest.md +++ b/lending/docs/models/operations/listaccountingdirectcostsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingdirectcostsresponse.md b/lending/docs/models/operations/listaccountingdirectcostsresponse.md index 2d9d27371..b7c72f2f2 100755 --- a/lending/docs/models/operations/listaccountingdirectcostsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectcostsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_direct_costs` | [Optional[shared.AccountingDirectCosts]](../../models/shared/accountingdirectcosts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectincomeattachmentsrequest.md b/lending/docs/models/operations/listaccountingdirectincomeattachmentsrequest.md index 60739af22..2c2514bac 100755 --- a/lending/docs/models/operations/listaccountingdirectincomeattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountingdirectincomeattachmentsrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `direct_income_id` | *str* | :heavy_check_mark: | Unique identifier for a direct income. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md b/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md index c244bcbc9..82ad154b6 100755 --- a/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingdirectincomesrequest.md b/lending/docs/models/operations/listaccountingdirectincomesrequest.md index 4d61c7d8e..65f2746da 100755 --- a/lending/docs/models/operations/listaccountingdirectincomesrequest.md +++ b/lending/docs/models/operations/listaccountingdirectincomesrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingdirectincomesresponse.md b/lending/docs/models/operations/listaccountingdirectincomesresponse.md index 3c7909e59..98f03e415 100755 --- a/lending/docs/models/operations/listaccountingdirectincomesresponse.md +++ b/lending/docs/models/operations/listaccountingdirectincomesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `accounting_direct_incomes` | [Optional[shared.AccountingDirectIncomes]](../../models/shared/accountingdirectincomes.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountinginvoiceattachmentsrequest.md b/lending/docs/models/operations/listaccountinginvoiceattachmentsrequest.md index 0608d4931..4df139e86 100755 --- a/lending/docs/models/operations/listaccountinginvoiceattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountinginvoiceattachmentsrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `invoice_id` | *str* | :heavy_check_mark: | Unique identifier for an invoice. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md b/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md index 588ed5cbb..1cfa9fd17 100755 --- a/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountinginvoicesrequest.md b/lending/docs/models/operations/listaccountinginvoicesrequest.md index 1efd17b8f..ddbb64b96 100755 --- a/lending/docs/models/operations/listaccountinginvoicesrequest.md +++ b/lending/docs/models/operations/listaccountinginvoicesrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountinginvoicesresponse.md b/lending/docs/models/operations/listaccountinginvoicesresponse.md index 8f8560e2c..1a19285df 100755 --- a/lending/docs/models/operations/listaccountinginvoicesresponse.md +++ b/lending/docs/models/operations/listaccountinginvoicesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_invoices` | [Optional[shared.AccountingInvoices]](../../models/shared/accountinginvoices.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingjournalentriesrequest.md b/lending/docs/models/operations/listaccountingjournalentriesrequest.md index cef5a8bc6..77d40e9ee 100755 --- a/lending/docs/models/operations/listaccountingjournalentriesrequest.md +++ b/lending/docs/models/operations/listaccountingjournalentriesrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingjournalentriesresponse.md b/lending/docs/models/operations/listaccountingjournalentriesresponse.md index 4fdf36b0a..d689481b1 100755 --- a/lending/docs/models/operations/listaccountingjournalentriesresponse.md +++ b/lending/docs/models/operations/listaccountingjournalentriesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `accounting_journal_entries` | [Optional[shared.AccountingJournalEntries]](../../models/shared/accountingjournalentries.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingjournalsrequest.md b/lending/docs/models/operations/listaccountingjournalsrequest.md index e8e2cb452..a5e9d7585 100755 --- a/lending/docs/models/operations/listaccountingjournalsrequest.md +++ b/lending/docs/models/operations/listaccountingjournalsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingjournalsresponse.md b/lending/docs/models/operations/listaccountingjournalsresponse.md index 30e358e04..65759133b 100755 --- a/lending/docs/models/operations/listaccountingjournalsresponse.md +++ b/lending/docs/models/operations/listaccountingjournalsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_journals` | [Optional[shared.AccountingJournals]](../../models/shared/accountingjournals.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingpaymentsrequest.md b/lending/docs/models/operations/listaccountingpaymentsrequest.md index 7fb88721c..799177f34 100755 --- a/lending/docs/models/operations/listaccountingpaymentsrequest.md +++ b/lending/docs/models/operations/listaccountingpaymentsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingpaymentsresponse.md b/lending/docs/models/operations/listaccountingpaymentsresponse.md index ff618993a..22d40ae77 100755 --- a/lending/docs/models/operations/listaccountingpaymentsresponse.md +++ b/lending/docs/models/operations/listaccountingpaymentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_payments` | [Optional[shared.AccountingPayments]](../../models/shared/accountingpayments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingsupplierattachmentsrequest.md b/lending/docs/models/operations/listaccountingsupplierattachmentsrequest.md index 2469747d9..0e9cb0bc7 100755 --- a/lending/docs/models/operations/listaccountingsupplierattachmentsrequest.md +++ b/lending/docs/models/operations/listaccountingsupplierattachmentsrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `supplier_id` | *str* | :heavy_check_mark: | Unique identifier for a supplier. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md b/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md index 3d8f81daa..af3d1ab79 100755 --- a/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingsuppliersrequest.md b/lending/docs/models/operations/listaccountingsuppliersrequest.md index 458539d78..9b02e42d1 100755 --- a/lending/docs/models/operations/listaccountingsuppliersrequest.md +++ b/lending/docs/models/operations/listaccountingsuppliersrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingsuppliersresponse.md b/lending/docs/models/operations/listaccountingsuppliersresponse.md index 5061915d3..183e5d5e0 100755 --- a/lending/docs/models/operations/listaccountingsuppliersresponse.md +++ b/lending/docs/models/operations/listaccountingsuppliersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_suppliers` | [Optional[shared.AccountingSuppliers]](../../models/shared/accountingsuppliers.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listaccountingtransfersrequest.md b/lending/docs/models/operations/listaccountingtransfersrequest.md index 893ca72a1..4936b63fe 100755 --- a/lending/docs/models/operations/listaccountingtransfersrequest.md +++ b/lending/docs/models/operations/listaccountingtransfersrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listaccountingtransfersresponse.md b/lending/docs/models/operations/listaccountingtransfersresponse.md index d29f05593..73ca94e77 100755 --- a/lending/docs/models/operations/listaccountingtransfersresponse.md +++ b/lending/docs/models/operations/listaccountingtransfersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_transfers` | [Optional[shared.AccountingTransfers]](../../models/shared/accountingtransfers.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listbankingaccountbalancesrequest.md b/lending/docs/models/operations/listbankingaccountbalancesrequest.md index 38296f28a..52c00640a 100755 --- a/lending/docs/models/operations/listbankingaccountbalancesrequest.md +++ b/lending/docs/models/operations/listbankingaccountbalancesrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listbankingaccountbalancesresponse.md b/lending/docs/models/operations/listbankingaccountbalancesresponse.md index d8f5e869b..4f4f23e77 100755 --- a/lending/docs/models/operations/listbankingaccountbalancesresponse.md +++ b/lending/docs/models/operations/listbankingaccountbalancesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `banking_account_balances` | [Optional[shared.BankingAccountBalances]](../../models/shared/bankingaccountbalances.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listbankingaccountsrequest.md b/lending/docs/models/operations/listbankingaccountsrequest.md index 86ccb6648..917912001 100755 --- a/lending/docs/models/operations/listbankingaccountsrequest.md +++ b/lending/docs/models/operations/listbankingaccountsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listbankingaccountsresponse.md b/lending/docs/models/operations/listbankingaccountsresponse.md index 4c5fb9876..93294bcb9 100755 --- a/lending/docs/models/operations/listbankingaccountsresponse.md +++ b/lending/docs/models/operations/listbankingaccountsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_accounts` | [Optional[shared.BankingAccounts]](../../models/shared/bankingaccounts.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listbankingtransactioncategoriesrequest.md b/lending/docs/models/operations/listbankingtransactioncategoriesrequest.md index 5874c4c9a..a81dd6806 100755 --- a/lending/docs/models/operations/listbankingtransactioncategoriesrequest.md +++ b/lending/docs/models/operations/listbankingtransactioncategoriesrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md b/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md index 5c932536b..77ebb0a54 100755 --- a/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md +++ b/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `banking_transaction_categories` | [Optional[shared.BankingTransactionCategories]](../../models/shared/bankingtransactioncategories.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listbankingtransactionsrequest.md b/lending/docs/models/operations/listbankingtransactionsrequest.md index cdd9c0a55..180ffb5f1 100755 --- a/lending/docs/models/operations/listbankingtransactionsrequest.md +++ b/lending/docs/models/operations/listbankingtransactionsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listbankingtransactionsresponse.md b/lending/docs/models/operations/listbankingtransactionsresponse.md index 1da85d503..2eefc367e 100755 --- a/lending/docs/models/operations/listbankingtransactionsresponse.md +++ b/lending/docs/models/operations/listbankingtransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_transactions` | [Optional[shared.BankingTransactions]](../../models/shared/bankingtransactions.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercecustomersrequest.md b/lending/docs/models/operations/listcommercecustomersrequest.md index 8e8182130..a8dc553f9 100755 --- a/lending/docs/models/operations/listcommercecustomersrequest.md +++ b/lending/docs/models/operations/listcommercecustomersrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommercecustomersresponse.md b/lending/docs/models/operations/listcommercecustomersresponse.md index 6e1960e2b..8b8a57ef6 100755 --- a/lending/docs/models/operations/listcommercecustomersresponse.md +++ b/lending/docs/models/operations/listcommercecustomersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customers` | [Optional[shared.CommerceCustomers]](../../models/shared/commercecustomers.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercedisputesrequest.md b/lending/docs/models/operations/listcommercedisputesrequest.md index 63b2d5c69..37776745c 100755 --- a/lending/docs/models/operations/listcommercedisputesrequest.md +++ b/lending/docs/models/operations/listcommercedisputesrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommercedisputesresponse.md b/lending/docs/models/operations/listcommercedisputesresponse.md index b945ac6c4..ad2949ad6 100755 --- a/lending/docs/models/operations/listcommercedisputesresponse.md +++ b/lending/docs/models/operations/listcommercedisputesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_disputes` | [Optional[shared.CommerceDisputes]](../../models/shared/commercedisputes.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercelocationsrequest.md b/lending/docs/models/operations/listcommercelocationsrequest.md index 210e397bc..8f84b7fe8 100755 --- a/lending/docs/models/operations/listcommercelocationsrequest.md +++ b/lending/docs/models/operations/listcommercelocationsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercelocationsresponse.md b/lending/docs/models/operations/listcommercelocationsresponse.md index 2826e01d7..c56356007 100755 --- a/lending/docs/models/operations/listcommercelocationsresponse.md +++ b/lending/docs/models/operations/listcommercelocationsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_locations` | [Optional[shared.CommerceLocations]](../../models/shared/commercelocations.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommerceordersrequest.md b/lending/docs/models/operations/listcommerceordersrequest.md index c2277180f..8a41c33c2 100755 --- a/lending/docs/models/operations/listcommerceordersrequest.md +++ b/lending/docs/models/operations/listcommerceordersrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommerceordersresponse.md b/lending/docs/models/operations/listcommerceordersresponse.md index a8dfb6e27..de4b9eccb 100755 --- a/lending/docs/models/operations/listcommerceordersresponse.md +++ b/lending/docs/models/operations/listcommerceordersresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_orders` | [Optional[shared.CommerceOrders]](../../models/shared/commerceorders.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercepaymentmethodsrequest.md b/lending/docs/models/operations/listcommercepaymentmethodsrequest.md index b092aca91..75202a1d7 100755 --- a/lending/docs/models/operations/listcommercepaymentmethodsrequest.md +++ b/lending/docs/models/operations/listcommercepaymentmethodsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommercepaymentmethodsresponse.md b/lending/docs/models/operations/listcommercepaymentmethodsresponse.md index 0e7218d16..1dfcf08cb 100755 --- a/lending/docs/models/operations/listcommercepaymentmethodsresponse.md +++ b/lending/docs/models/operations/listcommercepaymentmethodsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `commerce_payment_methods` | [Optional[shared.CommercePaymentMethods]](../../models/shared/commercepaymentmethods.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercepaymentsrequest.md b/lending/docs/models/operations/listcommercepaymentsrequest.md index 94c52bbcc..cf019922d 100755 --- a/lending/docs/models/operations/listcommercepaymentsrequest.md +++ b/lending/docs/models/operations/listcommercepaymentsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommercepaymentsresponse.md b/lending/docs/models/operations/listcommercepaymentsresponse.md index 03d62908f..6534b615e 100755 --- a/lending/docs/models/operations/listcommercepaymentsresponse.md +++ b/lending/docs/models/operations/listcommercepaymentsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payments` | [Optional[shared.CommercePayments]](../../models/shared/commercepayments.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommerceproductcategoriesrequest.md b/lending/docs/models/operations/listcommerceproductcategoriesrequest.md index daf973025..0022d533a 100755 --- a/lending/docs/models/operations/listcommerceproductcategoriesrequest.md +++ b/lending/docs/models/operations/listcommerceproductcategoriesrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommerceproductcategoriesresponse.md b/lending/docs/models/operations/listcommerceproductcategoriesresponse.md index 91a449832..7f59194be 100755 --- a/lending/docs/models/operations/listcommerceproductcategoriesresponse.md +++ b/lending/docs/models/operations/listcommerceproductcategoriesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `commerce_product_categories` | [Optional[shared.CommerceProductCategories]](../../models/shared/commerceproductcategories.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommerceproductsrequest.md b/lending/docs/models/operations/listcommerceproductsrequest.md index 7732ebee7..9d8dbae8e 100755 --- a/lending/docs/models/operations/listcommerceproductsrequest.md +++ b/lending/docs/models/operations/listcommerceproductsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommerceproductsresponse.md b/lending/docs/models/operations/listcommerceproductsresponse.md index d6b25fb86..c8b2b1c0d 100755 --- a/lending/docs/models/operations/listcommerceproductsresponse.md +++ b/lending/docs/models/operations/listcommerceproductsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_products` | [Optional[shared.CommerceProducts]](../../models/shared/commerceproducts.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcommercetransactionsrequest.md b/lending/docs/models/operations/listcommercetransactionsrequest.md index 32b12a7f2..2ad4e2072 100755 --- a/lending/docs/models/operations/listcommercetransactionsrequest.md +++ b/lending/docs/models/operations/listcommercetransactionsrequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcommercetransactionsresponse.md b/lending/docs/models/operations/listcommercetransactionsresponse.md index ea3f9f9f4..b5f60c346 100755 --- a/lending/docs/models/operations/listcommercetransactionsresponse.md +++ b/lending/docs/models/operations/listcommercetransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transactions` | [Optional[shared.CommerceTransactions]](../../models/shared/commercetransactions.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcompaniesresponse.md b/lending/docs/models/operations/listcompaniesresponse.md index 506ed1fa1..d9c512cea 100755 --- a/lending/docs/models/operations/listcompaniesresponse.md +++ b/lending/docs/models/operations/listcompaniesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listconnectionsrequest.md b/lending/docs/models/operations/listconnectionsrequest.md index 1cdcf0879..e13ad736b 100755 --- a/lending/docs/models/operations/listconnectionsrequest.md +++ b/lending/docs/models/operations/listconnectionsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listconnectionsresponse.md b/lending/docs/models/operations/listconnectionsresponse.md index 68f439c07..0de0ad796 100755 --- a/lending/docs/models/operations/listconnectionsresponse.md +++ b/lending/docs/models/operations/listconnectionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcreateoperationsrequest.md b/lending/docs/models/operations/listcreateoperationsrequest.md index 18afa5f66..81b28fc41 100755 --- a/lending/docs/models/operations/listcreateoperationsrequest.md +++ b/lending/docs/models/operations/listcreateoperationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listcreateoperationsresponse.md b/lending/docs/models/operations/listcreateoperationsresponse.md index bb3ebf648..0540ee668 100755 --- a/lending/docs/models/operations/listcreateoperationsresponse.md +++ b/lending/docs/models/operations/listcreateoperationsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `push_operations` | [Optional[shared.PushOperations]](../../models/shared/pushoperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listdataintegritydetailsrequest.md b/lending/docs/models/operations/listdataintegritydetailsrequest.md index 1b9375897..d400a4062 100755 --- a/lending/docs/models/operations/listdataintegritydetailsrequest.md +++ b/lending/docs/models/operations/listdataintegritydetailsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data_type` | [shared.DataIntegrityDataType](../../models/shared/dataintegritydatatype.md) | :heavy_check_mark: | A key for a Codat data type. | banking-accounts | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | diff --git a/lending/docs/models/operations/listdataintegritydetailsresponse.md b/lending/docs/models/operations/listdataintegritydetailsresponse.md index adb2dc25f..e6681428c 100755 --- a/lending/docs/models/operations/listdataintegritydetailsresponse.md +++ b/lending/docs/models/operations/listdataintegritydetailsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `data_integrity_details` | [Optional[shared.DataIntegrityDetails]](../../models/shared/dataintegritydetails.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listfilesrequest.md b/lending/docs/models/operations/listfilesrequest.md index bb6dd7f67..23e4a10f6 100755 --- a/lending/docs/models/operations/listfilesrequest.md +++ b/lending/docs/models/operations/listfilesrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/listfilesresponse.md b/lending/docs/models/operations/listfilesresponse.md index 412d61f5a..ecb2a827e 100755 --- a/lending/docs/models/operations/listfilesresponse.md +++ b/lending/docs/models/operations/listfilesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `files` | list[[shared.File](../../models/shared/file.md)] | :heavy_minus_sign: | Success | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `files` | List[[shared.File](../../models/shared/file.md)] | :heavy_minus_sign: | Success | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listloantransactionsrequest.md b/lending/docs/models/operations/listloantransactionsrequest.md index 1cf83c687..dc1c0a28e 100755 --- a/lending/docs/models/operations/listloantransactionsrequest.md +++ b/lending/docs/models/operations/listloantransactionsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `source_type` | [ListLoanTransactionsSourceType](../../models/operations/listloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [ListLoanTransactionsSourceType](../../models/operations/listloantransactionssourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file diff --git a/lending/docs/models/operations/listloantransactionsresponse.md b/lending/docs/models/operations/listloantransactionsresponse.md index 8ee977bb7..bf5515d58 100755 --- a/lending/docs/models/operations/listloantransactionsresponse.md +++ b/lending/docs/models/operations/listloantransactionsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `loan_transactions` | [Optional[shared.LoanTransactions]](../../models/shared/loantransactions.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listloantransactionssourcetype.md b/lending/docs/models/operations/listloantransactionssourcetype.md index 031dcbfc8..0019f1c99 100755 --- a/lending/docs/models/operations/listloantransactionssourcetype.md +++ b/lending/docs/models/operations/listloantransactionssourcetype.md @@ -1,6 +1,6 @@ # ListLoanTransactionsSourceType -Data source type +Data source type. ## Values diff --git a/lending/docs/models/operations/listpulloperationsrequest.md b/lending/docs/models/operations/listpulloperationsrequest.md index d5a4b553d..bdf3bef92 100755 --- a/lending/docs/models/operations/listpulloperationsrequest.md +++ b/lending/docs/models/operations/listpulloperationsrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/lending/docs/models/operations/listpulloperationsresponse.md b/lending/docs/models/operations/listpulloperationsresponse.md index 23240bd20..feff59654 100755 --- a/lending/docs/models/operations/listpulloperationsresponse.md +++ b/lending/docs/models/operations/listpulloperationsresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `pull_operations` | [Optional[shared.PullOperations]](../../models/shared/pulloperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listreconciledinvoicesrequest.md b/lending/docs/models/operations/listreconciledinvoicesrequest.md index 322f13119..aed5d02d0 100755 --- a/lending/docs/models/operations/listreconciledinvoicesrequest.md +++ b/lending/docs/models/operations/listreconciledinvoicesrequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | | `query` | *Optional[str]* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | | \ No newline at end of file diff --git a/lending/docs/models/operations/listreconciledinvoicesresponse.md b/lending/docs/models/operations/listreconciledinvoicesresponse.md index 325a55cc6..86abcc6a4 100755 --- a/lending/docs/models/operations/listreconciledinvoicesresponse.md +++ b/lending/docs/models/operations/listreconciledinvoicesresponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `enhanced_invoices_report` | [Optional[shared.EnhancedInvoicesReport]](../../models/shared/enhancedinvoicesreport.md) | :heavy_minus_sign: | OK | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/refreshalldatatypesrequest.md b/lending/docs/models/operations/refreshalldatatypesrequest.md index 33fb640ed..ea381e387 100755 --- a/lending/docs/models/operations/refreshalldatatypesrequest.md +++ b/lending/docs/models/operations/refreshalldatatypesrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/refreshalldatatypesresponse.md b/lending/docs/models/operations/refreshalldatatypesresponse.md index 22a543959..0788fc5da 100755 --- a/lending/docs/models/operations/refreshalldatatypesresponse.md +++ b/lending/docs/models/operations/refreshalldatatypesresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/refreshdatatyperequest.md b/lending/docs/models/operations/refreshdatatyperequest.md index cbefc996f..257381833 100755 --- a/lending/docs/models/operations/refreshdatatyperequest.md +++ b/lending/docs/models/operations/refreshdatatyperequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connection_id` | *Optional[str]* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | | `data_type` | [shared.DataType](../../models/shared/datatype.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file diff --git a/lending/docs/models/operations/refreshdatatyperesponse.md b/lending/docs/models/operations/refreshdatatyperesponse.md index 73215c3bd..5a4e614bb 100755 --- a/lending/docs/models/operations/refreshdatatyperesponse.md +++ b/lending/docs/models/operations/refreshdatatyperesponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/unlinkconnectionrequest.md b/lending/docs/models/operations/unlinkconnectionrequest.md index d20863dce..1f83e7cfa 100755 --- a/lending/docs/models/operations/unlinkconnectionrequest.md +++ b/lending/docs/models/operations/unlinkconnectionrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | `request_body` | [Optional[UnlinkConnectionUpdateConnection]](../../models/operations/unlinkconnectionupdateconnection.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/unlinkconnectionresponse.md b/lending/docs/models/operations/unlinkconnectionresponse.md index ced538908..642e8e815 100755 --- a/lending/docs/models/operations/unlinkconnectionresponse.md +++ b/lending/docs/models/operations/unlinkconnectionresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/updatecompanyrequest.md b/lending/docs/models/operations/updatecompanyrequest.md index 697f00528..7b76c7562 100755 --- a/lending/docs/models/operations/updatecompanyrequest.md +++ b/lending/docs/models/operations/updatecompanyrequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `company_request_body` | [Optional[shared.CompanyRequestBody]](../../models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/models/operations/updatecompanyresponse.md b/lending/docs/models/operations/updatecompanyresponse.md index 9b9c51eef..b60ed7a56 100755 --- a/lending/docs/models/operations/updatecompanyresponse.md +++ b/lending/docs/models/operations/updatecompanyresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/uploadfilesrequest.md b/lending/docs/models/operations/uploadfilesrequest.md index 3d98cc629..3894d4295 100755 --- a/lending/docs/models/operations/uploadfilesrequest.md +++ b/lending/docs/models/operations/uploadfilesrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `request_body` | [Optional[UploadFilesRequestBody]](../../models/operations/uploadfilesrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/lending/docs/models/operations/uploadfilesresponse.md b/lending/docs/models/operations/uploadfilesresponse.md index dd258b538..e0507d288 100755 --- a/lending/docs/models/operations/uploadfilesresponse.md +++ b/lending/docs/models/operations/uploadfilesresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaccount.md b/lending/docs/models/shared/accountingaccount.md index 7035b796b..d2c342843 100755 --- a/lending/docs/models/shared/accountingaccount.md +++ b/lending/docs/models/shared/accountingaccount.md @@ -20,7 +20,7 @@ The same account may have a different category based on the integration it is us At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided. To determine the list of allowed categories for a specific integration, you can: -- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). +- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). - Refer to the integration's own documentation. > **Accounts with no category** @@ -47,5 +47,6 @@ To determine the list of allowed categories for a specific integration, you can: | `nominal_code` | *Optional[str]* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [Optional[AccountStatus]](../../models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `type` | [Optional[AccountType]](../../models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset | -| `valid_datatype_links` | list[[AccountingAccountValidDataTypeLinks](../../models/shared/accountingaccountvaliddatatypelinks.md)] | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `valid_datatype_links` | List[[AccountingAccountValidDataTypeLinks](../../models/shared/accountingaccountvaliddatatypelinks.md)] | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/lending-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaccounts.md b/lending/docs/models/shared/accountingaccounts.md index 21007a9e8..e47ee4ee7 100755 --- a/lending/docs/models/shared/accountingaccounts.md +++ b/lending/docs/models/shared/accountingaccounts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingAccount](../../models/shared/accountingaccount.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingAccount](../../models/shared/accountingaccount.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaccounttransaction.md b/lending/docs/models/shared/accountingaccounttransaction.md index e9de61afc..9fe78c8d4 100755 --- a/lending/docs/models/shared/accountingaccounttransaction.md +++ b/lending/docs/models/shared/accountingaccounttransaction.md @@ -1,6 +1,6 @@ # AccountingAccountTransaction -> **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions). +> **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). > View the coverage for account transactions in the Data coverage explorer. @@ -16,7 +16,7 @@ Account transactions are created as a result of different business activities, f * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. * Transfers: for example, transferring money between two bank accounts. -Account transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer). +Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). ## Fields @@ -28,7 +28,7 @@ Account transactions is the parent data type of [payments](https://docs.codat.io | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the direct cost (unique to the company). | | -| `lines` | list[[AccountTransactionLine](../../models/shared/accounttransactionline.md)] | :heavy_minus_sign: | Array of account transaction lines. | | +| `lines` | List[[AccountTransactionLine](../../models/shared/accounttransactionline.md)] | :heavy_minus_sign: | Array of account transaction lines. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Additional information about the account transaction, if available. | | diff --git a/lending/docs/models/shared/accountingaccounttransactions.md b/lending/docs/models/shared/accountingaccounttransactions.md index ed68f5313..223abf4e5 100755 --- a/lending/docs/models/shared/accountingaccounttransactions.md +++ b/lending/docs/models/shared/accountingaccounttransactions.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingAccountTransaction](../../models/shared/accountingaccounttransaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingAccountTransaction](../../models/shared/accountingaccounttransaction.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaccountvaliddatatypelinks.md b/lending/docs/models/shared/accountingaccountvaliddatatypelinks.md index b5f41a9e1..fd889b8c6 100755 --- a/lending/docs/models/shared/accountingaccountvaliddatatypelinks.md +++ b/lending/docs/models/shared/accountingaccountvaliddatatypelinks.md @@ -46,5 +46,5 @@ If you'd like us to extend support to more data types or integrations, suggest o | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `links` | list[*str*] | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | +| `links` | List[*str*] | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | | `property` | *Optional[str]* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingagedcreditorreport.md b/lending/docs/models/shared/accountingagedcreditorreport.md index 50a0fad78..02b22e850 100755 --- a/lending/docs/models/shared/accountingagedcreditorreport.md +++ b/lending/docs/models/shared/accountingagedcreditorreport.md @@ -10,7 +10,7 @@ Total assets or liabilities are grouped into 30-day periods for each supplier, u ## Underlying data -The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). +The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. @@ -38,6 +38,6 @@ The report will be grouped per supplier and depending on the periods requested. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | list[[AgedCreditor](../../models/shared/agedcreditor.md)] | :heavy_minus_sign: | Array of aged creditor. | | +| `data` | List[[AgedCreditor](../../models/shared/agedcreditor.md)] | :heavy_minus_sign: | Array of aged creditor. | | | `generated` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `report_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingageddebtorreport.md b/lending/docs/models/shared/accountingageddebtorreport.md index 7c7342670..bab1b7c80 100755 --- a/lending/docs/models/shared/accountingageddebtorreport.md +++ b/lending/docs/models/shared/accountingageddebtorreport.md @@ -10,7 +10,7 @@ Total assets or liabilities are grouped into 30-day periods for each customer, u ## Underlying data -The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment). +The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. @@ -38,6 +38,6 @@ The report will be grouped per supplier and depending on the periods requested. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | list[[AgedDebtor](../../models/shared/ageddebtor.md)] | :heavy_minus_sign: | Array of aged debtors. | | +| `data` | List[[AgedDebtor](../../models/shared/ageddebtor.md)] | :heavy_minus_sign: | Array of aged debtors. | | | `generated` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `report_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingattachment.md b/lending/docs/models/shared/accountingattachment.md index a029eef03..b6c85f479 100755 --- a/lending/docs/models/shared/accountingattachment.md +++ b/lending/docs/models/shared/accountingattachment.md @@ -6,7 +6,7 @@ The Codat API supports pulling and pushing of file attachments for invoices, bil > > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. -Unlike other data types, Codat doesn't support sync settings for attachments. +Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. Note that different integrations have different requirements to file size and extension of attachments. diff --git a/lending/docs/models/shared/accountingbalancesheet.md b/lending/docs/models/shared/accountingbalancesheet.md index 45f6c8411..31330441c 100755 --- a/lending/docs/models/shared/accountingbalancesheet.md +++ b/lending/docs/models/shared/accountingbalancesheet.md @@ -27,4 +27,4 @@ Our [Enhanced Financials](https://docs.codat.io/assess/enhanced-financials/overv | `currency` | *str* | :heavy_check_mark: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `earliest_available_month` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `most_recent_available_month` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `reports` | list[[BalanceSheet](../../models/shared/balancesheet.md)] | :heavy_check_mark: | An array of balance sheet reports. | | \ No newline at end of file +| `reports` | List[[BalanceSheet](../../models/shared/balancesheet.md)] | :heavy_check_mark: | An array of balance sheet reports. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbankaccount.md b/lending/docs/models/shared/accountingbankaccount.md index 21259f6e1..f93c348fc 100755 --- a/lending/docs/models/shared/accountingbankaccount.md +++ b/lending/docs/models/shared/accountingbankaccount.md @@ -4,7 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account) +> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/schemas/Account) > View the coverage for bank accounts in the Data coverage explorer. @@ -36,4 +36,5 @@ Bank accounts data includes: | `nominal_code` | *Optional[str]* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | | `overdraft_limit` | *Optional[Decimal]* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | | `sort_code` | *Optional[str]* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbankaccounts.md b/lending/docs/models/shared/accountingbankaccounts.md index 7eb246961..20e31a072 100755 --- a/lending/docs/models/shared/accountingbankaccounts.md +++ b/lending/docs/models/shared/accountingbankaccounts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBankAccount](../../models/shared/accountingbankaccount.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBankAccount](../../models/shared/accountingbankaccount.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbanktransaction.md b/lending/docs/models/shared/accountingbanktransaction.md index 8ea4615c4..991d1fce5 100755 --- a/lending/docs/models/shared/accountingbanktransaction.md +++ b/lending/docs/models/shared/accountingbanktransaction.md @@ -4,7 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions) +> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions) > View the coverage for bank transactions in the Data coverage explorer. @@ -22,13 +22,13 @@ Bank transactions include the: | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `balance` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `account_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier to the `accountId` the bank transactions originates from. | | +| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount transacted in the bank transaction. | | +| `balance` | *Optional[Decimal]* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. | | | `cleared_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the bank transaction. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bank transaction, unique to the company in the accounting platform. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `reconciled` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `reconciled` | *Optional[bool]* | :heavy_minus_sign: | `True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting platform. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `transaction_type` | [Optional[BankTransactionType]](../../models/shared/banktransactiontype.md) | :heavy_minus_sign: | Type of transaction for the bank statement line | | \ No newline at end of file +| `transaction_type` | [Optional[BankTransactionType]](../../models/shared/banktransactiontype.md) | :heavy_minus_sign: | Type of transaction for the bank statement line. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbanktransactions.md b/lending/docs/models/shared/accountingbanktransactions.md index 6afbb619d..e2d0f30c1 100755 --- a/lending/docs/models/shared/accountingbanktransactions.md +++ b/lending/docs/models/shared/accountingbanktransactions.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBankTransaction](../../models/shared/accountingbanktransaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBankTransaction](../../models/shared/accountingbanktransaction.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbill.md b/lending/docs/models/shared/accountingbill.md index 11a2a2382..fb9e4226b 100755 --- a/lending/docs/models/shared/accountingbill.md +++ b/lending/docs/models/shared/accountingbill.md @@ -4,7 +4,7 @@ > > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. > -> See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills. +> See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. View the coverage for bills in the Data coverage explorer. @@ -18,7 +18,7 @@ In Codat, a bill contains details of: Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. -You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model. +You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. ## Fields @@ -31,12 +31,12 @@ You can find these types of transactions in our [Direct costs](https://docs.coda | `due_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bill, unique for the company in the accounting platform. | | | `issue_date` | *str* | :heavy_check_mark: | N/A | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[BillLineItem](../../models/shared/billlineitem.md)] | :heavy_minus_sign: | Array of Bill line items. | | +| `line_items` | List[[BillLineItem](../../models/shared/billlineitem.md)] | :heavy_minus_sign: | Array of Bill line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any private, company notes about the bill, such as payment information. | | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | -| `purchase_order_refs` | list[[AccountingBillPurchaseOrderReference](../../models/shared/accountingbillpurchaseorderreference.md)] | :heavy_minus_sign: | N/A | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `purchase_order_refs` | List[[AccountingBillPurchaseOrderReference](../../models/shared/accountingbillpurchaseorderreference.md)] | :heavy_minus_sign: | N/A | | | `reference` | *Optional[str]* | :heavy_minus_sign: | User-friendly reference for the bill. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [BillStatus](../../models/shared/billstatus.md) | :heavy_check_mark: | Current state of the bill. | | @@ -45,4 +45,4 @@ You can find these types of transactions in our [Direct costs](https://docs.coda | `supplier_ref` | [Optional[SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | | `tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax on the bill. | | | `total_amount` | *Decimal* | :heavy_check_mark: | Amount of the bill, including tax. | | -| `withholding_tax` | list[[AccountingBillWithholdingTax](../../models/shared/accountingbillwithholdingtax.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[AccountingBillWithholdingTax](../../models/shared/accountingbillwithholdingtax.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillcreditnote.md b/lending/docs/models/shared/accountingbillcreditnote.md index 80df56081..5c20e3abd 100755 --- a/lending/docs/models/shared/accountingbillcreditnote.md +++ b/lending/docs/models/shared/accountingbillcreditnote.md @@ -2,7 +2,7 @@ > **Bill credit notes or credit notes?** > -> In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). +> In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). View the coverage for bill credit notes in the Data coverage explorer. @@ -10,11 +10,11 @@ View the coverage for bill credit notes in the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[BillCreditNoteLineItem](../../models/shared/billcreditnotelineitem.md)] | :heavy_minus_sign: | An array of line | | +| `line_items` | List[[BillCreditNoteLineItem](../../models/shared/billcreditnotelineitem.md)] | :heavy_minus_sign: | An array of line | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information about the bill credit note. | Bill Credit Note with 1 line items, totaling 805.78 | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | | `remaining_credit` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the bill credit note that is still outstanding. | 0 | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [BillCreditNoteStatus](../../models/shared/billcreditnotestatus.md) | :heavy_check_mark: | Current state of the bill credit note | Paid | @@ -43,4 +43,4 @@ A bill credit note includes details of: | `total_amount` | *Decimal* | :heavy_check_mark: | Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax. | 805.78 | | `total_discount` | *Decimal* | :heavy_check_mark: | Total value of any discounts applied. | 0 | | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax included in the bill credit note. | 0 | -| `withholding_tax` | list[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillcreditnotes.md b/lending/docs/models/shared/accountingbillcreditnotes.md index 64fb1209a..483881501 100755 --- a/lending/docs/models/shared/accountingbillcreditnotes.md +++ b/lending/docs/models/shared/accountingbillcreditnotes.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBillCreditNote](../../models/shared/accountingbillcreditnote.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBillCreditNote](../../models/shared/accountingbillcreditnote.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillpayment.md b/lending/docs/models/shared/accountingbillpayment.md index fb4969dea..e2aadc51b 100755 --- a/lending/docs/models/shared/accountingbillpayment.md +++ b/lending/docs/models/shared/accountingbillpayment.md @@ -4,13 +4,13 @@ > > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment. > -> See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). +> See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). > View the coverage for bill payments in the Data coverage explorer. ## Overview -Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)). +Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)). A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to: @@ -27,9 +27,9 @@ In Codat, a bill payment contains details of: - Who the payment has been paid to, the _supplier_. - The types of bill payments, the _line items_. -Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model. +Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. -Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). +Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). --- @@ -162,11 +162,11 @@ These two rates allow the calculation of currency loss or gain for any of the tr | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `date_` | *str* | :heavy_check_mark: | N/A | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bill payment, unique for the company in the accounting platform. | 3d5a8e00-d108-4045-8823-7f342676cffa | -| `lines` | list[[BillPaymentLine](../../models/shared/billpaymentline.md)] | :heavy_minus_sign: | An array of bill payment lines. | | +| `lines` | List[[BillPaymentLine](../../models/shared/billpaymentline.md)] | :heavy_minus_sign: | An array of bill payment lines. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Additional information associated with the payment. | Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 | -| `payment_method_ref` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | N/A | | | `reference` | *Optional[str]* | :heavy_minus_sign: | Additional information associated with the payment. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | diff --git a/lending/docs/models/shared/accountingbillpayments.md b/lending/docs/models/shared/accountingbillpayments.md index 5a5edfcd2..b2d506ffd 100755 --- a/lending/docs/models/shared/accountingbillpayments.md +++ b/lending/docs/models/shared/accountingbillpayments.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBillPayment](../../models/shared/accountingbillpayment.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBillPayment](../../models/shared/accountingbillpayment.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbills.md b/lending/docs/models/shared/accountingbills.md index 3d37edb3e..e2cbac161 100755 --- a/lending/docs/models/shared/accountingbills.md +++ b/lending/docs/models/shared/accountingbills.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingBill](../../models/shared/accountingbill.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingBill](../../models/shared/accountingbill.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillwithholdingtax.md b/lending/docs/models/shared/accountingbillwithholdingtax.md index ec6202787..c12239ded 100755 --- a/lending/docs/models/shared/accountingbillwithholdingtax.md +++ b/lending/docs/models/shared/accountingbillwithholdingtax.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `amount` | *Decimal* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `amount` | *Decimal* | :heavy_check_mark: | Amount of tax withheld. | +| `name` | *str* | :heavy_check_mark: | Name assigned to withheld tax. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcashflowstatement.md b/lending/docs/models/shared/accountingcashflowstatement.md index c87c21049..7e2a13364 100755 --- a/lending/docs/models/shared/accountingcashflowstatement.md +++ b/lending/docs/models/shared/accountingcashflowstatement.md @@ -24,4 +24,4 @@ A cash flow statement is a financial report that records all cash that is receiv | `most_recent_available_month` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `report_basis` | [ReportBasis](../../models/shared/reportbasis.md) | :heavy_check_mark: | Accounting method used when aggregating the report data. In this case, `Cash`. | | | `report_input` | [ReportInput](../../models/shared/reportinput.md) | :heavy_check_mark: | Accounting method used to prepare the cash flow statement. | | -| `reports` | list[[CashFlowStatement](../../models/shared/cashflowstatement.md)] | :heavy_check_mark: | Array of cash flow statements. | | \ No newline at end of file +| `reports` | List[[CashFlowStatement](../../models/shared/cashflowstatement.md)] | :heavy_check_mark: | Array of cash flow statements. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcompanyinfo.md b/lending/docs/models/shared/accountingcompanyinfo.md index 88313fcb2..09e78b617 100755 --- a/lending/docs/models/shared/accountingcompanyinfo.md +++ b/lending/docs/models/shared/accountingcompanyinfo.md @@ -14,15 +14,16 @@ Company info provides standard details about a linked company such as their addr | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accounting_platform_ref` | *Optional[str]* | :heavy_minus_sign: | Identifier or reference for the company in the accounting platform. | | -| `addresses` | list[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | | `base_currency` | *Optional[str]* | :heavy_minus_sign: | Currency set in the accounting platform of the linked company. Used by the currency rate. | | | `company_legal_name` | *Optional[str]* | :heavy_minus_sign: | Registered legal name of the linked company. | | | `company_name` | *Optional[str]* | :heavy_minus_sign: | Name of the linked company. | | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `financial_year_start_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `ledger_lock_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `phone_numbers` | list[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | An array of phone numbers. | | +| `phone_numbers` | List[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | An array of phone numbers. | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. | | -| `source_urls` | dict[str, *str*] | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | +| `source_urls` | Dict[str, *str*] | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `tax_number` | *Optional[str]* | :heavy_minus_sign: | Company tax number. | | -| `web_links` | list[[WebLink](../../models/shared/weblink.md)] | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file +| `web_links` | List[[WebLink](../../models/shared/weblink.md)] | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreateaccountresponse.md b/lending/docs/models/shared/accountingcreateaccountresponse.md index 5db0889c7..0443246a1 100755 --- a/lending/docs/models/shared/accountingcreateaccountresponse.md +++ b/lending/docs/models/shared/accountingcreateaccountresponse.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data` | [Optional[AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.

View the coverage for accounts in the Data coverage explorer.

## Overview

Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.

The categories for an account include:
* Asset
* Expense
* Income
* Liability
* Equity.

The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.

At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.

To determine the list of allowed categories for a specific integration, you can:
- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).
- Refer to the integration's own documentation.

> **Accounts with no category**
>
> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
>
> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. | | -| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | -| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | -| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `data` | [Optional[AccountingAccount]](../../models/shared/accountingaccount.md) | :heavy_minus_sign: | > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.

View the coverage for accounts in the Data coverage explorer.

## Overview

Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.

The categories for an account include:
* Asset
* Expense
* Income
* Liability
* Equity.

The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.

At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.

To determine the list of allowed categories for a specific integration, you can:
- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).
- Refer to the integration's own documentation.

> **Accounts with no category**
>
> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
>
> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports. | | +| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | +| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatebankaccountresponse.md b/lending/docs/models/shared/accountingcreatebankaccountresponse.md deleted file mode 100755 index 1e55721ce..000000000 --- a/lending/docs/models/shared/accountingcreatebankaccountresponse.md +++ /dev/null @@ -1,21 +0,0 @@ -# AccountingCreateBankAccountResponse - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data` | [Optional[AccountingBankAccount]](../../models/shared/accountingbankaccount.md) | :heavy_minus_sign: | > **Accessing Bank Accounts through Banking API**
>
> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
>
> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)

> View the coverage for bank accounts in the Data coverage explorer.

## Overview

A list of bank accounts associated with a company and a specific data connection.

Bank accounts data includes:
* The name and ID of the account in the accounting platform.
* The currency and balance of the account.
* The sort code and account number. | | -| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | -| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | -| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatebanktransactions.md b/lending/docs/models/shared/accountingcreatebanktransactions.md index c271ad17e..ccdfbaa73 100755 --- a/lending/docs/models/shared/accountingcreatebanktransactions.md +++ b/lending/docs/models/shared/accountingcreatebanktransactions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `account_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `transactions` | list[[CreateBankAccountTransaction](../../models/shared/createbankaccounttransaction.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `account_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a bank account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `transactions` | List[[CreateBankAccountTransaction](../../models/shared/createbankaccounttransaction.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatebanktransactionsresponse.md b/lending/docs/models/shared/accountingcreatebanktransactionsresponse.md index 6eb8b39e1..aaa9e2830 100755 --- a/lending/docs/models/shared/accountingcreatebanktransactionsresponse.md +++ b/lending/docs/models/shared/accountingcreatebanktransactionsresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data` | [Optional[AccountingCreateBankTransactions]](../../models/shared/accountingcreatebanktransactions.md) | :heavy_minus_sign: | N/A | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatedirectcostresponse.md b/lending/docs/models/shared/accountingcreatedirectcostresponse.md index 152fc8446..453c0e1e5 100755 --- a/lending/docs/models/shared/accountingcreatedirectcostresponse.md +++ b/lending/docs/models/shared/accountingcreatedirectcostresponse.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data` | [Optional[AccountingDirectCost]](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.

> View the coverage for direct costs in the Data coverage explorer.

## Overview

Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.

Direct costs include:
* Purchasing an item and paying it off at the point of the purchase
* Receiving cash from a refunded item if the refund is made by the supplier
* Withdrawing money from a bank account
* Writing a cheque

Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). | | -| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | -| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | -| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `data` | [Optional[AccountingDirectCost]](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.

> View the coverage for direct costs in the Data coverage explorer.

## Overview

Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.

Direct costs include:
* Purchasing an item and paying it off at the point of the purchase
* Receiving cash from a refunded item if the refund is made by the supplier
* Withdrawing money from a bank account
* Writing a cheque

Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). | | +| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | +| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatepaymentresponse.md b/lending/docs/models/shared/accountingcreatepaymentresponse.md new file mode 100755 index 000000000..7ee4b081a --- /dev/null +++ b/lending/docs/models/shared/accountingcreatepaymentresponse.md @@ -0,0 +1,21 @@ +# AccountingCreatePaymentResponse + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `data` | [Optional[AccountingPayment]](../../models/shared/accountingpayment.md) | :heavy_minus_sign: | > **Payments or bill payments?**
>
> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.

> View the coverage for payments in the Data coverage explorer.

## Overview

Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).

A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:

- A payment made against an invoice, like a credit card, cheque, or cash payment.
- An allocation of a customer's credit note, either to an invoice or maybe a refund.
- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.

Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details.

In Codat, a payment contains details of:

- When the payment was recorded in the accounting system.
- How much it is for and in what currency that amount is in.
- Who the payment was _paid by_ – the _customer_.
- The payment method used.
- The breakdown of the types of payments – the _line items_.

Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).

## Payment types

## Payment of an invoice

A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:

- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of **link**, in this case an `Invoice`.
- An **id** that contains the ID of the invoice that was paid.
- An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.

The **amount** field on the **line** equals the **totalAmount** on the payment.

## Payment of multiple invoices

A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:

- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).
- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.

Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.

## Payments and refunds on account

A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:

- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.
- The **id** containing the ID of the customer.
- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.

It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.

## Using a credit note to pay an invoice

The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:

- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.
- A **links** array containing two elements:
- The first **link** has:
- A **type** that indicates the type of **link**, in this case an `Invoice`.
- An **id** that contains the ID of the invoice that was paid.
- The second **link** has:
- A **type** that indicates the type of **link**, in this case a `CreditNote`.
- An **id** that contains the ID of the credit note used by this payment.

The **amount** field on the **line** equals the **totalAmount** on the payment.

## Refunding a credit note

A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:

- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.
- A **links** array that contains one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `CreditNote`.
- An **id** that contains the ID of the credit note that was refunded.

The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.

## Refunding a payment

If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:

- One for the incoming over payment.
- Another for the outgoing refund.

The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:

- An **amount** that indicates the amount that was refunded. This is always negative.
- A **links** array that contains one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `Payment`.
- An **id** that contains the ID of the payment that was refunded.

The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.

The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.

For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:

- One for £1,000 linked to the invoice that was paid.
- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.

The **line** linked to the payment has the following properties:

- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
- A **links** array containing one element with the following properties:
- A **type** that indicates the type of **link**, in this case a `Refund`.
- An **id** that contains the ID of the payment that refunded this line.

> **Support for linked payments**
>
> Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.

## Foreign currencies

There are two types of currency rate that are included in the payments data type:

Payment currency rate:

- Base currency of the accounts receivable account.
- Foreign currency of the payment.

Payment line link currency rate:

- Base currency of the item the link represents.
- Foreign currency of the payment.

These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:

- The base currency for the accounts receivable account.
- The currency of the item.

```json title="Currency rate example"
{
"id": "123",
"note": ""
"totalAmount": 99.99,
"currency": "GBP",
"lines": [
{
"amount": 99.99,
"links": [
{
"type": "Invoice",
"id": "178",
"amount": -50,
"currencyRate": 1.9998,
}
]
}
]
}
```



## Example data

> **Object properties**
>
> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).

## Simple examples

```json title="Payment for invoice"
{
"totalAmount": 1000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
}
]
}
```



```json title="Allocation of credit note"
{
"totalAmount": 0,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Payment of invoice and payment on account"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "y",
"amount" : -1000
}
]
}
]
}
```



```json title="Refund of credit note"
{
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Refund on accounts receivable account"
{
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "y",
"amount" : 1000
}
]
}
]
}
```



```json title="Linked refund on accounts receivable account"
{
"id" : "payment-001",
"totalAmount": 1000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Refund",
"id" : "refund-001",
"amount" : -1000
}
]
}
]
}
{
"id" : "refund-001",
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "Payment",
"id" : "payment-001",
"amount" : 1000
}
]
}
]
}
```



```json title="Using a credit note and cash to pay an invoice"
{
"totalAmount": 250,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Invoice",
"id": "x",
"amount": -750
},
{
"type": "CreditNote",
"id": "y",
"amount": 750
}
]
},
{
"amount": 250,
"links": [
{
"type": "Invoice",
"id": "x",
"amount": -250
}
]
}
]
}
```



## Complex examples

```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
{
"totalAmount": 1000,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
},
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
}
]
}
```



```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
}
]
},
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "customer-001",
"amount" : -1000
}
]
}
]
}
```



```json title="Two credit notes pay two invoices with no allocation amount specified"
{
"totalAmount": 0,
"lines": [
{
"amount" : 0,
"links" : [
{
"type" : "Invoice",
"id" : "w",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
}
]
}
```



```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
{
"totalAmount": 2000,
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "w",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "x",
"amount" : -1000
},
{
"type" : "Invoice",
"id" : "u",
"amount" : -1000
},
{
"type" : "CreditNote",
"id" : "y",
"amount" : 1000
},
{
"type" : "CreditNote",
"id" : "z",
"amount" : 1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Refund",
"id" : "refund-001",
"amount" : -1000
}
]
}
]
}
{
"id" : "refund-001",
"totalAmount": -1000,
"lines": [
{
"amount" : -1000,
"links" : [
{
"type" : "Payment",
"id" : "payment-001",
"amount" : 1000
}
]
}
]
}
```



In this example, a payment on account is used to pay the same invoice in January and again in February.

```json title="January"
{
"id": "001",
"totalAmount": 5000,
"date" : "1901-01-01",
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-x",
"amount" : -1000
}
]
},
{
"amount" : 4000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "PaymentOnAccount-y",
"amount" : -4000
}
]
}
]
}
```



```json title="February"
{
"id": "001",
"totalAmount": 5000,
"date" : "1901-02-01",
"lines": [
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-x",
"amount" : -1000
}
]
},
{
"amount" : 1000,
"links" : [
{
"type" : "Invoice",
"id" : "Invoice-y",
"amount" : -1000
}
]
},
{
"amount" : 3000,
"links" : [
{
"type" : "PaymentOnAccount",
"id" : "PaymentOnAccount-y",
"amount" : -3000
}
]
}
]
}
```



```json title="Two credit notes and some cash pay two invoices with no allocations specified"
{
"totalAmount": 500,
"lines": [
{
"amount": 500,
"links": [{
"type": "Invoice",
"id": "a",
"amount": -1000
}, {
"type": "Invoice",
"id": "b",
"amount": -1000
}, {
"type": "CreditNote",
"id": "y",
"amount": 750
},{
"type": "CreditNote",
"id": "z",
"amount": 750
}
]
}
]
}
``` | | +| `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | +| `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatesupplierresponse.md b/lending/docs/models/shared/accountingcreatesupplierresponse.md index f647a15fd..db41dbe4e 100755 --- a/lending/docs/models/shared/accountingcreatesupplierresponse.md +++ b/lending/docs/models/shared/accountingcreatesupplierresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data` | [Optional[AccountingSupplier]](../../models/shared/accountingsupplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill). | | +| `data` | [Optional[AccountingSupplier]](../../models/shared/accountingsupplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the Data coverage explorer.

## Overview

From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreatetransferresponse.md b/lending/docs/models/shared/accountingcreatetransferresponse.md index edfa75b62..0bb339e54 100755 --- a/lending/docs/models/shared/accountingcreatetransferresponse.md +++ b/lending/docs/models/shared/accountingcreatetransferresponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data` | [Optional[AccountingTransfer]](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | > View the coverage for transfers in the Data coverage explorer.

A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). | | +| `data` | [Optional[AccountingTransfer]](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | > View the coverage for transfers in the Data coverage explorer.

A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). | | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreditnote.md b/lending/docs/models/shared/accountingcreditnote.md index 85b245be0..1c0c71256 100755 --- a/lending/docs/models/shared/accountingcreditnote.md +++ b/lending/docs/models/shared/accountingcreditnote.md @@ -6,7 +6,7 @@ Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely. -In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. +In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. It contains details of: * The amount of credit remaining and its status. @@ -18,8 +18,8 @@ It contains details of: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Additional tax amount applied to credit note. | | +| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any additional tax applied to the credit note. | | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `credit_note_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the credit note. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | @@ -28,17 +28,17 @@ It contains details of: | `discount_percentage` | *Decimal* | :heavy_check_mark: | Percentage rate (from 0 to 100) of discounts applied to the credit note. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the credit note, unique to the company in the accounting platform. | | | `issue_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[CreditNoteLineItem](../../models/shared/creditnotelineitem.md)] | :heavy_minus_sign: | N/A | | +| `line_items` | List[[CreditNoteLineItem](../../models/shared/creditnotelineitem.md)] | :heavy_minus_sign: | N/A | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information about the credit note. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting platform to the customer. | | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | | `remaining_credit` | *Decimal* | :heavy_check_mark: | Unused balance of totalAmount originally raised. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [CreditNoteStatus](../../models/shared/creditnotestatus.md) | :heavy_check_mark: | N/A | | +| `status` | [CreditNoteStatus](../../models/shared/creditnotestatus.md) | :heavy_check_mark: | Current state of the credit note. | | | `sub_total` | *Decimal* | :heavy_check_mark: | Value of the credit note, including discounts and excluding tax. | | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `total_amount` | *Decimal* | :heavy_check_mark: | Total amount of credit that has been applied to the customer's accounts receivable | | | `total_discount` | *Decimal* | :heavy_check_mark: | Any discounts applied to the credit note amount. | | | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Any tax applied to the credit note amount. | | -| `withholding_tax` | list[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcreditnotes.md b/lending/docs/models/shared/accountingcreditnotes.md index 9d7fe37e1..93f76dc88 100755 --- a/lending/docs/models/shared/accountingcreditnotes.md +++ b/lending/docs/models/shared/accountingcreditnotes.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingCreditNote](../../models/shared/accountingcreditnote.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingCreditNote](../../models/shared/accountingcreditnote.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcustomer.md b/lending/docs/models/shared/accountingcustomer.md index 0221f6b4a..6fac12f6a 100755 --- a/lending/docs/models/shared/accountingcustomer.md +++ b/lending/docs/models/shared/accountingcustomer.md @@ -6,7 +6,7 @@ A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). -Customers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice). +Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). @@ -14,9 +14,9 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/ac | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | | `contact_name` | *Optional[str]* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | -| `contacts` | list[[Contact](../../models/shared/contact.md)] | :heavy_minus_sign: | An array of Contacts. | | +| `contacts` | List[[Contact](../../models/shared/contact.md)] | :heavy_minus_sign: | An array of Contacts. | | | `customer_name` | *Optional[str]* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `email_address` | *Optional[str]* | :heavy_minus_sign: | Email address the customer can be contacted by. | | diff --git a/lending/docs/models/shared/accountingcustomers.md b/lending/docs/models/shared/accountingcustomers.md index 598188758..792c1e66d 100755 --- a/lending/docs/models/shared/accountingcustomers.md +++ b/lending/docs/models/shared/accountingcustomers.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingCustomer](../../models/shared/accountingcustomer.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingCustomer](../../models/shared/accountingcustomer.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingdirectcost.md b/lending/docs/models/shared/accountingdirectcost.md index b762ed651..8a771f199 100755 --- a/lending/docs/models/shared/accountingdirectcost.md +++ b/lending/docs/models/shared/accountingdirectcost.md @@ -14,7 +14,7 @@ Direct costs include: * Withdrawing money from a bank account * Writing a cheque -Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). +Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). ## Fields @@ -26,11 +26,11 @@ Direct costs is a child data type of [account transactions](https://docs.codat.i | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the direct cost, unique for the company. | | | `issue_date` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[DirectCostLineItem](../../models/shared/directcostlineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `line_items` | List[[DirectCostLineItem](../../models/shared/directcostlineitem.md)] | :heavy_check_mark: | An array of line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | A note attached to the direct cost. | | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_check_mark: | An array of payment allocations. | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_check_mark: | An array of payment allocations. | | | `reference` | *Optional[str]* | :heavy_minus_sign: | User-friendly reference for the direct cost. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `sub_total` | *Decimal* | :heavy_check_mark: | The total amount of the direct costs, excluding any taxes. | | diff --git a/lending/docs/models/shared/accountingdirectcosts.md b/lending/docs/models/shared/accountingdirectcosts.md index e7e505883..5e8c35625 100755 --- a/lending/docs/models/shared/accountingdirectcosts.md +++ b/lending/docs/models/shared/accountingdirectcosts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingDirectCost](../../models/shared/accountingdirectcost.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingDirectCost](../../models/shared/accountingdirectcost.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingdirectincome.md b/lending/docs/models/shared/accountingdirectincome.md index 955f62535..1124de41a 100755 --- a/lending/docs/models/shared/accountingdirectincome.md +++ b/lending/docs/models/shared/accountingdirectincome.md @@ -14,7 +14,7 @@ Direct incomes include: - Refunding an item in cash to a contact. - Depositing money into a bank account. -Direct incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). +Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). @@ -27,11 +27,11 @@ Direct incomes is a child data type of [account transactions](https://docs.codat | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the direct income, unique for the company. | | | `issue_date` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[DirectIncomeLineItem](../../models/shared/directincomelineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `line_items` | List[[DirectIncomeLineItem](../../models/shared/directincomelineitem.md)] | :heavy_check_mark: | An array of line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `note` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_check_mark: | N/A | | +| `note` | *Optional[str]* | :heavy_minus_sign: | An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_check_mark: | N/A | | | `reference` | *Optional[str]* | :heavy_minus_sign: | User-friendly reference for the direct income. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `sub_total` | *Decimal* | :heavy_check_mark: | The total amount of the direct incomes, excluding any taxes. | | diff --git a/lending/docs/models/shared/accountingdirectincomes.md b/lending/docs/models/shared/accountingdirectincomes.md index 89bcef07c..5b5a2573c 100755 --- a/lending/docs/models/shared/accountingdirectincomes.md +++ b/lending/docs/models/shared/accountingdirectincomes.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingDirectIncome](../../models/shared/accountingdirectincome.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingDirectIncome](../../models/shared/accountingdirectincome.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountinginvoice.md b/lending/docs/models/shared/accountinginvoice.md index 9ca0b4a6f..c16c2b378 100755 --- a/lending/docs/models/shared/accountinginvoice.md +++ b/lending/docs/models/shared/accountinginvoice.md @@ -4,13 +4,13 @@ > > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice. > -> See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills. +> See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills. View the coverage for invoices in the Data coverage explorer. ## Overview -An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer). +An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer). In Codat, an invoice contains details of: @@ -18,11 +18,11 @@ In Codat, an invoice contains details of: - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. - Who the invoice has been raised to; the _customer_. - The breakdown of what the invoice is for; the _line items_. -- Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. +- Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. > **Invoice PDF downloads** > -> You can download a PDF version of an invoice for supported integrations. +> You can download a PDF version of an invoice for supported integrations. > > The filename will be invoice-{number}.pdf. @@ -35,8 +35,8 @@ In Codat, an invoice contains details of: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `additional_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Additional tax amount applied to invoice. | | +| `additional_tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any additional tax applied to the invoice. | | | `amount_due` | *Decimal* | :heavy_check_mark: | Amount outstanding on the invoice. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | @@ -46,13 +46,13 @@ In Codat, an invoice contains details of: | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the invoice, unique to the company in the accounting platform. | | | `invoice_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the invoice. If available, this appears in the file name of invoice attachments. | | | `issue_date` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `line_items` | list[[InvoiceLineItem](../../models/shared/invoicelineitem.md)] | :heavy_minus_sign: | An array of line items. | | +| `line_items` | List[[InvoiceLineItem](../../models/shared/invoicelineitem.md)] | :heavy_minus_sign: | An array of line items. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information about the invoice. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting platform to the customer. | | | `paid_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `payment_allocations` | list[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | -| `sales_order_refs` | list[[AccountingInvoiceSalesOrderReference](../../models/shared/accountinginvoicesalesorderreference.md)] | :heavy_minus_sign: | List of references to related Sales orders. | | +| `payment_allocations` | List[[AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `sales_order_refs` | List[[AccountingInvoiceSalesOrderReference](../../models/shared/accountinginvoicesalesorderreference.md)] | :heavy_minus_sign: | List of references to related Sales orders. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [InvoiceStatus](../../models/shared/invoicestatus.md) | :heavy_check_mark: | Current state of the invoice:

- `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
- `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount).
- `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount).
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the invoice excluding any taxes. | | @@ -60,4 +60,4 @@ In Codat, an invoice contains details of: | `total_amount` | *Decimal* | :heavy_check_mark: | Amount of the invoice, inclusive of tax. | | | `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Numerical value of discounts applied to the invoice. | | | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax on the invoice. | | -| `withholding_tax` | list[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `withholding_tax` | List[[Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountinginvoices.md b/lending/docs/models/shared/accountinginvoices.md index aee8667f7..003504aab 100755 --- a/lending/docs/models/shared/accountinginvoices.md +++ b/lending/docs/models/shared/accountinginvoices.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingInvoice](../../models/shared/accountinginvoice.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingInvoice](../../models/shared/accountinginvoice.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountinginvoicesalesorderreference.md b/lending/docs/models/shared/accountinginvoicesalesorderreference.md index 369098fac..44f8a6394 100755 --- a/lending/docs/models/shared/accountinginvoicesalesorderreference.md +++ b/lending/docs/models/shared/accountinginvoicesalesorderreference.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier to a record in `dataType`. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingjournal.md b/lending/docs/models/shared/accountingjournal.md index 0b96a82a9..94c2a8053 100755 --- a/lending/docs/models/shared/accountingjournal.md +++ b/lending/docs/models/shared/accountingjournal.md @@ -1,12 +1,12 @@ # AccountingJournal -> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type +> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type > View the coverage for journals in the Data coverage explorer. ## Overview -In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. +In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. diff --git a/lending/docs/models/shared/accountingjournalentries.md b/lending/docs/models/shared/accountingjournalentries.md index af5a2719c..21dbff3da 100755 --- a/lending/docs/models/shared/accountingjournalentries.md +++ b/lending/docs/models/shared/accountingjournalentries.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingJournalEntry](../../models/shared/accountingjournalentry.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingJournalEntry](../../models/shared/accountingjournalentry.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingjournalentry.md b/lending/docs/models/shared/accountingjournalentry.md index 499133488..6694058a9 100755 --- a/lending/docs/models/shared/accountingjournalentry.md +++ b/lending/docs/models/shared/accountingjournalentry.md @@ -1,12 +1,12 @@ # AccountingJournalEntry -> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type +> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type > View the coverage for journal entries in the Data coverage explorer. ## Overview -A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. +A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. A journal entry line item is a single transaction line on the journal entry. For example: @@ -31,7 +31,7 @@ In Codat a journal entry contains details of: | `created_on` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `description` | *Optional[str]* | :heavy_minus_sign: | Optional description of the journal entry. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the journal entry for the company in the accounting platform. | | -| `journal_lines` | list[[JournalLine](../../models/shared/journalline.md)] | :heavy_minus_sign: | An array of journal lines. | | +| `journal_lines` | List[[JournalLine](../../models/shared/journalline.md)] | :heavy_minus_sign: | An array of journal lines. | | | `journal_ref` | [Optional[JournalRef]](../../models/shared/journalref.md) | :heavy_minus_sign: | Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | diff --git a/lending/docs/models/shared/accountingjournals.md b/lending/docs/models/shared/accountingjournals.md index cb8849bb9..b5f852c48 100755 --- a/lending/docs/models/shared/accountingjournals.md +++ b/lending/docs/models/shared/accountingjournals.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingJournal](../../models/shared/accountingjournal.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingJournal](../../models/shared/accountingjournal.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingpayment.md b/lending/docs/models/shared/accountingpayment.md index 3a5925662..bc4f37f26 100755 --- a/lending/docs/models/shared/accountingpayment.md +++ b/lending/docs/models/shared/accountingpayment.md @@ -2,13 +2,13 @@ > **Payments or bill payments?** > -> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills. +> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills. > View the coverage for payments in the Data coverage explorer. ## Overview -Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). +Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to: @@ -26,7 +26,7 @@ In Codat, a payment contains details of: - The payment method used. - The breakdown of the types of payments – the _line items_. -Payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). +Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). ## Payment types @@ -690,11 +690,11 @@ In this example, a payment on account is used to pay the same invoice in January | `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | | `date_` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the payment, unique to the company in the accounting platform. | | -| `lines` | list[[PaymentLine](../../models/shared/paymentline.md)] | :heavy_minus_sign: | An array of payment lines. | | +| `lines` | List[[PaymentLine](../../models/shared/paymentline.md)] | :heavy_minus_sign: | An array of payment lines. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `note` | *Optional[str]* | :heavy_minus_sign: | Any additional information associated with the payment. | | -| `payment_method_ref` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | | `reference` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the payment. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | diff --git a/lending/docs/models/shared/accountingpayments.md b/lending/docs/models/shared/accountingpayments.md index dbd51e87b..7057a4914 100755 --- a/lending/docs/models/shared/accountingpayments.md +++ b/lending/docs/models/shared/accountingpayments.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingPayment](../../models/shared/accountingpayment.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingPayment](../../models/shared/accountingpayment.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingprofitandlossreport.md b/lending/docs/models/shared/accountingprofitandlossreport.md index ef0996f8b..b107c2a6e 100755 --- a/lending/docs/models/shared/accountingprofitandlossreport.md +++ b/lending/docs/models/shared/accountingprofitandlossreport.md @@ -32,4 +32,4 @@ Our [Enhanced Financials](https://docs.codat.io/assess/reports/enhanced-financia | `earliest_available_month` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `most_recent_available_month` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `report_basis` | [ReportBasis](../../models/shared/reportbasis.md) | :heavy_check_mark: | The basis of a report. | | -| `reports` | list[[ProfitAndLossReport](../../models/shared/profitandlossreport.md)] | :heavy_check_mark: | An array of profit and loss reports. | | \ No newline at end of file +| `reports` | List[[ProfitAndLossReport](../../models/shared/profitandlossreport.md)] | :heavy_check_mark: | An array of profit and loss reports. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingsupplier.md b/lending/docs/models/shared/accountingsupplier.md index a5080ce34..5afe27893 100755 --- a/lending/docs/models/shared/accountingsupplier.md +++ b/lending/docs/models/shared/accountingsupplier.md @@ -4,14 +4,14 @@ ## Overview -From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill). +From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). ## Fields | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | | `contact_name` | *Optional[str]* | :heavy_minus_sign: | Name of the main contact for the supplier. | | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | | `email_address` | *Optional[str]* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | diff --git a/lending/docs/models/shared/accountingsuppliers.md b/lending/docs/models/shared/accountingsuppliers.md index 47c1eac9e..6f45c5a06 100755 --- a/lending/docs/models/shared/accountingsuppliers.md +++ b/lending/docs/models/shared/accountingsuppliers.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingSupplier](../../models/shared/accountingsupplier.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingSupplier](../../models/shared/accountingsupplier.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingtransfer.md b/lending/docs/models/shared/accountingtransfer.md index fcc66e0ce..fe315a055 100755 --- a/lending/docs/models/shared/accountingtransfer.md +++ b/lending/docs/models/shared/accountingtransfer.md @@ -2,7 +2,7 @@ > View the coverage for transfers in the Data coverage explorer. -A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). +A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). ## Fields @@ -11,13 +11,13 @@ A transfer records the movement of money between two bank accounts, or between a | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contact_ref` | [Optional[AccountingTransferContactRef]](../../models/shared/accountingtransfercontactref.md) | :heavy_minus_sign: | The customer or supplier for the transfer, if available. | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `deposited_record_refs` | list[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | +| `deposited_record_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | | `description` | *Optional[str]* | :heavy_minus_sign: | Description of the transfer. | | -| `from_` | [Optional[TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | N/A | | +| `from_` | [Optional[TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the transfer. | | | `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `to` | [Optional[TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | N/A | | -| `tracking_category_refs` | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | Reference to the tracking categories this transfer is being tracked against. | | \ No newline at end of file +| `to` | [Optional[TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | +| `tracking_category_refs` | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | Reference to the tracking categories this transfer is being tracked against. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingtransfercontactref.md b/lending/docs/models/shared/accountingtransfercontactref.md index f5b7b91fb..c63713e81 100755 --- a/lending/docs/models/shared/accountingtransfercontactref.md +++ b/lending/docs/models/shared/accountingtransfercontactref.md @@ -5,7 +5,7 @@ The customer or supplier for the transfer, if available. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `id` | *str* | :heavy_check_mark: | Unique identifier for a customer or supplier. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingtransfers.md b/lending/docs/models/shared/accountingtransfers.md index 181db3168..bbd1bae8c 100755 --- a/lending/docs/models/shared/accountingtransfers.md +++ b/lending/docs/models/shared/accountingtransfers.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[AccountingTransfer](../../models/shared/accountingtransfer.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[AccountingTransfer](../../models/shared/accountingtransfer.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountspayabletracking.md b/lending/docs/models/shared/accountspayabletracking.md index f333b230e..818c78ef3 100755 --- a/lending/docs/models/shared/accountspayabletracking.md +++ b/lending/docs/models/shared/accountspayabletracking.md @@ -5,10 +5,10 @@ Categories, and a project and customer, against which the item is tracked. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `category_refs` | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | -| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | -| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | -| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | N/A | -| `project_ref` | [Optional[ProjectRef]](../../models/shared/projectref.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `category_refs` | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | +| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | +| `is_billed_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the invoice or credit note is billed/rebilled to a project or customer. | +| `is_rebilled_to` | [BilledToType](../../models/shared/billedtotype.md) | :heavy_check_mark: | Defines if the invoice or credit note is billed/rebilled to a project or customer. | +| `project_ref` | [Optional[ProjectRef]](../../models/shared/projectref.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/accountsreceivabletracking.md b/lending/docs/models/shared/accountsreceivabletracking.md index 87332f8dc..d4b35ec70 100755 --- a/lending/docs/models/shared/accountsreceivabletracking.md +++ b/lending/docs/models/shared/accountsreceivabletracking.md @@ -7,9 +7,9 @@ Categories, and a project and customer, against which the item is tracked. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `category_refs` | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | +| `category_refs` | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | | `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | -| `is_billed_to` | [BilledToType1](../../models/shared/billedtotype1.md) | :heavy_check_mark: | N/A | -| `is_rebilled_to` | [BilledToType1](../../models/shared/billedtotype1.md) | :heavy_check_mark: | N/A | +| `is_billed_to` | [BilledToType1](../../models/shared/billedtotype1.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | +| `is_rebilled_to` | [BilledToType1](../../models/shared/billedtotype1.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | | `project_ref` | [Optional[ProjectRef]](../../models/shared/projectref.md) | :heavy_minus_sign: | N/A | | `record_ref` | [Optional[AccountsReceivableTrackingRecordReference]](../../models/shared/accountsreceivabletrackingrecordreference.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file diff --git a/lending/docs/models/shared/agedcreditor.md b/lending/docs/models/shared/agedcreditor.md index c099d29a9..c83364a02 100755 --- a/lending/docs/models/shared/agedcreditor.md +++ b/lending/docs/models/shared/agedcreditor.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `aged_currency_outstanding` | list[[AgedCurrencyOutstanding](../../models/shared/agedcurrencyoutstanding.md)] | :heavy_minus_sign: | Array of aged creditors by currency. | | +| `aged_currency_outstanding` | List[[AgedCurrencyOutstanding](../../models/shared/agedcurrencyoutstanding.md)] | :heavy_minus_sign: | Array of aged creditors by currency. | | | `supplier_id` | *Optional[str]* | :heavy_minus_sign: | Supplier ID of the aged creditor. | f594cefb-7750-4c3a-bab2-b5322026dee9 | | `supplier_name` | *Optional[str]* | :heavy_minus_sign: | Supplier name of the aged creditor. | John Doe | \ No newline at end of file diff --git a/lending/docs/models/shared/agedcurrencyoutstanding.md b/lending/docs/models/shared/agedcurrencyoutstanding.md index 1084e44a1..8d82a411e 100755 --- a/lending/docs/models/shared/agedcurrencyoutstanding.md +++ b/lending/docs/models/shared/agedcurrencyoutstanding.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aged_outstanding_amounts` | list[[AgedOutstandingAmount](../../models/shared/agedoutstandingamount.md)] | :heavy_minus_sign: | Array of outstanding amounts by period. | | +| `aged_outstanding_amounts` | List[[AgedOutstandingAmount](../../models/shared/agedoutstandingamount.md)] | :heavy_minus_sign: | Array of outstanding amounts by period. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | \ No newline at end of file diff --git a/lending/docs/models/shared/ageddebtor.md b/lending/docs/models/shared/ageddebtor.md index 17f9fd6cd..6b51d2071 100755 --- a/lending/docs/models/shared/ageddebtor.md +++ b/lending/docs/models/shared/ageddebtor.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `aged_currency_outstanding` | list[[AgedCurrencyOutstanding](../../models/shared/agedcurrencyoutstanding.md)] | :heavy_minus_sign: | Array of aged debtors by currency. | | +| `aged_currency_outstanding` | List[[AgedCurrencyOutstanding](../../models/shared/agedcurrencyoutstanding.md)] | :heavy_minus_sign: | Array of aged debtors by currency. | | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | Customer ID of the aged debtor. | f594cefb-7750-4c3a-bab2-b5322026dee9 | | `customer_name` | *Optional[str]* | :heavy_minus_sign: | Customer name of the aged debtor. | John Doe | \ No newline at end of file diff --git a/lending/docs/models/shared/agedoutstandingamount.md b/lending/docs/models/shared/agedoutstandingamount.md index 8cedbc027..0c3f2063b 100755 --- a/lending/docs/models/shared/agedoutstandingamount.md +++ b/lending/docs/models/shared/agedoutstandingamount.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount outstanding. | | -| `details` | list[[AgedOutstandingAmountDetail](../../models/shared/agedoutstandingamountdetail.md)] | :heavy_minus_sign: | Array of details. | | +| `details` | List[[AgedOutstandingAmountDetail](../../models/shared/agedoutstandingamountdetail.md)] | :heavy_minus_sign: | Array of details. | | | `from_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `to_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/attachments.md b/lending/docs/models/shared/attachments.md index 0cdeb8736..08f31011d 100755 --- a/lending/docs/models/shared/attachments.md +++ b/lending/docs/models/shared/attachments.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `attachments` | list[[AccountingAttachment](../../models/shared/accountingattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `attachments` | List[[AccountingAttachment](../../models/shared/accountingattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingaccountbalance.md b/lending/docs/models/shared/bankingaccountbalance.md index 91bc87ca0..b869ef8a2 100755 --- a/lending/docs/models/shared/bankingaccountbalance.md +++ b/lending/docs/models/shared/bankingaccountbalance.md @@ -6,7 +6,7 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter > **How often should I pull Account Balances?** > -> Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/banking-api#/schemas/Account) data type. +> Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type. > > Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer. diff --git a/lending/docs/models/shared/bankingaccountbalances.md b/lending/docs/models/shared/bankingaccountbalances.md index 15285667f..3d2abca3e 100755 --- a/lending/docs/models/shared/bankingaccountbalances.md +++ b/lending/docs/models/shared/bankingaccountbalances.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[BankingAccountBalance](../../models/shared/bankingaccountbalance.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[BankingAccountBalance](../../models/shared/bankingaccountbalance.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingaccounts.md b/lending/docs/models/shared/bankingaccounts.md index add760085..3714770e1 100755 --- a/lending/docs/models/shared/bankingaccounts.md +++ b/lending/docs/models/shared/bankingaccounts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[BankingAccount](../../models/shared/bankingaccount.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[BankingAccount](../../models/shared/bankingaccount.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingtransactioncategories.md b/lending/docs/models/shared/bankingtransactioncategories.md index 7e0a1b1d8..8f08a59c5 100755 --- a/lending/docs/models/shared/bankingtransactioncategories.md +++ b/lending/docs/models/shared/bankingtransactioncategories.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[BankingTransactionCategory](../../models/shared/bankingtransactioncategory.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[BankingTransactionCategory](../../models/shared/bankingtransactioncategory.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingtransactioncategory.md b/lending/docs/models/shared/bankingtransactioncategory.md index dadb80945..e51fd2ad1 100755 --- a/lending/docs/models/shared/bankingtransactioncategory.md +++ b/lending/docs/models/shared/bankingtransactioncategory.md @@ -13,4 +13,4 @@ Status of the bank transaction category. | `name` | *str* | :heavy_check_mark: | The name of the bank transaction category. | | | `parent_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the parent bank transaction category. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[TransactionCategoryStatus]](../../models/shared/transactioncategorystatus.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `status` | [Optional[TransactionCategoryStatus]](../../models/shared/transactioncategorystatus.md) | :heavy_minus_sign: | The status of the transaction category. | | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingtransactionref.md b/lending/docs/models/shared/bankingtransactionref.md index 4873b2939..e721f86c1 100755 --- a/lending/docs/models/shared/bankingtransactionref.md +++ b/lending/docs/models/shared/bankingtransactionref.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `account_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `account_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the bank transaction's account. | | +| `account_name` | *Optional[str]* | :heavy_minus_sign: | Name given to account. | | +| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Bank transaction amount. | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the bank transaction's connection. | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *Optional[str]* | :heavy_minus_sign: | Description given to bank transaction. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the bank transaction. | | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingtransactions.md b/lending/docs/models/shared/bankingtransactions.md index e3076705b..9f469e988 100755 --- a/lending/docs/models/shared/bankingtransactions.md +++ b/lending/docs/models/shared/bankingtransactions.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[BankingTransaction](../../models/shared/bankingtransaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[BankingTransaction](../../models/shared/bankingtransaction.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/banktransactiontype.md b/lending/docs/models/shared/banktransactiontype.md index 169e66430..db199507e 100755 --- a/lending/docs/models/shared/banktransactiontype.md +++ b/lending/docs/models/shared/banktransactiontype.md @@ -1,6 +1,6 @@ # BankTransactionType -Type of transaction for the bank statement line +Type of transaction for the bank statement line. ## Values diff --git a/lending/docs/models/shared/billcreditnotelineitem.md b/lending/docs/models/shared/billcreditnotelineitem.md index 86265b124..ee1576577 100755 --- a/lending/docs/models/shared/billcreditnotelineitem.md +++ b/lending/docs/models/shared/billcreditnotelineitem.md @@ -16,5 +16,5 @@ | `tax_rate_ref` | [Optional[BillCreditNoteLineItemTaxRateReference]](../../models/shared/billcreditnotelineitemtaxratereference.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | `tracking` | [Optional[AccountsPayableTracking]](../../models/shared/accountspayabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Unit price of the goods or service. | \ No newline at end of file diff --git a/lending/docs/models/shared/billedtotype.md b/lending/docs/models/shared/billedtotype.md index 3b49db591..61634e737 100755 --- a/lending/docs/models/shared/billedtotype.md +++ b/lending/docs/models/shared/billedtotype.md @@ -1,5 +1,7 @@ # BilledToType +Defines if the invoice or credit note is billed/rebilled to a project or customer. + ## Values diff --git a/lending/docs/models/shared/billedtotype1.md b/lending/docs/models/shared/billedtotype1.md index 5b7c60f11..b4d4c665b 100755 --- a/lending/docs/models/shared/billedtotype1.md +++ b/lending/docs/models/shared/billedtotype1.md @@ -1,5 +1,7 @@ # BilledToType1 +Defines if the bill or bill credit note is billed/rebilled to a project. + ## Values diff --git a/lending/docs/models/shared/billlineitem.md b/lending/docs/models/shared/billlineitem.md index 659c48059..8559699ad 100755 --- a/lending/docs/models/shared/billlineitem.md +++ b/lending/docs/models/shared/billlineitem.md @@ -8,14 +8,16 @@ | `account_ref` | [Optional[AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | | `description` | *Optional[str]* | :heavy_minus_sign: | Friendly name of the goods or services received. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Numerical value of any discounts applied.

Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. | -| `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | -| `is_direct_cost` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any discount applied to the bill. | +| `is_direct_cost` | *Optional[bool]* | :heavy_minus_sign: | The bill is a direct cost if `True`. | | `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | +| `line_number` | *Optional[str]* | :heavy_minus_sign: | The bill line's number. | +| `purchase_order_line_ref` | [Optional[BillLineItemRecordLineReference]](../../models/shared/billlineitemrecordlinereference.md) | :heavy_minus_sign: | Reference to the purchase order line this line was generated from. | | `quantity` | *Decimal* | :heavy_check_mark: | Number of units of goods or services received. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the line, inclusive of discounts but exclusive of tax. | | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of tax for the line. | | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line, including tax. | | `tracking` | [Optional[AccountsPayableTracking]](../../models/shared/accountspayabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| `tracking_category_refs` | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | Collection of categories against which this item is tracked. | +| `tracking_category_refs` | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | Collection of categories against which this item is tracked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Price of each unit of goods or services. | \ No newline at end of file diff --git a/lending/docs/models/shared/billlineitemrecordlinereference.md b/lending/docs/models/shared/billlineitemrecordlinereference.md new file mode 100755 index 000000000..28cbcb0ac --- /dev/null +++ b/lending/docs/models/shared/billlineitemrecordlinereference.md @@ -0,0 +1,12 @@ +# BillLineItemRecordLineReference + +Reference to the purchase order line this line was generated from. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `data_type` | [Optional[BillLineItemRecordLineReferenceDataType]](../../models/shared/billlineitemrecordlinereferencedatatype.md) | :heavy_minus_sign: | Allowed name of the 'dataType'. | +| `id` | *Optional[str]* | :heavy_minus_sign: | 'id' of the underlying record. | +| `line_number` | *Optional[str]* | :heavy_minus_sign: | Line number of the underlying record. | \ No newline at end of file diff --git a/lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md b/lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md new file mode 100755 index 000000000..d9a52b128 --- /dev/null +++ b/lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md @@ -0,0 +1,10 @@ +# BillLineItemRecordLineReferenceDataType + +Allowed name of the 'dataType'. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `PURCHASE_ORDERS` | purchaseOrders | \ No newline at end of file diff --git a/lending/docs/models/shared/billpaymentline.md b/lending/docs/models/shared/billpaymentline.md index bba4eb109..2795b0f9f 100755 --- a/lending/docs/models/shared/billpaymentline.md +++ b/lending/docs/models/shared/billpaymentline.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `amount` | *Decimal* | :heavy_check_mark: | Amount in the bill payment currency. | | -| `links` | list[[BillPaymentLineLink](../../models/shared/billpaymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `links` | List[[BillPaymentLineLink](../../models/shared/billpaymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/commercecompanyinfo.md b/lending/docs/models/shared/commercecompanyinfo.md index 30b2aebba..15b50db10 100755 --- a/lending/docs/models/shared/commercecompanyinfo.md +++ b/lending/docs/models/shared/commercecompanyinfo.md @@ -11,16 +11,16 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_balances` | list[[AccountBalance](../../models/shared/accountbalance.md)] | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | -| `addresses` | list[[CommerceAddress](../../models/shared/commerceaddress.md)] | :heavy_minus_sign: | Addresses associated with the company | | +| `account_balances` | List[[AccountBalance](../../models/shared/accountbalance.md)] | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | +| `addresses` | List[[CommerceAddress](../../models/shared/commerceaddress.md)] | :heavy_minus_sign: | Addresses associated with the company | | | `base_currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `commerce_platform_ref` | *Optional[str]* | :heavy_minus_sign: | Identifier or reference for the company in the commerce platform | | | `company_legal_name` | *Optional[str]* | :heavy_minus_sign: | The full legal name of the company | Codat Limited | | `company_name` | *Optional[str]* | :heavy_minus_sign: | The name of the company | Codat | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `phone_numbers` | list[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | Phone numbers associated with the company | | +| `phone_numbers` | List[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | Phone numbers associated with the company | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | The registration number of the company | 10480375 | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `source_urls` | dict[str, *str*] | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | | -| `web_links` | list[[WebLink](../../models/shared/weblink.md)] | :heavy_minus_sign: | Weblinks associated with the company | | \ No newline at end of file +| `source_urls` | Dict[str, *str*] | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | [object Object] | +| `web_links` | List[[WebLink](../../models/shared/weblink.md)] | :heavy_minus_sign: | Weblinks associated with the company | | \ No newline at end of file diff --git a/lending/docs/models/shared/commercecustomer.md b/lending/docs/models/shared/commercecustomer.md index 244d15704..da1e6f69e 100755 --- a/lending/docs/models/shared/commercecustomer.md +++ b/lending/docs/models/shared/commercecustomer.md @@ -9,7 +9,7 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | list[[CommerceAddress](../../models/shared/commerceaddress.md)] | :heavy_minus_sign: | Addresses of the customer | | +| `addresses` | List[[CommerceAddress](../../models/shared/commerceaddress.md)] | :heavy_minus_sign: | Addresses of the customer | | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `customer_name` | *Optional[str]* | :heavy_minus_sign: | Name of the customer | Fred Smith | | `default_currency` | *Optional[str]* | :heavy_minus_sign: | N/A | GBP | diff --git a/lending/docs/models/shared/commercecustomers.md b/lending/docs/models/shared/commercecustomers.md index a6d130796..fa7a58dda 100755 --- a/lending/docs/models/shared/commercecustomers.md +++ b/lending/docs/models/shared/commercecustomers.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceCustomer](../../models/shared/commercecustomer.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceCustomer](../../models/shared/commercecustomer.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercedispute.md b/lending/docs/models/shared/commercedispute.md index 4f96a6ee3..6ec01d1e9 100755 --- a/lending/docs/models/shared/commercedispute.md +++ b/lending/docs/models/shared/commercedispute.md @@ -16,11 +16,11 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `currency` | *str* | :heavy_check_mark: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `disputed_transactions` | list[[TransactionSourceRef](../../models/shared/transactionsourceref.md)] | :heavy_minus_sign: | Link to the source event(s) which triggered this transaction. | | +| `disputed_transactions` | List[[TransactionSourceRef](../../models/shared/transactionsourceref.md)] | :heavy_minus_sign: | Link to the source event(s) which triggered this transaction. | | | `due_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `reason` | *Optional[str]* | :heavy_minus_sign: | Reason for the dispute | Unhappy with product | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [Optional[DisputeStatus]](../../models/shared/disputestatus.md) | :heavy_minus_sign: | Current status of the dispute | EvidenceRequired | -| `total_amount` | *Optional[Any]* | :heavy_minus_sign: | Total transaction amount that is under dispute. | | \ No newline at end of file +| `total_amount` | *Optional[Any]* | :heavy_minus_sign: | Total transaction amount that is under dispute. | 194.12 | \ No newline at end of file diff --git a/lending/docs/models/shared/commercedisputes.md b/lending/docs/models/shared/commercedisputes.md index 7a07ff5a3..01325a74d 100755 --- a/lending/docs/models/shared/commercedisputes.md +++ b/lending/docs/models/shared/commercedisputes.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceDispute](../../models/shared/commercedispute.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceDispute](../../models/shared/commercedispute.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercelocations.md b/lending/docs/models/shared/commercelocations.md index e008e0bef..43dfaa980 100755 --- a/lending/docs/models/shared/commercelocations.md +++ b/lending/docs/models/shared/commercelocations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceLocation](../../models/shared/commercelocation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceLocation](../../models/shared/commercelocation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceorder.md b/lending/docs/models/shared/commerceorder.md index f99c53f2b..16e92d5e2 100755 --- a/lending/docs/models/shared/commerceorder.md +++ b/lending/docs/models/shared/commerceorder.md @@ -18,14 +18,14 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `location_ref` | [Optional[LocationRef]](../../models/shared/locationref.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `order_line_items` | list[[OrderLineItem](../../models/shared/orderlineitem.md)] | :heavy_minus_sign: | N/A | | +| `order_line_items` | List[[OrderLineItem](../../models/shared/orderlineitem.md)] | :heavy_minus_sign: | N/A | | | `order_number` | *Optional[str]* | :heavy_minus_sign: | Friendly reference for the order in the commerce or point of sale platform. | | -| `payments` | list[[PaymentRef](../../models/shared/paymentref.md)] | :heavy_minus_sign: | N/A | | -| `service_charges` | list[[ServiceCharge](../../models/shared/servicecharge.md)] | :heavy_minus_sign: | N/A | | +| `payments` | List[[PaymentRef](../../models/shared/paymentref.md)] | :heavy_minus_sign: | N/A | | +| `service_charges` | List[[ServiceCharge](../../models/shared/servicecharge.md)] | :heavy_minus_sign: | N/A | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `supplemental_data` | [Optional[CommerceOrderSupplementalData]](../../models/shared/commerceordersupplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the order, including tax, net of any discounts and refunds. | | -| `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied to the order. | | -| `total_gratuity` | *Optional[Decimal]* | :heavy_minus_sign: | Extra amount added to a bill. | | -| `total_refund` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount refunded issued by a merchant on an order (always a negative value). | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the order, including discounts, refunds, and tax, but excluding gratuities. | | +| `total_discount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order). | | +| `total_gratuity` | *Optional[Decimal]* | :heavy_minus_sign: | Extra amount added to the order. | | +| `total_refund` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative. | | | `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the order. | | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceorders.md b/lending/docs/models/shared/commerceorders.md index 767f3ef02..965bcd7c0 100755 --- a/lending/docs/models/shared/commerceorders.md +++ b/lending/docs/models/shared/commerceorders.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceOrder](../../models/shared/commerceorder.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceOrder](../../models/shared/commerceorder.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceordersupplementaldata.md b/lending/docs/models/shared/commerceordersupplementaldata.md deleted file mode 100755 index b3927c0c0..000000000 --- a/lending/docs/models/shared/commerceordersupplementaldata.md +++ /dev/null @@ -1,12 +0,0 @@ -# CommerceOrderSupplementalData - -Supplemental data is additional data you can include in our standard data types. - -It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. - - -## Fields - -| Field | Type | Required | Description | -| --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `content` | dict[str, dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/commercepayment.md b/lending/docs/models/shared/commercepayment.md index a669fe08a..0150c9949 100755 --- a/lending/docs/models/shared/commercepayment.md +++ b/lending/docs/models/shared/commercepayment.md @@ -19,7 +19,8 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `due_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `payment_method_ref` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | | `payment_provider` | *Optional[str]* | :heavy_minus_sign: | Service provider of the payment, if applicable. | Amazon Pay | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | \ No newline at end of file +| `status` | [Optional[PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/lending/docs/models/shared/commercepaymentmethod.md b/lending/docs/models/shared/commercepaymentmethod.md index 917fe0d84..a486924c7 100755 --- a/lending/docs/models/shared/commercepaymentmethod.md +++ b/lending/docs/models/shared/commercepaymentmethod.md @@ -7,10 +7,10 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[PaymentMethodStatus]](../../models/shared/paymentmethodstatus.md) | :heavy_minus_sign: | Status of the Payment Method | Active | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | +| `status` | [Optional[CommercePaymentMethodStatus]](../../models/shared/commercepaymentmethodstatus.md) | :heavy_minus_sign: | Status of the Payment Method. | | \ No newline at end of file diff --git a/lending/docs/models/shared/commercepaymentmethods.md b/lending/docs/models/shared/commercepaymentmethods.md index 636c5d30e..d9ed0537a 100755 --- a/lending/docs/models/shared/commercepaymentmethods.md +++ b/lending/docs/models/shared/commercepaymentmethods.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommercePaymentMethod](../../models/shared/commercepaymentmethod.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommercePaymentMethod](../../models/shared/commercepaymentmethod.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercepaymentmethodstatus.md b/lending/docs/models/shared/commercepaymentmethodstatus.md new file mode 100755 index 000000000..7ec7c78b1 --- /dev/null +++ b/lending/docs/models/shared/commercepaymentmethodstatus.md @@ -0,0 +1,12 @@ +# CommercePaymentMethodStatus + +Status of the Payment Method. + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `UNKNOWN` | Unknown | +| `ACTIVE` | Active | +| `ARCHIVED` | Archived | \ No newline at end of file diff --git a/lending/docs/models/shared/commercepayments.md b/lending/docs/models/shared/commercepayments.md index 3ae2b0a03..1342faa9e 100755 --- a/lending/docs/models/shared/commercepayments.md +++ b/lending/docs/models/shared/commercepayments.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommercePayment](../../models/shared/commercepayment.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommercePayment](../../models/shared/commercepayment.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceproduct.md b/lending/docs/models/shared/commerceproduct.md index a61e6153b..c5475c1b9 100755 --- a/lending/docs/models/shared/commerceproduct.md +++ b/lending/docs/models/shared/commerceproduct.md @@ -8,11 +8,12 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `categorization` | *Optional[str]* | :heavy_minus_sign: | Retail category that the product is assigned to | Hardware | -| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | 1tb Western Digital Hard Drive | -| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `is_gift_card` | *Optional[bool]* | :heavy_minus_sign: | Whether the product represents a gift card or voucher that
can be redeemed in the commerce or POS platform
| | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product in the commerce or POS system | Hard Drive | -| `variants` | list[[ProductVariant](../../models/shared/productvariant.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `categorization` | *Optional[str]* | :heavy_minus_sign: | Retail category that the product is assigned to e.g. `Hardware`. | Hardware | +| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | 1tb Western Digital Hard Drive | +| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `is_gift_card` | *Optional[bool]* | :heavy_minus_sign: | Whether the product represents a gift card or voucher that
can be redeemed in the commerce or POS platform.
| | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product in the commerce or POS system | Hard Drive | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `variants` | List[[ProductVariant](../../models/shared/productvariant.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceproductcategories.md b/lending/docs/models/shared/commerceproductcategories.md index fa63ba735..529adb2a5 100755 --- a/lending/docs/models/shared/commerceproductcategories.md +++ b/lending/docs/models/shared/commerceproductcategories.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceProductCategory](../../models/shared/commerceproductcategory.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceProductCategory](../../models/shared/commerceproductcategory.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceproductcategory.md b/lending/docs/models/shared/commerceproductcategory.md index b9786194c..75299f937 100755 --- a/lending/docs/models/shared/commerceproductcategory.md +++ b/lending/docs/models/shared/commerceproductcategory.md @@ -9,7 +9,7 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ancestor_refs` | list[[CommerceRecordRef](../../models/shared/commercerecordref.md)] | :heavy_minus_sign: | A collection of parent product categories implicitly ordered with the immediate parent last in the list. | | +| `ancestor_refs` | List[[CommerceRecordRef](../../models/shared/commercerecordref.md)] | :heavy_minus_sign: | A collection of parent product categories implicitly ordered with the immediate parent last in the list. | | | `has_children` | *Optional[bool]* | :heavy_minus_sign: | A boolean indicating whether there are other product categories beneath this one in the hierarchy. | | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the product category | "102" | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | diff --git a/lending/docs/models/shared/commerceproducts.md b/lending/docs/models/shared/commerceproducts.md index 665f0f9f2..8ef137024 100755 --- a/lending/docs/models/shared/commerceproducts.md +++ b/lending/docs/models/shared/commerceproducts.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceProduct](../../models/shared/commerceproduct.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceProduct](../../models/shared/commerceproduct.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereport.md b/lending/docs/models/shared/commercereport.md index d86e5d222..dde2b5c4b 100755 --- a/lending/docs/models/shared/commercereport.md +++ b/lending/docs/models/shared/commercereport.md @@ -47,8 +47,8 @@ Reports can be rendered as follows (ordering is implicit rather than explicit): | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `dimensions` | list[[CommerceReportDimension](../../models/shared/commercereportdimension.md)] | :heavy_minus_sign: | N/A | -| `errors` | list[[CommerceReportError](../../models/shared/commercereporterror.md)] | :heavy_minus_sign: | N/A | -| `measures` | list[[CommerceReportMeasure](../../models/shared/commercereportmeasure.md)] | :heavy_minus_sign: | N/A | -| `report_data` | list[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | -| `report_info` | dict[str, *str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `dimensions` | List[[CommerceReportDimension](../../models/shared/commercereportdimension.md)] | :heavy_minus_sign: | N/A | +| `errors` | List[[CommerceReportError](../../models/shared/commercereporterror.md)] | :heavy_minus_sign: | N/A | +| `measures` | List[[CommerceReportMeasure](../../models/shared/commercereportmeasure.md)] | :heavy_minus_sign: | N/A | +| `report_data` | List[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | +| `report_info` | Dict[str, *str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereportcomponent.md b/lending/docs/models/shared/commercereportcomponent.md index 7c1074a2b..bfdb6a8aa 100755 --- a/lending/docs/models/shared/commercereportcomponent.md +++ b/lending/docs/models/shared/commercereportcomponent.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `components` | list[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | -| `dimension` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `item` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `measures` | list[[ReportComponentMeasure](../../models/shared/reportcomponentmeasure.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `components` | List[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | +| `dimension` | *Optional[int]* | :heavy_minus_sign: | The component's dimension. | +| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's display name. | +| `item` | *Optional[int]* | :heavy_minus_sign: | The component's item number. | +| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's item display name. | +| `measures` | List[[ReportComponentMeasure](../../models/shared/reportcomponentmeasure.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereportdimension.md b/lending/docs/models/shared/commercereportdimension.md index 16bd136eb..d97101c1d 100755 --- a/lending/docs/models/shared/commercereportdimension.md +++ b/lending/docs/models/shared/commercereportdimension.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `items` | list[[CommerceReportDimensionItems](../../models/shared/commercereportdimensionitems.md)] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The dimension's display name. | +| `index` | *Optional[int]* | :heavy_minus_sign: | The dimension's index. | +| `items` | List[[CommerceReportDimensionItems](../../models/shared/commercereportdimensionitems.md)] | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_minus_sign: | The dimension's type. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereportdimensionitems.md b/lending/docs/models/shared/commercereportdimensionitems.md index 0bf2f60ef..6dd2d2f97 100755 --- a/lending/docs/models/shared/commercereportdimensionitems.md +++ b/lending/docs/models/shared/commercereportdimensionitems.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | +| `index` | *Optional[int]* | :heavy_minus_sign: | The dimension's items index. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereporterror.md b/lending/docs/models/shared/commercereporterror.md index 0ff78d8b4..b4e20f1c6 100755 --- a/lending/docs/models/shared/commercereporterror.md +++ b/lending/docs/models/shared/commercereporterror.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `details` | dict[str, list[*str*]] | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| `details` | Dict[str, List[*str*]] | :heavy_minus_sign: | Additional details on the error. | +| `message` | *Optional[str]* | :heavy_minus_sign: | Message returned by error. | +| `type` | *Optional[str]* | :heavy_minus_sign: | The type of error. | \ No newline at end of file diff --git a/lending/docs/models/shared/commercereportmeasure.md b/lending/docs/models/shared/commercereportmeasure.md index 72e261fbb..368742f88 100755 --- a/lending/docs/models/shared/commercereportmeasure.md +++ b/lending/docs/models/shared/commercereportmeasure.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `units` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The measure's display name. | +| `index` | *Optional[int]* | :heavy_minus_sign: | The measure's index. | +| `type` | *Optional[str]* | :heavy_minus_sign: | The measure's type. | +| `units` | *Optional[str]* | :heavy_minus_sign: | The measure's units e.g. percentage (%). | \ No newline at end of file diff --git a/lending/docs/models/shared/commercetransaction.md b/lending/docs/models/shared/commercetransaction.md index 10d4ad5c0..f93909601 100755 --- a/lending/docs/models/shared/commercetransaction.md +++ b/lending/docs/models/shared/commercetransaction.md @@ -23,6 +23,7 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `source_created_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `sub_type` | *Optional[str]* | :heavy_minus_sign: | Non-standardised transaction type data from the commerce platform | CardPayment | +| `supplemental_data` | [Optional[SupplementalData]](../../models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The total transaction amount | 194.12 | | `transaction_source_ref` | [Optional[TransactionSourceRef]](../../models/shared/transactionsourceref.md) | :heavy_minus_sign: | Link to the source event which triggered this transaction | | | `type` | [Optional[TransactionType]](../../models/shared/transactiontype.md) | :heavy_minus_sign: | The type of the platform transaction:
- `Unknown`
- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
- `Payment` — Credit and debit card payments.
- `PaymentFee` — Payment provider's fee on each card payment.
- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
- `Payout` — Transfer of funds from the seller's merchant account to their bank account.
- `Refund` — Refunds to a customer's credit or debit card.
- `Transfer` — Secure transfer of funds to the seller's bank account. | | \ No newline at end of file diff --git a/lending/docs/models/shared/commercetransactions.md b/lending/docs/models/shared/commercetransactions.md index 8e1fd267e..2f0ecba32 100755 --- a/lending/docs/models/shared/commercetransactions.md +++ b/lending/docs/models/shared/commercetransactions.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CommerceTransaction](../../models/shared/commercetransaction.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[CommerceTransaction](../../models/shared/commercetransaction.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/companies.md b/lending/docs/models/shared/companies.md index c4c6e0399..eeaacf9de 100755 --- a/lending/docs/models/shared/companies.md +++ b/lending/docs/models/shared/companies.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/company.md b/lending/docs/models/shared/company.md index e1391be08..a13a89f7b 100755 --- a/lending/docs/models/shared/company.md +++ b/lending/docs/models/shared/company.md @@ -12,11 +12,11 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `created` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `created_by_user_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `data_connections` | list[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | +| `created_by_user_name` | *Optional[str]* | :heavy_minus_sign: | Name of user that created the company in Codat. | | +| `data_connections` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | | `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `last_sync` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `name` | *str* | :heavy_check_mark: | The name of the company | Codat Ltd. | -| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | Xero | +| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`platformKeys` name used when creating the company. | Xero | | `redirect` | *str* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | \ No newline at end of file diff --git a/lending/docs/models/shared/connection.md b/lending/docs/models/shared/connection.md index b84876a60..5e93e4ddf 100755 --- a/lending/docs/models/shared/connection.md +++ b/lending/docs/models/shared/connection.md @@ -17,15 +17,15 @@ Before you can use a data connection to pull or push data, the company must gran | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `additional_properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `connection_info` | dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `connection_info` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | | `created` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `data_connection_errors` | list[[DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | +| `data_connection_errors` | List[[DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | | `id` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integration_id` | *str* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integration_key` | *str* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | | `last_sync` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `link_url` | *str* | :heavy_check_mark: | N/A | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | -| `platform_name` | *str* | :heavy_check_mark: | N/A | | +| `link_url` | *str* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | +| `platform_name` | *str* | :heavy_check_mark: | Name of integration connected to company. | | | `source_id` | *str* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `source_type` | [ConnectionSourceType](../../models/shared/connectionsourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | | `status` | [DataConnectionStatus](../../models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | \ No newline at end of file diff --git a/lending/docs/models/shared/connections.md b/lending/docs/models/shared/connections.md index d9a1a748e..87ee809ab 100755 --- a/lending/docs/models/shared/connections.md +++ b/lending/docs/models/shared/connections.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/contact.md b/lending/docs/models/shared/contact.md index 59c75fc97..c2513a928 100755 --- a/lending/docs/models/shared/contact.md +++ b/lending/docs/models/shared/contact.md @@ -9,5 +9,5 @@ | `email` | *Optional[str]* | :heavy_minus_sign: | Email of a contact for a customer. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of a contact for a customer. | | -| `phone` | list[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | An array of Phone numbers. | | +| `phone` | List[[PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | An array of Phone numbers. | | | `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | \ No newline at end of file diff --git a/lending/docs/models/shared/contactref.md b/lending/docs/models/shared/contactref.md index 4cf698195..8f6603c01 100755 --- a/lending/docs/models/shared/contactref.md +++ b/lending/docs/models/shared/contactref.md @@ -5,7 +5,7 @@ The customer or supplier for the transfer, if available. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `id` | *str* | :heavy_check_mark: | Unique identifier for a customer or supplier. | | \ No newline at end of file diff --git a/lending/docs/models/shared/createbankaccounttransaction.md b/lending/docs/models/shared/createbankaccounttransaction.md index f69d51e05..18d780b7d 100755 --- a/lending/docs/models/shared/createbankaccounttransaction.md +++ b/lending/docs/models/shared/createbankaccounttransaction.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `balance` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount transacted in the bank transaction. | | +| `balance` | *Optional[Decimal]* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the bank transaction. | | +| `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bank account transaction, unique for the company in the accounting platform. | | \ No newline at end of file diff --git a/lending/docs/models/shared/creditnotelineitem.md b/lending/docs/models/shared/creditnotelineitem.md index d5b1b4451..687ee912a 100755 --- a/lending/docs/models/shared/creditnotelineitem.md +++ b/lending/docs/models/shared/creditnotelineitem.md @@ -9,7 +9,7 @@ | `description` | *Optional[str]* | :heavy_minus_sign: | Friendly name of each line item. For example, the goods or service for which credit has been issued. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Value of any discounts applied. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate of any discount applied to the line item. | -| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | The credit note is a direct income if `True`. | | `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | | `quantity` | *Decimal* | :heavy_check_mark: | Number of units of the goods or service for which credit has been issued. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of credit associated with the line item, including discounts but excluding tax. | @@ -17,5 +17,5 @@ | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | `tracking` | [Optional[AccountsReceivableTracking]](../../models/shared/accountsreceivabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Unit price of the goods or service. | \ No newline at end of file diff --git a/lending/docs/models/shared/creditnotestatus.md b/lending/docs/models/shared/creditnotestatus.md index 5ae9874f2..bf285b397 100755 --- a/lending/docs/models/shared/creditnotestatus.md +++ b/lending/docs/models/shared/creditnotestatus.md @@ -1,5 +1,7 @@ # CreditNoteStatus +Current state of the credit note. + ## Values diff --git a/lending/docs/models/shared/dataconnectionerror.md b/lending/docs/models/shared/dataconnectionerror.md index 6c85722e1..7dd2be969 100755 --- a/lending/docs/models/shared/dataconnectionerror.md +++ b/lending/docs/models/shared/dataconnectionerror.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A brief message about the error. | | | `errored_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status_code` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `status_code` | *Optional[str]* | :heavy_minus_sign: | The HTTP status code returned by the error. | | +| `status_text` | *Optional[str]* | :heavy_minus_sign: | A non-numeric status code/text. | | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegrityconnectionid.md b/lending/docs/models/shared/dataintegrityconnectionid.md index 9897ee7af..cfa30c8ca 100755 --- a/lending/docs/models/shared/dataintegrityconnectionid.md +++ b/lending/docs/models/shared/dataintegrityconnectionid.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `source` | list[*str*] | :heavy_minus_sign: | An array of strings. The connection IDs for the type specified in the url. | -| `target` | list[*str*] | :heavy_minus_sign: | An array of strings. The connection IDs for the type being matched to. | \ No newline at end of file +| `source` | List[*str*] | :heavy_minus_sign: | An array of strings. The connection IDs for the type specified in the url. | +| `target` | List[*str*] | :heavy_minus_sign: | An array of strings. The connection IDs for the type being matched to. | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritydetail.md b/lending/docs/models/shared/dataintegritydetail.md index eef10283d..f567c88e1 100755 --- a/lending/docs/models/shared/dataintegritydetail.md +++ b/lending/docs/models/shared/dataintegritydetail.md @@ -11,5 +11,5 @@ | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `description` | *Optional[str]* | :heavy_minus_sign: | The transaction description. | | | `id` | *Optional[str]* | :heavy_minus_sign: | ID GUID of the transaction. | | -| `matches` | list[[DataIntegrityMatch](../../models/shared/dataintegritymatch.md)] | :heavy_minus_sign: | N/A | | +| `matches` | List[[DataIntegrityMatch](../../models/shared/dataintegritymatch.md)] | :heavy_minus_sign: | N/A | | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type of the record. | | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritydetails.md b/lending/docs/models/shared/dataintegritydetails.md index 46c58d6ad..2c0ddf84f 100755 --- a/lending/docs/models/shared/dataintegritydetails.md +++ b/lending/docs/models/shared/dataintegritydetails.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[DataIntegrityDetail](../../models/shared/dataintegritydetail.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[DataIntegrityDetail](../../models/shared/dataintegritydetail.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritystatuses.md b/lending/docs/models/shared/dataintegritystatuses.md index 3f6823315..d556429b8 100755 --- a/lending/docs/models/shared/dataintegritystatuses.md +++ b/lending/docs/models/shared/dataintegritystatuses.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `metadata` | list[[DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `metadata` | List[[DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritysummaries.md b/lending/docs/models/shared/dataintegritysummaries.md index de69c10fc..41d4fd9d6 100755 --- a/lending/docs/models/shared/dataintegritysummaries.md +++ b/lending/docs/models/shared/dataintegritysummaries.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `summaries` | list[[DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `summaries` | List[[DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/datasource.md b/lending/docs/models/shared/datasource.md index 126c0ff25..2152d333c 100755 --- a/lending/docs/models/shared/datasource.md +++ b/lending/docs/models/shared/datasource.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounts` | list[[Accounts](../../models/shared/accounts.md)] | :heavy_minus_sign: | An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`. | \ No newline at end of file +| `accounts` | List[[Accounts](../../models/shared/accounts.md)] | :heavy_minus_sign: | An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`. | \ No newline at end of file diff --git a/lending/docs/models/shared/datastatus.md b/lending/docs/models/shared/datastatus.md index 389c2cf54..e835378ab 100755 --- a/lending/docs/models/shared/datastatus.md +++ b/lending/docs/models/shared/datastatus.md @@ -7,8 +7,8 @@ Describes the state of data in the Codat cache for a company and data type | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `current_status` | *str* | :heavy_check_mark: | N/A | | -| `data_type` | *str* | :heavy_check_mark: | N/A | | +| `current_status` | *str* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | | +| `data_type` | [DataStatusDataTypes](../../models/shared/datastatusdatatypes.md) | :heavy_check_mark: | Available Data types | invoices | | `last_successful_sync` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `latest_successful_sync_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 8220fc90-55b6-47bc-9417-48ac6ea93101 | -| `latest_sync_id` | *Optional[str]* | :heavy_minus_sign: | N/A | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file +| `latest_successful_sync_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | +| `latest_sync_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file diff --git a/lending/docs/models/shared/datastatusdatatypes.md b/lending/docs/models/shared/datastatusdatatypes.md new file mode 100755 index 000000000..bb62bc2d3 --- /dev/null +++ b/lending/docs/models/shared/datastatusdatatypes.md @@ -0,0 +1,51 @@ +# DataStatusDataTypes + +Available Data types + + +## Values + +| Name | Value | +| -------------------------------- | -------------------------------- | +| `ACCOUNT_TRANSACTIONS` | accountTransactions | +| `BALANCE_SHEET` | balanceSheet | +| `BANK_ACCOUNTS` | bankAccounts | +| `BANK_TRANSACTIONS` | bankTransactions | +| `BILL_CREDIT_NOTES` | billCreditNotes | +| `BILL_PAYMENTS` | billPayments | +| `BILLS` | bills | +| `CASH_FLOW_STATEMENT` | cashFlowStatement | +| `CHART_OF_ACCOUNTS` | chartOfAccounts | +| `COMPANY` | company | +| `CREDIT_NOTES` | creditNotes | +| `CUSTOMERS` | customers | +| `DIRECT_COSTS` | directCosts | +| `DIRECT_INCOMES` | directIncomes | +| `INVOICES` | invoices | +| `ITEMS` | items | +| `JOURNAL_ENTRIES` | journalEntries | +| `JOURNALS` | journals | +| `PAYMENT_METHODS` | paymentMethods | +| `PAYMENTS` | payments | +| `PROFIT_AND_LOSS` | profitAndLoss | +| `PURCHASE_ORDERS` | purchaseOrders | +| `SALES_ORDERS` | salesOrders | +| `SUPPLIERS` | suppliers | +| `TAX_RATES` | taxRates | +| `TRACKING_CATEGORIES` | trackingCategories | +| `TRANSFERS` | transfers | +| `BANKING_ACCOUNT_BALANCES` | banking-accountBalances | +| `BANKING_ACCOUNTS` | banking-accounts | +| `BANKING_TRANSACTION_CATEGORIES` | banking-transactionCategories | +| `BANKING_TRANSACTIONS` | banking-transactions | +| `COMMERCE_COMPANY_INFO` | commerce-companyInfo | +| `COMMERCE_CUSTOMERS` | commerce-customers | +| `COMMERCE_DISPUTES` | commerce-disputes | +| `COMMERCE_LOCATIONS` | commerce-locations | +| `COMMERCE_ORDERS` | commerce-orders | +| `COMMERCE_PAYMENT_METHODS` | commerce-paymentMethods | +| `COMMERCE_PAYMENTS` | commerce-payments | +| `COMMERCE_PRODUCT_CATEGORIES` | commerce-productCategories | +| `COMMERCE_PRODUCTS` | commerce-products | +| `COMMERCE_TAX_COMPONENTS` | commerce-taxComponents | +| `COMMERCE_TRANSACTIONS` | commerce-transactions | \ No newline at end of file diff --git a/lending/docs/models/shared/directcostlineitem.md b/lending/docs/models/shared/directcostlineitem.md index 937cd0528..61b96f81b 100755 --- a/lending/docs/models/shared/directcostlineitem.md +++ b/lending/docs/models/shared/directcostlineitem.md @@ -16,5 +16,5 @@ | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line, including tax. | | `tracking` | [Optional[Tracking]](../../models/shared/tracking.md) | :heavy_minus_sign: | N/A | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Collection of categories against which this direct cost is tracked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Collection of categories against which this direct cost is tracked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Price of each unit of goods or services.
Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. | \ No newline at end of file diff --git a/lending/docs/models/shared/directincomelineitem.md b/lending/docs/models/shared/directincomelineitem.md index e49f31d71..55507edc8 100755 --- a/lending/docs/models/shared/directincomelineitem.md +++ b/lending/docs/models/shared/directincomelineitem.md @@ -15,5 +15,5 @@ | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount of tax for the line.
Note: If the platform does not provide this information, the quantity will be mapped as 0.00. | | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | The total amount of the line, including tax. | -| `tracking_category_refs` | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | An array of categories against which this direct cost is tracked. | +| `tracking_category_refs` | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | An array of categories against which this direct cost is tracked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | The price of each unit of goods or services.
Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedcashflowitem.md b/lending/docs/models/shared/enhancedcashflowitem.md index 059dcf13f..99b05b723 100755 --- a/lending/docs/models/shared/enhancedcashflowitem.md +++ b/lending/docs/models/shared/enhancedcashflowitem.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `transactions` | list[[EnhancedCashFlowTransaction](../../models/shared/enhancedcashflowtransaction.md)] | :heavy_minus_sign: | An array of transaction data. | \ No newline at end of file +| `transactions` | List[[EnhancedCashFlowTransaction](../../models/shared/enhancedcashflowtransaction.md)] | :heavy_minus_sign: | An array of transaction data. | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedcashflowtransaction.md b/lending/docs/models/shared/enhancedcashflowtransaction.md index c6c093e96..11af4ff6e 100755 --- a/lending/docs/models/shared/enhancedcashflowtransaction.md +++ b/lending/docs/models/shared/enhancedcashflowtransaction.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_ref` | [Optional[AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | An account reference containing the account id and name. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The bank transaction amount. | | -| `currency` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `description` | *Optional[str]* | :heavy_minus_sign: | The description of the bank transaction. | | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the bank transaction. | | diff --git a/lending/docs/models/shared/enhancedcashflowtransactions.md b/lending/docs/models/shared/enhancedcashflowtransactions.md index ccaff4fb3..05a5a3682 100755 --- a/lending/docs/models/shared/enhancedcashflowtransactions.md +++ b/lending/docs/models/shared/enhancedcashflowtransactions.md @@ -11,6 +11,6 @@ The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `data_sources` | list[[DataSource](../../models/shared/datasource.md)] | :heavy_minus_sign: | N/A | -| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Assess reports | -| `report_items` | list[[EnhancedCashFlowItem](../../models/shared/enhancedcashflowitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `data_sources` | List[[DataSource](../../models/shared/datasource.md)] | :heavy_minus_sign: | N/A | +| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[EnhancedCashFlowItem](../../models/shared/enhancedcashflowitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedfinancialreport.md b/lending/docs/models/shared/enhancedfinancialreport.md index f5bb33c88..23d82874b 100755 --- a/lending/docs/models/shared/enhancedfinancialreport.md +++ b/lending/docs/models/shared/enhancedfinancialreport.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `report_info` | [Optional[EnhancedReportInfo]](../../models/shared/enhancedreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | list[[EnhancedFinancialReportReportItem](../../models/shared/enhancedfinancialreportreportitem.md)] | :heavy_minus_sign: | An array of report items. | \ No newline at end of file +| `report_items` | List[[EnhancedFinancialReportReportItem](../../models/shared/enhancedfinancialreportreportitem.md)] | :heavy_minus_sign: | An array of report items. | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedinvoicereportitem.md b/lending/docs/models/shared/enhancedinvoicereportitem.md index 368f17dac..3047eea69 100755 --- a/lending/docs/models/shared/enhancedinvoicereportitem.md +++ b/lending/docs/models/shared/enhancedinvoicereportitem.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount_due` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | +| `amount_due` | *Optional[Decimal]* | :heavy_minus_sign: | Invoice's total amount due. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `customer_ref` | [Optional[LendingCustomerRef]](../../models/shared/lendingcustomerref.md) | :heavy_minus_sign: | N/A | | | `due_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `id` | *Optional[str]* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting platdform | | -| `invoice_number` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `id` | *Optional[str]* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform. | | +| `invoice_number` | *Optional[str]* | :heavy_minus_sign: | Invoice number. | | | `issue_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `paid_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `payments` | list[[Payment](../../models/shared/payment.md)] | :heavy_minus_sign: | N/A | | +| `payments` | List[[Payment](../../models/shared/payment.md)] | :heavy_minus_sign: | N/A | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `status` | [Optional[InvoiceStatus]](../../models/shared/invoicestatus.md) | :heavy_minus_sign: | Current state of the invoice:

- `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
- `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount).
- `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount).
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Invoice's total amount. | | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedinvoicesreport.md b/lending/docs/models/shared/enhancedinvoicesreport.md index 861e662b8..e64964c88 100755 --- a/lending/docs/models/shared/enhancedinvoicesreport.md +++ b/lending/docs/models/shared/enhancedinvoicesreport.md @@ -7,5 +7,5 @@ The enhanced invoices report takes the key elements of the Invoices report verif | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Assess reports | -| `report_items` | list[[EnhancedInvoiceReportItem](../../models/shared/enhancedinvoicereportitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[EnhancedInvoiceReportItem](../../models/shared/enhancedinvoicereportitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedreportaccountcategory.md b/lending/docs/models/shared/enhancedreportaccountcategory.md index efcff8966..5655c1db2 100755 --- a/lending/docs/models/shared/enhancedreportaccountcategory.md +++ b/lending/docs/models/shared/enhancedreportaccountcategory.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `levels` | list[[AccountCategoryLevel](../../models/shared/accountcategorylevel.md)] | :heavy_minus_sign: | N/A | +| `levels` | List[[AccountCategoryLevel](../../models/shared/accountcategorylevel.md)] | :heavy_minus_sign: | N/A | | `status` | *Optional[str]* | :heavy_minus_sign: | Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned. | \ No newline at end of file diff --git a/lending/docs/models/shared/errormessage.md b/lending/docs/models/shared/errormessage.md index 4f34c9a64..2d1289c0d 100755 --- a/lending/docs/models/shared/errormessage.md +++ b/lending/docs/models/shared/errormessage.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `error` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `service` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. | +| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. | \ No newline at end of file diff --git a/lending/docs/models/shared/file.md b/lending/docs/models/shared/file.md index 733fb778f..0231c4b4a 100755 --- a/lending/docs/models/shared/file.md +++ b/lending/docs/models/shared/file.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `file_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `source_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | An optional display name for the file. | | +| `file_name` | *Optional[str]* | :heavy_minus_sign: | The file's name. | | +| `source_type` | *Optional[str]* | :heavy_minus_sign: | The source of the file uploaded. | | | `uploaded` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/halref.md b/lending/docs/models/shared/halref.md index fef2ab2fc..94c6476ff 100755 --- a/lending/docs/models/shared/halref.md +++ b/lending/docs/models/shared/halref.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `href` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `href` | *Optional[str]* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file diff --git a/lending/docs/models/shared/invoicelineitem.md b/lending/docs/models/shared/invoicelineitem.md index a6dbfad6d..7915e991b 100755 --- a/lending/docs/models/shared/invoicelineitem.md +++ b/lending/docs/models/shared/invoicelineitem.md @@ -9,7 +9,7 @@ | `description` | *Optional[str]* | :heavy_minus_sign: | Friendly name of the goods or services provided. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Numerical value of any discounts applied. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any discounts applied to the unit amount. | -| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `is_direct_income` | *Optional[bool]* | :heavy_minus_sign: | The invoice is a direct income if `True`. | | `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | | `quantity` | *Decimal* | :heavy_check_mark: | Number of units of goods or services provided. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the line, inclusive of discounts but exclusive of tax. | @@ -17,5 +17,5 @@ | `tax_rate_ref` | [Optional[TaxRateRef]](../../models/shared/taxrateref.md) | :heavy_minus_sign: | Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.

Found on:

- Bill line items
- Bill Credit Note line items
- Credit Note line items
- Direct incomes line items
- Invoice line items
- Items | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified. | | `tracking` | [Optional[AccountsReceivableTracking]](../../models/shared/accountsreceivabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | -| ~~`tracking_category_refs`~~ | list[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | +| ~~`tracking_category_refs`~~ | List[[TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Reference to the tracking categories to which the line item is linked. | | `unit_amount` | *Decimal* | :heavy_check_mark: | Price of each unit of goods or services. | \ No newline at end of file diff --git a/lending/docs/models/shared/items.md b/lending/docs/models/shared/items.md index 22094dce2..ef943d1f5 100755 --- a/lending/docs/models/shared/items.md +++ b/lending/docs/models/shared/items.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `amount` | *Decimal* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `amount` | *Decimal* | :heavy_check_mark: | Amount of tax withheld. | +| `name` | *str* | :heavy_check_mark: | Name assigned to withheld tax. | \ No newline at end of file diff --git a/lending/docs/models/shared/journallinetracking.md b/lending/docs/models/shared/journallinetracking.md index 29f3d72ca..91cc6cd30 100755 --- a/lending/docs/models/shared/journallinetracking.md +++ b/lending/docs/models/shared/journallinetracking.md @@ -7,4 +7,4 @@ List of record refs associated with the tracking information for the line (eg to | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `record_refs` | list[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `record_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/lendingcustomerref.md b/lending/docs/models/shared/lendingcustomerref.md index e49c19fe2..74d37b953 100755 --- a/lending/docs/models/shared/lendingcustomerref.md +++ b/lending/docs/models/shared/lendingcustomerref.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `customer_name` | *Optional[str]* | :heavy_minus_sign: | `customerName` from the Customer data type | -| `id` | *Optional[str]* | :heavy_minus_sign: | `id` from the Customers data type | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `customer_name` | *Optional[str]* | :heavy_minus_sign: | `customerName` from the Customer data type. | +| `id` | *Optional[str]* | :heavy_minus_sign: | `id` from the Customers data type. | \ No newline at end of file diff --git a/lending/docs/models/shared/loansummary.md b/lending/docs/models/shared/loansummary.md index 42e3dbb63..2095b55b2 100755 --- a/lending/docs/models/shared/loansummary.md +++ b/lending/docs/models/shared/loansummary.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `report_info` | [Optional[LoanSummaryReportInfo]](../../models/shared/loansummaryreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | list[[LoanSummaryReportItem](../../models/shared/loansummaryreportitem.md)] | :heavy_minus_sign: | Returns a summary of all loan activity for that integration type | \ No newline at end of file +| `report_items` | List[[LoanSummaryReportItem](../../models/shared/loansummaryreportitem.md)] | :heavy_minus_sign: | Returns a summary of all loan activity for that integration type | \ No newline at end of file diff --git a/lending/docs/models/shared/loansummaryreportitem.md b/lending/docs/models/shared/loansummaryreportitem.md index 0c6105186..7330021b3 100755 --- a/lending/docs/models/shared/loansummaryreportitem.md +++ b/lending/docs/models/shared/loansummaryreportitem.md @@ -7,6 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `balance` | *Optional[Decimal]* | :heavy_minus_sign: | The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. | | | `description` | *Optional[str]* | :heavy_minus_sign: | The description of the object being referred to. E.g. the account. | | +| `lender_name` | *Optional[str]* | :heavy_minus_sign: | The name of lender providing the loan. | | | `record_ref` | [Optional[LoanSummaryRecordRef]](../../models/shared/loansummaryrecordref.md) | :heavy_minus_sign: | N/A | | | `start_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `total_drawdowns` | *Optional[Decimal]* | :heavy_minus_sign: | The total loan drawdowns. | | diff --git a/lending/docs/models/shared/loantransactions.md b/lending/docs/models/shared/loantransactions.md index fc38dfae3..866b23b34 100755 --- a/lending/docs/models/shared/loantransactions.md +++ b/lending/docs/models/shared/loantransactions.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `errors` | list[*Any*] | :heavy_minus_sign: | If there are no errors, an empty array is returned. | +| `errors` | List[*Any*] | :heavy_minus_sign: | If there are no errors, an empty array is returned. | | `report_info` | [Optional[LoanTransactionsReportInfo]](../../models/shared/loantransactionsreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | list[[ReportItems](../../models/shared/reportitems.md)] | :heavy_minus_sign: | Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. | \ No newline at end of file +| `report_items` | List[[ReportItems](../../models/shared/reportitems.md)] | :heavy_minus_sign: | Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. | \ No newline at end of file diff --git a/lending/docs/models/shared/orderdiscountallocation.md b/lending/docs/models/shared/orderdiscountallocation.md index 3bfdab4d5..84a454e20 100755 --- a/lending/docs/models/shared/orderdiscountallocation.md +++ b/lending/docs/models/shared/orderdiscountallocation.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the discount in the commerce or point of sale platform. | Promotional Discount | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied. | 15.25 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the discount in the commerce or point of sale platform. | Promotional Discount | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line). | 15.25 | \ No newline at end of file diff --git a/lending/docs/models/shared/orderlineitem.md b/lending/docs/models/shared/orderlineitem.md index b759a1785..fa5ad253a 100755 --- a/lending/docs/models/shared/orderlineitem.md +++ b/lending/docs/models/shared/orderlineitem.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `discount_allocations` | list[[OrderDiscountAllocation](../../models/shared/orderdiscountallocation.md)] | :heavy_minus_sign: | N/A | | +| `discount_allocations` | List[[OrderDiscountAllocation](../../models/shared/orderdiscountallocation.md)] | :heavy_minus_sign: | N/A | | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `product_ref` | [Optional[ProductRef]](../../models/shared/productref.md) | :heavy_minus_sign: | Reference that links the line item to the correct product details. | | | `product_variant_ref` | [Optional[ProductVariantRef]](../../models/shared/productvariantref.md) | :heavy_minus_sign: | Reference that links the line item to the specific version of product that has been ordered. | | -| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is a negative value.
| | -| `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sale tax applied to the unit amount. | 0 | -| `taxes` | list[[TaxComponentAllocation](../../models/shared/taxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total price of the line item, including discounts, tax and minus any refunds. | | -| `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the line item. | | -| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | Price per unit of goods or service. | | \ No newline at end of file +| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is negative.
| | +| `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sales tax applied to the unit price. | 0 | +| `taxes` | List[[TaxComponentAllocation](../../models/shared/taxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | +| `total_tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of tax applied to the line item, factoring in any discounts. | | +| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | Price per unit of goods or services, excluding discounts and tax. | | \ No newline at end of file diff --git a/lending/docs/models/shared/payment.md b/lending/docs/models/shared/payment.md index 7bb1bd7ee..b1d90f1c1 100755 --- a/lending/docs/models/shared/payment.md +++ b/lending/docs/models/shared/payment.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | -| `banking_transaction_refs` | list[[BankingTransactionRef](../../models/shared/bankingtransactionref.md)] | :heavy_minus_sign: | N/A | | +| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Payment amount. | | +| `banking_transaction_refs` | List[[BankingTransactionRef](../../models/shared/bankingtransactionref.md)] | :heavy_minus_sign: | N/A | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `id` | *Optional[str]* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform | | -| `payment_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform. | | +| `payment_type` | *Optional[str]* | :heavy_minus_sign: | The type of payment. | | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentline.md b/lending/docs/models/shared/paymentline.md index af0fe8ddf..e59a9cb01 100755 --- a/lending/docs/models/shared/paymentline.md +++ b/lending/docs/models/shared/paymentline.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `amount` | *Decimal* | :heavy_check_mark: | Amount in the payment currency. | | -| `links` | list[[PaymentLineLink](../../models/shared/paymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `links` | List[[PaymentLineLink](../../models/shared/paymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentmethodref.md b/lending/docs/models/shared/paymentmethodref.md new file mode 100755 index 000000000..9f8fd8995 --- /dev/null +++ b/lending/docs/models/shared/paymentmethodref.md @@ -0,0 +1,11 @@ +# PaymentMethodRef + +The payment method the record is linked to in the accounting or commerce platform. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the location being referenced. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the location being referenced. | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentmethodstatus.md b/lending/docs/models/shared/paymentmethodstatus.md deleted file mode 100755 index a34ab7a84..000000000 --- a/lending/docs/models/shared/paymentmethodstatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# PaymentMethodStatus - -Status of the Payment Method - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ACTIVE` | Active | -| `ARCHIVED` | Archived | -| `UNKNOWN` | Unknown | \ No newline at end of file diff --git a/lending/docs/models/shared/phonenumber.md b/lending/docs/models/shared/phonenumber.md index 252898c68..84a85c5e2 100755 --- a/lending/docs/models/shared/phonenumber.md +++ b/lending/docs/models/shared/phonenumber.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `number` | *str* | :heavy_check_mark: | A phone number. | +44 25691 154789 | +| `number` | *Optional[str]* | :heavy_check_mark: | A phone number. | +44 25691 154789 | | `type` | [PhoneNumberType](../../models/shared/phonenumbertype.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/lending/docs/models/shared/productinventory.md b/lending/docs/models/shared/productinventory.md index 0bfa223b2..a551e7026 100755 --- a/lending/docs/models/shared/productinventory.md +++ b/lending/docs/models/shared/productinventory.md @@ -7,5 +7,5 @@ Information about the total inventory as well as the locations inventory is in. | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `locations` | list[[ProductInventoryLocation](../../models/shared/productinventorylocation.md)] | :heavy_minus_sign: | N/A | -| `total_quantity` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `locations` | List[[ProductInventoryLocation](../../models/shared/productinventorylocation.md)] | :heavy_minus_sign: | N/A | +| `total_quantity` | *Optional[Decimal]* | :heavy_minus_sign: | The total quantity of stock remaining across locations. | \ No newline at end of file diff --git a/lending/docs/models/shared/productinventorylocation.md b/lending/docs/models/shared/productinventorylocation.md index f7bb3d716..3ebe8cefa 100755 --- a/lending/docs/models/shared/productinventorylocation.md +++ b/lending/docs/models/shared/productinventorylocation.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `location_ref` | [Optional[LocationRef]](../../models/shared/locationref.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | -| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `quantity` | *Optional[Decimal]* | :heavy_minus_sign: | The quantity of stock remaining at location. | \ No newline at end of file diff --git a/lending/docs/models/shared/productprice.md b/lending/docs/models/shared/productprice.md index e92fe544d..c7143ea68 100755 --- a/lending/docs/models/shared/productprice.md +++ b/lending/docs/models/shared/productprice.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `unit_price` | *Optional[Decimal]* | :heavy_minus_sign: | The product variant's unit price. | | \ No newline at end of file diff --git a/lending/docs/models/shared/productref.md b/lending/docs/models/shared/productref.md index 442e20373..69c038149 100755 --- a/lending/docs/models/shared/productref.md +++ b/lending/docs/models/shared/productref.md @@ -5,7 +5,7 @@ Reference that links the line item to the correct product details. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identitifer of the product being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the product being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file diff --git a/lending/docs/models/shared/productvariant.md b/lending/docs/models/shared/productvariant.md index cc1e04314..70b360a62 100755 --- a/lending/docs/models/shared/productvariant.md +++ b/lending/docs/models/shared/productvariant.md @@ -15,10 +15,10 @@ Represents a variation of a product available for sale, for example an item of c | `is_tax_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether sales taxes are enabled for this product variant. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product recorded in the commerce or point of sale platform. | Red Coat | -| `prices` | list[[ProductPrice](../../models/shared/productprice.md)] | :heavy_minus_sign: | Prices for the product variants in different currencies. | | +| `prices` | List[[ProductPrice](../../models/shared/productprice.md)] | :heavy_minus_sign: | Prices for the product variants in different currencies. | | | `shipping_required` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether or not the product requires physical delivery. | | | `sku` | *Optional[str]* | :heavy_minus_sign: | SKU (stock keeping unit) of the variant, as defined by the merchant. | Coat-Red-Lrg | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[ProductVariantStatus]](../../models/shared/productvariantstatus.md) | :heavy_minus_sign: | N/A | | +| `status` | [Optional[ProductVariantStatus]](../../models/shared/productvariantstatus.md) | :heavy_minus_sign: | The status of the product variant. | | | `unit_of_measure` | *Optional[str]* | :heavy_minus_sign: | Unit of measure for the variant, such as `kg` or `meters`. | kg | | `vat_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | VAT rate for the product variant if sales taxes are enabled. | 12.5 | \ No newline at end of file diff --git a/lending/docs/models/shared/productvariantref.md b/lending/docs/models/shared/productvariantref.md index 7eb6aeee5..34c2bb82f 100755 --- a/lending/docs/models/shared/productvariantref.md +++ b/lending/docs/models/shared/productvariantref.md @@ -5,7 +5,7 @@ Reference that links the line item to the specific version of product that has b ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identitifer of the product variant being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | The unique identifier of the product variant being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file diff --git a/lending/docs/models/shared/productvariantstatus.md b/lending/docs/models/shared/productvariantstatus.md index 3a6aefbda..cac82c987 100755 --- a/lending/docs/models/shared/productvariantstatus.md +++ b/lending/docs/models/shared/productvariantstatus.md @@ -1,5 +1,7 @@ # ProductVariantStatus +The status of the product variant. + ## Values diff --git a/lending/docs/models/shared/projectref.md b/lending/docs/models/shared/projectref.md index 45ab50290..96a679000 100755 --- a/lending/docs/models/shared/projectref.md +++ b/lending/docs/models/shared/projectref.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the project reference. | +| `name` | *Optional[str]* | :heavy_minus_sign: | The project's name. | \ No newline at end of file diff --git a/lending/docs/models/shared/pulloperation.md b/lending/docs/models/shared/pulloperation.md index a4f6d0c4b..07104cbd5 100755 --- a/lending/docs/models/shared/pulloperation.md +++ b/lending/docs/models/shared/pulloperation.md @@ -8,12 +8,14 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 22ece347-e5f6-4896-95e0-35a4c7f17023 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | -| `data_type` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | 943accd0-4247-42d8-865b-363c8629e1da | -| `is_completed` | *bool* | :heavy_check_mark: | N/A | | -| `is_errored` | *bool* | :heavy_check_mark: | N/A | | -| `progress` | *int* | :heavy_check_mark: | N/A | | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | +| `completed` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | +| `data_type` | [DataType](../../models/shared/datatype.md) | :heavy_check_mark: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about a transient or persistent error. | | +| `id` | *str* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | +| `is_completed` | *bool* | :heavy_check_mark: | `True` if the pull operation completed successfully. | | +| `is_errored` | *bool* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | +| `progress` | *int* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `requested` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PullOperationStatus](../../models/shared/pulloperationstatus.md) | :heavy_check_mark: | N/A | Complete | \ No newline at end of file +| `status` | [PullOperationStatus](../../models/shared/pulloperationstatus.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | \ No newline at end of file diff --git a/lending/docs/models/shared/pulloperations.md b/lending/docs/models/shared/pulloperations.md index afe4f6f90..e15916751 100755 --- a/lending/docs/models/shared/pulloperations.md +++ b/lending/docs/models/shared/pulloperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/pulloperationstatus.md b/lending/docs/models/shared/pulloperationstatus.md index 12b8f9fd5..8f1bae914 100755 --- a/lending/docs/models/shared/pulloperationstatus.md +++ b/lending/docs/models/shared/pulloperationstatus.md @@ -1,5 +1,7 @@ # PullOperationStatus +The current status of the pull operation. + ## Values diff --git a/lending/docs/models/shared/pushchangetype.md b/lending/docs/models/shared/pushchangetype.md index 4818f5d2a..33a957e79 100755 --- a/lending/docs/models/shared/pushchangetype.md +++ b/lending/docs/models/shared/pushchangetype.md @@ -1,5 +1,7 @@ # PushChangeType +Type of change being applied to record in third party platform. + ## Values diff --git a/lending/docs/models/shared/pushfieldvalidation.md b/lending/docs/models/shared/pushfieldvalidation.md index 1008b54d5..60ce548f0 100755 --- a/lending/docs/models/shared/pushfieldvalidation.md +++ b/lending/docs/models/shared/pushfieldvalidation.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `details` | *str* | :heavy_check_mark: | N/A | -| `field` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `ref` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `details` | *str* | :heavy_check_mark: | Details on the validation issue. | +| `field` | *Optional[str]* | :heavy_minus_sign: | Field name that resulted in the validation issue. | +| `ref` | *Optional[str]* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoperation.md b/lending/docs/models/shared/pushoperation.md index c89b853f7..4e0594ecc 100755 --- a/lending/docs/models/shared/pushoperation.md +++ b/lending/docs/models/shared/pushoperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | list[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List[[PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `completed_on_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | -| `status_code` | *int* | :heavy_check_mark: | N/A | | -| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoperationchange.md b/lending/docs/models/shared/pushoperationchange.md index b57a9c8b9..cf6e86896 100755 --- a/lending/docs/models/shared/pushoperationchange.md +++ b/lending/docs/models/shared/pushoperationchange.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | | `record_ref` | [Optional[PushOperationRef]](../../models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A | -| `type` | [Optional[PushChangeType]](../../models/shared/pushchangetype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [Optional[PushChangeType]](../../models/shared/pushchangetype.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoperationref.md b/lending/docs/models/shared/pushoperationref.md index 10503c8ee..df895faa0 100755 --- a/lending/docs/models/shared/pushoperationref.md +++ b/lending/docs/models/shared/pushoperationref.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoperations.md b/lending/docs/models/shared/pushoperations.md index 83fd674fe..1f224ca9b 100755 --- a/lending/docs/models/shared/pushoperations.md +++ b/lending/docs/models/shared/pushoperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoption.md b/lending/docs/models/shared/pushoption.md index a9a0e479a..72e02d203 100755 --- a/lending/docs/models/shared/pushoption.md +++ b/lending/docs/models/shared/pushoption.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `display_name` | *str* | :heavy_check_mark: | N/A | -| `options` | list[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | -| `required` | *bool* | :heavy_check_mark: | N/A | -| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | N/A | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | | `validation` | [Optional[PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoptionchoice.md b/lending/docs/models/shared/pushoptionchoice.md index fe6383d2b..0b1c9b987 100755 --- a/lending/docs/models/shared/pushoptionchoice.md +++ b/lending/docs/models/shared/pushoptionchoice.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `required` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[PushOptionType]](../../models/shared/pushoptiontype.md) | :heavy_minus_sign: | N/A | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The property's display name. | +| `required` | *Optional[bool]* | :heavy_minus_sign: | The property is required if `True`. | +| `type` | [Optional[PushOptionType]](../../models/shared/pushoptiontype.md) | :heavy_minus_sign: | The option type. | | `value` | *Optional[str]* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoptionproperty.md b/lending/docs/models/shared/pushoptionproperty.md index 2178375f1..c53a8177f 100755 --- a/lending/docs/models/shared/pushoptionproperty.md +++ b/lending/docs/models/shared/pushoptionproperty.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `description` | *str* | :heavy_check_mark: | N/A | -| `display_name` | *str* | :heavy_check_mark: | N/A | -| `options` | list[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | -| `required` | *bool* | :heavy_check_mark: | N/A | -| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | N/A | +| `description` | *str* | :heavy_check_mark: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | | `validation` | [Optional[PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/pushoptiontype.md b/lending/docs/models/shared/pushoptiontype.md index f03b48ce2..2f263a07c 100755 --- a/lending/docs/models/shared/pushoptiontype.md +++ b/lending/docs/models/shared/pushoptiontype.md @@ -1,5 +1,7 @@ # PushOptionType +The option type. + ## Values diff --git a/lending/docs/models/shared/pushvalidationinfo.md b/lending/docs/models/shared/pushvalidationinfo.md index 9faf9b85f..bf2fdc062 100755 --- a/lending/docs/models/shared/pushvalidationinfo.md +++ b/lending/docs/models/shared/pushvalidationinfo.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `information` | list[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | -| `warnings` | list[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `information` | List[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/reportcomponentmeasure.md b/lending/docs/models/shared/reportcomponentmeasure.md index f2a0b609f..327497d75 100755 --- a/lending/docs/models/shared/reportcomponentmeasure.md +++ b/lending/docs/models/shared/reportcomponentmeasure.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `measure_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `value` | *Optional[Decimal]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `index` | *Optional[int]* | :heavy_minus_sign: | The measure's index. | +| `measure_display_name` | *Optional[str]* | :heavy_minus_sign: | The measure's display name. | +| `value` | *Optional[Decimal]* | :heavy_minus_sign: | The measure's value. | \ No newline at end of file diff --git a/lending/docs/models/shared/reportinfo.md b/lending/docs/models/shared/reportinfo.md index fba508f2e..47fb031db 100755 --- a/lending/docs/models/shared/reportinfo.md +++ b/lending/docs/models/shared/reportinfo.md @@ -1,6 +1,6 @@ # ReportInfo -Report additional information, which is specific to Assess reports +Report additional information, which is specific to Lending API reports. ## Fields @@ -8,8 +8,8 @@ Report additional information, which is specific to Assess reports | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `company_name` | *Optional[str]* | :heavy_minus_sign: | The name of the company being queried. | -| `generated_date` | *Optional[str]* | :heavy_minus_sign: | Date the report was generated | +| `generated_date` | *Optional[str]* | :heavy_minus_sign: | Date the report was generated. | | `page_number` | *Optional[int]* | :heavy_minus_sign: | The number of the page queried. | | `page_size` | *Optional[int]* | :heavy_minus_sign: | The number of transactions returned per page. | -| `report_name` | *Optional[str]* | :heavy_minus_sign: | Name of the report | +| `report_name` | *Optional[str]* | :heavy_minus_sign: | Name of the report. | | `total_results` | *Optional[int]* | :heavy_minus_sign: | The total number of transactions available for a company for the period specified in the query string. | \ No newline at end of file diff --git a/lending/docs/models/shared/reportitems.md b/lending/docs/models/shared/reportitems.md index 429263c7e..61560f5ca 100755 --- a/lending/docs/models/shared/reportitems.md +++ b/lending/docs/models/shared/reportitems.md @@ -8,5 +8,6 @@ | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The loan transaction amount. | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `item_ref` | [Optional[DefinitionsitemRef]](../../models/shared/definitionsitemref.md) | :heavy_minus_sign: | N/A | | +| `lender_name` | *Optional[str]* | :heavy_minus_sign: | The name of lender providing the loan. | | | `loan_ref` | [Optional[LoanRef]](../../models/shared/loanref.md) | :heavy_minus_sign: | N/A | | -| `loan_transaction_type` | [Optional[ReportItemsLoanTransactionType]](../../models/shared/reportitemsloantransactiontype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `loan_transaction_type` | [Optional[ReportItemsLoanTransactionType]](../../models/shared/reportitemsloantransactiontype.md) | :heavy_minus_sign: | The type of loan transaction. | | \ No newline at end of file diff --git a/lending/docs/models/shared/reportitemsloantransactiontype.md b/lending/docs/models/shared/reportitemsloantransactiontype.md index 897053b9a..548c10b9a 100755 --- a/lending/docs/models/shared/reportitemsloantransactiontype.md +++ b/lending/docs/models/shared/reportitemsloantransactiontype.md @@ -1,5 +1,7 @@ # ReportItemsLoanTransactionType +The type of loan transaction. + ## Values diff --git a/lending/docs/models/shared/reportline.md b/lending/docs/models/shared/reportline.md index c16cd346b..2adc33882 100755 --- a/lending/docs/models/shared/reportline.md +++ b/lending/docs/models/shared/reportline.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `account_id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting platform. | -| `items` | list[[ReportLine](../../models/shared/reportline.md)] | :heavy_minus_sign: | An array of ReportLine items. | +| `items` | List[[ReportLine](../../models/shared/reportline.md)] | :heavy_minus_sign: | An array of ReportLine items. | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the report line item. | | `value` | *Decimal* | :heavy_check_mark: | Numerical value of the line item. | \ No newline at end of file diff --git a/lending/docs/models/shared/servicecharge.md b/lending/docs/models/shared/servicecharge.md index f5b3c49f5..0b098f367 100755 --- a/lending/docs/models/shared/servicecharge.md +++ b/lending/docs/models/shared/servicecharge.md @@ -9,6 +9,6 @@ | `quantity` | *Optional[int]* | :heavy_minus_sign: | The number of times the charge is charged. | 1 | | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the service charge that is tax. | 0 | | `tax_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any tax applied to the service charge. | 0 | -| `taxes` | list[[TaxComponentAllocation](../../models/shared/taxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to service charges. | | -| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total service charge, including taxes. | 0 | +| `taxes` | List[[TaxComponentAllocation](../../models/shared/taxcomponentallocation.md)] | :heavy_minus_sign: | Taxes breakdown as applied to service charges. | | +| `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the service charge, including tax. | 0 | | `type` | [Optional[ServiceChargeType]](../../models/shared/servicechargetype.md) | :heavy_minus_sign: | The type of the service charge. | Overpayment | \ No newline at end of file diff --git a/lending/docs/models/shared/supplementaldata.md b/lending/docs/models/shared/supplementaldata.md index f18fbb90d..f9d04fc2b 100755 --- a/lending/docs/models/shared/supplementaldata.md +++ b/lending/docs/models/shared/supplementaldata.md @@ -9,4 +9,4 @@ It is referenced as a configured dynamic key value pair that is unique to the ac | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `content` | dict[str, dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | Dict[str, Dict[str, *Any*]] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/tracking.md b/lending/docs/models/shared/tracking.md index b2564c599..bd0549de8 100755 --- a/lending/docs/models/shared/tracking.md +++ b/lending/docs/models/shared/tracking.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `invoice_to` | [Optional[RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | -| `record_refs` | list[[RecordRef](../../models/shared/recordref.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `record_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/trackingcategoryref.md b/lending/docs/models/shared/trackingcategoryref.md index c07926a39..1dc18e1c6 100755 --- a/lending/docs/models/shared/trackingcategoryref.md +++ b/lending/docs/models/shared/trackingcategoryref.md @@ -7,7 +7,7 @@ References a category against which the item is tracked. ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier to the tracking category. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of tracking category. | \ No newline at end of file diff --git a/lending/docs/models/shared/transactioncategory.md b/lending/docs/models/shared/transactioncategory.md index c836b7aeb..2583d176e 100755 --- a/lending/docs/models/shared/transactioncategory.md +++ b/lending/docs/models/shared/transactioncategory.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `confidence` | *Optional[Decimal]* | :heavy_minus_sign: | Returns the confidence of the suggested category for the transaction. The value is between 0 and 100. | -| `levels` | list[*str*] | :heavy_minus_sign: | The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). | \ No newline at end of file +| `levels` | List[*str*] | :heavy_minus_sign: | The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). | \ No newline at end of file diff --git a/lending/docs/models/shared/transactioncategorystatus.md b/lending/docs/models/shared/transactioncategorystatus.md index e7c675656..7b1e187ec 100755 --- a/lending/docs/models/shared/transactioncategorystatus.md +++ b/lending/docs/models/shared/transactioncategorystatus.md @@ -1,5 +1,7 @@ # TransactionCategoryStatus +The status of the transaction category. + ## Values diff --git a/lending/docs/models/shared/transactionsourceref.md b/lending/docs/models/shared/transactionsourceref.md index f39387a85..5336242fc 100755 --- a/lending/docs/models/shared/transactionsourceref.md +++ b/lending/docs/models/shared/transactionsourceref.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | The unique identitifer of the record being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `type` | [TransactionSourceType](../../models/shared/transactionsourcetype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `type` | [TransactionSourceType](../../models/shared/transactionsourcetype.md) | :heavy_check_mark: | The type of source the transaction arose. | | \ No newline at end of file diff --git a/lending/docs/models/shared/transactionsourcetype.md b/lending/docs/models/shared/transactionsourcetype.md index dc353aa07..1c0f09833 100755 --- a/lending/docs/models/shared/transactionsourcetype.md +++ b/lending/docs/models/shared/transactionsourcetype.md @@ -1,5 +1,7 @@ # TransactionSourceType +The type of source the transaction arose. + ## Values diff --git a/lending/docs/models/shared/transferaccount.md b/lending/docs/models/shared/transferaccount.md index 02b64ba18..39a94a454 100755 --- a/lending/docs/models/shared/transferaccount.md +++ b/lending/docs/models/shared/transferaccount.md @@ -1,5 +1,7 @@ # TransferAccount +Account details of the account sending or receiving the transfer. + ## Fields diff --git a/lending/docs/models/shared/validation.md b/lending/docs/models/shared/validation.md index 196cb46c2..294281b51 100755 --- a/lending/docs/models/shared/validation.md +++ b/lending/docs/models/shared/validation.md @@ -7,5 +7,5 @@ A human-readable object describing validation decisions Codat has made when push | Field | Type | Required | Description | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `errors` | list[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | -| `warnings` | list[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `errors` | List[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/validationitem.md b/lending/docs/models/shared/validationitem.md index f3fb8b302..fe913f43e 100755 --- a/lending/docs/models/shared/validationitem.md +++ b/lending/docs/models/shared/validationitem.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `item_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `validator_name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `item_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *Optional[str]* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validator_name` | *Optional[str]* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md b/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md index b9e4a9611..4f66e0321 100755 --- a/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md +++ b/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/webhooks/clientratelimitreachedresponse.md b/lending/docs/models/webhooks/clientratelimitreachedresponse.md index a5368aedf..690170c94 100755 --- a/lending/docs/models/webhooks/clientratelimitreachedresponse.md +++ b/lending/docs/models/webhooks/clientratelimitreachedresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/webhooks/clientratelimitresetresponse.md b/lending/docs/models/webhooks/clientratelimitresetresponse.md index d5db35b1b..9fdae0007 100755 --- a/lending/docs/models/webhooks/clientratelimitresetresponse.md +++ b/lending/docs/models/webhooks/clientratelimitresetresponse.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/sdks/accountingbankdata/README.md b/lending/docs/sdks/accountingbankdata/README.md index b8729cc65..672af50c6 100755 --- a/lending/docs/sdks/accountingbankdata/README.md +++ b/lending/docs/sdks/accountingbankdata/README.md @@ -1,4 +1,5 @@ # AccountingBankData +(*accounting_bank_data*) ## Overview @@ -10,9 +11,9 @@ Access bank transactions from an accounting platform. ## list_transactions -The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection. +The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. -[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. +[Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions. @@ -32,19 +33,19 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBankAccountTransactionsRequest( - account_id='distinctio', + account_id='Anchorage Product', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', order_by='-modifiedDate', page=1, page_size=100, - query='quibusdam', ) res = s.accounting_bank_data.list_transactions(req) if res.accounting_bank_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountingbankdataaccounts/README.md b/lending/docs/sdks/accountingbankdataaccounts/README.md index e968312c8..808bdb076 100755 --- a/lending/docs/sdks/accountingbankdataaccounts/README.md +++ b/lending/docs/sdks/accountingbankdataaccounts/README.md @@ -1,4 +1,5 @@ -# AccountingBankData.Accounts +# AccountingBankDataAccounts +(*accounting_bank_data.accounts*) ### Available Operations @@ -9,7 +10,7 @@ The *Get bank account* endpoint returns a single account for a given accountId. -[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. +[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support getting a specific bank account. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBankAccountRequest( - account_id='unde', + account_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -38,6 +39,7 @@ res = s.accounting_bank_data.accounts.get(req) if res.accounting_bank_account is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.accounting_bank_account is not None: ## list -The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection. +The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection. -[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. +[Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListAccountingBankAccountsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='nulla', ) res = s.accounting_bank_data.accounts.list(req) if res.accounting_bank_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountspayable/README.md b/lending/docs/sdks/accountspayable/README.md index 733976f94..d05bada40 100755 --- a/lending/docs/sdks/accountspayable/README.md +++ b/lending/docs/sdks/accountspayable/README.md @@ -1,4 +1,5 @@ # AccountsPayable +(*accounts_payable*) ### Available Operations diff --git a/lending/docs/sdks/accountspayablebillcreditnotes/README.md b/lending/docs/sdks/accountspayablebillcreditnotes/README.md index d427b0feb..2ee4634f9 100755 --- a/lending/docs/sdks/accountspayablebillcreditnotes/README.md +++ b/lending/docs/sdks/accountspayablebillcreditnotes/README.md @@ -1,4 +1,5 @@ -# AccountsPayable.BillCreditNotes +# AccountsPayableBillCreditNotes +(*accounts_payable.bill_credit_notes*) ### Available Operations @@ -9,7 +10,7 @@ The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. -[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. +[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillCreditNoteRequest( - bill_credit_note_id='molestiae', + bill_credit_note_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -37,6 +38,7 @@ res = s.accounts_payable.bill_credit_notes.get(req) if res.accounting_bill_credit_note is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_bill_credit_note is not None: ## list -The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection. +The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection. -[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. +[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingBillCreditNotesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='minus', ) res = s.accounts_payable.bill_credit_notes.list(req) if res.accounting_bill_credit_notes is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountspayablebillpayments/README.md b/lending/docs/sdks/accountspayablebillpayments/README.md index 87d2b0fd6..43ed4c8bb 100755 --- a/lending/docs/sdks/accountspayablebillpayments/README.md +++ b/lending/docs/sdks/accountspayablebillpayments/README.md @@ -1,4 +1,5 @@ -# AccountsPayable.BillPayments +# AccountsPayableBillPayments +(*accounts_payable.bill_payments*) ### Available Operations @@ -9,7 +10,7 @@ The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. -[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. +[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillPaymentRequest( - bill_payment_id='placeat', + bill_payment_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -37,6 +38,7 @@ res = s.accounts_payable.bill_payments.get(req) if res.accounting_bill_payment is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_bill_payment is not None: ## list -The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection. +The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection. -[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. +[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingBillPaymentsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='voluptatum', ) res = s.accounts_payable.bill_payments.list(req) if res.accounting_bill_payments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountspayablebills/README.md b/lending/docs/sdks/accountspayablebills/README.md index 53a541e49..926c1555c 100755 --- a/lending/docs/sdks/accountspayablebills/README.md +++ b/lending/docs/sdks/accountspayablebills/README.md @@ -1,4 +1,5 @@ -# AccountsPayable.Bills +# AccountsPayableBills +(*accounts_payable.bills*) ### Available Operations @@ -12,7 +13,7 @@ The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. -[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment. @@ -31,7 +32,7 @@ s = codatlending.CodatLending( req = operations.DownloadAccountingBillAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', - bill_id='iusto', + bill_id='Dakota Avon specifically', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -40,6 +41,7 @@ res = s.accounts_payable.bills.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -59,7 +61,7 @@ if res.data is not None: The *Get bill* endpoint returns a single bill for a given billId. -[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill. @@ -79,7 +81,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillRequest( - bill_id='excepturi', + bill_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -87,6 +89,7 @@ res = s.accounts_payable.bills.get(req) if res.accounting_bill is not None: # handle response + pass ``` ### Parameters @@ -106,7 +109,7 @@ if res.accounting_bill is not None: The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. -[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment. @@ -125,7 +128,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingBillAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', - bill_id='nisi', + bill_id='array East along', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -134,6 +137,7 @@ res = s.accounts_payable.bills.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -151,9 +155,9 @@ if res.accounting_attachment is not None: ## list -The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection. +The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. -[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -175,13 +179,13 @@ req = operations.ListAccountingBillsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='recusandae', ) res = s.accounts_payable.bills.list(req) if res.accounting_bills is not None: # handle response + pass ``` ### Parameters @@ -201,7 +205,7 @@ if res.accounting_bills is not None: The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. -[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments. @@ -219,7 +223,7 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBillAttachmentsRequest( - bill_id='temporibus', + bill_id='intuitive Frozen ouch', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -228,6 +232,7 @@ res = s.accounts_payable.bills.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountspayablesuppliers/README.md b/lending/docs/sdks/accountspayablesuppliers/README.md index cc6278070..34f666307 100755 --- a/lending/docs/sdks/accountspayablesuppliers/README.md +++ b/lending/docs/sdks/accountspayablesuppliers/README.md @@ -1,4 +1,5 @@ -# AccountsPayable.Suppliers +# AccountsPayableSuppliers +(*accounts_payable.suppliers*) ### Available Operations @@ -12,7 +13,7 @@ The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment. @@ -33,13 +34,14 @@ req = operations.DownloadAccountingSupplierAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - supplier_id='ab', + supplier_id='Dakota Avon specifically', ) res = s.accounts_payable.suppliers.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -59,7 +61,7 @@ if res.data is not None: The *Get supplier* endpoint returns a single supplier for a given supplierId. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. @@ -80,13 +82,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingSupplierRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - supplier_id='quis', + supplier_id='Northeast Hatchback Kia', ) res = s.accounts_payable.suppliers.get(req) if res.accounting_supplier is not None: # handle response + pass ``` ### Parameters @@ -106,7 +109,7 @@ if res.accounting_supplier is not None: The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment. @@ -127,13 +130,14 @@ req = operations.GetAccountingSupplierAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - supplier_id='veritatis', + supplier_id='array East along', ) res = s.accounts_payable.suppliers.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -151,9 +155,9 @@ if res.accounting_attachment is not None: ## list -The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection. +The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -175,13 +179,13 @@ req = operations.ListAccountingSuppliersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='deserunt', ) res = s.accounts_payable.suppliers.list(req) if res.accounting_suppliers is not None: # handle response + pass ``` ### Parameters @@ -201,7 +205,7 @@ if res.accounting_suppliers is not None: The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments. @@ -221,13 +225,14 @@ s = codatlending.CodatLending( req = operations.ListAccountingSupplierAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - supplier_id='perferendis', + supplier_id='intuitive Frozen ouch', ) res = s.accounts_payable.suppliers.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivable/README.md b/lending/docs/sdks/accountsreceivable/README.md index c265bf25e..995d24ec1 100755 --- a/lending/docs/sdks/accountsreceivable/README.md +++ b/lending/docs/sdks/accountsreceivable/README.md @@ -1,4 +1,5 @@ # AccountsReceivable +(*accounts_receivable*) ### Available Operations diff --git a/lending/docs/sdks/accountsreceivablecreditnotes/README.md b/lending/docs/sdks/accountsreceivablecreditnotes/README.md index 9a8f18322..d14747767 100755 --- a/lending/docs/sdks/accountsreceivablecreditnotes/README.md +++ b/lending/docs/sdks/accountsreceivablecreditnotes/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.CreditNotes +# AccountsReceivableCreditNotes +(*accounts_receivable.credit_notes*) ### Available Operations @@ -9,7 +10,7 @@ The *Get credit note* endpoint returns a single credit note for a given creditNoteId. -[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. +[Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note. @@ -30,13 +31,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingCreditNoteRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - credit_note_id='ipsam', + credit_note_id='Northeast Hatchback Kia', ) res = s.accounts_receivable.credit_notes.get(req) if res.accounting_credit_note is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_credit_note is not None: ## list -The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection. +The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection. -[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. +[Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingCreditNotesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='repellendus', ) res = s.accounts_receivable.credit_notes.list(req) if res.accounting_credit_notes is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivablecustomers/README.md b/lending/docs/sdks/accountsreceivablecustomers/README.md index b89769752..af39e7bab 100755 --- a/lending/docs/sdks/accountsreceivablecustomers/README.md +++ b/lending/docs/sdks/accountsreceivablecustomers/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.Customers +# AccountsReceivableCustomers +(*accounts_receivable.customers*) ### Available Operations @@ -12,7 +13,7 @@ The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. -[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment. @@ -33,13 +34,14 @@ req = operations.DownloadAccountingCustomerAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='sapiente', + customer_id='Dakota Avon specifically', ) res = s.accounts_receivable.customers.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -59,7 +61,7 @@ if res.data is not None: The *Get customer* endpoint returns a single customer for a given customerId. -[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. @@ -80,13 +82,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingCustomerRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - customer_id='quo', + customer_id='Northeast Hatchback Kia', ) res = s.accounts_receivable.customers.get(req) if res.accounting_customer is not None: # handle response + pass ``` ### Parameters @@ -106,7 +109,7 @@ if res.accounting_customer is not None: The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. -[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment. @@ -127,13 +130,14 @@ req = operations.GetAccountingCustomerAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='odit', + customer_id='array East along', ) res = s.accounts_receivable.customers.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -151,9 +155,9 @@ if res.accounting_attachment is not None: ## list -The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection. +The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. -[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -175,13 +179,13 @@ req = operations.ListAccountingCustomersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='at', ) res = s.accounts_receivable.customers.list(req) if res.accounting_customers is not None: # handle response + pass ``` ### Parameters @@ -201,7 +205,7 @@ if res.accounting_customers is not None: The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. -[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments. @@ -221,13 +225,14 @@ s = codatlending.CodatLending( req = operations.ListAccountingCustomerAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='at', + customer_id='intuitive Frozen ouch', ) res = s.accounts_receivable.customers.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivabledirectincomes/README.md b/lending/docs/sdks/accountsreceivabledirectincomes/README.md index f20859477..11c3b5003 100755 --- a/lending/docs/sdks/accountsreceivabledirectincomes/README.md +++ b/lending/docs/sdks/accountsreceivabledirectincomes/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.DirectIncomes +# AccountsReceivableDirectIncomes +(*accounts_receivable.direct_incomes*) ### Available Operations @@ -12,7 +13,7 @@ The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. -[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. +[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment. @@ -33,13 +34,14 @@ req = operations.DownloadAccountingDirectIncomeAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='maiores', + direct_income_id='Dakota Avon specifically', ) res = s.accounts_receivable.direct_incomes.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -59,7 +61,7 @@ if res.data is not None: The *Get direct income* endpoint returns a single direct income for a given directIncomeId. -[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. +[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income. @@ -81,13 +83,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingDirectIncomeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='molestiae', + direct_income_id='Northeast Hatchback Kia', ) res = s.accounts_receivable.direct_incomes.get(req) if res.accounting_direct_income is not None: # handle response + pass ``` ### Parameters @@ -107,7 +110,7 @@ if res.accounting_direct_income is not None: The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. -[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. +[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment. @@ -128,14 +131,14 @@ req = operations.GetAccountingDirectIncomeAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='quod', - timeout_in_minutes=800911, + direct_income_id='array East along', ) res = s.accounts_receivable.direct_incomes.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -153,9 +156,9 @@ if res.accounting_attachment is not None: ## list -The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection. +The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection. -[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. +[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -178,13 +181,13 @@ req = operations.ListAccountingDirectIncomesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='esse', ) res = s.accounts_receivable.direct_incomes.list(req) if res.accounting_direct_incomes is not None: # handle response + pass ``` ### Parameters @@ -204,7 +207,7 @@ if res.accounting_direct_incomes is not None: The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. -[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. +[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments. @@ -224,13 +227,14 @@ s = codatlending.CodatLending( req = operations.ListAccountingDirectIncomeAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='totam', + direct_income_id='intuitive Frozen ouch', ) res = s.accounts_receivable.direct_incomes.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivableinvoices/README.md b/lending/docs/sdks/accountsreceivableinvoices/README.md index 7c4506ad8..c0236ecc6 100755 --- a/lending/docs/sdks/accountsreceivableinvoices/README.md +++ b/lending/docs/sdks/accountsreceivableinvoices/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.Invoices +# AccountsReceivableInvoices +(*accounts_receivable.invoices*) ### Available Operations @@ -14,7 +15,7 @@ The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. -[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment. @@ -35,13 +36,14 @@ req = operations.DownloadAccountingInvoiceAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - invoice_id='porro', + invoice_id='Dakota Avon specifically', ) res = s.accounts_receivable.invoices.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -75,13 +77,14 @@ s = codatlending.CodatLending( req = operations.DownloadAccountingInvoicePdfRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - invoice_id='dolorum', + invoice_id='Associate', ) res = s.accounts_receivable.invoices.download_pdf(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -101,7 +104,7 @@ if res.data is not None: The *Get invoice* endpoint returns a single invoice for a given invoiceId. -[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice. @@ -121,13 +124,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingInvoiceRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - invoice_id='dicta', + invoice_id='Northeast Hatchback Kia', ) res = s.accounts_receivable.invoices.get(req) if res.accounting_invoice is not None: # handle response + pass ``` ### Parameters @@ -147,7 +151,7 @@ if res.accounting_invoice is not None: The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. -[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment. @@ -168,13 +172,14 @@ req = operations.GetAccountingInvoiceAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - invoice_id='nam', + invoice_id='array East along', ) res = s.accounts_receivable.invoices.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -192,9 +197,9 @@ if res.accounting_attachment is not None: ## list -The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection. +The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection. -[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -222,13 +227,13 @@ req = operations.ListAccountingInvoicesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='officia', ) res = s.accounts_receivable.invoices.list(req) if res.accounting_invoices is not None: # handle response + pass ``` ### Parameters @@ -248,7 +253,7 @@ if res.accounting_invoices is not None: The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. -[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments. @@ -268,13 +273,14 @@ s = codatlending.CodatLending( req = operations.ListAccountingInvoiceAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - invoice_id='occaecati', + invoice_id='intuitive Frozen ouch', ) res = s.accounts_receivable.invoices.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters @@ -310,13 +316,13 @@ req = operations.ListReconciledInvoicesRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', page=1, page_size=100, - query='fugit', ) res = s.accounts_receivable.invoices.list_reconciled(req) if res.enhanced_invoices_report is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivablepayments/README.md b/lending/docs/sdks/accountsreceivablepayments/README.md index b4387b4e4..d8f95d112 100755 --- a/lending/docs/sdks/accountsreceivablepayments/README.md +++ b/lending/docs/sdks/accountsreceivablepayments/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.Payments +# AccountsReceivablePayments +(*accounts_receivable.payments*) ### Available Operations @@ -9,7 +10,7 @@ The *Get payment* endpoint returns a single payment for a given paymentId. -[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment. @@ -30,13 +31,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingPaymentRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - payment_id='deleniti', + payment_id='Northeast Hatchback Kia', ) res = s.accounts_receivable.payments.get(req) if res.accounting_payment is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_payment is not None: ## list -The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection. +The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. -[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingPaymentsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='hic', ) res = s.accounts_receivable.payments.list(req) if res.accounting_payments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/accountsreceivablereports/README.md b/lending/docs/sdks/accountsreceivablereports/README.md index 7f88f6abc..809250873 100755 --- a/lending/docs/sdks/accountsreceivablereports/README.md +++ b/lending/docs/sdks/accountsreceivablereports/README.md @@ -1,4 +1,5 @@ -# AccountsReceivable.Reports +# AccountsReceivableReports +(*accounts_receivable.reports*) ### Available Operations @@ -35,6 +36,7 @@ res = s.accounts_receivable.reports.get_aged_creditors(req) if res.accounting_aged_creditor_report is not None: # handle response + pass ``` ### Parameters @@ -78,6 +80,7 @@ res = s.accounts_receivable.reports.get_aged_debtors(req) if res.accounting_aged_debtor_report is not None: # handle response + pass ``` ### Parameters @@ -117,6 +120,7 @@ res = s.accounts_receivable.reports.is_aged_creditors_available(req) if res.is_aged_creditors_report_available_200_application_json_boolean is not None: # handle response + pass ``` ### Parameters @@ -156,6 +160,7 @@ res = s.accounts_receivable.reports.is_aged_debtors_available(req) if res.is_aged_debtors_report_available_200_application_json_boolean is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/banking/README.md b/lending/docs/sdks/banking/README.md index c902d930c..bca4e10c5 100755 --- a/lending/docs/sdks/banking/README.md +++ b/lending/docs/sdks/banking/README.md @@ -1,4 +1,5 @@ # Banking +(*banking*) ### Available Operations diff --git a/lending/docs/sdks/bankingaccountbalances/README.md b/lending/docs/sdks/bankingaccountbalances/README.md index 3517609ec..340dfd8de 100755 --- a/lending/docs/sdks/bankingaccountbalances/README.md +++ b/lending/docs/sdks/bankingaccountbalances/README.md @@ -1,4 +1,5 @@ -# Banking.AccountBalances +# BankingAccountBalances +(*banking.account_balances*) ### Available Operations @@ -6,9 +7,9 @@ ## list -The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection. +The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection. -[Account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. +[Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -31,13 +32,13 @@ req = operations.ListBankingAccountBalancesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='optio', ) res = s.banking.account_balances.list(req) if res.banking_account_balances is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/bankingaccounts/README.md b/lending/docs/sdks/bankingaccounts/README.md index a86ad0910..9fb5a1161 100755 --- a/lending/docs/sdks/bankingaccounts/README.md +++ b/lending/docs/sdks/bankingaccounts/README.md @@ -1,4 +1,5 @@ -# Banking.Accounts +# BankingAccounts +(*banking.accounts*) ### Available Operations @@ -9,7 +10,7 @@ The *Get account* endpoint returns a single account for a given accountId. -[Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetBankingAccountRequest( - account_id='totam', + account_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -38,6 +39,7 @@ res = s.banking.accounts.get(req) if res.banking_account is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.banking_account is not None: ## list -The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection. +The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. -[Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListBankingAccountsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='beatae', ) res = s.banking.accounts.list(req) if res.banking_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/bankingcategorizedstatement/README.md b/lending/docs/sdks/bankingcategorizedstatement/README.md index 9482b2d38..da87524d3 100755 --- a/lending/docs/sdks/bankingcategorizedstatement/README.md +++ b/lending/docs/sdks/bankingcategorizedstatement/README.md @@ -1,4 +1,5 @@ -# Banking.CategorizedStatement +# BankingCategorizedStatement +(*banking.categorized_statement*) ### Available Operations @@ -6,8 +7,8 @@ ## get -> **Categorization engine** -> +> **Categorization engine** +> > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. The _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. @@ -28,13 +29,13 @@ req = operations.GetCategorizedBankStatementRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', page=1, page_size=100, - query='commodi', ) res = s.banking.categorized_statement.get(req) if res.enhanced_cash_flow_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/bankingtransactioncategories/README.md b/lending/docs/sdks/bankingtransactioncategories/README.md index c96fd584c..5e005c19c 100755 --- a/lending/docs/sdks/bankingtransactioncategories/README.md +++ b/lending/docs/sdks/bankingtransactioncategories/README.md @@ -1,4 +1,5 @@ -# Banking.TransactionCategories +# BankingTransactionCategories +(*banking.transaction_categories*) ### Available Operations @@ -9,7 +10,7 @@ The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. -[Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. +[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetBankingTransactionCategoryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_category_id='molestiae', + transaction_category_id='Northeast Hatchback Kia', ) res = s.banking.transaction_categories.get(req) if res.banking_transaction_category is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.banking_transaction_category is not None: ## list -The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection. +The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection. -[Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. +[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListBankingTransactionCategoriesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='modi', ) res = s.banking.transaction_categories.list(req) if res.banking_transaction_categories is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/bankingtransactions/README.md b/lending/docs/sdks/bankingtransactions/README.md index e7a932be3..0e2f61c9a 100755 --- a/lending/docs/sdks/bankingtransactions/README.md +++ b/lending/docs/sdks/bankingtransactions/README.md @@ -1,4 +1,5 @@ -# Banking.Transactions +# BankingTransactions +(*banking.transactions*) ### Available Operations @@ -9,7 +10,7 @@ The *Get transaction* endpoint returns a single transaction for a given transactionId. -[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. +[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetBankingTransactionRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_id='qui', + transaction_id='Northeast Hatchback Kia', ) res = s.banking.transactions.get(req) if res.banking_transaction is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.banking_transaction is not None: ## list -The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection. +The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. -[Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. +[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListBankingTransactionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='impedit', ) res = s.banking.transactions.list(req) if res.banking_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/codatlending/README.md b/lending/docs/sdks/codatlending/README.md index 24a26f09c..e3012d974 100755 --- a/lending/docs/sdks/codatlending/README.md +++ b/lending/docs/sdks/codatlending/README.md @@ -1,5 +1,6 @@ # CodatLending SDK + ## Overview Lending API: Our Lending API helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce platforms they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. diff --git a/lending/docs/sdks/companies/README.md b/lending/docs/sdks/companies/README.md index d5d3a2707..6f6e266f7 100755 --- a/lending/docs/sdks/companies/README.md +++ b/lending/docs/sdks/companies/README.md @@ -1,4 +1,5 @@ # Companies +(*companies*) ## Overview @@ -41,6 +42,7 @@ res = s.companies.create(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -81,6 +83,7 @@ res = s.companies.delete(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -120,6 +123,7 @@ res = s.companies.get(req) if res.company is not None: # handle response + pass ``` ### Parameters @@ -155,13 +159,13 @@ req = operations.ListCompaniesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='corrupti', ) res = s.companies.list(req) if res.companies is not None: # handle response + pass ``` ### Parameters @@ -205,6 +209,7 @@ res = s.companies.update(req) if res.company is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/companyinfo/README.md b/lending/docs/sdks/companyinfo/README.md index 86d22e910..fb19f15d1 100755 --- a/lending/docs/sdks/companyinfo/README.md +++ b/lending/docs/sdks/companyinfo/README.md @@ -1,4 +1,5 @@ # CompanyInfo +(*company_info*) ## Overview @@ -33,6 +34,7 @@ res = s.company_info.get_accounting_profile(req) if res.accounting_company_info is not None: # handle response + pass ``` ### Parameters @@ -75,6 +77,7 @@ res = s.company_info.get_commerce_profile(req) if res.commerce_company_info is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/connections/README.md b/lending/docs/sdks/connections/README.md index ead59a29e..5b498e3cd 100755 --- a/lending/docs/sdks/connections/README.md +++ b/lending/docs/sdks/connections/README.md @@ -1,4 +1,5 @@ # Connections +(*connections*) ## Overview @@ -32,7 +33,7 @@ s = codatlending.CodatLending( req = operations.CreateConnectionRequest( request_body=operations.CreateConnectionRequestBody( - platform_key='illum', + platform_key='gbol', ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -41,6 +42,7 @@ res = s.connections.create(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -82,6 +84,7 @@ res = s.connections.delete(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -122,6 +125,7 @@ res = s.connections.get(req) if res.connection is not None: # handle response + pass ``` ### Parameters @@ -158,13 +162,13 @@ req = operations.ListConnectionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='vel', ) res = s.connections.list(req) if res.connections is not None: # handle response + pass ``` ### Parameters @@ -197,9 +201,7 @@ s = codatlending.CodatLending( ) req = operations.UnlinkConnectionRequest( - request_body=operations.UnlinkConnectionUpdateConnection( - status=shared.DataConnectionStatus.UNLINKED, - ), + request_body=operations.UnlinkConnectionUpdateConnection(), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -208,6 +210,7 @@ res = s.connections.unlink(req) if res.connection is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/dataintegrity/README.md b/lending/docs/sdks/dataintegrity/README.md index 048bd0224..4b8b4cb90 100755 --- a/lending/docs/sdks/dataintegrity/README.md +++ b/lending/docs/sdks/dataintegrity/README.md @@ -1,4 +1,5 @@ # DataIntegrity +(*data_integrity*) ## Overview @@ -34,13 +35,13 @@ req = operations.ListDataIntegrityDetailsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='deserunt', ) res = s.data_integrity.details(req) if res.data_integrity_details is not None: # handle response + pass ``` ### Parameters @@ -88,6 +89,7 @@ res = s.data_integrity.status(req) if res.data_integrity_statuses is not None: # handle response + pass ``` ### Parameters @@ -126,13 +128,13 @@ s = codatlending.CodatLending( req = operations.GetDataIntegritySummariesRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, - query='suscipit', ) res = s.data_integrity.summaries(req) if res.data_integrity_summaries is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/excelreports/README.md b/lending/docs/sdks/excelreports/README.md index 330982ca8..f6fa46bc3 100755 --- a/lending/docs/sdks/excelreports/README.md +++ b/lending/docs/sdks/excelreports/README.md @@ -1,4 +1,5 @@ # ExcelReports +(*excel_reports*) ## Overview @@ -39,6 +40,7 @@ res = s.excel_reports.download(req) if res.body is not None: # handle response + pass ``` ### Parameters @@ -88,13 +90,14 @@ s = codatlending.CodatLending( req = operations.GenerateExcelReportRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - report_type=shared.ExcelReportTypes.ENHANCED_FINANCIALS, + report_type=shared.ExcelReportTypes.ENHANCED_INVOICES, ) res = s.excel_reports.generate(req) if res.excel_status is not None: # handle response + pass ``` ### Parameters @@ -139,6 +142,7 @@ res = s.excel_reports.get_status(req) if res.excel_status is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/fileupload/README.md b/lending/docs/sdks/fileupload/README.md index 92c2cd52e..c75590918 100755 --- a/lending/docs/sdks/fileupload/README.md +++ b/lending/docs/sdks/fileupload/README.md @@ -1,4 +1,5 @@ # FileUpload +(*file_upload*) ## Overview @@ -35,6 +36,7 @@ res = s.file_upload.download(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -74,6 +76,7 @@ res = s.file_upload.list_uploaded(req) if res.files is not None: # handle response + pass ``` ### Parameters @@ -113,8 +116,8 @@ s = codatlending.CodatLending( req = operations.UploadFilesRequest( request_body=operations.UploadFilesRequestBody( - content='delectus'.encode(), - request_body='tempora', + content='F?SRSKG@^n'.encode(), + request_body='ullam', ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', @@ -124,6 +127,7 @@ res = s.file_upload.upload(req) if res.status_code == 200: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/financialstatements/README.md b/lending/docs/sdks/financialstatements/README.md index 7c85348b8..810c9bcfe 100755 --- a/lending/docs/sdks/financialstatements/README.md +++ b/lending/docs/sdks/financialstatements/README.md @@ -1,4 +1,5 @@ # FinancialStatements +(*financial_statements*) ### Available Operations diff --git a/lending/docs/sdks/financialstatementsaccounts/README.md b/lending/docs/sdks/financialstatementsaccounts/README.md index fa7b495de..8e761579e 100755 --- a/lending/docs/sdks/financialstatementsaccounts/README.md +++ b/lending/docs/sdks/financialstatementsaccounts/README.md @@ -1,4 +1,5 @@ -# FinancialStatements.Accounts +# FinancialStatementsAccounts +(*financial_statements.accounts*) ### Available Operations @@ -9,7 +10,7 @@ The *Get account* endpoint returns a single account for a given accountId. -[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingAccountRequest( - account_id='cum', + account_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -37,6 +38,7 @@ res = s.financial_statements.accounts.get(req) if res.accounting_account is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_account is not None: ## list -The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection. +The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. -[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -77,13 +79,13 @@ req = operations.ListAccountingAccountsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='esse', ) res = s.financial_statements.accounts.list(req) if res.accounting_accounts is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/financialstatementsbalancesheet/README.md b/lending/docs/sdks/financialstatementsbalancesheet/README.md index e56b7561a..a0a3a7bec 100755 --- a/lending/docs/sdks/financialstatementsbalancesheet/README.md +++ b/lending/docs/sdks/financialstatementsbalancesheet/README.md @@ -1,4 +1,5 @@ -# FinancialStatements.BalanceSheet +# FinancialStatementsBalanceSheet +(*financial_statements.balance_sheet*) ### Available Operations @@ -32,6 +33,7 @@ res = s.financial_statements.balance_sheet.get(req) if res.accounting_balance_sheet is not None: # handle response + pass ``` ### Parameters @@ -67,7 +69,6 @@ s = codatlending.CodatLending( req = operations.GetCategorizedBalanceSheetStatementRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - number_of_periods=568434, report_date='29-09-2020', ) @@ -75,6 +76,7 @@ res = s.financial_statements.balance_sheet.get_categorized_accounts(req) if res.enhanced_financial_report is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/financialstatementscashflow/README.md b/lending/docs/sdks/financialstatementscashflow/README.md index 92a61c7f8..c3405248e 100755 --- a/lending/docs/sdks/financialstatementscashflow/README.md +++ b/lending/docs/sdks/financialstatementscashflow/README.md @@ -1,4 +1,5 @@ -# FinancialStatements.CashFlow +# FinancialStatementsCashFlow +(*financial_statements.cash_flow*) ### Available Operations @@ -31,6 +32,7 @@ res = s.financial_statements.cash_flow.get(req) if res.accounting_cash_flow_statement is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/financialstatementsprofitandloss/README.md b/lending/docs/sdks/financialstatementsprofitandloss/README.md index e9aad69d8..f444f88eb 100755 --- a/lending/docs/sdks/financialstatementsprofitandloss/README.md +++ b/lending/docs/sdks/financialstatementsprofitandloss/README.md @@ -1,4 +1,5 @@ -# FinancialStatements.ProfitAndLoss +# FinancialStatementsProfitAndLoss +(*financial_statements.profit_and_loss*) ### Available Operations @@ -32,6 +33,7 @@ res = s.financial_statements.profit_and_loss.get(req) if res.accounting_profit_and_loss_report is not None: # handle response + pass ``` ### Parameters @@ -67,7 +69,6 @@ s = codatlending.CodatLending( req = operations.GetCategorizedProfitAndLossStatementRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - number_of_periods=324141, report_date='29-09-2020', ) @@ -75,6 +76,7 @@ res = s.financial_statements.profit_and_loss.get_categorized_accounts(req) if res.enhanced_financial_report is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/liabilities/README.md b/lending/docs/sdks/liabilities/README.md index 6f359f8bc..4e03697f8 100755 --- a/lending/docs/sdks/liabilities/README.md +++ b/lending/docs/sdks/liabilities/README.md @@ -1,4 +1,5 @@ # Liabilities +(*liabilities*) ## Overview @@ -6,12 +7,106 @@ Debt and other liabilities. ### Available Operations +* [generate_loan_summary](#generate_loan_summary) - Generate loan summaries report +* [generate_loan_transactions](#generate_loan_transactions) - Generate loan transactions report * [get_loan_summary](#get_loan_summary) - Get loan summaries * [list_loan_transactions](#list_loan_transactions) - List loan transactions +## generate_loan_summary + +The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + +Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + +Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + + +### Example Usage + +```python +import codatlending +from codatlending.models import operations, shared + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) + +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.GenerateLoanSummarySourceType.ACCOUNTING, +) + +res = s.liabilities.generate_loan_summary(req) + +if res.status_code == 200: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `request` | [operations.GenerateLoanSummaryRequest](../../models/operations/generateloansummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + + +### Response + +**[operations.GenerateLoanSummaryResponse](../../models/operations/generateloansummaryresponse.md)** + + +## generate_loan_transactions + +The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + +Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + +Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + + +### Example Usage + +```python +import codatlending +from codatlending.models import operations, shared + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) + +req = operations.GenerateLoanTransactionsRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.GenerateLoanTransactionsSourceType.ACCOUNTING, +) + +res = s.liabilities.generate_loan_transactions(req) + +if res.status_code == 200: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `request` | [operations.GenerateLoanTransactionsRequest](../../models/operations/generateloantransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + + +### Response + +**[operations.GenerateLoanTransactionsResponse](../../models/operations/generateloantransactionsresponse.md)** + + ## get_loan_summary -The *Get loan summaries* endpoint returns a summary by integration type of all loans identified in each integration. +The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. @@ -32,12 +127,14 @@ s = codatlending.CodatLending( req = operations.GetLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.GetLoanSummarySourceType.BANKING, ) res = s.liabilities.get_loan_summary(req) if res.loan_summary is not None: # handle response + pass ``` ### Parameters @@ -83,6 +180,7 @@ res = s.liabilities.list_loan_transactions(req) if res.loan_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwriteback/README.md b/lending/docs/sdks/loanwriteback/README.md index 4d21cd6c8..2d4a785a2 100755 --- a/lending/docs/sdks/loanwriteback/README.md +++ b/lending/docs/sdks/loanwriteback/README.md @@ -1,4 +1,5 @@ # LoanWriteback +(*loan_writeback*) ### Available Operations diff --git a/lending/docs/sdks/loanwritebackaccounts/README.md b/lending/docs/sdks/loanwritebackaccounts/README.md index df4f523f9..c9284c24e 100755 --- a/lending/docs/sdks/loanwritebackaccounts/README.md +++ b/lending/docs/sdks/loanwritebackaccounts/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.Accounts +# LoanWritebackAccounts +(*loan_writeback.accounts*) ### Available Operations @@ -7,13 +8,13 @@ ## create -The *Create account* endpoint creates a new [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection. +The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. -[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). +Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. @@ -39,36 +40,37 @@ req = operations.CreateAccountRequest( fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - is_bank_account=False, - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), 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={ + "Money": { + "blue": 'shred', + }, + }, + ), type=shared.AccountType.ASSET, valid_datatype_links=[ shared.AccountingAccountValidDataTypeLinks( links=[ - 'natus', + 'abnormally', ], - property='laboriosam', ), ], ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=943749, ) res = s.loan_writeback.accounts.create(req) if res.accounting_create_account_response is not None: # handle response + pass ``` ### Parameters @@ -86,9 +88,9 @@ if res.accounting_create_account_response is not None: ## get_create_model -The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company and integration. +The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. -[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. **Integration-specific behaviour** @@ -118,6 +120,7 @@ res = s.loan_writeback.accounts.get_create_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwritebackbankaccounts/README.md b/lending/docs/sdks/loanwritebackbankaccounts/README.md deleted file mode 100755 index 17ee11656..000000000 --- a/lending/docs/sdks/loanwritebackbankaccounts/README.md +++ /dev/null @@ -1,126 +0,0 @@ -# LoanWriteback.BankAccounts - -### Available Operations - -* [create](#create) - Create bank account -* [get_create_update_model](#get_create_update_model) - Get create/update bank account model - -## create - -The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection. - -[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. - -**Integration-specific behaviour** - -Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/accounting-api#/operations/get-create-update-bankAccounts-model). - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. - -### Example Usage - -```python -import codatlending -from codatlending.models import operations, shared -from decimal import Decimal - -s = codatlending.CodatLending( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.CreateBankAccountRequest( - accounting_bank_account=shared.AccountingBankAccount( - account_name='saepe', - account_number='fuga', - account_type=shared.AccountingBankAccountType.CREDIT, - available_balance=Decimal('3595.08'), - balance=Decimal('6130.64'), - currency='USD', - i_ban='saepe', - id='b10faaa2-352c-4595-9907-aff1a3a2fa94', - institution='commodi', - metadata=shared.Metadata( - is_deleted=False, - ), - modified_date='2022-10-23T00:00:00.000Z', - nominal_code='molestiae', - overdraft_limit=Decimal('2444.25'), - sort_code='error', - source_modified_date='2022-10-23T00:00:00.000Z', - ), - allow_sync_on_push_complete=False, - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=338007, -) - -res = s.loan_writeback.bank_accounts.create(req) - -if res.accounting_create_bank_account_response is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateBankAccountRequest](../../models/operations/createbankaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.CreateBankAccountResponse](../../models/operations/createbankaccountresponse.md)** - - -## get_create_update_model - -The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company and integration. - -[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. - -**Integration-specific behaviour** - -See the *response examples* for integration-specific indicative models. - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - - -### Example Usage - -```python -import codatlending -from codatlending.models import operations, shared - -s = codatlending.CodatLending( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.GetCreateUpdateBankAccountsModelRequest( - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', -) - -res = s.loan_writeback.bank_accounts.get_create_update_model(req) - -if res.push_option is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCreateUpdateBankAccountsModelRequest](../../models/operations/getcreateupdatebankaccountsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.GetCreateUpdateBankAccountsModelResponse](../../models/operations/getcreateupdatebankaccountsmodelresponse.md)** - diff --git a/lending/docs/sdks/loanwritebackbanktransactions/README.md b/lending/docs/sdks/loanwritebackbanktransactions/README.md index eeca14a91..c2ed98c0d 100755 --- a/lending/docs/sdks/loanwritebackbanktransactions/README.md +++ b/lending/docs/sdks/loanwritebackbanktransactions/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.BankTransactions +# LoanWritebackBankTransactions +(*loan_writeback.bank_transactions*) ### Available Operations @@ -7,13 +8,13 @@ ## create -The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection. +The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. -[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. +[Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model). +Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. @@ -33,29 +34,23 @@ s = codatlending.CodatLending( req = operations.CreateBankTransactionsRequest( accounting_create_bank_transactions=shared.AccountingCreateBankTransactions( - account_id='vitae', + account_id='7110701885', transactions=[ shared.CreateBankAccountTransaction( - amount=Decimal('6747.52'), - balance=Decimal('6563.3'), date_='2022-10-23T00:00:00.000Z', - description='odit', - id='c3f5ad01-9da1-4ffe-b8f0-97b0074f1547', ), ], ), - account_id='dicta', - allow_sync_on_push_complete=False, + account_id='Extended South', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=688661, ) res = s.loan_writeback.bank_transactions.create(req) if res.accounting_create_bank_transactions_response is not None: # handle response + pass ``` ### Parameters @@ -73,9 +68,9 @@ if res.accounting_create_bank_transactions_response is not None: ## get_create_model -The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration. +The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. -[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. +[Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. **Integration-specific behaviour** @@ -97,7 +92,7 @@ s = codatlending.CodatLending( ) req = operations.GetCreateBankTransactionsModelRequest( - account_id='enim', + account_id='Northwest', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -106,6 +101,7 @@ res = s.loan_writeback.bank_transactions.get_create_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwritebackcreateoperations/README.md b/lending/docs/sdks/loanwritebackcreateoperations/README.md index 4b53baab9..826603a56 100755 --- a/lending/docs/sdks/loanwritebackcreateoperations/README.md +++ b/lending/docs/sdks/loanwritebackcreateoperations/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.CreateOperations +# LoanWritebackCreateOperations +(*loan_writeback.create_operations*) ### Available Operations @@ -23,13 +24,14 @@ s = codatlending.CodatLending( req = operations.GetCreateOperationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - push_operation_key='e6e13b99-d488-4e1e-91e4-50ad2abd4426', + push_operation_key='b18d8d81-fd7b-4764-a31e-475cb1f36591', ) res = s.loan_writeback.create_operations.get(req) if res.push_operation is not None: # handle response + pass ``` ### Parameters @@ -66,13 +68,13 @@ req = operations.ListCreateOperationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='cupiditate', ) res = s.loan_writeback.create_operations.list(req) if res.push_operations is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwritebackdirectcosts/README.md b/lending/docs/sdks/loanwritebackdirectcosts/README.md index c50d0cd18..7e0a6c912 100755 --- a/lending/docs/sdks/loanwritebackdirectcosts/README.md +++ b/lending/docs/sdks/loanwritebackdirectcosts/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.DirectCosts +# LoanWritebackDirectCosts +(*loan_writeback.direct_costs*) ### Available Operations @@ -7,13 +8,13 @@ ## create -The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection. +The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs. **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/accounting-api#/operations/get-create-directCosts-model). +Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account. @@ -34,108 +35,73 @@ s = codatlending.CodatLending( req = operations.CreateDirectCostRequest( accounting_direct_cost=shared.AccountingDirectCost( contact_ref=shared.ContactRef( - data_type='quos', - id='02d502a9-4bb4-4f63-8969-e9a3efa77dfb', + data_type=shared.DataType.INVOICES, + id='', ), - currency='GBP', - currency_rate=Decimal('2974.37'), - id='cd66ae39-5efb-49ba-88f3-a66997074ba4', + currency='USD', issue_date='2022-10-23T00:00:00.000Z', line_items=[ shared.DirectCostLineItem( - account_ref=shared.AccountRef( - id='69b6e214-1959-4890-afa5-63e2516fe4c8', - name='Dr. Arnold Bradtke', - ), - description='expedita', - discount_amount=Decimal('4692.49'), - discount_percentage=Decimal('9988.48'), + account_ref=shared.AccountRef(), item_ref=shared.ItemRef( - id='d2ed0289-21cd-4dc6-9260-1fb576b0d5f0', - name='Vincent Anderson', - ), - quantity=Decimal('9441.24'), - sub_total=Decimal('7299.91'), - tax_amount=Decimal('7499.99'), - tax_rate_ref=shared.TaxRateRef( - effective_tax_rate=Decimal('1716.29'), - id='58705320-2c73-4d5f-a9b9-0c28909b3fe4', - name='Omar Leuschke', + id='', ), - total_amount=Decimal('7508.44'), + quantity=Decimal('6384.24'), + tax_rate_ref=shared.TaxRateRef(), tracking=shared.Tracking( invoice_to=shared.RecordRef( - data_type='accountTransaction', - id='f4863332-3f9b-477f-ba41-00674ebf6928', + data_type='transfer', ), record_refs=[ shared.RecordRef( - data_type='journalEntry', - id='d1ba77a8-9ebf-4737-ae42-03ce5e6a95d8', + data_type='invoice', ), ], ), tracking_category_refs=[ shared.TrackingCategoryRef( - id='a0d446ce-2af7-4a73-8f3b-e453f870b326', - name='Glen Oberbrunner', + id='', ), ], - unit_amount=Decimal('2776.28'), + unit_amount=Decimal('2884.08'), ), ], - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - note='cupiditate', payment_allocations=[ shared.AccountingPaymentAllocation( allocation=shared.AccountingPaymentAllocationAllocation( allocated_on_date='2022-10-23T00:00:00.000Z', - currency='EUR', - currency_rate=Decimal('7470.8'), - total_amount=Decimal('1175.31'), + currency='GBP', ), payment=shared.PaymentAllocationPayment( - account_ref=shared.AccountRef( - id='a8422bb6-79d2-4322-b15b-f0cbb1e31b8b', - name='Kevin Willms', - ), - currency='GBP', - currency_rate=Decimal('2408.29'), - id='a1108e0a-dcf4-4b92-9879-fce953f73ef7', - note='hic', + account_ref=shared.AccountRef(), + currency='EUR', paid_on_date='2022-10-23T00:00:00.000Z', - reference='quod', - total_amount=Decimal('4861.6'), ), ), ], - reference='similique', source_modified_date='2022-10-23T00:00:00.000Z', - sub_total=Decimal('8742.88'), + sub_total=Decimal('9510.62'), supplemental_data=shared.SupplementalData( content={ - "ducimus": { - "dolore": 'quibusdam', + "abnormally": { + "deposit": 'evolve', }, }, ), - tax_amount=Decimal('8489.44'), - total_amount=Decimal('1943.42'), + tax_amount=Decimal('7150.4'), + total_amount=Decimal('7926.2'), ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=617877, ) res = s.loan_writeback.direct_costs.create(req) if res.accounting_create_direct_cost_response is not None: # handle response + pass ``` ### Parameters @@ -153,9 +119,9 @@ if res.accounting_create_direct_cost_response is not None: ## get_create_model -The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company and integration. +The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. **Integration-specific behaviour** @@ -185,6 +151,7 @@ res = s.loan_writeback.direct_costs.get_create_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwritebackpayments/README.md b/lending/docs/sdks/loanwritebackpayments/README.md new file mode 100755 index 000000000..92d7af8e4 --- /dev/null +++ b/lending/docs/sdks/loanwritebackpayments/README.md @@ -0,0 +1,140 @@ +# LoanWritebackPayments +(*loan_writeback.payments*) + +### Available Operations + +* [create](#create) - Create payment +* [get_create_model](#get_create_model) - Get create payment model + +## create + +The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + +**Integration-specific behaviour** + +Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). + +Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating an account. + + +### Example Usage + +```python +import codatlending +from codatlending.models import operations, shared +from decimal import Decimal + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) + +req = operations.CreatePaymentRequest( + accounting_payment=shared.AccountingPayment( + account_ref=shared.AccountRef(), + currency='USD', + customer_ref=shared.AccountingCustomerRef( + id='', + ), + date_='2022-10-23T00:00:00.000Z', + lines=[ + shared.PaymentLine( + allocated_on_date='2022-10-23T00:00:00.000Z', + amount=Decimal('8592.13'), + links=[ + shared.PaymentLineLink( + type=shared.PaymentLinkType.OTHER, + ), + ], + ), + ], + metadata=shared.Metadata(), + modified_date='2022-10-23T00:00:00.000Z', + payment_method_ref=shared.PaymentMethodRef( + id='', + ), + source_modified_date='2022-10-23T00:00:00.000Z', + supplemental_data=shared.SupplementalData( + content={ + "blue": { + "shred": 'abnormally', + }, + }, + ), + ), + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', +) + +res = s.loan_writeback.payments.create(req) + +if res.accounting_create_payment_response is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `request` | [operations.CreatePaymentRequest](../../models/operations/createpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + + +### Response + +**[operations.CreatePaymentResponse](../../models/operations/createpaymentresponse.md)** + + +## get_create_model + +The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. + +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + +**Integration-specific behaviour** + +See the *response examples* for integration-specific indicative models. + +Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating a payment. + + +### Example Usage + +```python +import codatlending +from codatlending.models import operations, shared + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) + +req = operations.GetCreatePaymentsModelRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', +) + +res = s.loan_writeback.payments.get_create_model(req) + +if res.push_option is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetCreatePaymentsModelRequest](../../models/operations/getcreatepaymentsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | + + +### Response + +**[operations.GetCreatePaymentsModelResponse](../../models/operations/getcreatepaymentsmodelresponse.md)** + diff --git a/lending/docs/sdks/loanwritebacksuppliers/README.md b/lending/docs/sdks/loanwritebacksuppliers/README.md index 3828964f2..e819ad9b7 100755 --- a/lending/docs/sdks/loanwritebacksuppliers/README.md +++ b/lending/docs/sdks/loanwritebacksuppliers/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.Suppliers +# LoanWritebackSuppliers +(*loan_writeback.suppliers*) ### Available Operations @@ -7,13 +8,13 @@ ## create -The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection. +The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/accounting-api#/operations/get-create-update-suppliers-model). +Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. @@ -34,48 +35,31 @@ req = operations.CreateSupplierRequest( accounting_supplier=shared.AccountingSupplier( addresses=[ shared.AccountingAddress( - city='Ankundingworth', - country='Guadeloupe', - line1='nulla', - line2='fugit', - postal_code='99474-0623', - region='ea', - type=shared.AccountingAddressType.UNKNOWN, + type=shared.AccountingAddressType.BILLING, ), ], - contact_name='vel', - default_currency='possimus', - email_address='magnam', - id='36813f16-d9f5-4fce-ac55-6146c3e250fb', - metadata=shared.Metadata( - is_deleted=False, - ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', - phone='+44 25691 154789', - registration_number='deleniti', + phone='(877) 492-8687', source_modified_date='2022-10-23T00:00:00.000Z', - status=shared.SupplierStatus.UNKNOWN, + status=shared.SupplierStatus.ACTIVE, supplemental_data=shared.SupplementalData( content={ - "fugit": { - "accusamus": 'inventore', + "innovative": { + "blue": 'shred', }, }, ), - supplier_name='non', - tax_number='et', ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=677412, ) res = s.loan_writeback.suppliers.create(req) if res.accounting_create_supplier_response is not None: # handle response + pass ``` ### Parameters @@ -93,9 +77,9 @@ if res.accounting_create_supplier_response is not None: ## get_create_update_model -The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company and integration. +The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration. -[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** @@ -125,6 +109,7 @@ res = s.loan_writeback.suppliers.get_create_update_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/loanwritebacktransfers/README.md b/lending/docs/sdks/loanwritebacktransfers/README.md index 98132ac9a..df8424963 100755 --- a/lending/docs/sdks/loanwritebacktransfers/README.md +++ b/lending/docs/sdks/loanwritebacktransfers/README.md @@ -1,4 +1,5 @@ -# LoanWriteback.Transfers +# LoanWritebackTransfers +(*loan_writeback.transfers*) ### Available Operations @@ -7,13 +8,13 @@ ## create -The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection. +The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. -[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. +[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/accounting-api#/operations/get-create-transfers-model). +Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account. @@ -34,64 +35,48 @@ s = codatlending.CodatLending( req = operations.CreateTransferRequest( accounting_transfer=shared.AccountingTransfer( contact_ref=shared.AccountingTransferContactRef( - data_type='laborum', - id='c366c8dd-6b14-4429-8747-4778a7bd466d', + data_type=shared.DataType.INVOICES, + id='', ), date_='2022-10-23T00:00:00.000Z', deposited_record_refs=[ shared.RecordRef( - data_type='accountTransaction', - id='c10ab3cd-ca42-4519-84e5-23c7e0bc7178', + data_type='invoice', ), ], - description='accusamus', from_=shared.TransferAccount( - account_ref=shared.AccountRef( - id='4796f2a7-0c68-4828-aaa4-82562f222e98', - name='Tamara Vandervort IV', - ), - amount=Decimal('8003.79'), - currency='EUR', - ), - id='e61e6b7b-95bc-40ab-bc20-c4f3789fd871', - metadata=shared.Metadata( - is_deleted=False, + account_ref=shared.AccountRef(), + currency='USD', ), + metadata=shared.Metadata(), modified_date='2022-10-23T00:00:00.000Z', source_modified_date='2022-10-23T00:00:00.000Z', supplemental_data=shared.SupplementalData( content={ - "sint": { - "pariatur": 'possimus', + "innovative": { + "blue": 'shred', }, }, ), to=shared.TransferAccount( - account_ref=shared.AccountRef( - id='2efd121a-a6f1-4e67-8bdb-04f15756082d', - name='Cassandra Ward V', - ), - amount=Decimal('9453.02'), - currency='GBP', + account_ref=shared.AccountRef(), + currency='USD', ), tracking_category_refs=[ shared.TrackingCategoryRef( - id='d1705133-9d08-4086-a184-0394c26071f9', - name='Camille Hirthe III', + id='', ), ], ), - allow_sync_on_push_complete=False, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - force_update=False, - timeout_in_minutes=310067, ) res = s.loan_writeback.transfers.create(req) if res.accounting_create_transfer_response is not None: # handle response + pass ``` ### Parameters @@ -109,9 +94,9 @@ if res.accounting_create_transfer_response is not None: ## get_create_model -The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company and integration. +The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. -[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. +[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. **Integration-specific behaviour** @@ -141,6 +126,7 @@ res = s.loan_writeback.transfers.get_create_model(req) if res.push_option is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/managedata/README.md b/lending/docs/sdks/managedata/README.md index 195d96468..9976e3005 100755 --- a/lending/docs/sdks/managedata/README.md +++ b/lending/docs/sdks/managedata/README.md @@ -1,4 +1,5 @@ # ManageData +(*manage_data*) ### Available Operations @@ -28,6 +29,7 @@ res = s.manage_data.get_status(req) if res.data_status_response is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/managedatapulloperations/README.md b/lending/docs/sdks/managedatapulloperations/README.md index b4ff8438c..4224b47c2 100755 --- a/lending/docs/sdks/managedatapulloperations/README.md +++ b/lending/docs/sdks/managedatapulloperations/README.md @@ -1,4 +1,5 @@ -# ManageData.PullOperations +# ManageDataPullOperations +(*manage_data.pull_operations*) ### Available Operations @@ -23,13 +24,14 @@ s = codatlending.CodatLending( req = operations.GetPullOperationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - dataset_id='eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18', + dataset_id='b18d8d81-fd7b-4764-a31e-475cb1f36591', ) res = s.manage_data.pull_operations.get(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters @@ -66,13 +68,13 @@ req = operations.ListPullOperationsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='consequuntur', ) res = s.manage_data.pull_operations.list(req) if res.pull_operations is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/managedatarefresh/README.md b/lending/docs/sdks/managedatarefresh/README.md index 9dc3c9e17..c18f9bbba 100755 --- a/lending/docs/sdks/managedatarefresh/README.md +++ b/lending/docs/sdks/managedatarefresh/README.md @@ -1,4 +1,5 @@ -# ManageData.Refresh +# ManageDataRefresh +(*manage_data.refresh*) ### Available Operations @@ -33,6 +34,7 @@ res = s.manage_data.refresh.all_data_types(req) if res.status_code == 200: # handle response + pass ``` ### Parameters @@ -68,7 +70,6 @@ s = codatlending.CodatLending( req = operations.RefreshDataTypeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='dac7af51-5cc4-413a-a63a-ae8d67864dbb', data_type=shared.DataType.INVOICES, ) @@ -76,6 +77,7 @@ res = s.manage_data.refresh.data_type(req) if res.pull_operation is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/sales/README.md b/lending/docs/sdks/sales/README.md index da2995e18..3bba63af8 100755 --- a/lending/docs/sdks/sales/README.md +++ b/lending/docs/sdks/sales/README.md @@ -1,4 +1,5 @@ # Sales +(*sales*) ### Available Operations diff --git a/lending/docs/sdks/salescustomers/README.md b/lending/docs/sdks/salescustomers/README.md index 027d2c2f2..72d2fe0e3 100755 --- a/lending/docs/sdks/salescustomers/README.md +++ b/lending/docs/sdks/salescustomers/README.md @@ -1,4 +1,5 @@ -# Sales.Customers +# SalesCustomers +(*sales.customers*) ### Available Operations @@ -9,7 +10,7 @@ The *Get customer* endpoint returns a single customer for a given customerId. -[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific customer. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceCustomerRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='commodi', + customer_id='Northeast Hatchback Kia', ) res = s.sales.customers.get(req) if res.commerce_customer is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_customer is not None: ## list -The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection. +The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. -[Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceCustomersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='in', ) res = s.sales.customers.list(req) if res.commerce_customers is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesdisputes/README.md b/lending/docs/sdks/salesdisputes/README.md index d9cd855ac..51f01e54b 100755 --- a/lending/docs/sdks/salesdisputes/README.md +++ b/lending/docs/sdks/salesdisputes/README.md @@ -1,4 +1,5 @@ -# Sales.Disputes +# SalesDisputes +(*sales.disputes*) ### Available Operations @@ -9,7 +10,7 @@ The *Get dispute* endpoint returns a single dispute for a given disputeId. -[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. +[Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceDisputeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - dispute_id='corporis', + dispute_id='Northeast Hatchback Kia', ) res = s.sales.disputes.get(req) if res.commerce_dispute is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_dispute is not None: ## list -The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection. +The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection. -[Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. +[Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceDisputesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='reiciendis', ) res = s.sales.disputes.list(req) if res.commerce_disputes is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/saleslocations/README.md b/lending/docs/sdks/saleslocations/README.md index 0da8fafa4..042c34a11 100755 --- a/lending/docs/sdks/saleslocations/README.md +++ b/lending/docs/sdks/saleslocations/README.md @@ -1,4 +1,5 @@ -# Sales.Locations +# SalesLocations +(*sales.locations*) ### Available Operations @@ -9,7 +10,7 @@ The *Get location* endpoint returns a single location for a given locationId. -[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed. +[Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceLocationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - location_id='assumenda', + location_id='Northeast Hatchback Kia', ) res = s.sales.locations.get(req) if res.commerce_location is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_location is not None: ## list -The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection. +The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection. -[Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed. +[Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -83,6 +85,7 @@ res = s.sales.locations.list(req) if res.commerce_locations is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesmetrics/README.md b/lending/docs/sdks/salesmetrics/README.md index e6ebb0cef..ab4f9ece1 100755 --- a/lending/docs/sdks/salesmetrics/README.md +++ b/lending/docs/sdks/salesmetrics/README.md @@ -1,4 +1,5 @@ -# Sales.Metrics +# SalesMetrics +(*sales.metrics*) ### Available Operations @@ -53,9 +54,8 @@ s = codatlending.CodatLending( req = operations.GetCommerceCustomerRetentionMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=363161, - period_length=924967, + number_of_periods=497588, + period_length=613110, period_unit=shared.PeriodUnit.WEEK, report_date='29-09-2020', ) @@ -64,6 +64,7 @@ res = s.sales.metrics.get_customer_retention(req) if res.commerce_report is not None: # handle response + pass ``` ### Parameters @@ -120,10 +121,9 @@ s = codatlending.CodatLending( req = operations.GetCommerceLifetimeValueMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=46007, - period_length=738683, - period_unit=shared.PeriodUnit.DAY, + number_of_periods=900865, + period_length=614777, + period_unit=shared.PeriodUnit.MONTH, report_date='29-09-2020', ) @@ -131,6 +131,7 @@ res = s.sales.metrics.get_lifetime_value(req) if res.commerce_report is not None: # handle response + pass ``` ### Parameters @@ -188,10 +189,9 @@ s = codatlending.CodatLending( req = operations.GetCommerceRevenueMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=449083, - period_length=348519, - period_unit=shared.PeriodUnit.YEAR, + number_of_periods=307462, + period_length=944219, + period_unit=shared.PeriodUnit.DAY, report_date='29-09-2020', ) @@ -199,6 +199,7 @@ res = s.sales.metrics.get_revenue(req) if res.commerce_report is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesorders/README.md b/lending/docs/sdks/salesorders/README.md index da095d28b..8177d53e7 100755 --- a/lending/docs/sdks/salesorders/README.md +++ b/lending/docs/sdks/salesorders/README.md @@ -1,4 +1,5 @@ -# Sales.Orders +# SalesOrders +(*sales.orders*) ### Available Operations @@ -9,7 +10,7 @@ The *Get order* endpoint returns a single order for a given orderId. -[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company. +[Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceOrderRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - order_id='facere', + order_id='Northeast Hatchback Kia', ) res = s.sales.orders.get(req) if res.commerce_order is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_order is not None: ## list -The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection. +The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection. -[Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company. +[Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceOrdersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='numquam', ) res = s.sales.orders.list(req) if res.commerce_orders is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salespaymentmethods/README.md b/lending/docs/sdks/salespaymentmethods/README.md index c7afdc260..bae352a07 100755 --- a/lending/docs/sdks/salespaymentmethods/README.md +++ b/lending/docs/sdks/salespaymentmethods/README.md @@ -1,4 +1,5 @@ -# Sales.PaymentMethods +# SalesPaymentMethods +(*sales.payment_methods*) ### Available Operations @@ -9,7 +10,7 @@ The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. -[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. +[Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for integrations that support getting a specific payment method. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommercePaymentMethodRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_method_id='doloribus', + payment_method_id='Northeast Hatchback Kia', ) res = s.sales.payment_methods.get(req) if res.commerce_payment_method is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_payment_method is not None: ## list -The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) for a given company's connection. +The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection. -[Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. +[Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommercePaymentMethodsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='suscipit', ) res = s.sales.payment_methods.list(req) if res.commerce_payment_methods is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salespayments/README.md b/lending/docs/sdks/salespayments/README.md index d359df108..e42f3b12a 100755 --- a/lending/docs/sdks/salespayments/README.md +++ b/lending/docs/sdks/salespayments/README.md @@ -1,4 +1,5 @@ -# Sales.Payments +# SalesPayments +(*sales.payments*) ### Available Operations @@ -9,7 +10,7 @@ The *Get payment* endpoint returns a single payment for a given paymentId. -[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company. +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for integrations that support getting a specific payment. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommercePaymentRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_id='reiciendis', + payment_id='Northeast Hatchback Kia', ) res = s.sales.payments.get(req) if res.commerce_payment is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_payment is not None: ## list -The *List payments* endpoint returns a list of [payments](https://docs.codat.io/commerce-api#/schemas/Payment) for a given company's connection. +The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. -[Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company. +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommercePaymentsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='quidem', ) res = s.sales.payments.list(req) if res.commerce_payments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesproductcategories/README.md b/lending/docs/sdks/salesproductcategories/README.md index 2d614e53e..0f05247a9 100755 --- a/lending/docs/sdks/salesproductcategories/README.md +++ b/lending/docs/sdks/salesproductcategories/README.md @@ -1,4 +1,5 @@ -# Sales.ProductCategories +# SalesProductCategories +(*sales.product_categories*) ### Available Operations @@ -9,7 +10,7 @@ The *Get product* endpoint returns a single product for a given productId. -[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. +[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for integrations that support getting a specific product. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceProductCategoryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - product_id='saepe', + product_id='Northeast Hatchback Kia', ) res = s.sales.product_categories.get(req) if res.commerce_product_category is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_product_category is not None: ## list -The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) for a given company's connection. +The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection. -[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. +[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceProductCategoriesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='necessitatibus', ) res = s.sales.product_categories.list(req) if res.commerce_product_categories is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesproducts/README.md b/lending/docs/sdks/salesproducts/README.md index 037dc1e15..e43f19fc7 100755 --- a/lending/docs/sdks/salesproducts/README.md +++ b/lending/docs/sdks/salesproducts/README.md @@ -1,4 +1,5 @@ -# Sales.Products +# SalesProducts +(*sales.products*) ### Available Operations @@ -9,7 +10,7 @@ The *Get product* endpoint returns a single product for a given productId. -[Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale. +[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for integrations that support getting a specific product. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceProductRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - product_id='dolore', + product_id='Northeast Hatchback Kia', ) res = s.sales.products.get(req) if res.commerce_product is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_product is not None: ## list -The *List products* endpoint returns a list of [products](https://docs.codat.io/commerce-api#/schemas/Product) for a given company's connection. +The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection. -[Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale. +[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceProductsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='sunt', ) res = s.sales.products.list(req) if res.commerce_products is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salesreports/README.md b/lending/docs/sdks/salesreports/README.md index d06f019de..c3f863e87 100755 --- a/lending/docs/sdks/salesreports/README.md +++ b/lending/docs/sdks/salesreports/README.md @@ -1,4 +1,5 @@ -# Sales.Reports +# SalesReports +(*sales.reports*) ### Available Operations @@ -47,10 +48,9 @@ s = codatlending.CodatLending( req = operations.GetCommerceOrdersReportRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=992012, - period_length=241545, - period_unit=shared.PeriodUnit.DAY, + number_of_periods=491586, + period_length=776309, + period_unit=shared.PeriodUnit.WEEK, report_date='29-09-2020', ) @@ -58,6 +58,7 @@ res = s.sales.reports.get_orders(req) if res.commerce_report is not None: # handle response + pass ``` ### Parameters @@ -116,10 +117,9 @@ s = codatlending.CodatLending( req = operations.GetCommerceRefundsReportRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=228263, - period_length=105906, - period_unit=shared.PeriodUnit.WEEK, + number_of_periods=277786, + period_length=876670, + period_unit=shared.PeriodUnit.YEAR, report_date='29-09-2020', ) @@ -127,6 +127,7 @@ res = s.sales.reports.get_refunds(req) if res.commerce_report is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/salestransactions/README.md b/lending/docs/sdks/salestransactions/README.md index 3a888115b..ae06f9120 100755 --- a/lending/docs/sdks/salestransactions/README.md +++ b/lending/docs/sdks/salestransactions/README.md @@ -1,4 +1,5 @@ -# Sales.Transactions +# SalesTransactions +(*sales.transactions*) ### Available Operations @@ -9,7 +10,7 @@ The *Get transaction* endpoint returns a single transaction for a given transactionId. -[Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. +[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for integrations that support getting a specific transaction. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetCommerceTransactionRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_id='a', + transaction_id='Northeast Hatchback Kia', ) res = s.sales.transactions.get(req) if res.commerce_transaction is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.commerce_transaction is not None: ## list -The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) for a given company's connection. +The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. -[Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. +[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListCommerceTransactionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='debitis', ) res = s.sales.transactions.list(req) if res.commerce_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/transactions/README.md b/lending/docs/sdks/transactions/README.md index 6b3774915..a82638fed 100755 --- a/lending/docs/sdks/transactions/README.md +++ b/lending/docs/sdks/transactions/README.md @@ -1,4 +1,5 @@ # Transactions +(*transactions*) ### Available Operations diff --git a/lending/docs/sdks/transactionsaccounttransactions/README.md b/lending/docs/sdks/transactionsaccounttransactions/README.md index a34b58d25..814520547 100755 --- a/lending/docs/sdks/transactionsaccounttransactions/README.md +++ b/lending/docs/sdks/transactionsaccounttransactions/README.md @@ -1,4 +1,5 @@ -# Transactions.AccountTransactions +# TransactionsAccountTransactions +(*transactions.account_transactions*) ### Available Operations @@ -9,7 +10,7 @@ The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. -[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. +[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction. @@ -29,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingAccountTransactionRequest( - account_transaction_id='consectetur', + account_transaction_id='Northeast Hatchback Kia', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -38,6 +39,7 @@ res = s.transactions.account_transactions.get(req) if res.accounting_account_transaction is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.accounting_account_transaction is not None: ## list -The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection. +The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection. -[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. +[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListAccountingAccountTransactionsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='corporis', ) res = s.transactions.account_transactions.list(req) if res.accounting_account_transactions is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/transactionsdirectcosts/README.md b/lending/docs/sdks/transactionsdirectcosts/README.md index 2a41e754b..a6a03267c 100755 --- a/lending/docs/sdks/transactionsdirectcosts/README.md +++ b/lending/docs/sdks/transactionsdirectcosts/README.md @@ -1,4 +1,5 @@ -# Transactions.DirectCosts +# TransactionsDirectCosts +(*transactions.direct_costs*) ### Available Operations @@ -12,7 +13,7 @@ The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment. @@ -33,13 +34,14 @@ req = operations.DownloadAccountingDirectCostAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='harum', + direct_cost_id='Dakota Avon specifically', ) res = s.transactions.direct_costs.download_attachment(req) if res.data is not None: # handle response + pass ``` ### Parameters @@ -59,7 +61,7 @@ if res.data is not None: The *Get direct cost* endpoint returns a single direct cost for a given directCostId. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost. @@ -81,13 +83,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingDirectCostRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='laboriosam', + direct_cost_id='Northeast Hatchback Kia', ) res = s.transactions.direct_costs.get(req) if res.accounting_direct_cost is not None: # handle response + pass ``` ### Parameters @@ -107,7 +110,7 @@ if res.accounting_direct_cost is not None: The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment. @@ -128,13 +131,14 @@ req = operations.GetAccountingDirectCostAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='ipsa', + direct_cost_id='array East along', ) res = s.transactions.direct_costs.get_attachment(req) if res.accounting_attachment is not None: # handle response + pass ``` ### Parameters @@ -152,9 +156,9 @@ if res.accounting_attachment is not None: ## list -The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection. +The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -177,13 +181,13 @@ req = operations.ListAccountingDirectCostsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='voluptates', ) res = s.transactions.direct_costs.list(req) if res.accounting_direct_costs is not None: # handle response + pass ``` ### Parameters @@ -203,7 +207,7 @@ if res.accounting_direct_costs is not None: The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. -[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. +[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments. @@ -223,13 +227,14 @@ s = codatlending.CodatLending( req = operations.ListAccountingDirectCostAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='libero', + direct_cost_id='intuitive Frozen ouch', ) res = s.transactions.direct_costs.list_attachments(req) if res.attachments is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/transactionsjournalentries/README.md b/lending/docs/sdks/transactionsjournalentries/README.md index fac8bfdd5..195f8fe76 100755 --- a/lending/docs/sdks/transactionsjournalentries/README.md +++ b/lending/docs/sdks/transactionsjournalentries/README.md @@ -1,4 +1,5 @@ -# Transactions.JournalEntries +# TransactionsJournalEntries +(*transactions.journal_entries*) ### Available Operations @@ -9,7 +10,7 @@ The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. -[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. +[Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry. @@ -30,13 +31,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingJournalEntryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - journal_entry_id='vitae', + journal_entry_id='Northeast Hatchback Kia', ) res = s.transactions.journal_entries.get(req) if res.accounting_journal_entry is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_journal_entry is not None: ## list -The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection. +The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection. -[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. +[Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingJournalEntriesRequest( order_by='-modifiedDate', page=1, page_size=100, - query='accusamus', ) res = s.transactions.journal_entries.list(req) if res.accounting_journal_entries is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/transactionsjournals/README.md b/lending/docs/sdks/transactionsjournals/README.md index 6f576e0e0..aecea4524 100755 --- a/lending/docs/sdks/transactionsjournals/README.md +++ b/lending/docs/sdks/transactionsjournals/README.md @@ -1,4 +1,5 @@ -# Transactions.Journals +# TransactionsJournals +(*transactions.journals*) ### Available Operations @@ -9,7 +10,7 @@ The *Get journal* endpoint returns a single journal for a given journalId. -[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company. +[Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal. @@ -30,13 +31,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingJournalRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - journal_id='similique', + journal_id='Northeast Hatchback Kia', ) res = s.transactions.journals.get(req) if res.accounting_journal is not None: # handle response + pass ``` ### Parameters @@ -54,9 +56,9 @@ if res.accounting_journal is not None: ## list -The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection. +The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection. -[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company. +[Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -78,13 +80,13 @@ req = operations.ListAccountingJournalsRequest( order_by='-modifiedDate', page=1, page_size=100, - query='tempora', ) res = s.transactions.journals.list(req) if res.accounting_journals is not None: # handle response + pass ``` ### Parameters diff --git a/lending/docs/sdks/transactionstransfers/README.md b/lending/docs/sdks/transactionstransfers/README.md index acccfe0ca..cca5b8d5e 100755 --- a/lending/docs/sdks/transactionstransfers/README.md +++ b/lending/docs/sdks/transactionstransfers/README.md @@ -1,4 +1,5 @@ -# Transactions.Transfers +# TransactionsTransfers +(*transactions.transfers*) ### Available Operations @@ -9,7 +10,7 @@ The *Get transfer* endpoint returns a single transfer for a given transferId. -[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. +[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer. @@ -31,13 +32,14 @@ s = codatlending.CodatLending( req = operations.GetAccountingTransferRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transfer_id='aspernatur', + transfer_id='Northeast Hatchback Kia', ) res = s.transactions.transfers.get(req) if res.accounting_transfer is not None: # handle response + pass ``` ### Parameters @@ -55,9 +57,9 @@ if res.accounting_transfer is not None: ## list -The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection. +The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. -[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. +[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -80,13 +82,13 @@ req = operations.ListAccountingTransfersRequest( order_by='-modifiedDate', page=1, page_size=100, - query='voluptas', ) res = s.transactions.transfers.list(req) if res.accounting_transfers is not None: # handle response + pass ``` ### Parameters diff --git a/lending/files.gen b/lending/files.gen index 385d8334a..4ad6b397f 100755 --- a/lending/files.gen +++ b/lending/files.gen @@ -32,10 +32,10 @@ src/codatlending/financial_statements_cash_flow.py src/codatlending/financial_statements_profit_and_loss.py src/codatlending/financial_statements.py src/codatlending/loan_writeback_accounts.py -src/codatlending/loan_writeback_bank_accounts.py src/codatlending/loan_writeback_bank_transactions.py src/codatlending/loan_writeback_create_operations.py src/codatlending/loan_writeback_direct_costs.py +src/codatlending/loan_writeback_payments.py src/codatlending/loan_writeback_suppliers.py src/codatlending/loan_writeback_transfers.py src/codatlending/loan_writeback.py @@ -93,6 +93,8 @@ src/codatlending/models/operations/get_excel_report_generation_status.py src/codatlending/models/operations/download_files.py src/codatlending/models/operations/list_files.py src/codatlending/models/operations/upload_files.py +src/codatlending/models/operations/generate_loan_summary.py +src/codatlending/models/operations/generate_loan_transactions.py src/codatlending/models/operations/get_loan_summary.py src/codatlending/models/operations/list_loan_transactions.py src/codatlending/models/operations/get_accounting_bill_credit_note.py @@ -151,14 +153,14 @@ src/codatlending/models/operations/get_accounting_profit_and_loss.py src/codatlending/models/operations/get_categorized_profit_and_loss_statement.py src/codatlending/models/operations/create_account.py src/codatlending/models/operations/get_create_chartofaccounts_model.py -src/codatlending/models/operations/create_bank_account.py -src/codatlending/models/operations/get_create_update_bankaccounts_model.py src/codatlending/models/operations/create_bank_transactions.py src/codatlending/models/operations/get_create_bank_transactions_model.py src/codatlending/models/operations/get_create_operation.py src/codatlending/models/operations/list_create_operations.py src/codatlending/models/operations/create_direct_cost.py src/codatlending/models/operations/get_create_directcosts_model.py +src/codatlending/models/operations/create_payment.py +src/codatlending/models/operations/get_create_payments_model.py src/codatlending/models/operations/create_supplier.py src/codatlending/models/operations/get_create_update_suppliers_model.py src/codatlending/models/operations/create_transfer.py @@ -207,6 +209,7 @@ src/codatlending/models/operations/list_accounting_transfers.py src/codatlending/models/operations/__init__.py src/codatlending/models/shared/errormessage.py src/codatlending/models/shared/accountingbankaccount.py +src/codatlending/models/shared/supplementaldata.py src/codatlending/models/shared/metadata.py src/codatlending/models/shared/accountingbankaccounttype.py src/codatlending/models/shared/accountingbankaccounts.py @@ -264,7 +267,6 @@ src/codatlending/models/shared/loantransactionsreportinfo.py src/codatlending/models/shared/accountingbillcreditnote.py src/codatlending/models/shared/items.py src/codatlending/models/shared/supplierref.py -src/codatlending/models/shared/supplementaldata.py src/codatlending/models/shared/billcreditnotestatus.py src/codatlending/models/shared/accountingpaymentallocation.py src/codatlending/models/shared/paymentallocationpayment.py @@ -277,6 +279,7 @@ src/codatlending/models/shared/billedtotype.py src/codatlending/models/shared/accountingcustomerref.py src/codatlending/models/shared/accountingbillcreditnotes.py src/codatlending/models/shared/accountingbillpayment.py +src/codatlending/models/shared/paymentmethodref.py src/codatlending/models/shared/billpaymentline.py src/codatlending/models/shared/billpaymentlinelink.py src/codatlending/models/shared/billpaymentlinelinktype.py @@ -305,6 +308,7 @@ src/codatlending/models/shared/accountingcustomers.py src/codatlending/models/shared/accountingdirectincome.py src/codatlending/models/shared/directincomelineitem.py src/codatlending/models/shared/contactref.py +src/codatlending/models/shared/datatype.py src/codatlending/models/shared/accountingdirectincomes.py src/codatlending/models/shared/accountinginvoice.py src/codatlending/models/shared/invoicestatus.py @@ -371,7 +375,6 @@ src/codatlending/models/shared/accountingcreateaccountresponse.py src/codatlending/models/shared/validation.py src/codatlending/models/shared/validationitem.py src/codatlending/models/shared/pushoperationstatus.py -src/codatlending/models/shared/datatype.py src/codatlending/models/shared/pushoperationchange.py src/codatlending/models/shared/pushchangetype.py src/codatlending/models/shared/pushoperationref.py @@ -381,7 +384,6 @@ src/codatlending/models/shared/pushfieldvalidation.py src/codatlending/models/shared/pushoptiontype.py src/codatlending/models/shared/pushoptionproperty.py src/codatlending/models/shared/pushoptionchoice.py -src/codatlending/models/shared/accountingcreatebankaccountresponse.py src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py src/codatlending/models/shared/accountingcreatebanktransactions.py src/codatlending/models/shared/createbankaccounttransaction.py @@ -392,6 +394,7 @@ src/codatlending/models/shared/accountingdirectcost.py src/codatlending/models/shared/directcostlineitem.py src/codatlending/models/shared/tracking.py src/codatlending/models/shared/recordref.py +src/codatlending/models/shared/accountingcreatepaymentresponse.py src/codatlending/models/shared/accountingcreatesupplierresponse.py src/codatlending/models/shared/accountingcreatetransferresponse.py src/codatlending/models/shared/accountingtransfer.py @@ -431,7 +434,6 @@ src/codatlending/models/shared/locationref.py src/codatlending/models/shared/commercecustomerref.py src/codatlending/models/shared/commerceorders.py src/codatlending/models/shared/commercepaymentmethod.py -src/codatlending/models/shared/paymentmethodstatus.py src/codatlending/models/shared/commercepaymentmethods.py src/codatlending/models/shared/commercepayment.py src/codatlending/models/shared/commercepayments.py @@ -474,69 +476,6 @@ src/codatlending/models/webhooks/client_rate_limit_reached.py src/codatlending/models/webhooks/client_rate_limit_reset.py src/codatlending/models/webhooks/__init__.py src/codatlending/models/errors/__init__.py -docs/sdks/codatlending/README.md -docs/models/utils/retryconfig.md -docs/sdks/accountingbankdata/README.md -docs/sdks/accountingbankdataaccounts/README.md -docs/sdks/companies/README.md -docs/sdks/companyinfo/README.md -docs/sdks/connections/README.md -docs/sdks/dataintegrity/README.md -docs/sdks/excelreports/README.md -docs/sdks/fileupload/README.md -docs/sdks/liabilities/README.md -docs/sdks/accountspayable/README.md -docs/sdks/accountspayablebillcreditnotes/README.md -docs/sdks/accountspayablebillpayments/README.md -docs/sdks/accountspayablebills/README.md -docs/sdks/accountspayablesuppliers/README.md -docs/sdks/accountsreceivable/README.md -docs/sdks/accountsreceivablecreditnotes/README.md -docs/sdks/accountsreceivablecustomers/README.md -docs/sdks/accountsreceivabledirectincomes/README.md -docs/sdks/accountsreceivableinvoices/README.md -docs/sdks/accountsreceivablepayments/README.md -docs/sdks/accountsreceivablereports/README.md -docs/sdks/banking/README.md -docs/sdks/bankingaccountbalances/README.md -docs/sdks/bankingaccounts/README.md -docs/sdks/bankingcategorizedstatement/README.md -docs/sdks/bankingtransactioncategories/README.md -docs/sdks/bankingtransactions/README.md -docs/sdks/financialstatements/README.md -docs/sdks/financialstatementsaccounts/README.md -docs/sdks/financialstatementsbalancesheet/README.md -docs/sdks/financialstatementscashflow/README.md -docs/sdks/financialstatementsprofitandloss/README.md -docs/sdks/loanwriteback/README.md -docs/sdks/loanwritebackaccounts/README.md -docs/sdks/loanwritebackbankaccounts/README.md -docs/sdks/loanwritebackbanktransactions/README.md -docs/sdks/loanwritebackcreateoperations/README.md -docs/sdks/loanwritebackdirectcosts/README.md -docs/sdks/loanwritebacksuppliers/README.md -docs/sdks/loanwritebacktransfers/README.md -docs/sdks/managedata/README.md -docs/sdks/managedatapulloperations/README.md -docs/sdks/managedatarefresh/README.md -docs/sdks/sales/README.md -docs/sdks/salescustomers/README.md -docs/sdks/salesdisputes/README.md -docs/sdks/saleslocations/README.md -docs/sdks/salesmetrics/README.md -docs/sdks/salesorders/README.md -docs/sdks/salespaymentmethods/README.md -docs/sdks/salespayments/README.md -docs/sdks/salesproductcategories/README.md -docs/sdks/salesproducts/README.md -docs/sdks/salesreports/README.md -docs/sdks/salestransactions/README.md -docs/sdks/transactions/README.md -docs/sdks/transactionsaccounttransactions/README.md -docs/sdks/transactionsdirectcosts/README.md -docs/sdks/transactionsjournalentries/README.md -docs/sdks/transactionsjournals/README.md -docs/sdks/transactionstransfers/README.md USAGE.md docs/models/operations/getaccountingbankaccountrequest.md docs/models/operations/getaccountingbankaccountresponse.md @@ -588,6 +527,13 @@ docs/models/operations/listfilesresponse.md docs/models/operations/uploadfilesrequestbody.md docs/models/operations/uploadfilesrequest.md docs/models/operations/uploadfilesresponse.md +docs/models/operations/generateloansummarysourcetype.md +docs/models/operations/generateloansummaryrequest.md +docs/models/operations/generateloansummaryresponse.md +docs/models/operations/generateloantransactionssourcetype.md +docs/models/operations/generateloantransactionsrequest.md +docs/models/operations/generateloantransactionsresponse.md +docs/models/operations/getloansummarysourcetype.md docs/models/operations/getloansummaryrequest.md docs/models/operations/getloansummaryresponse.md docs/models/operations/listloantransactionssourcetype.md @@ -705,10 +651,6 @@ docs/models/operations/createaccountrequest.md docs/models/operations/createaccountresponse.md docs/models/operations/getcreatechartofaccountsmodelrequest.md docs/models/operations/getcreatechartofaccountsmodelresponse.md -docs/models/operations/createbankaccountrequest.md -docs/models/operations/createbankaccountresponse.md -docs/models/operations/getcreateupdatebankaccountsmodelrequest.md -docs/models/operations/getcreateupdatebankaccountsmodelresponse.md docs/models/operations/createbanktransactionsrequest.md docs/models/operations/createbanktransactionsresponse.md docs/models/operations/getcreatebanktransactionsmodelrequest.md @@ -721,6 +663,10 @@ docs/models/operations/createdirectcostrequest.md docs/models/operations/createdirectcostresponse.md docs/models/operations/getcreatedirectcostsmodelrequest.md docs/models/operations/getcreatedirectcostsmodelresponse.md +docs/models/operations/createpaymentrequest.md +docs/models/operations/createpaymentresponse.md +docs/models/operations/getcreatepaymentsmodelrequest.md +docs/models/operations/getcreatepaymentsmodelresponse.md docs/models/operations/createsupplierrequest.md docs/models/operations/createsupplierresponse.md docs/models/operations/getcreateupdatesuppliersmodelrequest.md @@ -813,6 +759,7 @@ docs/models/operations/listaccountingtransfersrequest.md docs/models/operations/listaccountingtransfersresponse.md docs/models/shared/errormessage.md docs/models/shared/accountingbankaccount.md +docs/models/shared/supplementaldata.md docs/models/shared/metadata.md docs/models/shared/accountingbankaccounttype.md docs/models/shared/accountingbankaccounts.md @@ -873,7 +820,6 @@ docs/models/shared/loantransactionsreportinfo.md docs/models/shared/accountingbillcreditnote.md docs/models/shared/items.md docs/models/shared/supplierref.md -docs/models/shared/supplementaldata.md docs/models/shared/billcreditnotestatus.md docs/models/shared/accountingpaymentallocationallocation.md docs/models/shared/accountingpaymentallocation.md @@ -889,6 +835,7 @@ docs/models/shared/billedtotype.md docs/models/shared/accountingcustomerref.md docs/models/shared/accountingbillcreditnotes.md docs/models/shared/accountingbillpayment.md +docs/models/shared/paymentmethodref.md docs/models/shared/billpaymentline.md docs/models/shared/billpaymentlinelink.md docs/models/shared/billpaymentlinelinktype.md @@ -897,6 +844,8 @@ docs/models/shared/accountingbillpurchaseorderreference.md docs/models/shared/accountingbillwithholdingtax.md docs/models/shared/accountingbill.md docs/models/shared/billstatus.md +docs/models/shared/billlineitemrecordlinereferencedatatype.md +docs/models/shared/billlineitemrecordlinereference.md docs/models/shared/billlineitem.md docs/models/shared/taxrateref.md docs/models/shared/itemref.md @@ -920,6 +869,7 @@ docs/models/shared/accountingcustomers.md docs/models/shared/accountingdirectincome.md docs/models/shared/directincomelineitem.md docs/models/shared/contactref.md +docs/models/shared/datatype.md docs/models/shared/accountingdirectincomes.md docs/models/shared/accountinginvoicesalesorderreference.md docs/models/shared/accountinginvoice.md @@ -989,7 +939,6 @@ docs/models/shared/accountingcreateaccountresponse.md docs/models/shared/validation.md docs/models/shared/validationitem.md docs/models/shared/pushoperationstatus.md -docs/models/shared/datatype.md docs/models/shared/pushoperationchange.md docs/models/shared/pushchangetype.md docs/models/shared/pushoperationref.md @@ -999,7 +948,6 @@ docs/models/shared/pushfieldvalidation.md docs/models/shared/pushoptiontype.md docs/models/shared/pushoptionproperty.md docs/models/shared/pushoptionchoice.md -docs/models/shared/accountingcreatebankaccountresponse.md docs/models/shared/accountingcreatebanktransactionsresponse.md docs/models/shared/accountingcreatebanktransactions.md docs/models/shared/createbankaccounttransaction.md @@ -1010,6 +958,7 @@ docs/models/shared/accountingdirectcost.md docs/models/shared/directcostlineitem.md docs/models/shared/tracking.md docs/models/shared/recordref.md +docs/models/shared/accountingcreatepaymentresponse.md docs/models/shared/accountingcreatesupplierresponse.md docs/models/shared/accountingcreatetransferresponse.md docs/models/shared/accountingtransfercontactref.md @@ -1018,6 +967,7 @@ docs/models/shared/transferaccount.md docs/models/shared/pulloperationstatus.md docs/models/shared/pulloperation.md docs/models/shared/pulloperations.md +docs/models/shared/datastatusdatatypes.md docs/models/shared/datastatus.md docs/models/shared/commercecustomer.md docs/models/shared/commercecustomers.md @@ -1036,7 +986,6 @@ docs/models/shared/commercereporterror.md docs/models/shared/commercereportdimensionitems.md docs/models/shared/commercereportdimension.md docs/models/shared/periodunit.md -docs/models/shared/commerceordersupplementaldata.md docs/models/shared/commerceorder.md docs/models/shared/servicecharge.md docs/models/shared/servicechargetype.md @@ -1052,8 +1001,8 @@ docs/models/shared/orderdiscountallocation.md docs/models/shared/locationref.md docs/models/shared/commercecustomerref.md docs/models/shared/commerceorders.md +docs/models/shared/commercepaymentmethodstatus.md docs/models/shared/commercepaymentmethod.md -docs/models/shared/paymentmethodstatus.md docs/models/shared/commercepaymentmethods.md docs/models/shared/commercepayment.md docs/models/shared/commercepayments.md @@ -1095,4 +1044,67 @@ docs/models/shared/clientratelimitresetwebhookdata.md docs/models/webhooks/accountcategoriesupdatedresponse.md docs/models/webhooks/clientratelimitreachedresponse.md docs/models/webhooks/clientratelimitresetresponse.md +docs/sdks/codatlending/README.md +docs/models/utils/retryconfig.md +docs/sdks/accountingbankdata/README.md +docs/sdks/accountingbankdataaccounts/README.md +docs/sdks/companies/README.md +docs/sdks/companyinfo/README.md +docs/sdks/connections/README.md +docs/sdks/dataintegrity/README.md +docs/sdks/excelreports/README.md +docs/sdks/fileupload/README.md +docs/sdks/liabilities/README.md +docs/sdks/accountspayable/README.md +docs/sdks/accountspayablebillcreditnotes/README.md +docs/sdks/accountspayablebillpayments/README.md +docs/sdks/accountspayablebills/README.md +docs/sdks/accountspayablesuppliers/README.md +docs/sdks/accountsreceivable/README.md +docs/sdks/accountsreceivablecreditnotes/README.md +docs/sdks/accountsreceivablecustomers/README.md +docs/sdks/accountsreceivabledirectincomes/README.md +docs/sdks/accountsreceivableinvoices/README.md +docs/sdks/accountsreceivablepayments/README.md +docs/sdks/accountsreceivablereports/README.md +docs/sdks/banking/README.md +docs/sdks/bankingaccountbalances/README.md +docs/sdks/bankingaccounts/README.md +docs/sdks/bankingcategorizedstatement/README.md +docs/sdks/bankingtransactioncategories/README.md +docs/sdks/bankingtransactions/README.md +docs/sdks/financialstatements/README.md +docs/sdks/financialstatementsaccounts/README.md +docs/sdks/financialstatementsbalancesheet/README.md +docs/sdks/financialstatementscashflow/README.md +docs/sdks/financialstatementsprofitandloss/README.md +docs/sdks/loanwriteback/README.md +docs/sdks/loanwritebackaccounts/README.md +docs/sdks/loanwritebackbanktransactions/README.md +docs/sdks/loanwritebackcreateoperations/README.md +docs/sdks/loanwritebackdirectcosts/README.md +docs/sdks/loanwritebackpayments/README.md +docs/sdks/loanwritebacksuppliers/README.md +docs/sdks/loanwritebacktransfers/README.md +docs/sdks/managedata/README.md +docs/sdks/managedatapulloperations/README.md +docs/sdks/managedatarefresh/README.md +docs/sdks/sales/README.md +docs/sdks/salescustomers/README.md +docs/sdks/salesdisputes/README.md +docs/sdks/saleslocations/README.md +docs/sdks/salesmetrics/README.md +docs/sdks/salesorders/README.md +docs/sdks/salespaymentmethods/README.md +docs/sdks/salespayments/README.md +docs/sdks/salesproductcategories/README.md +docs/sdks/salesproducts/README.md +docs/sdks/salesreports/README.md +docs/sdks/salestransactions/README.md +docs/sdks/transactions/README.md +docs/sdks/transactionsaccounttransactions/README.md +docs/sdks/transactionsdirectcosts/README.md +docs/sdks/transactionsjournalentries/README.md +docs/sdks/transactionsjournals/README.md +docs/sdks/transactionstransfers/README.md .gitattributes \ No newline at end of file diff --git a/lending/gen.yaml b/lending/gen.yaml index 823d05a3e..01b7dc9e0 100644 --- a/lending/gen.yaml +++ b/lending/gen.yaml @@ -1,27 +1,28 @@ configVersion: 1.0.0 management: - docChecksum: 0add1e087e1653186370d8ee74641f07 + docChecksum: 49794ddbb09eb6f879edbfdbcf289538 docVersion: 3.0.0 - speakeasyVersion: 1.88.1 - generationVersion: 2.122.1 + speakeasyVersion: 1.100.2 + generationVersion: 2.159.2 generation: sdkClassName: CodatLending singleTagPerOp: false telemetryEnabled: true features: python: - core: 2.85.6 + core: 3.0.2 deprecations: 2.81.1 + downloadStreams: 0.0.1 examples: 2.81.2 - globalSecurity: 2.81.1 + globalSecurity: 2.82.0 globalServerURLs: 2.82.0 - groups: 2.81.1 + groups: 2.81.2 nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 4.2.0 + version: 5.0.0 author: Codat - description: Make credit decisions backed by enhanced financials, metrics, reports, - and data integrity features. + description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. + flattenGlobalSecurity: false maxMethodParams: 0 packageName: codat-lending diff --git a/lending/pylintrc b/lending/pylintrc index 409631707..35b4e583a 100755 --- a/lending/pylintrc +++ b/lending/pylintrc @@ -88,7 +88,7 @@ persistent=yes # Minimum Python version to use for version dependent checks. Will default to # the version used to run pylint. -py-version=3.9 +py-version=3.8 # Discover python modules and packages in the file system subtree. recursive=no @@ -116,12 +116,12 @@ argument-naming-style=snake_case #argument-rgx= # Naming style matching correct attribute names. -attr-naming-style=snake_case +#attr-naming-style=snake_case # Regular expression matching correct attribute names. Overrides attr-naming- # style. If left empty, attribute names will be checked with the set naming # style. -#attr-rgx= +attr-rgx=[^\W\d][^\W]*|__.*__$ # Bad variable names which should always be refused, separated by a comma. bad-names= diff --git a/lending/setup.py b/lending/setup.py index 7c64a99ff..e4f1c6754 100755 --- a/lending/setup.py +++ b/lending/setup.py @@ -10,33 +10,31 @@ setuptools.setup( name="codat-lending", - version="4.2.0", + version="5.0.0", author="Codat", description="Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ - "certifi>=2022.12.7", - "charset-normalizer>=2.1.1", - "dataclasses-json>=0.5.12", - "idna>=3.3", + "certifi>=2023.7.22", + "charset-normalizer>=3.2.0", + "dataclasses-json>=0.6.1", + "idna>=3.4", "jsonpath-python>=1.0.6 ", - "marshmallow>=3.17.1", - "marshmallow-enum>=1.5.1", - "mypy-extensions>=0.4.3", - "packaging>=21.3", - "pyparsing>=3.0.9", + "marshmallow>=3.19.0", + "mypy-extensions>=1.0.0", + "packaging>=23.1", "python-dateutil>=2.8.2", - "requests>=2.28.1", + "requests>=2.31.0", "six>=1.16.0", - "typing-inspect>=0.8.0", - "typing_extensions>=4.3.0", - "urllib3>=1.26.12", + "typing-inspect>=0.9.0", + "typing_extensions>=4.7.1", + "urllib3>=2.0.4", ], extras_require={ "dev":["pylint==2.16.2"] }, package_dir={'': 'src'}, - python_requires='>=3.9' + python_requires='>=3.8' ) diff --git a/lending/src/codatlending/accounting_bank_data.py b/lending/src/codatlending/accounting_bank_data.py index d11de52ef..205ca592e 100755 --- a/lending/src/codatlending/accounting_bank_data.py +++ b/lending/src/codatlending/accounting_bank_data.py @@ -21,9 +21,9 @@ def _init_sdks(self): def list_transactions(self, request: operations.ListAccountingBankAccountTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBankAccountTransactionsResponse: r"""List bank account transactions - The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection. + The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. - [Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions. @@ -35,7 +35,7 @@ def list_transactions(self, request: operations.ListAccountingBankAccountTransac headers = {} query_params = utils.get_query_params(operations.ListAccountingBankAccountTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -49,7 +49,7 @@ def list_transactions(self, request: operations.ListAccountingBankAccountTransac def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounting_bank_data_accounts.py b/lending/src/codatlending/accounting_bank_data_accounts.py index c9f8fda2d..7652ea9a2 100755 --- a/lending/src/codatlending/accounting_bank_data_accounts.py +++ b/lending/src/codatlending/accounting_bank_data_accounts.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingBankAccountRequest, retries: Opti r"""Get bank account The *Get bank account* endpoint returns a single account for a given accountId. - [Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + [Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support getting a specific bank account. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingBankAccountRequest, retries: Opti url = utils.generate_url(operations.GetAccountingBankAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingBankAccountRequest, retries: Opti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingBankAccountsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBankAccountsResponse: r"""List bank accounts - The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection. + The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection. - [Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + [Bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingBankAccountsRequest, retries: O headers = {} query_params = utils.get_query_params(operations.ListAccountingBankAccountsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingBankAccountsRequest, retries: O def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_payable_bill_credit_notes.py b/lending/src/codatlending/accounts_payable_bill_credit_notes.py index 78649b26e..b50d0f391 100755 --- a/lending/src/codatlending/accounts_payable_bill_credit_notes.py +++ b/lending/src/codatlending/accounts_payable_bill_credit_notes.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingBillCreditNoteRequest, retries: O r"""Get bill credit note The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. - [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingBillCreditNoteRequest, retries: O url = utils.generate_url(operations.GetAccountingBillCreditNoteRequest, base_url, '/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingBillCreditNoteRequest, retries: O def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingBillCreditNotesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBillCreditNotesResponse: r"""List bill credit notes - The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection. + The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection. - [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingBillCreditNotesRequest, retries headers = {} query_params = utils.get_query_params(operations.ListAccountingBillCreditNotesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingBillCreditNotesRequest, retries def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_payable_bill_payments.py b/lending/src/codatlending/accounts_payable_bill_payments.py index d47c4ba90..e7012e225 100755 --- a/lending/src/codatlending/accounts_payable_bill_payments.py +++ b/lending/src/codatlending/accounts_payable_bill_payments.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingBillPaymentRequest, retries: Opti r"""Get bill payment The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. - [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingBillPaymentRequest, retries: Opti url = utils.generate_url(operations.GetAccountingBillPaymentRequest, base_url, '/companies/{companyId}/data/billPayments/{billPaymentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingBillPaymentRequest, retries: Opti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingBillPaymentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBillPaymentsResponse: r"""List bill payments - The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection. + The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection. - [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingBillPaymentsRequest, retries: O headers = {} query_params = utils.get_query_params(operations.ListAccountingBillPaymentsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingBillPaymentsRequest, retries: O def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_payable_bills.py b/lending/src/codatlending/accounts_payable_bills.py index 007dcc323..4743d3413 100755 --- a/lending/src/codatlending/accounts_payable_bills.py +++ b/lending/src/codatlending/accounts_payable_bills.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingBillAttachme r"""Download bill attachment The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. - [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingBillAttachme headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingBillAttachme def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -76,7 +76,7 @@ def get(self, request: operations.GetAccountingBillRequest, retries: Optional[ut r"""Get bill The *Get bill* endpoint returns a single bill for a given billId. - [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill. @@ -87,7 +87,7 @@ def get(self, request: operations.GetAccountingBillRequest, retries: Optional[ut url = utils.generate_url(operations.GetAccountingBillRequest, base_url, '/companies/{companyId}/data/bills/{billId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -101,7 +101,7 @@ def get(self, request: operations.GetAccountingBillRequest, retries: Optional[ut def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -131,7 +131,7 @@ def get_attachment(self, request: operations.GetAccountingBillAttachmentRequest, r"""Get bill attachment The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. - [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment. """ @@ -140,7 +140,7 @@ def get_attachment(self, request: operations.GetAccountingBillAttachmentRequest, url = utils.generate_url(operations.GetAccountingBillAttachmentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -154,7 +154,7 @@ def get_attachment(self, request: operations.GetAccountingBillAttachmentRequest, def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -182,9 +182,9 @@ def do_request(): def list(self, request: operations.ListAccountingBillsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBillsResponse: r"""List bills - The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection. + The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. - [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -194,7 +194,7 @@ def list(self, request: operations.ListAccountingBillsRequest, retries: Optional headers = {} query_params = utils.get_query_params(operations.ListAccountingBillsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -208,7 +208,7 @@ def list(self, request: operations.ListAccountingBillsRequest, retries: Optional def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -238,7 +238,7 @@ def list_attachments(self, request: operations.ListAccountingBillAttachmentsRequ r"""List bill attachments The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. - [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments. """ @@ -247,7 +247,7 @@ def list_attachments(self, request: operations.ListAccountingBillAttachmentsRequ url = utils.generate_url(operations.ListAccountingBillAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -261,7 +261,7 @@ def list_attachments(self, request: operations.ListAccountingBillAttachmentsRequ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_payable_suppliers.py b/lending/src/codatlending/accounts_payable_suppliers.py index fd7eae15f..bd7e29e47 100755 --- a/lending/src/codatlending/accounts_payable_suppliers.py +++ b/lending/src/codatlending/accounts_payable_suppliers.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingSupplierAtta r"""Download supplier attachment The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingSupplierAtta headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingSupplierAtta def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -76,7 +76,7 @@ def get(self, request: operations.GetAccountingSupplierRequest, retries: Optiona r"""Get supplier The *Get supplier* endpoint returns a single supplier for a given supplierId. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. @@ -87,7 +87,7 @@ def get(self, request: operations.GetAccountingSupplierRequest, retries: Optiona url = utils.generate_url(operations.GetAccountingSupplierRequest, base_url, '/companies/{companyId}/data/suppliers/{supplierId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -101,7 +101,7 @@ def get(self, request: operations.GetAccountingSupplierRequest, retries: Optiona def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -131,7 +131,7 @@ def get_attachment(self, request: operations.GetAccountingSupplierAttachmentRequ r"""Get supplier attachment The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment. """ @@ -140,7 +140,7 @@ def get_attachment(self, request: operations.GetAccountingSupplierAttachmentRequ url = utils.generate_url(operations.GetAccountingSupplierAttachmentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -154,7 +154,7 @@ def get_attachment(self, request: operations.GetAccountingSupplierAttachmentRequ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -182,9 +182,9 @@ def do_request(): def list(self, request: operations.ListAccountingSuppliersRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingSuppliersResponse: r"""List suppliers - The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection. + The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -194,7 +194,7 @@ def list(self, request: operations.ListAccountingSuppliersRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.ListAccountingSuppliersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -208,7 +208,7 @@ def list(self, request: operations.ListAccountingSuppliersRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -238,7 +238,7 @@ def list_attachments(self, request: operations.ListAccountingSupplierAttachments r"""List supplier attachments The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments. """ @@ -247,7 +247,7 @@ def list_attachments(self, request: operations.ListAccountingSupplierAttachments url = utils.generate_url(operations.ListAccountingSupplierAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -261,7 +261,7 @@ def list_attachments(self, request: operations.ListAccountingSupplierAttachments def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_credit_notes.py b/lending/src/codatlending/accounts_receivable_credit_notes.py index 9b3a8fc6f..b46577c92 100755 --- a/lending/src/codatlending/accounts_receivable_credit_notes.py +++ b/lending/src/codatlending/accounts_receivable_credit_notes.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingCreditNoteRequest, retries: Optio r"""Get credit note The *Get credit note* endpoint returns a single credit note for a given creditNoteId. - [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingCreditNoteRequest, retries: Optio url = utils.generate_url(operations.GetAccountingCreditNoteRequest, base_url, '/companies/{companyId}/data/creditNotes/{creditNoteId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingCreditNoteRequest, retries: Optio def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingCreditNotesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingCreditNotesResponse: r"""List credit notes - The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection. + The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection. - [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingCreditNotesRequest, retries: Op headers = {} query_params = utils.get_query_params(operations.ListAccountingCreditNotesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingCreditNotesRequest, retries: Op def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_customers.py b/lending/src/codatlending/accounts_receivable_customers.py index 75863d6e2..7eb909e7e 100755 --- a/lending/src/codatlending/accounts_receivable_customers.py +++ b/lending/src/codatlending/accounts_receivable_customers.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingCustomerAtta r"""Download customer attachment The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. - [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingCustomerAtta headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingCustomerAtta def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -76,7 +76,7 @@ def get(self, request: operations.GetAccountingCustomerRequest, retries: Optiona r"""Get customer The *Get customer* endpoint returns a single customer for a given customerId. - [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. @@ -87,7 +87,7 @@ def get(self, request: operations.GetAccountingCustomerRequest, retries: Optiona url = utils.generate_url(operations.GetAccountingCustomerRequest, base_url, '/companies/{companyId}/data/customers/{customerId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -101,7 +101,7 @@ def get(self, request: operations.GetAccountingCustomerRequest, retries: Optiona def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -131,7 +131,7 @@ def get_attachment(self, request: operations.GetAccountingCustomerAttachmentRequ r"""Get customer attachment The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. - [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment. """ @@ -140,7 +140,7 @@ def get_attachment(self, request: operations.GetAccountingCustomerAttachmentRequ url = utils.generate_url(operations.GetAccountingCustomerAttachmentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -154,7 +154,7 @@ def get_attachment(self, request: operations.GetAccountingCustomerAttachmentRequ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -182,9 +182,9 @@ def do_request(): def list(self, request: operations.ListAccountingCustomersRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingCustomersResponse: r"""List customers - The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection. + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. - [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -194,7 +194,7 @@ def list(self, request: operations.ListAccountingCustomersRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.ListAccountingCustomersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -208,7 +208,7 @@ def list(self, request: operations.ListAccountingCustomersRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -238,7 +238,7 @@ def list_attachments(self, request: operations.ListAccountingCustomerAttachments r"""List customer attachments The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. - [Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments. """ @@ -247,7 +247,7 @@ def list_attachments(self, request: operations.ListAccountingCustomerAttachments url = utils.generate_url(operations.ListAccountingCustomerAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -261,7 +261,7 @@ def list_attachments(self, request: operations.ListAccountingCustomerAttachments def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_direct_incomes.py b/lending/src/codatlending/accounts_receivable_direct_incomes.py index 0c79e00d1..f54c7ffe0 100755 --- a/lending/src/codatlending/accounts_receivable_direct_incomes.py +++ b/lending/src/codatlending/accounts_receivable_direct_incomes.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectIncome r"""Download direct income attachment The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. - [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectIncome headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectIncome def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -76,7 +76,7 @@ def get(self, request: operations.GetAccountingDirectIncomeRequest, retries: Opt r"""Get direct income The *Get direct income* endpoint returns a single direct income for a given directIncomeId. - [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income. @@ -87,7 +87,7 @@ def get(self, request: operations.GetAccountingDirectIncomeRequest, retries: Opt url = utils.generate_url(operations.GetAccountingDirectIncomeRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -101,7 +101,7 @@ def get(self, request: operations.GetAccountingDirectIncomeRequest, retries: Opt def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -131,7 +131,7 @@ def get_attachment(self, request: operations.GetAccountingDirectIncomeAttachment r"""Get direct income attachment The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. - [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment. """ @@ -141,7 +141,7 @@ def get_attachment(self, request: operations.GetAccountingDirectIncomeAttachment headers = {} query_params = utils.get_query_params(operations.GetAccountingDirectIncomeAttachmentRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -155,7 +155,7 @@ def get_attachment(self, request: operations.GetAccountingDirectIncomeAttachment def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -183,9 +183,9 @@ def do_request(): def list(self, request: operations.ListAccountingDirectIncomesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingDirectIncomesResponse: r"""List direct incomes - The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection. + The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection. - [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -195,7 +195,7 @@ def list(self, request: operations.ListAccountingDirectIncomesRequest, retries: headers = {} query_params = utils.get_query_params(operations.ListAccountingDirectIncomesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -209,7 +209,7 @@ def list(self, request: operations.ListAccountingDirectIncomesRequest, retries: def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -239,7 +239,7 @@ def list_attachments(self, request: operations.ListAccountingDirectIncomeAttachm r"""List direct income attachments The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. - [Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments. """ @@ -248,7 +248,7 @@ def list_attachments(self, request: operations.ListAccountingDirectIncomeAttachm url = utils.generate_url(operations.ListAccountingDirectIncomeAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -262,7 +262,7 @@ def list_attachments(self, request: operations.ListAccountingDirectIncomeAttachm def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_invoices.py b/lending/src/codatlending/accounts_receivable_invoices.py index b6eb47b36..4dce5466a 100755 --- a/lending/src/codatlending/accounts_receivable_invoices.py +++ b/lending/src/codatlending/accounts_receivable_invoices.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingInvoiceAttac r"""Download invoice attachment The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. - [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingInvoiceAttac headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingInvoiceAttac def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -81,7 +81,7 @@ def download_pdf(self, request: operations.DownloadAccountingInvoicePdfRequest, url = utils.generate_url(operations.DownloadAccountingInvoicePdfRequest, base_url, '/companies/{companyId}/data/invoices/{invoiceId}/pdf', request) headers = {} headers['Accept'] = 'application/octet-stream' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def download_pdf(self, request: operations.DownloadAccountingInvoicePdfRequest, def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -107,7 +107,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -118,7 +118,7 @@ def get(self, request: operations.GetAccountingInvoiceRequest, retries: Optional r"""Get invoice The *Get invoice* endpoint returns a single invoice for a given invoiceId. - [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice. @@ -129,7 +129,7 @@ def get(self, request: operations.GetAccountingInvoiceRequest, retries: Optional url = utils.generate_url(operations.GetAccountingInvoiceRequest, base_url, '/companies/{companyId}/data/invoices/{invoiceId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -143,7 +143,7 @@ def get(self, request: operations.GetAccountingInvoiceRequest, retries: Optional def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -173,7 +173,7 @@ def get_attachment(self, request: operations.GetAccountingInvoiceAttachmentReque r"""Get invoice attachment The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. - [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment. """ @@ -182,7 +182,7 @@ def get_attachment(self, request: operations.GetAccountingInvoiceAttachmentReque url = utils.generate_url(operations.GetAccountingInvoiceAttachmentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -196,7 +196,7 @@ def get_attachment(self, request: operations.GetAccountingInvoiceAttachmentReque def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -224,9 +224,9 @@ def do_request(): def list(self, request: operations.ListAccountingInvoicesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingInvoicesResponse: r"""List invoices - The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection. + The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection. - [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). @@ -243,7 +243,7 @@ def list(self, request: operations.ListAccountingInvoicesRequest, retries: Optio headers = {} query_params = utils.get_query_params(operations.ListAccountingInvoicesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -257,7 +257,7 @@ def list(self, request: operations.ListAccountingInvoicesRequest, retries: Optio def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -287,7 +287,7 @@ def list_attachments(self, request: operations.ListAccountingInvoiceAttachmentsR r"""List invoice attachments The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. - [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments. """ @@ -296,7 +296,7 @@ def list_attachments(self, request: operations.ListAccountingInvoiceAttachmentsR url = utils.generate_url(operations.ListAccountingInvoiceAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -310,7 +310,7 @@ def list_attachments(self, request: operations.ListAccountingInvoiceAttachmentsR def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -346,7 +346,7 @@ def list_reconciled(self, request: operations.ListReconciledInvoicesRequest, ret headers = {} query_params = utils.get_query_params(operations.ListReconciledInvoicesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -360,7 +360,7 @@ def list_reconciled(self, request: operations.ListReconciledInvoicesRequest, ret def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_payments.py b/lending/src/codatlending/accounts_receivable_payments.py index 3b37ee187..0d2e05067 100755 --- a/lending/src/codatlending/accounts_receivable_payments.py +++ b/lending/src/codatlending/accounts_receivable_payments.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingPaymentRequest, retries: Optional r"""Get payment The *Get payment* endpoint returns a single payment for a given paymentId. - [Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingPaymentRequest, retries: Optional url = utils.generate_url(operations.GetAccountingPaymentRequest, base_url, '/companies/{companyId}/data/payments/{paymentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingPaymentRequest, retries: Optional def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingPaymentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingPaymentsResponse: r"""List payments - The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection. + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. - [Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingPaymentsRequest, retries: Optio headers = {} query_params = utils.get_query_params(operations.ListAccountingPaymentsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingPaymentsRequest, retries: Optio def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/accounts_receivable_reports.py b/lending/src/codatlending/accounts_receivable_reports.py index 4707bc3cb..e115ff3d3 100755 --- a/lending/src/codatlending/accounts_receivable_reports.py +++ b/lending/src/codatlending/accounts_receivable_reports.py @@ -22,7 +22,7 @@ def get_aged_creditors(self, request: operations.GetAccountingAgedCreditorsRepor headers = {} query_params = utils.get_query_params(operations.GetAccountingAgedCreditorsReportRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_aged_creditors(self, request: operations.GetAccountingAgedCreditorsRepor def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -72,7 +72,7 @@ def get_aged_debtors(self, request: operations.GetAccountingAgedDebtorsReportReq headers = {} query_params = utils.get_query_params(operations.GetAccountingAgedDebtorsReportRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -86,7 +86,7 @@ def get_aged_debtors(self, request: operations.GetAccountingAgedDebtorsReportReq def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -121,7 +121,7 @@ def is_aged_creditors_available(self, request: operations.IsAgedCreditorsReportA url = utils.generate_url(operations.IsAgedCreditorsReportAvailableRequest, base_url, '/companies/{companyId}/reports/agedCreditor/available', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -135,7 +135,7 @@ def is_aged_creditors_available(self, request: operations.IsAgedCreditorsReportA def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -164,7 +164,7 @@ def is_aged_debtors_available(self, request: operations.IsAgedDebtorsReportAvail url = utils.generate_url(operations.IsAgedDebtorsReportAvailableRequest, base_url, '/companies/{companyId}/reports/agedDebtor/available', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -178,7 +178,7 @@ def is_aged_debtors_available(self, request: operations.IsAgedDebtorsReportAvail def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/banking_account_balances.py b/lending/src/codatlending/banking_account_balances.py index 8057f0d17..5f17bee2a 100755 --- a/lending/src/codatlending/banking_account_balances.py +++ b/lending/src/codatlending/banking_account_balances.py @@ -14,9 +14,9 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def list(self, request: operations.ListBankingAccountBalancesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankingAccountBalancesResponse: r"""List account balances - The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection. + The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection. - [Account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. + [Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -26,7 +26,7 @@ def list(self, request: operations.ListBankingAccountBalancesRequest, retries: O headers = {} query_params = utils.get_query_params(operations.ListBankingAccountBalancesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -40,7 +40,7 @@ def list(self, request: operations.ListBankingAccountBalancesRequest, retries: O def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/banking_accounts.py b/lending/src/codatlending/banking_accounts.py index f06447cd7..20eaf8131 100755 --- a/lending/src/codatlending/banking_accounts.py +++ b/lending/src/codatlending/banking_accounts.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetBankingAccountRequest, retries: Optional[ut r"""Get account The *Get account* endpoint returns a single account for a given accountId. - [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account. @@ -27,7 +27,7 @@ def get(self, request: operations.GetBankingAccountRequest, retries: Optional[ut url = utils.generate_url(operations.GetBankingAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetBankingAccountRequest, retries: Optional[ut def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -63,9 +63,9 @@ def do_request(): def list(self, request: operations.ListBankingAccountsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankingAccountsResponse: r"""List accounts - The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection. + The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. - [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -75,7 +75,7 @@ def list(self, request: operations.ListBankingAccountsRequest, retries: Optional headers = {} query_params = utils.get_query_params(operations.ListBankingAccountsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -89,7 +89,7 @@ def list(self, request: operations.ListBankingAccountsRequest, retries: Optional def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/banking_categorized_statement.py b/lending/src/codatlending/banking_categorized_statement.py index 1f7ffacbd..5561f40c3 100755 --- a/lending/src/codatlending/banking_categorized_statement.py +++ b/lending/src/codatlending/banking_categorized_statement.py @@ -15,7 +15,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def get(self, request: operations.GetCategorizedBankStatementRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCategorizedBankStatementResponse: r"""Get categorized bank statement > **Categorization engine** - > + > > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. The _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. @@ -26,7 +26,7 @@ def get(self, request: operations.GetCategorizedBankStatementRequest, retries: O headers = {} query_params = utils.get_query_params(operations.GetCategorizedBankStatementRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -40,7 +40,7 @@ def get(self, request: operations.GetCategorizedBankStatementRequest, retries: O def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/banking_transaction_categories.py b/lending/src/codatlending/banking_transaction_categories.py index f51ec7e15..e03b360c3 100755 --- a/lending/src/codatlending/banking_transaction_categories.py +++ b/lending/src/codatlending/banking_transaction_categories.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetBankingTransactionCategoryRequest, retries: r"""Get transaction category The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. - [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category. @@ -27,7 +27,7 @@ def get(self, request: operations.GetBankingTransactionCategoryRequest, retries: url = utils.generate_url(operations.GetBankingTransactionCategoryRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetBankingTransactionCategoryRequest, retries: def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -63,9 +63,9 @@ def do_request(): def list(self, request: operations.ListBankingTransactionCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankingTransactionCategoriesResponse: r"""List transaction categories - The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection. + The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection. - [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -75,7 +75,7 @@ def list(self, request: operations.ListBankingTransactionCategoriesRequest, retr headers = {} query_params = utils.get_query_params(operations.ListBankingTransactionCategoriesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -89,7 +89,7 @@ def list(self, request: operations.ListBankingTransactionCategoriesRequest, retr def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/banking_transactions.py b/lending/src/codatlending/banking_transactions.py index ae93e44e9..a89548f1b 100755 --- a/lending/src/codatlending/banking_transactions.py +++ b/lending/src/codatlending/banking_transactions.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetBankingTransactionRequest, retries: Optiona r"""Get bank transaction The *Get transaction* endpoint returns a single transaction for a given transactionId. - [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction. @@ -27,7 +27,7 @@ def get(self, request: operations.GetBankingTransactionRequest, retries: Optiona url = utils.generate_url(operations.GetBankingTransactionRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetBankingTransactionRequest, retries: Optiona def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -63,9 +63,9 @@ def do_request(): def list(self, request: operations.ListBankingTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListBankingTransactionsResponse: r"""List transactions - The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection. + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. - [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -75,7 +75,7 @@ def list(self, request: operations.ListBankingTransactionsRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.ListBankingTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -89,7 +89,7 @@ def list(self, request: operations.ListBankingTransactionsRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/companies.py b/lending/src/codatlending/companies.py index da9aa65f2..8180d18da 100755 --- a/lending/src/codatlending/companies.py +++ b/lending/src/codatlending/companies.py @@ -23,11 +23,11 @@ def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.Ret url = base_url + '/companies' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.Ret def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -76,7 +76,7 @@ def delete(self, request: operations.DeleteCompanyRequest, retries: Optional[uti url = utils.generate_url(operations.DeleteCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -90,7 +90,7 @@ def delete(self, request: operations.DeleteCompanyRequest, retries: Optional[uti def do_request(): return client.request('DELETE', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -121,7 +121,7 @@ def get(self, request: operations.GetCompanyRequest, retries: Optional[utils.Ret url = utils.generate_url(operations.GetCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -135,7 +135,7 @@ def get(self, request: operations.GetCompanyRequest, retries: Optional[utils.Ret def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -171,7 +171,7 @@ def list(self, request: operations.ListCompaniesRequest, retries: Optional[utils headers = {} query_params = utils.get_query_params(operations.ListCompaniesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -185,7 +185,7 @@ def list(self, request: operations.ListCompaniesRequest, retries: Optional[utils def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -219,11 +219,11 @@ def update(self, request: operations.UpdateCompanyRequest, retries: Optional[uti url = utils.generate_url(operations.UpdateCompanyRequest, base_url, '/companies/{companyId}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "company_request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "company_request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -237,7 +237,7 @@ def update(self, request: operations.UpdateCompanyRequest, retries: Optional[uti def do_request(): return client.request('PUT', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/company_info.py b/lending/src/codatlending/company_info.py index 0cd474789..956d40054 100755 --- a/lending/src/codatlending/company_info.py +++ b/lending/src/codatlending/company_info.py @@ -22,7 +22,7 @@ def get_accounting_profile(self, request: operations.GetAccountingProfileRequest url = utils.generate_url(operations.GetAccountingProfileRequest, base_url, '/companies/{companyId}/data/info', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get_accounting_profile(self, request: operations.GetAccountingProfileRequest def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -73,7 +73,7 @@ def get_commerce_profile(self, request: operations.GetCommerceProfileRequest, re url = utils.generate_url(operations.GetCommerceProfileRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-info', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -87,7 +87,7 @@ def get_commerce_profile(self, request: operations.GetCommerceProfileRequest, re def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/connections.py b/lending/src/codatlending/connections.py index f2fe2e662..6b62bf07b 100755 --- a/lending/src/codatlending/connections.py +++ b/lending/src/codatlending/connections.py @@ -23,11 +23,11 @@ def create(self, request: operations.CreateConnectionRequest, retries: Optional[ url = utils.generate_url(operations.CreateConnectionRequest, base_url, '/companies/{companyId}/connections', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def create(self, request: operations.CreateConnectionRequest, retries: Optional[ def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -77,7 +77,7 @@ def delete(self, request: operations.DeleteConnectionRequest, retries: Optional[ url = utils.generate_url(operations.DeleteConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -91,7 +91,7 @@ def delete(self, request: operations.DeleteConnectionRequest, retries: Optional[ def do_request(): return client.request('DELETE', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -122,7 +122,7 @@ def get(self, request: operations.GetConnectionRequest, retries: Optional[utils. url = utils.generate_url(operations.GetConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -136,7 +136,7 @@ def get(self, request: operations.GetConnectionRequest, retries: Optional[utils. def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -172,7 +172,7 @@ def list(self, request: operations.ListConnectionsRequest, retries: Optional[uti headers = {} query_params = utils.get_query_params(operations.ListConnectionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -186,7 +186,7 @@ def list(self, request: operations.ListConnectionsRequest, retries: Optional[uti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -220,11 +220,11 @@ def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[ url = utils.generate_url(operations.UnlinkConnectionRequest, base_url, '/companies/{companyId}/connections/{connectionId}', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -238,7 +238,7 @@ def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[ def do_request(): return client.request('PATCH', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/data_integrity.py b/lending/src/codatlending/data_integrity.py index 49ae723b6..56e80ba86 100755 --- a/lending/src/codatlending/data_integrity.py +++ b/lending/src/codatlending/data_integrity.py @@ -25,7 +25,7 @@ def details(self, request: operations.ListDataIntegrityDetailsRequest, retries: headers = {} query_params = utils.get_query_params(operations.ListDataIntegrityDetailsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -39,7 +39,7 @@ def details(self, request: operations.ListDataIntegrityDetailsRequest, retries: def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -81,7 +81,7 @@ def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Opt url = utils.generate_url(operations.GetDataIntegrityStatusRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Opt def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -135,7 +135,7 @@ def summaries(self, request: operations.GetDataIntegritySummariesRequest, retrie headers = {} query_params = utils.get_query_params(operations.GetDataIntegritySummariesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -149,7 +149,7 @@ def summaries(self, request: operations.GetDataIntegritySummariesRequest, retrie def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/excel_reports.py b/lending/src/codatlending/excel_reports.py index ad93ed1f6..10b07e09e 100755 --- a/lending/src/codatlending/excel_reports.py +++ b/lending/src/codatlending/excel_reports.py @@ -35,7 +35,7 @@ def download(self, request: operations.DownloadExcelReportRequest, retries: Opti headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -49,7 +49,7 @@ def download(self, request: operations.DownloadExcelReportRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -97,7 +97,7 @@ def generate(self, request: operations.GenerateExcelReportRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.GenerateExcelReportRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -111,7 +111,7 @@ def generate(self, request: operations.GenerateExcelReportRequest, retries: Opti def do_request(): return client.request('POST', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -151,7 +151,7 @@ def get_status(self, request: operations.GetExcelReportGenerationStatusRequest, headers = {} query_params = utils.get_query_params(operations.GetExcelReportGenerationStatusRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -165,7 +165,7 @@ def get_status(self, request: operations.GetExcelReportGenerationStatusRequest, def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/file_upload.py b/lending/src/codatlending/file_upload.py index 055da33e8..2f93a6075 100755 --- a/lending/src/codatlending/file_upload.py +++ b/lending/src/codatlending/file_upload.py @@ -4,7 +4,7 @@ from codatlending import utils from codatlending.models import errors, operations, shared from enum import Enum -from typing import Optional +from typing import List, Optional class DownloadAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" @@ -31,7 +31,7 @@ def download(self, request: operations.DownloadFilesRequest, retries: Optional[u headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -45,7 +45,7 @@ def download(self, request: operations.DownloadFilesRequest, retries: Optional[u def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -57,7 +57,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [400, 401, 404, 429]: @@ -79,7 +79,7 @@ def list_uploaded(self, request: operations.ListFilesRequest, retries: Optional[ url = utils.generate_url(operations.ListFilesRequest, base_url, '/companies/{companyId}/files', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -93,7 +93,7 @@ def list_uploaded(self, request: operations.ListFilesRequest, retries: Optional[ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -105,7 +105,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[shared.File]]) + out = utils.unmarshal_json(http_res.text, Optional[List[shared.File]]) res.files = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) @@ -133,11 +133,11 @@ def upload(self, request: operations.UploadFilesRequest, retries: Optional[utils url = utils.generate_url(operations.UploadFilesRequest, base_url, '/companies/{companyId}/connections/{connectionId}/files', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request_body", 'multipart') + req_content_type, data, form = utils.serialize_request_body(request, "request_body", False, True, 'multipart') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -151,7 +151,7 @@ def upload(self, request: operations.UploadFilesRequest, retries: Optional[utils def do_request(): return client.request('POST', url, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/financial_statements_accounts.py b/lending/src/codatlending/financial_statements_accounts.py index fb80ae962..6a4fe2177 100755 --- a/lending/src/codatlending/financial_statements_accounts.py +++ b/lending/src/codatlending/financial_statements_accounts.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingAccountRequest, retries: Optional r"""Get account The *Get account* endpoint returns a single account for a given accountId. - [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingAccountRequest, retries: Optional url = utils.generate_url(operations.GetAccountingAccountRequest, base_url, '/companies/{companyId}/data/accounts/{accountId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingAccountRequest, retries: Optional def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingAccountsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingAccountsResponse: r"""List accounts - The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection. + The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. - [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingAccountsRequest, retries: Optio headers = {} query_params = utils.get_query_params(operations.ListAccountingAccountsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingAccountsRequest, retries: Optio def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/financial_statements_balance_sheet.py b/lending/src/codatlending/financial_statements_balance_sheet.py index fbd94903d..5cc682aad 100755 --- a/lending/src/codatlending/financial_statements_balance_sheet.py +++ b/lending/src/codatlending/financial_statements_balance_sheet.py @@ -22,7 +22,7 @@ def get(self, request: operations.GetAccountingBalanceSheetRequest, retries: Opt headers = {} query_params = utils.get_query_params(operations.GetAccountingBalanceSheetRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get(self, request: operations.GetAccountingBalanceSheetRequest, retries: Opt def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -74,7 +74,7 @@ def get_categorized_accounts(self, request: operations.GetCategorizedBalanceShee headers = {} query_params = utils.get_query_params(operations.GetCategorizedBalanceSheetStatementRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -88,7 +88,7 @@ def get_categorized_accounts(self, request: operations.GetCategorizedBalanceShee def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/financial_statements_cash_flow.py b/lending/src/codatlending/financial_statements_cash_flow.py index 88cc881cd..2cf769b09 100755 --- a/lending/src/codatlending/financial_statements_cash_flow.py +++ b/lending/src/codatlending/financial_statements_cash_flow.py @@ -22,7 +22,7 @@ def get(self, request: operations.GetAccountingCashFlowStatementRequest, retries headers = {} query_params = utils.get_query_params(operations.GetAccountingCashFlowStatementRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get(self, request: operations.GetAccountingCashFlowStatementRequest, retries def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/financial_statements_profit_and_loss.py b/lending/src/codatlending/financial_statements_profit_and_loss.py index f6b0e4210..ad23263b6 100755 --- a/lending/src/codatlending/financial_statements_profit_and_loss.py +++ b/lending/src/codatlending/financial_statements_profit_and_loss.py @@ -22,7 +22,7 @@ def get(self, request: operations.GetAccountingProfitAndLossRequest, retries: Op headers = {} query_params = utils.get_query_params(operations.GetAccountingProfitAndLossRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -36,7 +36,7 @@ def get(self, request: operations.GetAccountingProfitAndLossRequest, retries: Op def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -74,7 +74,7 @@ def get_categorized_accounts(self, request: operations.GetCategorizedProfitAndLo headers = {} query_params = utils.get_query_params(operations.GetCategorizedProfitAndLossStatementRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -88,7 +88,7 @@ def get_categorized_accounts(self, request: operations.GetCategorizedProfitAndLo def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/liabilities.py b/lending/src/codatlending/liabilities.py index b9b6c68e8..101965eae 100755 --- a/lending/src/codatlending/liabilities.py +++ b/lending/src/codatlending/liabilities.py @@ -13,9 +13,109 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def generate_loan_summary(self, request: operations.GenerateLoanSummaryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateLoanSummaryResponse: + r"""Generate loan summaries report + The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(operations.GenerateLoanSummaryRequest, base_url, '/companies/{companyId}/reports/liabilities/loans', request) + headers = {} + query_params = utils.get_query_params(operations.GenerateLoanSummaryRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + client = self.sdk_configuration.security_client + + global_retry_config = self.sdk_configuration.retry_config + retry_config = retries + if retry_config is None: + if global_retry_config: + retry_config = global_retry_config + else: + retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) + + def do_request(): + return client.request('POST', url, params=query_params, headers=headers) + + http_res = utils.retry(do_request, utils.Retries(retry_config, [ + '408', + '429', + '5XX' + ])) + content_type = http_res.headers.get('Content-Type') + + res = operations.GenerateLoanSummaryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + if http_res.status_code == 202: + pass + elif http_res.status_code in [401, 404, 429]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + + return res + + + def generate_loan_transactions(self, request: operations.GenerateLoanTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateLoanTransactionsResponse: + r"""Generate loan transactions report + The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + """ + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(operations.GenerateLoanTransactionsRequest, base_url, '/companies/{companyId}/reports/liabilities/loans/transactions', request) + headers = {} + query_params = utils.get_query_params(operations.GenerateLoanTransactionsRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + client = self.sdk_configuration.security_client + + global_retry_config = self.sdk_configuration.retry_config + retry_config = retries + if retry_config is None: + if global_retry_config: + retry_config = global_retry_config + else: + retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) + + def do_request(): + return client.request('POST', url, params=query_params, headers=headers) + + http_res = utils.retry(do_request, utils.Retries(retry_config, [ + '408', + '429', + '5XX' + ])) + content_type = http_res.headers.get('Content-Type') + + res = operations.GenerateLoanTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + if http_res.status_code == 202: + pass + elif http_res.status_code in [401, 404, 429]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + + return res + + def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetLoanSummaryResponse: r"""Get loan summaries - The *Get loan summaries* endpoint returns a summary by integration type of all loans identified in each integration. + The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. @@ -23,10 +123,11 @@ def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: O """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetLoanSummaryRequest, base_url, '/companies/{companyId}/reports/enhancedLiabilities/loan', request) + url = utils.generate_url(operations.GetLoanSummaryRequest, base_url, '/companies/{companyId}/reports/liabilities/loans', request) headers = {} + query_params = utils.get_query_params(operations.GetLoanSummaryRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -39,8 +140,8 @@ def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: O retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) def do_request(): - return client.request('GET', url, headers=headers) - + return client.request('GET', url, params=query_params, headers=headers) + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -56,7 +157,7 @@ def do_request(): res.loan_summary = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code in [401, 404]: + elif http_res.status_code in [401, 404, 429]: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) res.error_message = out @@ -76,11 +177,11 @@ def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.ListLoanTransactionsRequest, base_url, '/companies/{companyId}/reports/enhancedLiabilities/loan/transactions', request) + url = utils.generate_url(operations.ListLoanTransactionsRequest, base_url, '/companies/{companyId}/reports/liabilities/loans/transactions', request) headers = {} query_params = utils.get_query_params(operations.ListLoanTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -94,7 +195,7 @@ def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -110,7 +211,7 @@ def do_request(): res.loan_transactions = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code in [401, 404]: + elif http_res.status_code in [401, 404, 429]: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) res.error_message = out diff --git a/lending/src/codatlending/loan_writeback.py b/lending/src/codatlending/loan_writeback.py index 27b279266..201ce599a 100755 --- a/lending/src/codatlending/loan_writeback.py +++ b/lending/src/codatlending/loan_writeback.py @@ -1,20 +1,20 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .loan_writeback_accounts import LoanWritebackAccounts -from .loan_writeback_bank_accounts import LoanWritebackBankAccounts from .loan_writeback_bank_transactions import LoanWritebackBankTransactions from .loan_writeback_create_operations import LoanWritebackCreateOperations from .loan_writeback_direct_costs import LoanWritebackDirectCosts +from .loan_writeback_payments import LoanWritebackPayments from .loan_writeback_suppliers import LoanWritebackSuppliers from .loan_writeback_transfers import LoanWritebackTransfers from .sdkconfiguration import SDKConfiguration class LoanWriteback: accounts: LoanWritebackAccounts - bank_accounts: LoanWritebackBankAccounts bank_transactions: LoanWritebackBankTransactions create_operations: LoanWritebackCreateOperations direct_costs: LoanWritebackDirectCosts + payments: LoanWritebackPayments suppliers: LoanWritebackSuppliers transfers: LoanWritebackTransfers sdk_configuration: SDKConfiguration @@ -25,10 +25,10 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def _init_sdks(self): self.accounts = LoanWritebackAccounts(self.sdk_configuration) - self.bank_accounts = LoanWritebackBankAccounts(self.sdk_configuration) self.bank_transactions = LoanWritebackBankTransactions(self.sdk_configuration) self.create_operations = LoanWritebackCreateOperations(self.sdk_configuration) self.direct_costs = LoanWritebackDirectCosts(self.sdk_configuration) + self.payments = LoanWritebackPayments(self.sdk_configuration) self.suppliers = LoanWritebackSuppliers(self.sdk_configuration) self.transfers = LoanWritebackTransfers(self.sdk_configuration) diff --git a/lending/src/codatlending/loan_writeback_accounts.py b/lending/src/codatlending/loan_writeback_accounts.py index 42273d349..041803fd0 100755 --- a/lending/src/codatlending/loan_writeback_accounts.py +++ b/lending/src/codatlending/loan_writeback_accounts.py @@ -14,13 +14,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create(self, request: operations.CreateAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateAccountResponse: r"""Create account - The *Create account* endpoint creates a new [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection. + The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. - [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. """ @@ -28,12 +28,12 @@ def create(self, request: operations.CreateAccountRequest, retries: Optional[uti url = utils.generate_url(operations.CreateAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/accounts', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_account", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_account", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateAccountRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateAccountRequest, retries: Optional[uti def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -75,9 +75,9 @@ def do_request(): def get_create_model(self, request: operations.GetCreateChartOfAccountsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateChartOfAccountsModelResponse: r"""Get create account model - The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company and integration. + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. - [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions. + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. **Integration-specific behaviour** @@ -90,7 +90,7 @@ def get_create_model(self, request: operations.GetCreateChartOfAccountsModelRequ url = utils.generate_url(operations.GetCreateChartOfAccountsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_model(self, request: operations.GetCreateChartOfAccountsModelRequ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/loan_writeback_bank_transactions.py b/lending/src/codatlending/loan_writeback_bank_transactions.py index 8987e8730..446aefa84 100755 --- a/lending/src/codatlending/loan_writeback_bank_transactions.py +++ b/lending/src/codatlending/loan_writeback_bank_transactions.py @@ -14,13 +14,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create(self, request: operations.CreateBankTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateBankTransactionsResponse: r"""Create bank account transactions - The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection. + The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. - [Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model). + Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. """ @@ -28,12 +28,12 @@ def create(self, request: operations.CreateBankTransactionsRequest, retries: Opt url = utils.generate_url(operations.CreateBankTransactionsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_create_bank_transactions", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_create_bank_transactions", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateBankTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateBankTransactionsRequest, retries: Opt def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -75,9 +75,9 @@ def do_request(): def get_create_model(self, request: operations.GetCreateBankTransactionsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateBankTransactionsModelResponse: r"""Get create bank account transactions model - The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration. + The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. - [Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. **Integration-specific behaviour** @@ -90,7 +90,7 @@ def get_create_model(self, request: operations.GetCreateBankTransactionsModelReq url = utils.generate_url(operations.GetCreateBankTransactionsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_model(self, request: operations.GetCreateBankTransactionsModelReq def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/loan_writeback_create_operations.py b/lending/src/codatlending/loan_writeback_create_operations.py index 121e5e7b7..ad1a143b7 100755 --- a/lending/src/codatlending/loan_writeback_create_operations.py +++ b/lending/src/codatlending/loan_writeback_create_operations.py @@ -21,7 +21,7 @@ def get(self, request: operations.GetCreateOperationRequest, retries: Optional[u url = utils.generate_url(operations.GetCreateOperationRequest, base_url, '/companies/{companyId}/push/{pushOperationKey}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -35,7 +35,7 @@ def get(self, request: operations.GetCreateOperationRequest, retries: Optional[u def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -71,7 +71,7 @@ def list(self, request: operations.ListCreateOperationsRequest, retries: Optiona headers = {} query_params = utils.get_query_params(operations.ListCreateOperationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -85,7 +85,7 @@ def list(self, request: operations.ListCreateOperationsRequest, retries: Optiona def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/loan_writeback_direct_costs.py b/lending/src/codatlending/loan_writeback_direct_costs.py index 141d7e905..81bf0faae 100755 --- a/lending/src/codatlending/loan_writeback_direct_costs.py +++ b/lending/src/codatlending/loan_writeback_direct_costs.py @@ -14,13 +14,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create(self, request: operations.CreateDirectCostRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateDirectCostResponse: r"""Create direct cost - The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection. + The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/accounting-api#/operations/get-create-directCosts-model). + Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account. """ @@ -28,12 +28,12 @@ def create(self, request: operations.CreateDirectCostRequest, retries: Optional[ url = utils.generate_url(operations.CreateDirectCostRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/directCosts', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_direct_cost", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_direct_cost", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateDirectCostRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateDirectCostRequest, retries: Optional[ def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -75,9 +75,9 @@ def do_request(): def get_create_model(self, request: operations.GetCreateDirectCostsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateDirectCostsModelResponse: r"""Get create direct cost model - The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company and integration. + The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. **Integration-specific behaviour** @@ -90,7 +90,7 @@ def get_create_model(self, request: operations.GetCreateDirectCostsModelRequest, url = utils.generate_url(operations.GetCreateDirectCostsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/directCosts', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_model(self, request: operations.GetCreateDirectCostsModelRequest, def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/loan_writeback_bank_accounts.py b/lending/src/codatlending/loan_writeback_payments.py similarity index 61% rename from lending/src/codatlending/loan_writeback_bank_accounts.py rename to lending/src/codatlending/loan_writeback_payments.py index d6236d6a0..f052ef4ab 100755 --- a/lending/src/codatlending/loan_writeback_bank_accounts.py +++ b/lending/src/codatlending/loan_writeback_payments.py @@ -5,35 +5,35 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackBankAccounts: +class LoanWritebackPayments: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config - def create(self, request: operations.CreateBankAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateBankAccountResponse: - r"""Create bank account - The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection. + def create(self, request: operations.CreatePaymentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreatePaymentResponse: + r"""Create payment + The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. - [Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/accounting-api#/operations/get-create-update-bankAccounts-model). + Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). - Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. + Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating an account. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.CreateBankAccountRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/bankAccounts', request) + url = utils.generate_url(operations.CreatePaymentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/payments', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_bank_account", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_payment", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type - query_params = utils.get_query_params(operations.CreateBankAccountRequest, request) + query_params = utils.get_query_params(operations.CreatePaymentRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateBankAccountRequest, retries: Optional def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -55,12 +55,12 @@ def do_request(): ])) content_type = http_res.headers.get('Content-Type') - res = operations.CreateBankAccountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + res = operations.CreatePaymentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.AccountingCreateBankAccountResponse]) - res.accounting_create_bank_account_response = out + out = utils.unmarshal_json(http_res.text, Optional[shared.AccountingCreatePaymentResponse]) + res.accounting_create_payment_response = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [400, 401, 404, 429]: @@ -73,24 +73,24 @@ def do_request(): return res - def get_create_update_model(self, request: operations.GetCreateUpdateBankAccountsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateUpdateBankAccountsModelResponse: - r"""Get create/update bank account model - The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company and integration. + def get_create_model(self, request: operations.GetCreatePaymentsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreatePaymentsModelResponse: + r"""Get create payment model + The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. - [Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. - Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. + Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating a payment. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetCreateUpdateBankAccountsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/bankAccounts', request) + url = utils.generate_url(operations.GetCreatePaymentsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/payments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_update_model(self, request: operations.GetCreateUpdateBankAccount def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -112,7 +112,7 @@ def do_request(): ])) content_type = http_res.headers.get('Content-Type') - res = operations.GetCreateUpdateBankAccountsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + res = operations.GetCreatePaymentsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): diff --git a/lending/src/codatlending/loan_writeback_suppliers.py b/lending/src/codatlending/loan_writeback_suppliers.py index 4fab2b17d..1dc8558de 100755 --- a/lending/src/codatlending/loan_writeback_suppliers.py +++ b/lending/src/codatlending/loan_writeback_suppliers.py @@ -14,13 +14,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create(self, request: operations.CreateSupplierRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateSupplierResponse: r"""Create supplier - The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection. + The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/accounting-api#/operations/get-create-update-suppliers-model). + Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. """ @@ -28,12 +28,12 @@ def create(self, request: operations.CreateSupplierRequest, retries: Optional[ut url = utils.generate_url(operations.CreateSupplierRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/suppliers', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_supplier", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_supplier", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateSupplierRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateSupplierRequest, retries: Optional[ut def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -75,9 +75,9 @@ def do_request(): def get_create_update_model(self, request: operations.GetCreateUpdateSuppliersModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateUpdateSuppliersModelResponse: r"""Get create/update supplier model - The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company and integration. + The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration. - [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** @@ -90,7 +90,7 @@ def get_create_update_model(self, request: operations.GetCreateUpdateSuppliersMo url = utils.generate_url(operations.GetCreateUpdateSuppliersModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/suppliers', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_update_model(self, request: operations.GetCreateUpdateSuppliersMo def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/loan_writeback_transfers.py b/lending/src/codatlending/loan_writeback_transfers.py index e6db58e6e..6561dd59e 100755 --- a/lending/src/codatlending/loan_writeback_transfers.py +++ b/lending/src/codatlending/loan_writeback_transfers.py @@ -14,13 +14,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def create(self, request: operations.CreateTransferRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateTransferResponse: r"""Create transfer - The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection. + The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. - [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. **Integration-specific behaviour** - Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/accounting-api#/operations/get-create-transfers-model). + Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account. """ @@ -28,12 +28,12 @@ def create(self, request: operations.CreateTransferRequest, retries: Optional[ut url = utils.generate_url(operations.CreateTransferRequest, base_url, '/companies/{companyId}/connections/{connectionId}/push/transfers', request) headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "accounting_transfer", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "accounting_transfer", True, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type query_params = utils.get_query_params(operations.CreateTransferRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def create(self, request: operations.CreateTransferRequest, retries: Optional[ut def do_request(): return client.request('POST', url, params=query_params, data=data, files=form, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -75,9 +75,9 @@ def do_request(): def get_create_model(self, request: operations.GetCreateTransfersModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateTransfersModelResponse: r"""Get create transfer model - The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company and integration. + The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. - [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. **Integration-specific behaviour** @@ -90,7 +90,7 @@ def get_create_model(self, request: operations.GetCreateTransfersModelRequest, r url = utils.generate_url(operations.GetCreateTransfersModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/transfers', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -104,7 +104,7 @@ def get_create_model(self, request: operations.GetCreateTransfersModelRequest, r def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/manage_data.py b/lending/src/codatlending/manage_data.py index c234a6d64..2e0298984 100755 --- a/lending/src/codatlending/manage_data.py +++ b/lending/src/codatlending/manage_data.py @@ -5,7 +5,7 @@ from .sdkconfiguration import SDKConfiguration from codatlending import utils from codatlending.models import errors, operations, shared -from typing import Optional +from typing import Dict, Optional class ManageData: pull_operations: ManageDataPullOperations @@ -30,7 +30,7 @@ def get_status(self, request: operations.GetDataStatusRequest, retries: Optional url = utils.generate_url(operations.GetDataStatusRequest, base_url, '/companies/{companyId}/dataStatus', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -44,7 +44,7 @@ def get_status(self, request: operations.GetDataStatusRequest, retries: Optional def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -56,7 +56,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[dict[str, shared.DataStatus]]) + out = utils.unmarshal_json(http_res.text, Optional[Dict[str, shared.DataStatus]]) res.data_status_response = out else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) diff --git a/lending/src/codatlending/manage_data_pull_operations.py b/lending/src/codatlending/manage_data_pull_operations.py index a66405457..4f9ec65db 100755 --- a/lending/src/codatlending/manage_data_pull_operations.py +++ b/lending/src/codatlending/manage_data_pull_operations.py @@ -21,7 +21,7 @@ def get(self, request: operations.GetPullOperationRequest, retries: Optional[uti url = utils.generate_url(operations.GetPullOperationRequest, base_url, '/companies/{companyId}/data/history/{datasetId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -35,7 +35,7 @@ def get(self, request: operations.GetPullOperationRequest, retries: Optional[uti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -71,7 +71,7 @@ def list(self, request: operations.ListPullOperationsRequest, retries: Optional[ headers = {} query_params = utils.get_query_params(operations.ListPullOperationsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -85,7 +85,7 @@ def list(self, request: operations.ListPullOperationsRequest, retries: Optional[ def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/manage_data_refresh.py b/lending/src/codatlending/manage_data_refresh.py index 85bd18bfd..e8940ac15 100755 --- a/lending/src/codatlending/manage_data_refresh.py +++ b/lending/src/codatlending/manage_data_refresh.py @@ -25,7 +25,7 @@ def all_data_types(self, request: operations.RefreshAllDataTypesRequest, retries url = utils.generate_url(operations.RefreshAllDataTypesRequest, base_url, '/companies/{companyId}/data/all', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -39,7 +39,7 @@ def all_data_types(self, request: operations.RefreshAllDataTypesRequest, retries def do_request(): return client.request('POST', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -73,7 +73,7 @@ def data_type(self, request: operations.RefreshDataTypeRequest, retries: Optiona headers = {} query_params = utils.get_query_params(operations.RefreshDataTypeRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -87,7 +87,7 @@ def data_type(self, request: operations.RefreshDataTypeRequest, retries: Optiona def do_request(): return client.request('POST', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/models/__init__.py b/lending/src/codatlending/models/__init__.py index 889f8adcf..36628d6cc 100755 --- a/lending/src/codatlending/models/__init__.py +++ b/lending/src/codatlending/models/__init__.py @@ -1,2 +1,3 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +# __init__.py diff --git a/lending/src/codatlending/models/operations/__init__.py b/lending/src/codatlending/models/operations/__init__.py index 5b5b1b159..b619cd9ba 100755 --- a/lending/src/codatlending/models/operations/__init__.py +++ b/lending/src/codatlending/models/operations/__init__.py @@ -1,11 +1,11 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .create_account import * -from .create_bank_account import * from .create_bank_transactions import * from .create_company import * from .create_connection import * from .create_direct_cost import * +from .create_payment import * from .create_supplier import * from .create_transfer import * from .delete_company import * @@ -20,6 +20,8 @@ from .download_excel_report import * from .download_files import * from .generate_excel_report import * +from .generate_loan_summary import * +from .generate_loan_transactions import * from .get_accounting_account import * from .get_accounting_account_transaction import * from .get_accounting_aged_creditors_report import * @@ -75,8 +77,8 @@ from .get_create_chartofaccounts_model import * from .get_create_directcosts_model import * from .get_create_operation import * +from .get_create_payments_model import * from .get_create_transfers_model import * -from .get_create_update_bankaccounts_model import * from .get_create_update_suppliers_model import * from .get_data_integrity_status import * from .get_data_integrity_summaries import * @@ -136,4 +138,4 @@ from .update_company import * from .upload_files import * -__all__ = ["CreateAccountRequest","CreateAccountResponse","CreateBankAccountRequest","CreateBankAccountResponse","CreateBankTransactionsRequest","CreateBankTransactionsResponse","CreateCompanyResponse","CreateConnectionRequest","CreateConnectionRequestBody","CreateConnectionResponse","CreateDirectCostRequest","CreateDirectCostResponse","CreateSupplierRequest","CreateSupplierResponse","CreateTransferRequest","CreateTransferResponse","DeleteCompanyRequest","DeleteCompanyResponse","DeleteConnectionRequest","DeleteConnectionResponse","DownloadAccountingBillAttachmentRequest","DownloadAccountingBillAttachmentResponse","DownloadAccountingCustomerAttachmentRequest","DownloadAccountingCustomerAttachmentResponse","DownloadAccountingDirectCostAttachmentRequest","DownloadAccountingDirectCostAttachmentResponse","DownloadAccountingDirectIncomeAttachmentRequest","DownloadAccountingDirectIncomeAttachmentResponse","DownloadAccountingInvoiceAttachmentRequest","DownloadAccountingInvoiceAttachmentResponse","DownloadAccountingInvoicePdfRequest","DownloadAccountingInvoicePdfResponse","DownloadAccountingSupplierAttachmentRequest","DownloadAccountingSupplierAttachmentResponse","DownloadExcelReportRequest","DownloadExcelReportResponse","DownloadFilesRequest","DownloadFilesResponse","GenerateExcelReportRequest","GenerateExcelReportResponse","GetAccountingAccountRequest","GetAccountingAccountResponse","GetAccountingAccountTransactionRequest","GetAccountingAccountTransactionResponse","GetAccountingAgedCreditorsReportRequest","GetAccountingAgedCreditorsReportResponse","GetAccountingAgedDebtorsReportRequest","GetAccountingAgedDebtorsReportResponse","GetAccountingBalanceSheetRequest","GetAccountingBalanceSheetResponse","GetAccountingBankAccountRequest","GetAccountingBankAccountResponse","GetAccountingBillAttachmentRequest","GetAccountingBillAttachmentResponse","GetAccountingBillCreditNoteRequest","GetAccountingBillCreditNoteResponse","GetAccountingBillPaymentRequest","GetAccountingBillPaymentResponse","GetAccountingBillRequest","GetAccountingBillResponse","GetAccountingCashFlowStatementRequest","GetAccountingCashFlowStatementResponse","GetAccountingCreditNoteRequest","GetAccountingCreditNoteResponse","GetAccountingCustomerAttachmentRequest","GetAccountingCustomerAttachmentResponse","GetAccountingCustomerRequest","GetAccountingCustomerResponse","GetAccountingDirectCostAttachmentRequest","GetAccountingDirectCostAttachmentResponse","GetAccountingDirectCostRequest","GetAccountingDirectCostResponse","GetAccountingDirectIncomeAttachmentRequest","GetAccountingDirectIncomeAttachmentResponse","GetAccountingDirectIncomeRequest","GetAccountingDirectIncomeResponse","GetAccountingInvoiceAttachmentRequest","GetAccountingInvoiceAttachmentResponse","GetAccountingInvoiceRequest","GetAccountingInvoiceResponse","GetAccountingJournalEntryRequest","GetAccountingJournalEntryResponse","GetAccountingJournalRequest","GetAccountingJournalResponse","GetAccountingPaymentRequest","GetAccountingPaymentResponse","GetAccountingProfileRequest","GetAccountingProfileResponse","GetAccountingProfitAndLossRequest","GetAccountingProfitAndLossResponse","GetAccountingSupplierAttachmentRequest","GetAccountingSupplierAttachmentResponse","GetAccountingSupplierRequest","GetAccountingSupplierResponse","GetAccountingTransferRequest","GetAccountingTransferResponse","GetBankingAccountRequest","GetBankingAccountResponse","GetBankingTransactionCategoryRequest","GetBankingTransactionCategoryResponse","GetBankingTransactionRequest","GetBankingTransactionResponse","GetCategorizedBalanceSheetStatementRequest","GetCategorizedBalanceSheetStatementResponse","GetCategorizedBankStatementRequest","GetCategorizedBankStatementResponse","GetCategorizedProfitAndLossStatementRequest","GetCategorizedProfitAndLossStatementResponse","GetCommerceCustomerRequest","GetCommerceCustomerResponse","GetCommerceCustomerRetentionMetricsRequest","GetCommerceCustomerRetentionMetricsResponse","GetCommerceDisputeRequest","GetCommerceDisputeResponse","GetCommerceLifetimeValueMetricsRequest","GetCommerceLifetimeValueMetricsResponse","GetCommerceLocationRequest","GetCommerceLocationResponse","GetCommerceOrderRequest","GetCommerceOrderResponse","GetCommerceOrdersReportRequest","GetCommerceOrdersReportResponse","GetCommercePaymentMethodRequest","GetCommercePaymentMethodResponse","GetCommercePaymentRequest","GetCommercePaymentResponse","GetCommerceProductCategoryRequest","GetCommerceProductCategoryResponse","GetCommerceProductRequest","GetCommerceProductResponse","GetCommerceProfileRequest","GetCommerceProfileResponse","GetCommerceRefundsReportRequest","GetCommerceRefundsReportResponse","GetCommerceRevenueMetricsRequest","GetCommerceRevenueMetricsResponse","GetCommerceTransactionRequest","GetCommerceTransactionResponse","GetCompanyRequest","GetCompanyResponse","GetConnectionRequest","GetConnectionResponse","GetCreateBankTransactionsModelRequest","GetCreateBankTransactionsModelResponse","GetCreateChartOfAccountsModelRequest","GetCreateChartOfAccountsModelResponse","GetCreateDirectCostsModelRequest","GetCreateDirectCostsModelResponse","GetCreateOperationRequest","GetCreateOperationResponse","GetCreateTransfersModelRequest","GetCreateTransfersModelResponse","GetCreateUpdateBankAccountsModelRequest","GetCreateUpdateBankAccountsModelResponse","GetCreateUpdateSuppliersModelRequest","GetCreateUpdateSuppliersModelResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetDataStatusRequest","GetDataStatusResponse","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetLoanSummaryRequest","GetLoanSummaryResponse","GetPullOperationRequest","GetPullOperationResponse","IsAgedCreditorsReportAvailableRequest","IsAgedCreditorsReportAvailableResponse","IsAgedDebtorsReportAvailableRequest","IsAgedDebtorsReportAvailableResponse","ListAccountingAccountTransactionsRequest","ListAccountingAccountTransactionsResponse","ListAccountingAccountsRequest","ListAccountingAccountsResponse","ListAccountingBankAccountTransactionsRequest","ListAccountingBankAccountTransactionsResponse","ListAccountingBankAccountsRequest","ListAccountingBankAccountsResponse","ListAccountingBillAttachmentsRequest","ListAccountingBillAttachmentsResponse","ListAccountingBillCreditNotesRequest","ListAccountingBillCreditNotesResponse","ListAccountingBillPaymentsRequest","ListAccountingBillPaymentsResponse","ListAccountingBillsRequest","ListAccountingBillsResponse","ListAccountingCreditNotesRequest","ListAccountingCreditNotesResponse","ListAccountingCustomerAttachmentsRequest","ListAccountingCustomerAttachmentsResponse","ListAccountingCustomersRequest","ListAccountingCustomersResponse","ListAccountingDirectCostAttachmentsRequest","ListAccountingDirectCostAttachmentsResponse","ListAccountingDirectCostsRequest","ListAccountingDirectCostsResponse","ListAccountingDirectIncomeAttachmentsRequest","ListAccountingDirectIncomeAttachmentsResponse","ListAccountingDirectIncomesRequest","ListAccountingDirectIncomesResponse","ListAccountingInvoiceAttachmentsRequest","ListAccountingInvoiceAttachmentsResponse","ListAccountingInvoicesRequest","ListAccountingInvoicesResponse","ListAccountingJournalEntriesRequest","ListAccountingJournalEntriesResponse","ListAccountingJournalsRequest","ListAccountingJournalsResponse","ListAccountingPaymentsRequest","ListAccountingPaymentsResponse","ListAccountingSupplierAttachmentsRequest","ListAccountingSupplierAttachmentsResponse","ListAccountingSuppliersRequest","ListAccountingSuppliersResponse","ListAccountingTransfersRequest","ListAccountingTransfersResponse","ListBankingAccountBalancesRequest","ListBankingAccountBalancesResponse","ListBankingAccountsRequest","ListBankingAccountsResponse","ListBankingTransactionCategoriesRequest","ListBankingTransactionCategoriesResponse","ListBankingTransactionsRequest","ListBankingTransactionsResponse","ListCommerceCustomersRequest","ListCommerceCustomersResponse","ListCommerceDisputesRequest","ListCommerceDisputesResponse","ListCommerceLocationsRequest","ListCommerceLocationsResponse","ListCommerceOrdersRequest","ListCommerceOrdersResponse","ListCommercePaymentMethodsRequest","ListCommercePaymentMethodsResponse","ListCommercePaymentsRequest","ListCommercePaymentsResponse","ListCommerceProductCategoriesRequest","ListCommerceProductCategoriesResponse","ListCommerceProductsRequest","ListCommerceProductsResponse","ListCommerceTransactionsRequest","ListCommerceTransactionsResponse","ListCompaniesRequest","ListCompaniesResponse","ListConnectionsRequest","ListConnectionsResponse","ListCreateOperationsRequest","ListCreateOperationsResponse","ListDataIntegrityDetailsRequest","ListDataIntegrityDetailsResponse","ListFilesRequest","ListFilesResponse","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListLoanTransactionsSourceType","ListPullOperationsRequest","ListPullOperationsResponse","ListReconciledInvoicesRequest","ListReconciledInvoicesResponse","RefreshAllDataTypesRequest","RefreshAllDataTypesResponse","RefreshDataTypeRequest","RefreshDataTypeResponse","UnlinkConnectionRequest","UnlinkConnectionResponse","UnlinkConnectionUpdateConnection","UpdateCompanyRequest","UpdateCompanyResponse","UploadFilesRequest","UploadFilesRequestBody","UploadFilesResponse"] +__all__ = ["CreateAccountRequest","CreateAccountResponse","CreateBankTransactionsRequest","CreateBankTransactionsResponse","CreateCompanyResponse","CreateConnectionRequest","CreateConnectionRequestBody","CreateConnectionResponse","CreateDirectCostRequest","CreateDirectCostResponse","CreatePaymentRequest","CreatePaymentResponse","CreateSupplierRequest","CreateSupplierResponse","CreateTransferRequest","CreateTransferResponse","DeleteCompanyRequest","DeleteCompanyResponse","DeleteConnectionRequest","DeleteConnectionResponse","DownloadAccountingBillAttachmentRequest","DownloadAccountingBillAttachmentResponse","DownloadAccountingCustomerAttachmentRequest","DownloadAccountingCustomerAttachmentResponse","DownloadAccountingDirectCostAttachmentRequest","DownloadAccountingDirectCostAttachmentResponse","DownloadAccountingDirectIncomeAttachmentRequest","DownloadAccountingDirectIncomeAttachmentResponse","DownloadAccountingInvoiceAttachmentRequest","DownloadAccountingInvoiceAttachmentResponse","DownloadAccountingInvoicePdfRequest","DownloadAccountingInvoicePdfResponse","DownloadAccountingSupplierAttachmentRequest","DownloadAccountingSupplierAttachmentResponse","DownloadExcelReportRequest","DownloadExcelReportResponse","DownloadFilesRequest","DownloadFilesResponse","GenerateExcelReportRequest","GenerateExcelReportResponse","GenerateLoanSummaryRequest","GenerateLoanSummaryResponse","GenerateLoanSummarySourceType","GenerateLoanTransactionsRequest","GenerateLoanTransactionsResponse","GenerateLoanTransactionsSourceType","GetAccountingAccountRequest","GetAccountingAccountResponse","GetAccountingAccountTransactionRequest","GetAccountingAccountTransactionResponse","GetAccountingAgedCreditorsReportRequest","GetAccountingAgedCreditorsReportResponse","GetAccountingAgedDebtorsReportRequest","GetAccountingAgedDebtorsReportResponse","GetAccountingBalanceSheetRequest","GetAccountingBalanceSheetResponse","GetAccountingBankAccountRequest","GetAccountingBankAccountResponse","GetAccountingBillAttachmentRequest","GetAccountingBillAttachmentResponse","GetAccountingBillCreditNoteRequest","GetAccountingBillCreditNoteResponse","GetAccountingBillPaymentRequest","GetAccountingBillPaymentResponse","GetAccountingBillRequest","GetAccountingBillResponse","GetAccountingCashFlowStatementRequest","GetAccountingCashFlowStatementResponse","GetAccountingCreditNoteRequest","GetAccountingCreditNoteResponse","GetAccountingCustomerAttachmentRequest","GetAccountingCustomerAttachmentResponse","GetAccountingCustomerRequest","GetAccountingCustomerResponse","GetAccountingDirectCostAttachmentRequest","GetAccountingDirectCostAttachmentResponse","GetAccountingDirectCostRequest","GetAccountingDirectCostResponse","GetAccountingDirectIncomeAttachmentRequest","GetAccountingDirectIncomeAttachmentResponse","GetAccountingDirectIncomeRequest","GetAccountingDirectIncomeResponse","GetAccountingInvoiceAttachmentRequest","GetAccountingInvoiceAttachmentResponse","GetAccountingInvoiceRequest","GetAccountingInvoiceResponse","GetAccountingJournalEntryRequest","GetAccountingJournalEntryResponse","GetAccountingJournalRequest","GetAccountingJournalResponse","GetAccountingPaymentRequest","GetAccountingPaymentResponse","GetAccountingProfileRequest","GetAccountingProfileResponse","GetAccountingProfitAndLossRequest","GetAccountingProfitAndLossResponse","GetAccountingSupplierAttachmentRequest","GetAccountingSupplierAttachmentResponse","GetAccountingSupplierRequest","GetAccountingSupplierResponse","GetAccountingTransferRequest","GetAccountingTransferResponse","GetBankingAccountRequest","GetBankingAccountResponse","GetBankingTransactionCategoryRequest","GetBankingTransactionCategoryResponse","GetBankingTransactionRequest","GetBankingTransactionResponse","GetCategorizedBalanceSheetStatementRequest","GetCategorizedBalanceSheetStatementResponse","GetCategorizedBankStatementRequest","GetCategorizedBankStatementResponse","GetCategorizedProfitAndLossStatementRequest","GetCategorizedProfitAndLossStatementResponse","GetCommerceCustomerRequest","GetCommerceCustomerResponse","GetCommerceCustomerRetentionMetricsRequest","GetCommerceCustomerRetentionMetricsResponse","GetCommerceDisputeRequest","GetCommerceDisputeResponse","GetCommerceLifetimeValueMetricsRequest","GetCommerceLifetimeValueMetricsResponse","GetCommerceLocationRequest","GetCommerceLocationResponse","GetCommerceOrderRequest","GetCommerceOrderResponse","GetCommerceOrdersReportRequest","GetCommerceOrdersReportResponse","GetCommercePaymentMethodRequest","GetCommercePaymentMethodResponse","GetCommercePaymentRequest","GetCommercePaymentResponse","GetCommerceProductCategoryRequest","GetCommerceProductCategoryResponse","GetCommerceProductRequest","GetCommerceProductResponse","GetCommerceProfileRequest","GetCommerceProfileResponse","GetCommerceRefundsReportRequest","GetCommerceRefundsReportResponse","GetCommerceRevenueMetricsRequest","GetCommerceRevenueMetricsResponse","GetCommerceTransactionRequest","GetCommerceTransactionResponse","GetCompanyRequest","GetCompanyResponse","GetConnectionRequest","GetConnectionResponse","GetCreateBankTransactionsModelRequest","GetCreateBankTransactionsModelResponse","GetCreateChartOfAccountsModelRequest","GetCreateChartOfAccountsModelResponse","GetCreateDirectCostsModelRequest","GetCreateDirectCostsModelResponse","GetCreateOperationRequest","GetCreateOperationResponse","GetCreatePaymentsModelRequest","GetCreatePaymentsModelResponse","GetCreateTransfersModelRequest","GetCreateTransfersModelResponse","GetCreateUpdateSuppliersModelRequest","GetCreateUpdateSuppliersModelResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetDataStatusRequest","GetDataStatusResponse","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetLoanSummaryRequest","GetLoanSummaryResponse","GetLoanSummarySourceType","GetPullOperationRequest","GetPullOperationResponse","IsAgedCreditorsReportAvailableRequest","IsAgedCreditorsReportAvailableResponse","IsAgedDebtorsReportAvailableRequest","IsAgedDebtorsReportAvailableResponse","ListAccountingAccountTransactionsRequest","ListAccountingAccountTransactionsResponse","ListAccountingAccountsRequest","ListAccountingAccountsResponse","ListAccountingBankAccountTransactionsRequest","ListAccountingBankAccountTransactionsResponse","ListAccountingBankAccountsRequest","ListAccountingBankAccountsResponse","ListAccountingBillAttachmentsRequest","ListAccountingBillAttachmentsResponse","ListAccountingBillCreditNotesRequest","ListAccountingBillCreditNotesResponse","ListAccountingBillPaymentsRequest","ListAccountingBillPaymentsResponse","ListAccountingBillsRequest","ListAccountingBillsResponse","ListAccountingCreditNotesRequest","ListAccountingCreditNotesResponse","ListAccountingCustomerAttachmentsRequest","ListAccountingCustomerAttachmentsResponse","ListAccountingCustomersRequest","ListAccountingCustomersResponse","ListAccountingDirectCostAttachmentsRequest","ListAccountingDirectCostAttachmentsResponse","ListAccountingDirectCostsRequest","ListAccountingDirectCostsResponse","ListAccountingDirectIncomeAttachmentsRequest","ListAccountingDirectIncomeAttachmentsResponse","ListAccountingDirectIncomesRequest","ListAccountingDirectIncomesResponse","ListAccountingInvoiceAttachmentsRequest","ListAccountingInvoiceAttachmentsResponse","ListAccountingInvoicesRequest","ListAccountingInvoicesResponse","ListAccountingJournalEntriesRequest","ListAccountingJournalEntriesResponse","ListAccountingJournalsRequest","ListAccountingJournalsResponse","ListAccountingPaymentsRequest","ListAccountingPaymentsResponse","ListAccountingSupplierAttachmentsRequest","ListAccountingSupplierAttachmentsResponse","ListAccountingSuppliersRequest","ListAccountingSuppliersResponse","ListAccountingTransfersRequest","ListAccountingTransfersResponse","ListBankingAccountBalancesRequest","ListBankingAccountBalancesResponse","ListBankingAccountsRequest","ListBankingAccountsResponse","ListBankingTransactionCategoriesRequest","ListBankingTransactionCategoriesResponse","ListBankingTransactionsRequest","ListBankingTransactionsResponse","ListCommerceCustomersRequest","ListCommerceCustomersResponse","ListCommerceDisputesRequest","ListCommerceDisputesResponse","ListCommerceLocationsRequest","ListCommerceLocationsResponse","ListCommerceOrdersRequest","ListCommerceOrdersResponse","ListCommercePaymentMethodsRequest","ListCommercePaymentMethodsResponse","ListCommercePaymentsRequest","ListCommercePaymentsResponse","ListCommerceProductCategoriesRequest","ListCommerceProductCategoriesResponse","ListCommerceProductsRequest","ListCommerceProductsResponse","ListCommerceTransactionsRequest","ListCommerceTransactionsResponse","ListCompaniesRequest","ListCompaniesResponse","ListConnectionsRequest","ListConnectionsResponse","ListCreateOperationsRequest","ListCreateOperationsResponse","ListDataIntegrityDetailsRequest","ListDataIntegrityDetailsResponse","ListFilesRequest","ListFilesResponse","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListLoanTransactionsSourceType","ListPullOperationsRequest","ListPullOperationsResponse","ListReconciledInvoicesRequest","ListReconciledInvoicesResponse","RefreshAllDataTypesRequest","RefreshAllDataTypesResponse","RefreshDataTypeRequest","RefreshDataTypeResponse","UnlinkConnectionRequest","UnlinkConnectionResponse","UnlinkConnectionUpdateConnection","UpdateCompanyRequest","UpdateCompanyResponse","UploadFilesRequest","UploadFilesRequestBody","UploadFilesResponse"] diff --git a/lending/src/codatlending/models/operations/create_account.py b/lending/src/codatlending/models/operations/create_account.py index c2a09db1a..64089c16d 100755 --- a/lending/src/codatlending/models/operations/create_account.py +++ b/lending/src/codatlending/models/operations/create_account.py @@ -9,29 +9,32 @@ from typing import Optional - @dataclasses.dataclass class CreateAccountRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_account: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_account_response: Optional[shared_accountingcreateaccountresponse.AccountingCreateAccountResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_bank_transactions.py b/lending/src/codatlending/models/operations/create_bank_transactions.py index 0f955e516..4e741656b 100755 --- a/lending/src/codatlending/models/operations/create_bank_transactions.py +++ b/lending/src/codatlending/models/operations/create_bank_transactions.py @@ -9,31 +9,34 @@ from typing import Optional - @dataclasses.dataclass class CreateBankTransactionsRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_create_bank_transactions: Optional[shared_accountingcreatebanktransactions.AccountingCreateBankTransactions] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateBankTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_bank_transactions_response: Optional[shared_accountingcreatebanktransactionsresponse.AccountingCreateBankTransactionsResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_company.py b/lending/src/codatlending/models/operations/create_company.py index a8a25afd3..3225796a8 100755 --- a/lending/src/codatlending/models/operations/create_company.py +++ b/lending/src/codatlending/models/operations/create_company.py @@ -8,15 +8,17 @@ from typing import Optional - @dataclasses.dataclass class CreateCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_connection.py b/lending/src/codatlending/models/operations/create_connection.py index be84d5501..77cc81b5f 100755 --- a/lending/src/codatlending/models/operations/create_connection.py +++ b/lending/src/codatlending/models/operations/create_connection.py @@ -11,32 +11,34 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreateConnectionRequestBody: platform_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformKey'), 'exclude': lambda f: f is None }}) + r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.""" - @dataclasses.dataclass class CreateConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" request_body: Optional[CreateConnectionRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class CreateConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_direct_cost.py b/lending/src/codatlending/models/operations/create_direct_cost.py index c121ab42b..7f0c56f42 100755 --- a/lending/src/codatlending/models/operations/create_direct_cost.py +++ b/lending/src/codatlending/models/operations/create_direct_cost.py @@ -9,29 +9,32 @@ from typing import Optional - @dataclasses.dataclass class CreateDirectCostRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_direct_cost: Optional[shared_accountingdirectcost.AccountingDirectCost] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateDirectCostResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_direct_cost_response: Optional[shared_accountingcreatedirectcostresponse.AccountingCreateDirectCostResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_bank_account.py b/lending/src/codatlending/models/operations/create_payment.py similarity index 51% rename from lending/src/codatlending/models/operations/create_bank_account.py rename to lending/src/codatlending/models/operations/create_payment.py index 5d36f6d45..8d603e6f8 100755 --- a/lending/src/codatlending/models/operations/create_bank_account.py +++ b/lending/src/codatlending/models/operations/create_payment.py @@ -3,35 +3,38 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbankaccount as shared_accountingbankaccount -from ..shared import accountingcreatebankaccountresponse as shared_accountingcreatebankaccountresponse +from ..shared import accountingcreatepaymentresponse as shared_accountingcreatepaymentresponse +from ..shared import accountingpayment as shared_accountingpayment from ..shared import errormessage as shared_errormessage from typing import Optional - @dataclasses.dataclass -class CreateBankAccountRequest: +class CreatePaymentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) - accounting_bank_account: Optional[shared_accountingbankaccount.AccountingBankAccount] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + r"""Unique identifier for a connection.""" + accounting_payment: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass -class CreateBankAccountResponse: +class CreatePaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - accounting_create_bank_account_response: Optional[shared_accountingcreatebankaccountresponse.AccountingCreateBankAccountResponse] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + accounting_create_payment_response: Optional[shared_accountingcreatepaymentresponse.AccountingCreatePaymentResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_supplier.py b/lending/src/codatlending/models/operations/create_supplier.py index 7f1b1b58b..be8b86e2f 100755 --- a/lending/src/codatlending/models/operations/create_supplier.py +++ b/lending/src/codatlending/models/operations/create_supplier.py @@ -9,29 +9,32 @@ from typing import Optional - @dataclasses.dataclass class CreateSupplierRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_supplier: Optional[shared_accountingsupplier.AccountingSupplier] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateSupplierResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_supplier_response: Optional[shared_accountingcreatesupplierresponse.AccountingCreateSupplierResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/create_transfer.py b/lending/src/codatlending/models/operations/create_transfer.py index ac8742f69..521d71fd9 100755 --- a/lending/src/codatlending/models/operations/create_transfer.py +++ b/lending/src/codatlending/models/operations/create_transfer.py @@ -9,29 +9,32 @@ from typing import Optional - @dataclasses.dataclass class CreateTransferRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" accounting_transfer: Optional[shared_accountingtransfer.AccountingTransfer] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) - force_update: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'forceUpdate', 'style': 'form', 'explode': True }}) - r"""When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting platform, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.""" + allow_sync_on_push_complete: Optional[bool] = dataclasses.field(default=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) + r"""Allow a sync upon push completion.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class CreateTransferResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_create_transfer_response: Optional[shared_accountingcreatetransferresponse.AccountingCreateTransferResponse] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/delete_company.py b/lending/src/codatlending/models/operations/delete_company.py index b5e6a5b86..0c7da43c5 100755 --- a/lending/src/codatlending/models/operations/delete_company.py +++ b/lending/src/codatlending/models/operations/delete_company.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class DeleteCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class DeleteCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/delete_connection.py b/lending/src/codatlending/models/operations/delete_connection.py index e12219d11..568a81d83 100755 --- a/lending/src/codatlending/models/operations/delete_connection.py +++ b/lending/src/codatlending/models/operations/delete_connection.py @@ -7,22 +7,25 @@ from typing import Optional - @dataclasses.dataclass class DeleteConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class DeleteConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py b/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py index 5da5f6864..68cf80a71 100755 --- a/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py @@ -7,28 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingBillAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" bill_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a bill""" + r"""Unique identifier for a bill.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class DownloadAccountingBillAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py b/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py index 62972fd15..98fa9dc3a 100755 --- a/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py @@ -7,27 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingCustomerAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a customer.""" - @dataclasses.dataclass class DownloadAccountingCustomerAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py b/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py index 71dd8a532..348d24c3c 100755 --- a/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py @@ -7,28 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingDirectCostAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_cost_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directCostId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct cost""" + r"""Unique identifier for a direct cost.""" - @dataclasses.dataclass class DownloadAccountingDirectCostAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py b/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py index 6168f8677..583bbafde 100755 --- a/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py @@ -7,28 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingDirectIncomeAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_income_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directIncomeId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct income""" + r"""Unique identifier for a direct income.""" - @dataclasses.dataclass class DownloadAccountingDirectIncomeAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py b/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py index 652bd7250..925e84be2 100755 --- a/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py @@ -7,28 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingInvoiceAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" invoice_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'invoiceId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an invoice""" + r"""Unique identifier for an invoice.""" - @dataclasses.dataclass class DownloadAccountingInvoiceAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py b/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py index d3c95ce21..d76adad24 100755 --- a/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py +++ b/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py @@ -6,23 +6,25 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingInvoicePdfRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" invoice_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'invoiceId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an invoice""" + r"""Unique identifier for an invoice.""" - @dataclasses.dataclass class DownloadAccountingInvoicePdfResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py b/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py index 7b7ad720c..cd6109829 100755 --- a/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py @@ -7,28 +7,31 @@ from typing import Optional - @dataclasses.dataclass class DownloadAccountingSupplierAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" supplier_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'supplierId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a supplier""" + r"""Unique identifier for a supplier.""" - @dataclasses.dataclass class DownloadAccountingSupplierAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_excel_report.py b/lending/src/codatlending/models/operations/download_excel_report.py index 969708dcd..afb3833b3 100755 --- a/lending/src/codatlending/models/operations/download_excel_report.py +++ b/lending/src/codatlending/models/operations/download_excel_report.py @@ -8,24 +8,26 @@ from typing import Optional - @dataclasses.dataclass class DownloadExcelReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" report_type: shared_excelreporttypes.ExcelReportTypes = dataclasses.field(metadata={'query_param': { 'field_name': 'reportType', 'style': 'form', 'explode': True }}) r"""The type of report you want to generate and download.""" - @dataclasses.dataclass class DownloadExcelReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" body: Optional[bytes] = dataclasses.field(default=None) error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/download_files.py b/lending/src/codatlending/models/operations/download_files.py index cf3b76372..16a0c9c21 100755 --- a/lending/src/codatlending/models/operations/download_files.py +++ b/lending/src/codatlending/models/operations/download_files.py @@ -7,25 +7,27 @@ from typing import Optional - @dataclasses.dataclass class DownloadFilesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" date_: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'date', 'style': 'form', 'explode': True }}) r"""Only download files uploaded on this date.""" - @dataclasses.dataclass class DownloadFilesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data: Optional[bytes] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data: Optional[requests_http.Response] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/generate_excel_report.py b/lending/src/codatlending/models/operations/generate_excel_report.py index 06b91296d..0f8d44f1d 100755 --- a/lending/src/codatlending/models/operations/generate_excel_report.py +++ b/lending/src/codatlending/models/operations/generate_excel_report.py @@ -9,25 +9,27 @@ from typing import Optional - @dataclasses.dataclass class GenerateExcelReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" report_type: shared_excelreporttypes.ExcelReportTypes = dataclasses.field(metadata={'query_param': { 'field_name': 'reportType', 'style': 'form', 'explode': True }}) r"""The type of report you want to generate and download.""" - @dataclasses.dataclass class GenerateExcelReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" excel_status: Optional[shared_excelstatus.ExcelStatus] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/generate_loan_summary.py b/lending/src/codatlending/models/operations/generate_loan_summary.py new file mode 100755 index 000000000..a8372fcd6 --- /dev/null +++ b/lending/src/codatlending/models/operations/generate_loan_summary.py @@ -0,0 +1,38 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ..shared import errormessage as shared_errormessage +from enum import Enum +from typing import Optional + +class GenerateLoanSummarySourceType(str, Enum): + r"""Data source type.""" + BANKING = 'banking' + COMMERCE = 'commerce' + ACCOUNTING = 'accounting' + + +@dataclasses.dataclass +class GenerateLoanSummaryRequest: + company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" + source_type: GenerateLoanSummarySourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + r"""Data source type.""" + + + + +@dataclasses.dataclass +class GenerateLoanSummaryResponse: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/lending/src/codatlending/models/operations/generate_loan_transactions.py b/lending/src/codatlending/models/operations/generate_loan_transactions.py new file mode 100755 index 000000000..291e38f4b --- /dev/null +++ b/lending/src/codatlending/models/operations/generate_loan_transactions.py @@ -0,0 +1,38 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ..shared import errormessage as shared_errormessage +from enum import Enum +from typing import Optional + +class GenerateLoanTransactionsSourceType(str, Enum): + r"""Data source type.""" + BANKING = 'banking' + COMMERCE = 'commerce' + ACCOUNTING = 'accounting' + + +@dataclasses.dataclass +class GenerateLoanTransactionsRequest: + company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" + source_type: GenerateLoanTransactionsSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + r"""Data source type.""" + + + + +@dataclasses.dataclass +class GenerateLoanTransactionsResponse: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/lending/src/codatlending/models/operations/get_accounting_account.py b/lending/src/codatlending/models/operations/get_accounting_account.py index 38abdf83b..f543647c4 100755 --- a/lending/src/codatlending/models/operations/get_accounting_account.py +++ b/lending/src/codatlending/models/operations/get_accounting_account.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingAccountRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_account: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_account_transaction.py b/lending/src/codatlending/models/operations/get_accounting_account_transaction.py index 476472a91..083929e79 100755 --- a/lending/src/codatlending/models/operations/get_accounting_account_transaction.py +++ b/lending/src/codatlending/models/operations/get_accounting_account_transaction.py @@ -8,25 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingAccountTransactionRequest: account_transaction_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountTransactionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for an account transaction.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetAccountingAccountTransactionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_account_transaction: Optional[shared_accountingaccounttransaction.AccountingAccountTransaction] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py b/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py index 99d6857f9..b395be7f6 100755 --- a/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py +++ b/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py @@ -9,10 +9,10 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingAgedCreditorsReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" number_of_periods: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""Number of periods to include in the report.""" period_length_days: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'periodLengthDays', 'style': 'form', 'explode': True }}) @@ -23,15 +23,17 @@ class GetAccountingAgedCreditorsReportRequest: - @dataclasses.dataclass class GetAccountingAgedCreditorsReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_aged_creditor_report: Optional[shared_accountingagedcreditorreport.AccountingAgedCreditorReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py b/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py index 023e82d2e..826826aa8 100755 --- a/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py +++ b/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py @@ -9,10 +9,10 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingAgedDebtorsReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" number_of_periods: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""Number of periods to include in the report.""" period_length_days: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'periodLengthDays', 'style': 'form', 'explode': True }}) @@ -23,15 +23,17 @@ class GetAccountingAgedDebtorsReportRequest: - @dataclasses.dataclass class GetAccountingAgedDebtorsReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_aged_debtor_report: Optional[shared_accountingageddebtorreport.AccountingAgedDebtorReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py b/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py index f4569d3d9..4b09d589a 100755 --- a/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py +++ b/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBalanceSheetRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) r"""Number of months defining the period of interest.""" periods_to_compare: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodsToCompare', 'style': 'form', 'explode': True }}) r"""Number of periods with `periodLength` to compare.""" start_month: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'startMonth', 'style': 'form', 'explode': True }}) + r"""The month the report starts from.""" - @dataclasses.dataclass class GetAccountingBalanceSheetResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_balance_sheet: Optional[shared_accountingbalancesheet.AccountingBalanceSheet] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_bank_account.py b/lending/src/codatlending/models/operations/get_accounting_bank_account.py index 8e5897e35..04785a72d 100755 --- a/lending/src/codatlending/models/operations/get_accounting_bank_account.py +++ b/lending/src/codatlending/models/operations/get_accounting_bank_account.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBankAccountRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetAccountingBankAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bank_account: Optional[shared_accountingbankaccount.AccountingBankAccount] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_bill.py b/lending/src/codatlending/models/operations/get_accounting_bill.py index 1f370842d..047c77f20 100755 --- a/lending/src/codatlending/models/operations/get_accounting_bill.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBillRequest: bill_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a bill""" + r"""Unique identifier for a bill.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingBillResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bill: Optional[shared_accountingbill.AccountingBill] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py b/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py index bffe35d93..928795c71 100755 --- a/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBillAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" bill_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a bill""" + r"""Unique identifier for a bill.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetAccountingBillAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py b/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py index d1241c458..aa98f09ef 100755 --- a/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBillCreditNoteRequest: bill_credit_note_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billCreditNoteId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a bill credit note.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingBillCreditNoteResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bill_credit_note: Optional[shared_accountingbillcreditnote.AccountingBillCreditNote] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_bill_payment.py b/lending/src/codatlending/models/operations/get_accounting_bill_payment.py index c3ab46c9b..1fb055c91 100755 --- a/lending/src/codatlending/models/operations/get_accounting_bill_payment.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_payment.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingBillPaymentRequest: bill_payment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billPaymentId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a bill payment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingBillPaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bill_payment: Optional[shared_accountingbillpayment.AccountingBillPayment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py b/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py index 75fa30a02..6d480a608 100755 --- a/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py +++ b/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingCashFlowStatementRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) r"""Number of months defining the period of interest.""" periods_to_compare: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodsToCompare', 'style': 'form', 'explode': True }}) r"""Number of periods with `periodLength` to compare.""" start_month: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'startMonth', 'style': 'form', 'explode': True }}) + r"""The month the report starts from.""" - @dataclasses.dataclass class GetAccountingCashFlowStatementResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_cash_flow_statement: Optional[shared_accountingcashflowstatement.AccountingCashFlowStatement] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_credit_note.py b/lending/src/codatlending/models/operations/get_accounting_credit_note.py index 45208cdb1..0657fc50c 100755 --- a/lending/src/codatlending/models/operations/get_accounting_credit_note.py +++ b/lending/src/codatlending/models/operations/get_accounting_credit_note.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingCreditNoteRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" credit_note_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'creditNoteId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a credit note.""" - @dataclasses.dataclass class GetAccountingCreditNoteResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_credit_note: Optional[shared_accountingcreditnote.AccountingCreditNote] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_customer.py b/lending/src/codatlending/models/operations/get_accounting_customer.py index cc42942d4..915e65b3b 100755 --- a/lending/src/codatlending/models/operations/get_accounting_customer.py +++ b/lending/src/codatlending/models/operations/get_accounting_customer.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a customer.""" - @dataclasses.dataclass class GetAccountingCustomerResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_customer: Optional[shared_accountingcustomer.AccountingCustomer] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py b/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py index 431ecda01..857e60c29 100755 --- a/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py @@ -8,27 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingCustomerAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a customer.""" - @dataclasses.dataclass class GetAccountingCustomerAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_direct_cost.py b/lending/src/codatlending/models/operations/get_accounting_direct_cost.py index fae96cb89..97aa7eb4c 100755 --- a/lending/src/codatlending/models/operations/get_accounting_direct_cost.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_cost.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingDirectCostRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_cost_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directCostId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct cost""" + r"""Unique identifier for a direct cost.""" - @dataclasses.dataclass class GetAccountingDirectCostResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_direct_cost: Optional[shared_accountingdirectcost.AccountingDirectCost] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py b/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py index 20d4445e8..7b685813b 100755 --- a/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingDirectCostAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_cost_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directCostId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct cost""" + r"""Unique identifier for a direct cost.""" - @dataclasses.dataclass class GetAccountingDirectCostAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_direct_income.py b/lending/src/codatlending/models/operations/get_accounting_direct_income.py index 71bf248ed..0ba595ac5 100755 --- a/lending/src/codatlending/models/operations/get_accounting_direct_income.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_income.py @@ -8,25 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingDirectIncomeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_income_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directIncomeId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a direct income.""" - @dataclasses.dataclass class GetAccountingDirectIncomeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_direct_income: Optional[shared_accountingdirectincome.AccountingDirectIncome] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py b/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py index 0ca9f9df1..27ac170c8 100755 --- a/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py @@ -8,29 +8,33 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingDirectIncomeAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_income_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directIncomeId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct income""" + r"""Unique identifier for a direct income.""" timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'timeoutInMinutes', 'style': 'form', 'explode': True }}) + r"""Time limit for the push operation to complete before it is timed out.""" - @dataclasses.dataclass class GetAccountingDirectIncomeAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_invoice.py b/lending/src/codatlending/models/operations/get_accounting_invoice.py index 0e36c5069..28605067a 100755 --- a/lending/src/codatlending/models/operations/get_accounting_invoice.py +++ b/lending/src/codatlending/models/operations/get_accounting_invoice.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingInvoiceRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" invoice_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'invoiceId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an invoice""" + r"""Unique identifier for an invoice.""" - @dataclasses.dataclass class GetAccountingInvoiceResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_invoice: Optional[shared_accountinginvoice.AccountingInvoice] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py b/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py index 2beac3788..8e6d197a1 100755 --- a/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingInvoiceAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" invoice_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'invoiceId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an invoice""" + r"""Unique identifier for an invoice.""" - @dataclasses.dataclass class GetAccountingInvoiceAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_journal.py b/lending/src/codatlending/models/operations/get_accounting_journal.py index 746214cbb..fa97b7a4f 100755 --- a/lending/src/codatlending/models/operations/get_accounting_journal.py +++ b/lending/src/codatlending/models/operations/get_accounting_journal.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingJournalRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" journal_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'journalId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a journal.""" - @dataclasses.dataclass class GetAccountingJournalResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_journal: Optional[shared_accountingjournal.AccountingJournal] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_journal_entry.py b/lending/src/codatlending/models/operations/get_accounting_journal_entry.py index 251d0ae60..546be20ff 100755 --- a/lending/src/codatlending/models/operations/get_accounting_journal_entry.py +++ b/lending/src/codatlending/models/operations/get_accounting_journal_entry.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingJournalEntryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" journal_entry_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'journalEntryId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a journal entry.""" - @dataclasses.dataclass class GetAccountingJournalEntryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_journal_entry: Optional[shared_accountingjournalentry.AccountingJournalEntry] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_payment.py b/lending/src/codatlending/models/operations/get_accounting_payment.py index ea58da839..9ea5c7586 100755 --- a/lending/src/codatlending/models/operations/get_accounting_payment.py +++ b/lending/src/codatlending/models/operations/get_accounting_payment.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingPaymentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" payment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'paymentId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a payment.""" - @dataclasses.dataclass class GetAccountingPaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_payment: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_profile.py b/lending/src/codatlending/models/operations/get_accounting_profile.py index db1575a77..aee5f6065 100755 --- a/lending/src/codatlending/models/operations/get_accounting_profile.py +++ b/lending/src/codatlending/models/operations/get_accounting_profile.py @@ -8,23 +8,25 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingProfileRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetAccountingProfileResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_company_info: Optional[shared_accountingcompanyinfo.AccountingCompanyInfo] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py b/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py index d9c775629..6ead1f6a3 100755 --- a/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py +++ b/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingProfitAndLossRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) r"""Number of months defining the period of interest.""" periods_to_compare: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodsToCompare', 'style': 'form', 'explode': True }}) r"""Number of periods with `periodLength` to compare.""" start_month: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'startMonth', 'style': 'form', 'explode': True }}) + r"""The month the report starts from.""" - @dataclasses.dataclass class GetAccountingProfitAndLossResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_profit_and_loss_report: Optional[shared_accountingprofitandlossreport.AccountingProfitAndLossReport] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_supplier.py b/lending/src/codatlending/models/operations/get_accounting_supplier.py index 51df1fd06..b53fa285b 100755 --- a/lending/src/codatlending/models/operations/get_accounting_supplier.py +++ b/lending/src/codatlending/models/operations/get_accounting_supplier.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingSupplierRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" supplier_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'supplierId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a supplier""" + r"""Unique identifier for a supplier.""" - @dataclasses.dataclass class GetAccountingSupplierResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_supplier: Optional[shared_accountingsupplier.AccountingSupplier] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py b/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py index 6892ab67d..5afd6acc1 100755 --- a/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py @@ -8,28 +8,31 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingSupplierAttachmentRequest: attachment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'attachmentId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an attachment""" + r"""Unique identifier for an attachment.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" supplier_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'supplierId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a supplier""" + r"""Unique identifier for a supplier.""" - @dataclasses.dataclass class GetAccountingSupplierAttachmentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_attachment: Optional[shared_accountingattachment.AccountingAttachment] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_accounting_transfer.py b/lending/src/codatlending/models/operations/get_accounting_transfer.py index 706222b09..2827543fd 100755 --- a/lending/src/codatlending/models/operations/get_accounting_transfer.py +++ b/lending/src/codatlending/models/operations/get_accounting_transfer.py @@ -8,25 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetAccountingTransferRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" transfer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'transferId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a transfer.""" - @dataclasses.dataclass class GetAccountingTransferResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_transfer: Optional[shared_accountingtransfer.AccountingTransfer] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_banking_account.py b/lending/src/codatlending/models/operations/get_banking_account.py index bc5bf878f..57f2231ae 100755 --- a/lending/src/codatlending/models/operations/get_banking_account.py +++ b/lending/src/codatlending/models/operations/get_banking_account.py @@ -7,24 +7,27 @@ from typing import Optional - @dataclasses.dataclass class GetBankingAccountRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetBankingAccountResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_account: Optional[shared_bankingaccount.BankingAccount] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_banking_transaction.py b/lending/src/codatlending/models/operations/get_banking_transaction.py index 0aa50b3c4..775875a2d 100755 --- a/lending/src/codatlending/models/operations/get_banking_transaction.py +++ b/lending/src/codatlending/models/operations/get_banking_transaction.py @@ -7,24 +7,27 @@ from typing import Optional - @dataclasses.dataclass class GetBankingTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" transaction_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'transactionId', 'style': 'simple', 'explode': False }}) r"""The unique identifier for a transaction""" - @dataclasses.dataclass class GetBankingTransactionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_transaction: Optional[shared_bankingtransaction.BankingTransaction] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_banking_transaction_category.py b/lending/src/codatlending/models/operations/get_banking_transaction_category.py index 4002a8033..a95ffca9b 100755 --- a/lending/src/codatlending/models/operations/get_banking_transaction_category.py +++ b/lending/src/codatlending/models/operations/get_banking_transaction_category.py @@ -7,24 +7,27 @@ from typing import Optional - @dataclasses.dataclass class GetBankingTransactionCategoryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" transaction_category_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'transactionCategoryId', 'style': 'simple', 'explode': False }}) r"""The unique identifier for a banking transaction category""" - @dataclasses.dataclass class GetBankingTransactionCategoryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_transaction_category: Optional[shared_bankingtransactioncategory.BankingTransactionCategory] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py b/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py index a9eb3acfe..e5e03feca 100755 --- a/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py +++ b/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py @@ -8,10 +8,10 @@ from typing import Optional - @dataclasses.dataclass class GetCategorizedBalanceSheetStatementRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" report_date: str = dataclasses.field(metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" number_of_periods: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) @@ -20,15 +20,17 @@ class GetCategorizedBalanceSheetStatementRequest: - @dataclasses.dataclass class GetCategorizedBalanceSheetStatementResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" enhanced_financial_report: Optional[shared_enhancedfinancialreport.EnhancedFinancialReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_categorized_bank_statement.py b/lending/src/codatlending/models/operations/get_categorized_bank_statement.py index c61644a6d..3126f15d1 100755 --- a/lending/src/codatlending/models/operations/get_categorized_bank_statement.py +++ b/lending/src/codatlending/models/operations/get_categorized_bank_statement.py @@ -8,13 +8,13 @@ from typing import Optional - @dataclasses.dataclass class GetCategorizedBankStatementRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + r"""Unique identifier for a company.""" + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -22,15 +22,17 @@ class GetCategorizedBankStatementRequest: - @dataclasses.dataclass class GetCategorizedBankStatementResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" enhanced_cash_flow_transactions: Optional[shared_enhancedcashflowtransactions.EnhancedCashFlowTransactions] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_categorized_profit_and_loss_statement.py b/lending/src/codatlending/models/operations/get_categorized_profit_and_loss_statement.py index b8f9436af..592dc3955 100755 --- a/lending/src/codatlending/models/operations/get_categorized_profit_and_loss_statement.py +++ b/lending/src/codatlending/models/operations/get_categorized_profit_and_loss_statement.py @@ -8,27 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCategorizedProfitAndLossStatementRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) - report_date: str = dataclasses.field(metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) - r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" + r"""Unique identifier for a company.""" number_of_periods: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. If not provided, 12 periods will be used as the default value.""" + report_date: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) + r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" - @dataclasses.dataclass class GetCategorizedProfitAndLossStatementResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" enhanced_financial_report: Optional[shared_enhancedfinancialreport.EnhancedFinancialReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_customer.py b/lending/src/codatlending/models/operations/get_commerce_customer.py index faa4cc635..5f3d50556 100755 --- a/lending/src/codatlending/models/operations/get_commerce_customer.py +++ b/lending/src/codatlending/models/operations/get_commerce_customer.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceCustomerRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a customer.""" - @dataclasses.dataclass class GetCommerceCustomerResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_customer: Optional[shared_commercecustomer.CommerceCustomer] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py b/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py index ca74da488..46b15217f 100755 --- a/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py @@ -9,11 +9,12 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceCustomerRetentionMetricsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. There will be no pagination as a query parameter.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) @@ -28,15 +29,17 @@ class GetCommerceCustomerRetentionMetricsRequest: - @dataclasses.dataclass class GetCommerceCustomerRetentionMetricsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_report: Optional[shared_commercereport.CommerceReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_dispute.py b/lending/src/codatlending/models/operations/get_commerce_dispute.py index a8c39d8a2..9e2446a72 100755 --- a/lending/src/codatlending/models/operations/get_commerce_dispute.py +++ b/lending/src/codatlending/models/operations/get_commerce_dispute.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceDisputeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" dispute_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'disputeId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a dispute.""" - @dataclasses.dataclass class GetCommerceDisputeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_dispute: Optional[shared_commercedispute.CommerceDispute] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py b/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py index 3533d0e8d..eaa26c364 100755 --- a/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py @@ -9,11 +9,12 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceLifetimeValueMetricsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. There will be no pagination as a query parameter.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) @@ -28,15 +29,17 @@ class GetCommerceLifetimeValueMetricsRequest: - @dataclasses.dataclass class GetCommerceLifetimeValueMetricsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_report: Optional[shared_commercereport.CommerceReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_location.py b/lending/src/codatlending/models/operations/get_commerce_location.py index 382aa086a..15d4a0a8e 100755 --- a/lending/src/codatlending/models/operations/get_commerce_location.py +++ b/lending/src/codatlending/models/operations/get_commerce_location.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceLocationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" location_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'locationId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a location.""" - @dataclasses.dataclass class GetCommerceLocationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_location: Optional[shared_commercelocation.CommerceLocation] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_order.py b/lending/src/codatlending/models/operations/get_commerce_order.py index b58784b06..993262aee 100755 --- a/lending/src/codatlending/models/operations/get_commerce_order.py +++ b/lending/src/codatlending/models/operations/get_commerce_order.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceOrderRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'orderId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for an order.""" - @dataclasses.dataclass class GetCommerceOrderResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_order: Optional[shared_commerceorder.CommerceOrder] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_orders_report.py b/lending/src/codatlending/models/operations/get_commerce_orders_report.py index dcc430d5f..7551adffb 100755 --- a/lending/src/codatlending/models/operations/get_commerce_orders_report.py +++ b/lending/src/codatlending/models/operations/get_commerce_orders_report.py @@ -9,11 +9,12 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceOrdersReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. There will be no pagination as a query parameter.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) @@ -28,15 +29,17 @@ class GetCommerceOrdersReportRequest: - @dataclasses.dataclass class GetCommerceOrdersReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_report: Optional[shared_commercereport.CommerceReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_payment.py b/lending/src/codatlending/models/operations/get_commerce_payment.py index c836d5764..a8f17ec7c 100755 --- a/lending/src/codatlending/models/operations/get_commerce_payment.py +++ b/lending/src/codatlending/models/operations/get_commerce_payment.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommercePaymentRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" payment_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'paymentId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a payment.""" - @dataclasses.dataclass class GetCommercePaymentResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment: Optional[shared_commercepayment.CommercePayment] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_payment_method.py b/lending/src/codatlending/models/operations/get_commerce_payment_method.py index 4250ed82d..e828c47a7 100755 --- a/lending/src/codatlending/models/operations/get_commerce_payment_method.py +++ b/lending/src/codatlending/models/operations/get_commerce_payment_method.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommercePaymentMethodRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" payment_method_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'paymentMethodId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a payment method.""" - @dataclasses.dataclass class GetCommercePaymentMethodResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment_method: Optional[shared_commercepaymentmethod.CommercePaymentMethod] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_product.py b/lending/src/codatlending/models/operations/get_commerce_product.py index de206e6fe..81309281e 100755 --- a/lending/src/codatlending/models/operations/get_commerce_product.py +++ b/lending/src/codatlending/models/operations/get_commerce_product.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceProductRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" product_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'productId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a product.""" - @dataclasses.dataclass class GetCommerceProductResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_product: Optional[shared_commerceproduct.CommerceProduct] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_product_category.py b/lending/src/codatlending/models/operations/get_commerce_product_category.py index fe8424979..6895344b1 100755 --- a/lending/src/codatlending/models/operations/get_commerce_product_category.py +++ b/lending/src/codatlending/models/operations/get_commerce_product_category.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceProductCategoryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" product_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'productId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a product.""" - @dataclasses.dataclass class GetCommerceProductCategoryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_product_category: Optional[shared_commerceproductcategory.CommerceProductCategory] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_profile.py b/lending/src/codatlending/models/operations/get_commerce_profile.py index 7816704fd..a7e4368c5 100755 --- a/lending/src/codatlending/models/operations/get_commerce_profile.py +++ b/lending/src/codatlending/models/operations/get_commerce_profile.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceProfileRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCommerceProfileResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_company_info: Optional[shared_commercecompanyinfo.CommerceCompanyInfo] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_refunds_report.py b/lending/src/codatlending/models/operations/get_commerce_refunds_report.py index 9c5a99394..77880e62e 100755 --- a/lending/src/codatlending/models/operations/get_commerce_refunds_report.py +++ b/lending/src/codatlending/models/operations/get_commerce_refunds_report.py @@ -9,11 +9,12 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceRefundsReportRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. There will be no pagination as a query parameter.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) @@ -28,15 +29,17 @@ class GetCommerceRefundsReportRequest: - @dataclasses.dataclass class GetCommerceRefundsReportResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_report: Optional[shared_commercereport.CommerceReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py b/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py index 10848620d..cd7d312e0 100755 --- a/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py @@ -9,11 +9,12 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceRevenueMetricsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) r"""The number of periods to return. There will be no pagination as a query parameter.""" period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) @@ -28,15 +29,17 @@ class GetCommerceRevenueMetricsRequest: - @dataclasses.dataclass class GetCommerceRevenueMetricsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_report: Optional[shared_commercereport.CommerceReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_commerce_transaction.py b/lending/src/codatlending/models/operations/get_commerce_transaction.py index 320015ccc..eda45f6fb 100755 --- a/lending/src/codatlending/models/operations/get_commerce_transaction.py +++ b/lending/src/codatlending/models/operations/get_commerce_transaction.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCommerceTransactionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" transaction_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'transactionId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a transaction.""" - @dataclasses.dataclass class GetCommerceTransactionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_transaction: Optional[shared_commercetransaction.CommerceTransaction] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_company.py b/lending/src/codatlending/models/operations/get_company.py index b9881123d..9660394e9 100755 --- a/lending/src/codatlending/models/operations/get_company.py +++ b/lending/src/codatlending/models/operations/get_company.py @@ -8,23 +8,25 @@ from typing import Optional - @dataclasses.dataclass class GetCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_connection.py b/lending/src/codatlending/models/operations/get_connection.py index af6188ccb..c21ca84ed 100755 --- a/lending/src/codatlending/models/operations/get_connection.py +++ b/lending/src/codatlending/models/operations/get_connection.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py b/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py index 2ac171766..5568e2eaf 100755 --- a/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py +++ b/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class GetCreateBankTransactionsModelRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCreateBankTransactionsModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py b/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py index 07630f5d8..7961bde4f 100755 --- a/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py +++ b/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCreateChartOfAccountsModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCreateChartOfAccountsModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_directcosts_model.py b/lending/src/codatlending/models/operations/get_create_directcosts_model.py index bb922c51a..9e98e73e5 100755 --- a/lending/src/codatlending/models/operations/get_create_directcosts_model.py +++ b/lending/src/codatlending/models/operations/get_create_directcosts_model.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCreateDirectCostsModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCreateDirectCostsModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_operation.py b/lending/src/codatlending/models/operations/get_create_operation.py index 46d34d263..8f6d546bd 100755 --- a/lending/src/codatlending/models/operations/get_create_operation.py +++ b/lending/src/codatlending/models/operations/get_create_operation.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCreateOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" push_operation_key: str = dataclasses.field(metadata={'path_param': { 'field_name': 'pushOperationKey', 'style': 'simple', 'explode': False }}) r"""Push operation key.""" - @dataclasses.dataclass class GetCreateOperationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_operation: Optional[shared_pushoperation.PushOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_update_bankaccounts_model.py b/lending/src/codatlending/models/operations/get_create_payments_model.py similarity index 75% rename from lending/src/codatlending/models/operations/get_create_update_bankaccounts_model.py rename to lending/src/codatlending/models/operations/get_create_payments_model.py index 8ba2b0b53..65b82c32c 100755 --- a/lending/src/codatlending/models/operations/get_create_update_bankaccounts_model.py +++ b/lending/src/codatlending/models/operations/get_create_payments_model.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass -class GetCreateUpdateBankAccountsModelRequest: +class GetCreatePaymentsModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass -class GetCreateUpdateBankAccountsModelResponse: +class GetCreatePaymentsModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_transfers_model.py b/lending/src/codatlending/models/operations/get_create_transfers_model.py index 20d6781c8..084497a55 100755 --- a/lending/src/codatlending/models/operations/get_create_transfers_model.py +++ b/lending/src/codatlending/models/operations/get_create_transfers_model.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCreateTransfersModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCreateTransfersModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py b/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py index c1824d3a1..5254ced72 100755 --- a/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py +++ b/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetCreateUpdateSuppliersModelRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class GetCreateUpdateSuppliersModelResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_data_integrity_status.py b/lending/src/codatlending/models/operations/get_data_integrity_status.py index a5131e34c..24727acd7 100755 --- a/lending/src/codatlending/models/operations/get_data_integrity_status.py +++ b/lending/src/codatlending/models/operations/get_data_integrity_status.py @@ -9,25 +9,27 @@ from typing import Optional - @dataclasses.dataclass class GetDataIntegrityStatusRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" data_type: shared_dataintegritydatatype.DataIntegrityDataType = dataclasses.field(metadata={'path_param': { 'field_name': 'dataType', 'style': 'simple', 'explode': False }}) r"""A key for a Codat data type.""" - @dataclasses.dataclass class GetDataIntegrityStatusResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" data_integrity_statuses: Optional[shared_dataintegritystatuses.DataIntegrityStatuses] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_data_integrity_summaries.py b/lending/src/codatlending/models/operations/get_data_integrity_summaries.py index c823fb008..4fe2ea5e3 100755 --- a/lending/src/codatlending/models/operations/get_data_integrity_summaries.py +++ b/lending/src/codatlending/models/operations/get_data_integrity_summaries.py @@ -9,10 +9,10 @@ from typing import Optional - @dataclasses.dataclass class GetDataIntegritySummariesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" data_type: shared_dataintegritydatatype.DataIntegrityDataType = dataclasses.field(metadata={'path_param': { 'field_name': 'dataType', 'style': 'simple', 'explode': False }}) r"""A key for a Codat data type.""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) @@ -21,15 +21,17 @@ class GetDataIntegritySummariesRequest: - @dataclasses.dataclass class GetDataIntegritySummariesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" data_integrity_summaries: Optional[shared_dataintegritysummaries.DataIntegritySummaries] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_data_status.py b/lending/src/codatlending/models/operations/get_data_status.py index 321711a5a..f6135ac0d 100755 --- a/lending/src/codatlending/models/operations/get_data_status.py +++ b/lending/src/codatlending/models/operations/get_data_status.py @@ -5,26 +5,28 @@ import requests as requests_http from ..shared import datastatus as shared_datastatus from ..shared import errormessage as shared_errormessage -from typing import Optional - +from typing import Dict, Optional @dataclasses.dataclass class GetDataStatusRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class GetDataStatusResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() - data_status_response: Optional[dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) + r"""HTTP response status code for this operation""" + data_status_response: Optional[Dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_excel_report_generation_status.py b/lending/src/codatlending/models/operations/get_excel_report_generation_status.py index 380aa03b2..4387fd00c 100755 --- a/lending/src/codatlending/models/operations/get_excel_report_generation_status.py +++ b/lending/src/codatlending/models/operations/get_excel_report_generation_status.py @@ -9,25 +9,27 @@ from typing import Optional - @dataclasses.dataclass class GetExcelReportGenerationStatusRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" report_type: shared_excelreporttypes.ExcelReportTypes = dataclasses.field(metadata={'query_param': { 'field_name': 'reportType', 'style': 'form', 'explode': True }}) r"""The type of report you want to generate and download.""" - @dataclasses.dataclass class GetExcelReportGenerationStatusResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" excel_status: Optional[shared_excelstatus.ExcelStatus] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_loan_summary.py b/lending/src/codatlending/models/operations/get_loan_summary.py index d08c25650..abb8b1962 100755 --- a/lending/src/codatlending/models/operations/get_loan_summary.py +++ b/lending/src/codatlending/models/operations/get_loan_summary.py @@ -5,26 +5,37 @@ import requests as requests_http from ..shared import errormessage as shared_errormessage from ..shared import loansummary as shared_loansummary +from enum import Enum from typing import Optional +class GetLoanSummarySourceType(str, Enum): + r"""Data source type.""" + BANKING = 'banking' + COMMERCE = 'commerce' + ACCOUNTING = 'accounting' @dataclasses.dataclass class GetLoanSummaryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" + source_type: GetLoanSummarySourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + r"""Data source type.""" - @dataclasses.dataclass class GetLoanSummaryResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" loan_summary: Optional[shared_loansummary.LoanSummary] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/get_pull_operation.py b/lending/src/codatlending/models/operations/get_pull_operation.py index b671bb1eb..09ba964b9 100755 --- a/lending/src/codatlending/models/operations/get_pull_operation.py +++ b/lending/src/codatlending/models/operations/get_pull_operation.py @@ -8,25 +8,27 @@ from typing import Optional - @dataclasses.dataclass class GetPullOperationRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" dataset_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'datasetId', 'style': 'simple', 'explode': False }}) - r"""Unique ID of a dataset or pull operation.""" + r"""Unique identifier for the dataset that completed its sync.""" - @dataclasses.dataclass class GetPullOperationResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py b/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py index b533777e7..2e8ea73f1 100755 --- a/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py +++ b/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py @@ -6,21 +6,23 @@ from typing import Optional - @dataclasses.dataclass class IsAgedCreditorsReportAvailableRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class IsAgedCreditorsReportAvailableResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" is_aged_creditors_report_available_200_application_json_boolean: Optional[bool] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py b/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py index 6e136de47..de5da8ea7 100755 --- a/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py +++ b/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py @@ -6,21 +6,23 @@ from typing import Optional - @dataclasses.dataclass class IsAgedDebtorsReportAvailableRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class IsAgedDebtorsReportAvailableResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" is_aged_debtors_report_available_200_application_json_boolean: Optional[bool] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_account_transactions.py b/lending/src/codatlending/models/operations/list_accounting_account_transactions.py index 7bc0058f4..2b81651ad 100755 --- a/lending/src/codatlending/models/operations/list_accounting_account_transactions.py +++ b/lending/src/codatlending/models/operations/list_accounting_account_transactions.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingAccountTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingAccountTransactionsRequest: - @dataclasses.dataclass class ListAccountingAccountTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_account_transactions: Optional[shared_accountingaccounttransactions.AccountingAccountTransactions] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_accounts.py b/lending/src/codatlending/models/operations/list_accounting_accounts.py index 54834b4a5..fa1a96656 100755 --- a/lending/src/codatlending/models/operations/list_accounting_accounts.py +++ b/lending/src/codatlending/models/operations/list_accounting_accounts.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingAccountsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingAccountsRequest: - @dataclasses.dataclass class ListAccountingAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_accounts: Optional[shared_accountingaccounts.AccountingAccounts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py b/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py index cb4d7c6e6..2ebad0ecb 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py +++ b/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py @@ -8,18 +8,19 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBankAccountTransactionsRequest: account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an account""" + r"""Unique identifier for an account.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -27,15 +28,17 @@ class ListAccountingBankAccountTransactionsRequest: - @dataclasses.dataclass class ListAccountingBankAccountTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bank_transactions: Optional[shared_accountingbanktransactions.AccountingBankTransactions] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py b/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py index 2768560b1..dd9640bd3 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py +++ b/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBankAccountsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingBankAccountsRequest: - @dataclasses.dataclass class ListAccountingBankAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bank_accounts: Optional[shared_accountingbankaccounts.AccountingBankAccounts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py b/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py index ee667b312..396869d02 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBillAttachmentsRequest: bill_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'billId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a bill""" + r"""Unique identifier for a bill.""" company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class ListAccountingBillAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py b/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py index a8f085c8f..e8652dcc7 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBillCreditNotesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingBillCreditNotesRequest: - @dataclasses.dataclass class ListAccountingBillCreditNotesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bill_credit_notes: Optional[shared_accountingbillcreditnotes.AccountingBillCreditNotes] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bill_payments.py b/lending/src/codatlending/models/operations/list_accounting_bill_payments.py index 4e478ac7a..d1cf2ac2b 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bill_payments.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_payments.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBillPaymentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingBillPaymentsRequest: - @dataclasses.dataclass class ListAccountingBillPaymentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bill_payments: Optional[shared_accountingbillpayments.AccountingBillPayments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_bills.py b/lending/src/codatlending/models/operations/list_accounting_bills.py index 03898efbe..96b63e120 100755 --- a/lending/src/codatlending/models/operations/list_accounting_bills.py +++ b/lending/src/codatlending/models/operations/list_accounting_bills.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingBillsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingBillsRequest: - @dataclasses.dataclass class ListAccountingBillsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_bills: Optional[shared_accountingbills.AccountingBills] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_credit_notes.py b/lending/src/codatlending/models/operations/list_accounting_credit_notes.py index fc2f783a2..3740d70dc 100755 --- a/lending/src/codatlending/models/operations/list_accounting_credit_notes.py +++ b/lending/src/codatlending/models/operations/list_accounting_credit_notes.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingCreditNotesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingCreditNotesRequest: - @dataclasses.dataclass class ListAccountingCreditNotesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_credit_notes: Optional[shared_accountingcreditnotes.AccountingCreditNotes] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py b/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py index 3f30b3a8f..8754a82de 100755 --- a/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py @@ -8,25 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingCustomerAttachmentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" customer_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'customerId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a customer.""" - @dataclasses.dataclass class ListAccountingCustomerAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_customers.py b/lending/src/codatlending/models/operations/list_accounting_customers.py index a209f4ef3..727445b24 100755 --- a/lending/src/codatlending/models/operations/list_accounting_customers.py +++ b/lending/src/codatlending/models/operations/list_accounting_customers.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingCustomersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingCustomersRequest: - @dataclasses.dataclass class ListAccountingCustomersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_customers: Optional[shared_accountingcustomers.AccountingCustomers] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py b/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py index b5ad0f334..6cdd41f47 100755 --- a/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingDirectCostAttachmentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_cost_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directCostId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct cost""" + r"""Unique identifier for a direct cost.""" - @dataclasses.dataclass class ListAccountingDirectCostAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_direct_costs.py b/lending/src/codatlending/models/operations/list_accounting_direct_costs.py index 203429e9f..16a6ad9da 100755 --- a/lending/src/codatlending/models/operations/list_accounting_direct_costs.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_costs.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingDirectCostsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingDirectCostsRequest: - @dataclasses.dataclass class ListAccountingDirectCostsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_direct_costs: Optional[shared_accountingdirectcosts.AccountingDirectCosts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py b/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py index d43be785d..3078e09ca 100755 --- a/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingDirectIncomeAttachmentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" direct_income_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'directIncomeId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a direct income""" + r"""Unique identifier for a direct income.""" - @dataclasses.dataclass class ListAccountingDirectIncomeAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py b/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py index 359c60e84..f34ca1d0a 100755 --- a/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingDirectIncomesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingDirectIncomesRequest: - @dataclasses.dataclass class ListAccountingDirectIncomesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_direct_incomes: Optional[shared_accountingdirectincomes.AccountingDirectIncomes] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py b/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py index 5c5d17541..7d04e8f0f 100755 --- a/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingInvoiceAttachmentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" invoice_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'invoiceId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for an invoice""" + r"""Unique identifier for an invoice.""" - @dataclasses.dataclass class ListAccountingInvoiceAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_invoices.py b/lending/src/codatlending/models/operations/list_accounting_invoices.py index bcfc33a56..9e1ef461d 100755 --- a/lending/src/codatlending/models/operations/list_accounting_invoices.py +++ b/lending/src/codatlending/models/operations/list_accounting_invoices.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingInvoicesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingInvoicesRequest: - @dataclasses.dataclass class ListAccountingInvoicesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_invoices: Optional[shared_accountinginvoices.AccountingInvoices] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_journal_entries.py b/lending/src/codatlending/models/operations/list_accounting_journal_entries.py index 8421947e5..8a33aad52 100755 --- a/lending/src/codatlending/models/operations/list_accounting_journal_entries.py +++ b/lending/src/codatlending/models/operations/list_accounting_journal_entries.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingJournalEntriesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingJournalEntriesRequest: - @dataclasses.dataclass class ListAccountingJournalEntriesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_journal_entries: Optional[shared_accountingjournalentries.AccountingJournalEntries] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_journals.py b/lending/src/codatlending/models/operations/list_accounting_journals.py index 8bbdebc48..e76248752 100755 --- a/lending/src/codatlending/models/operations/list_accounting_journals.py +++ b/lending/src/codatlending/models/operations/list_accounting_journals.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingJournalsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingJournalsRequest: - @dataclasses.dataclass class ListAccountingJournalsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_journals: Optional[shared_accountingjournals.AccountingJournals] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_payments.py b/lending/src/codatlending/models/operations/list_accounting_payments.py index 6951775da..a47496021 100755 --- a/lending/src/codatlending/models/operations/list_accounting_payments.py +++ b/lending/src/codatlending/models/operations/list_accounting_payments.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingPaymentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingPaymentsRequest: - @dataclasses.dataclass class ListAccountingPaymentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_payments: Optional[shared_accountingpayments.AccountingPayments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py b/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py index bb3f28d6c..45b424015 100755 --- a/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py @@ -8,26 +8,29 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingSupplierAttachmentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" supplier_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'supplierId', 'style': 'simple', 'explode': False }}) - r"""Unique identifier for a supplier""" + r"""Unique identifier for a supplier.""" - @dataclasses.dataclass class ListAccountingSupplierAttachmentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" attachments: Optional[shared_attachments.Attachments] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_suppliers.py b/lending/src/codatlending/models/operations/list_accounting_suppliers.py index 3f26a951c..f624e67f1 100755 --- a/lending/src/codatlending/models/operations/list_accounting_suppliers.py +++ b/lending/src/codatlending/models/operations/list_accounting_suppliers.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingSuppliersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListAccountingSuppliersRequest: - @dataclasses.dataclass class ListAccountingSuppliersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_suppliers: Optional[shared_accountingsuppliers.AccountingSuppliers] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_accounting_transfers.py b/lending/src/codatlending/models/operations/list_accounting_transfers.py index 050d2a2f0..8bc461b3f 100755 --- a/lending/src/codatlending/models/operations/list_accounting_transfers.py +++ b/lending/src/codatlending/models/operations/list_accounting_transfers.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListAccountingTransfersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListAccountingTransfersRequest: - @dataclasses.dataclass class ListAccountingTransfersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" accounting_transfers: Optional[shared_accountingtransfers.AccountingTransfers] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_banking_account_balances.py b/lending/src/codatlending/models/operations/list_banking_account_balances.py index 8f20daf1b..84e59d387 100755 --- a/lending/src/codatlending/models/operations/list_banking_account_balances.py +++ b/lending/src/codatlending/models/operations/list_banking_account_balances.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListBankingAccountBalancesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListBankingAccountBalancesRequest: - @dataclasses.dataclass class ListBankingAccountBalancesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_account_balances: Optional[shared_bankingaccountbalances.BankingAccountBalances] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_banking_accounts.py b/lending/src/codatlending/models/operations/list_banking_accounts.py index 83fd84aeb..7915f1043 100755 --- a/lending/src/codatlending/models/operations/list_banking_accounts.py +++ b/lending/src/codatlending/models/operations/list_banking_accounts.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListBankingAccountsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListBankingAccountsRequest: - @dataclasses.dataclass class ListBankingAccountsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_accounts: Optional[shared_bankingaccounts.BankingAccounts] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_banking_transaction_categories.py b/lending/src/codatlending/models/operations/list_banking_transaction_categories.py index 29d4e574f..487928436 100755 --- a/lending/src/codatlending/models/operations/list_banking_transaction_categories.py +++ b/lending/src/codatlending/models/operations/list_banking_transaction_categories.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListBankingTransactionCategoriesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListBankingTransactionCategoriesRequest: - @dataclasses.dataclass class ListBankingTransactionCategoriesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_transaction_categories: Optional[shared_bankingtransactioncategories.BankingTransactionCategories] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_banking_transactions.py b/lending/src/codatlending/models/operations/list_banking_transactions.py index 363b1d3a2..741782e98 100755 --- a/lending/src/codatlending/models/operations/list_banking_transactions.py +++ b/lending/src/codatlending/models/operations/list_banking_transactions.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListBankingTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListBankingTransactionsRequest: - @dataclasses.dataclass class ListBankingTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" banking_transactions: Optional[shared_bankingtransactions.BankingTransactions] = dataclasses.field(default=None) r"""Success""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_customers.py b/lending/src/codatlending/models/operations/list_commerce_customers.py index 99000572a..37b669f04 100755 --- a/lending/src/codatlending/models/operations/list_commerce_customers.py +++ b/lending/src/codatlending/models/operations/list_commerce_customers.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceCustomersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceCustomersRequest: - @dataclasses.dataclass class ListCommerceCustomersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_customers: Optional[shared_commercecustomers.CommerceCustomers] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_disputes.py b/lending/src/codatlending/models/operations/list_commerce_disputes.py index 43cc5c269..0df381cc5 100755 --- a/lending/src/codatlending/models/operations/list_commerce_disputes.py +++ b/lending/src/codatlending/models/operations/list_commerce_disputes.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceDisputesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceDisputesRequest: - @dataclasses.dataclass class ListCommerceDisputesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_disputes: Optional[shared_commercedisputes.CommerceDisputes] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_locations.py b/lending/src/codatlending/models/operations/list_commerce_locations.py index deee0ac17..1afe3f90e 100755 --- a/lending/src/codatlending/models/operations/list_commerce_locations.py +++ b/lending/src/codatlending/models/operations/list_commerce_locations.py @@ -8,24 +8,27 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceLocationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" - @dataclasses.dataclass class ListCommerceLocationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_locations: Optional[shared_commercelocations.CommerceLocations] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_orders.py b/lending/src/codatlending/models/operations/list_commerce_orders.py index acca262ce..8bf158f4e 100755 --- a/lending/src/codatlending/models/operations/list_commerce_orders.py +++ b/lending/src/codatlending/models/operations/list_commerce_orders.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceOrdersRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceOrdersRequest: - @dataclasses.dataclass class ListCommerceOrdersResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_orders: Optional[shared_commerceorders.CommerceOrders] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_payment_methods.py b/lending/src/codatlending/models/operations/list_commerce_payment_methods.py index 8775988fd..cbd25a49c 100755 --- a/lending/src/codatlending/models/operations/list_commerce_payment_methods.py +++ b/lending/src/codatlending/models/operations/list_commerce_payment_methods.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommercePaymentMethodsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommercePaymentMethodsRequest: - @dataclasses.dataclass class ListCommercePaymentMethodsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payment_methods: Optional[shared_commercepaymentmethods.CommercePaymentMethods] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_payments.py b/lending/src/codatlending/models/operations/list_commerce_payments.py index b3c3f068f..b8761efb2 100755 --- a/lending/src/codatlending/models/operations/list_commerce_payments.py +++ b/lending/src/codatlending/models/operations/list_commerce_payments.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommercePaymentsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommercePaymentsRequest: - @dataclasses.dataclass class ListCommercePaymentsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_payments: Optional[shared_commercepayments.CommercePayments] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_product_categories.py b/lending/src/codatlending/models/operations/list_commerce_product_categories.py index a7f9c9e81..80bd4f722 100755 --- a/lending/src/codatlending/models/operations/list_commerce_product_categories.py +++ b/lending/src/codatlending/models/operations/list_commerce_product_categories.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceProductCategoriesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceProductCategoriesRequest: - @dataclasses.dataclass class ListCommerceProductCategoriesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_product_categories: Optional[shared_commerceproductcategories.CommerceProductCategories] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_products.py b/lending/src/codatlending/models/operations/list_commerce_products.py index 728b192db..68e5d0c7d 100755 --- a/lending/src/codatlending/models/operations/list_commerce_products.py +++ b/lending/src/codatlending/models/operations/list_commerce_products.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceProductsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceProductsRequest: - @dataclasses.dataclass class ListCommerceProductsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_products: Optional[shared_commerceproducts.CommerceProducts] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_commerce_transactions.py b/lending/src/codatlending/models/operations/list_commerce_transactions.py index 74c26b936..1fe8bf4bf 100755 --- a/lending/src/codatlending/models/operations/list_commerce_transactions.py +++ b/lending/src/codatlending/models/operations/list_commerce_transactions.py @@ -8,16 +8,17 @@ from typing import Optional - @dataclasses.dataclass class ListCommerceTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -25,15 +26,17 @@ class ListCommerceTransactionsRequest: - @dataclasses.dataclass class ListCommerceTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" commerce_transactions: Optional[shared_commercetransactions.CommerceTransactions] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_companies.py b/lending/src/codatlending/models/operations/list_companies.py index bef24c7d7..601c3326c 100755 --- a/lending/src/codatlending/models/operations/list_companies.py +++ b/lending/src/codatlending/models/operations/list_companies.py @@ -8,14 +8,13 @@ from typing import Optional - @dataclasses.dataclass class ListCompaniesRequest: order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -23,15 +22,17 @@ class ListCompaniesRequest: - @dataclasses.dataclass class ListCompaniesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" companies: Optional[shared_companies.Companies] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_connections.py b/lending/src/codatlending/models/operations/list_connections.py index a8f988177..8c85c3ad3 100755 --- a/lending/src/codatlending/models/operations/list_connections.py +++ b/lending/src/codatlending/models/operations/list_connections.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListConnectionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListConnectionsRequest: - @dataclasses.dataclass class ListConnectionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connections: Optional[shared_connections.Connections] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_create_operations.py b/lending/src/codatlending/models/operations/list_create_operations.py index 06a45cd28..9aa9632cc 100755 --- a/lending/src/codatlending/models/operations/list_create_operations.py +++ b/lending/src/codatlending/models/operations/list_create_operations.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListCreateOperationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListCreateOperationsRequest: - @dataclasses.dataclass class ListCreateOperationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" push_operations: Optional[shared_pushoperations.PushOperations] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_data_integrity_details.py b/lending/src/codatlending/models/operations/list_data_integrity_details.py index 3fb3ed998..ff41cdbc6 100755 --- a/lending/src/codatlending/models/operations/list_data_integrity_details.py +++ b/lending/src/codatlending/models/operations/list_data_integrity_details.py @@ -9,17 +9,17 @@ from typing import Optional - @dataclasses.dataclass class ListDataIntegrityDetailsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" data_type: shared_dataintegritydatatype.DataIntegrityDataType = dataclasses.field(metadata={'path_param': { 'field_name': 'dataType', 'style': 'simple', 'explode': False }}) r"""A key for a Codat data type.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -27,15 +27,17 @@ class ListDataIntegrityDetailsRequest: - @dataclasses.dataclass class ListDataIntegrityDetailsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" data_integrity_details: Optional[shared_dataintegritydetails.DataIntegrityDetails] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_files.py b/lending/src/codatlending/models/operations/list_files.py index 12fdcd704..80adbc08f 100755 --- a/lending/src/codatlending/models/operations/list_files.py +++ b/lending/src/codatlending/models/operations/list_files.py @@ -5,26 +5,28 @@ import requests as requests_http from ..shared import errormessage as shared_errormessage from ..shared import file as shared_file -from typing import Optional - +from typing import List, Optional @dataclasses.dataclass class ListFilesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class ListFilesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" - files: Optional[list[shared_file.File]] = dataclasses.field(default=None) + files: Optional[List[shared_file.File]] = dataclasses.field(default=None) r"""Success""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_loan_transactions.py b/lending/src/codatlending/models/operations/list_loan_transactions.py index 2b6212e61..7e1c74ffb 100755 --- a/lending/src/codatlending/models/operations/list_loan_transactions.py +++ b/lending/src/codatlending/models/operations/list_loan_transactions.py @@ -9,31 +9,33 @@ from typing import Optional class ListLoanTransactionsSourceType(str, Enum): - r"""Data source type""" + r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' ACCOUNTING = 'accounting' - @dataclasses.dataclass class ListLoanTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" source_type: ListLoanTransactionsSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) - r"""Data source type""" + r"""Data source type.""" - @dataclasses.dataclass class ListLoanTransactionsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" loan_transactions: Optional[shared_loantransactions.LoanTransactions] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_pull_operations.py b/lending/src/codatlending/models/operations/list_pull_operations.py index 25f30893d..609e02e50 100755 --- a/lending/src/codatlending/models/operations/list_pull_operations.py +++ b/lending/src/codatlending/models/operations/list_pull_operations.py @@ -8,15 +8,15 @@ from typing import Optional - @dataclasses.dataclass class ListPullOperationsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -24,15 +24,17 @@ class ListPullOperationsRequest: - @dataclasses.dataclass class ListPullOperationsResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your `query` parameter was not correctly formed""" pull_operations: Optional[shared_pulloperations.PullOperations] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/list_reconciled_invoices.py b/lending/src/codatlending/models/operations/list_reconciled_invoices.py index 852843fe4..c6648382f 100755 --- a/lending/src/codatlending/models/operations/list_reconciled_invoices.py +++ b/lending/src/codatlending/models/operations/list_reconciled_invoices.py @@ -8,13 +8,13 @@ from typing import Optional - @dataclasses.dataclass class ListReconciledInvoicesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) + r"""Unique identifier for a company.""" + page: Optional[int] = dataclasses.field(default=1, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) + page_size: Optional[int] = dataclasses.field(default=100, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" @@ -22,15 +22,17 @@ class ListReconciledInvoicesRequest: - @dataclasses.dataclass class ListReconciledInvoicesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" enhanced_invoices_report: Optional[shared_enhancedinvoicesreport.EnhancedInvoicesReport] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/refresh_all_data_types.py b/lending/src/codatlending/models/operations/refresh_all_data_types.py index 1380cf252..526ab213e 100755 --- a/lending/src/codatlending/models/operations/refresh_all_data_types.py +++ b/lending/src/codatlending/models/operations/refresh_all_data_types.py @@ -7,21 +7,23 @@ from typing import Optional - @dataclasses.dataclass class RefreshAllDataTypesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" - @dataclasses.dataclass class RefreshAllDataTypesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/refresh_data_type.py b/lending/src/codatlending/models/operations/refresh_data_type.py index 23151273d..ad5ef640d 100755 --- a/lending/src/codatlending/models/operations/refresh_data_type.py +++ b/lending/src/codatlending/models/operations/refresh_data_type.py @@ -9,10 +9,10 @@ from typing import Optional - @dataclasses.dataclass class RefreshDataTypeRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" data_type: shared_datatype.DataType = dataclasses.field(metadata={'path_param': { 'field_name': 'dataType', 'style': 'simple', 'explode': False }}) r"""The key of a Codat data type""" connection_id: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'connectionId', 'style': 'form', 'explode': True }}) @@ -21,15 +21,17 @@ class RefreshDataTypeRequest: - @dataclasses.dataclass class RefreshDataTypeResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/unlink_connection.py b/lending/src/codatlending/models/operations/unlink_connection.py index 1339ae290..7c5f18780 100755 --- a/lending/src/codatlending/models/operations/unlink_connection.py +++ b/lending/src/codatlending/models/operations/unlink_connection.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class UnlinkConnectionUpdateConnection: status: Optional[shared_dataconnectionstatus.DataConnectionStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) @@ -21,25 +20,28 @@ class UnlinkConnectionUpdateConnection: - @dataclasses.dataclass class UnlinkConnectionRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" request_body: Optional[UnlinkConnectionUpdateConnection] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UnlinkConnectionResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/update_company.py b/lending/src/codatlending/models/operations/update_company.py index 22578dcd0..6f159a98a 100755 --- a/lending/src/codatlending/models/operations/update_company.py +++ b/lending/src/codatlending/models/operations/update_company.py @@ -9,24 +9,26 @@ from typing import Optional - @dataclasses.dataclass class UpdateCompanyRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" company_request_body: Optional[shared_companyrequestbody.CompanyRequestBody] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - @dataclasses.dataclass class UpdateCompanyResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/operations/upload_files.py b/lending/src/codatlending/models/operations/upload_files.py index e5338d3ca..9276fa0e7 100755 --- a/lending/src/codatlending/models/operations/upload_files.py +++ b/lending/src/codatlending/models/operations/upload_files.py @@ -7,7 +7,6 @@ from typing import Optional - @dataclasses.dataclass class UploadFilesRequestBody: content: bytes = dataclasses.field(metadata={'multipart_form': { 'content': True }}) @@ -16,23 +15,26 @@ class UploadFilesRequestBody: - @dataclasses.dataclass class UploadFilesRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a company.""" connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) + r"""Unique identifier for a connection.""" request_body: Optional[UploadFilesRequestBody] = dataclasses.field(default=None, metadata={'multipart_form': { 'file': True }, 'request': { 'media_type': 'multipart/form-data' }}) - @dataclasses.dataclass class UploadFilesResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""The request made is not valid.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/shared/__init__.py b/lending/src/codatlending/models/shared/__init__.py index dff16e2d5..9c069526b 100755 --- a/lending/src/codatlending/models/shared/__init__.py +++ b/lending/src/codatlending/models/shared/__init__.py @@ -31,10 +31,10 @@ from .accountingcashflowstatement import * from .accountingcompanyinfo import * from .accountingcreateaccountresponse import * -from .accountingcreatebankaccountresponse import * from .accountingcreatebanktransactions import * from .accountingcreatebanktransactionsresponse import * from .accountingcreatedirectcostresponse import * +from .accountingcreatepaymentresponse import * from .accountingcreatesupplierresponse import * from .accountingcreatetransferresponse import * from .accountingcreditnote import * @@ -203,7 +203,7 @@ from .paymentline import * from .paymentlinelink import * from .paymentlinktype import * -from .paymentmethodstatus import * +from .paymentmethodref import * from .paymentref import * from .paymentstatus import * from .paymenttype import * @@ -264,4 +264,4 @@ from .validationitem import * from .weblink import * -__all__ = ["AccountBalance","AccountBalanceAmounts","AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategoryLevel","AccountIdentifierType","AccountIdentifiers","AccountInstitution","AccountRef","AccountStatus","AccountTransactionLine","AccountType","AccountingAccount","AccountingAccountTransaction","AccountingAccountTransactionStatus","AccountingAccountTransactions","AccountingAccountValidDataTypeLinks","AccountingAccounts","AccountingAddress","AccountingAddressType","AccountingAgedCreditorReport","AccountingAgedDebtorReport","AccountingAttachment","AccountingBalanceSheet","AccountingBankAccount","AccountingBankAccountType","AccountingBankAccounts","AccountingBankTransaction","AccountingBankTransactions","AccountingBill","AccountingBillCreditNote","AccountingBillCreditNotes","AccountingBillPayment","AccountingBillPayments","AccountingBillPurchaseOrderReference","AccountingBillWithholdingTax","AccountingBills","AccountingCashFlowStatement","AccountingCompanyInfo","AccountingCreateAccountResponse","AccountingCreateBankAccountResponse","AccountingCreateBankTransactions","AccountingCreateBankTransactionsResponse","AccountingCreateDirectCostResponse","AccountingCreateSupplierResponse","AccountingCreateTransferResponse","AccountingCreditNote","AccountingCreditNotes","AccountingCustomer","AccountingCustomerRef","AccountingCustomers","AccountingDirectCost","AccountingDirectCosts","AccountingDirectIncome","AccountingDirectIncomes","AccountingInvoice","AccountingInvoiceSalesOrderReference","AccountingInvoices","AccountingJournal","AccountingJournalEntries","AccountingJournalEntry","AccountingJournals","AccountingPayment","AccountingPaymentAllocation","AccountingPaymentAllocationAllocation","AccountingPayments","AccountingProfitAndLossReport","AccountingSupplier","AccountingSuppliers","AccountingTransfer","AccountingTransferContactRef","AccountingTransfers","Accounts","AccountsPayableTracking","AccountsReceivableTracking","AccountsReceivableTrackingRecordReference","AgedCreditor","AgedCurrencyOutstanding","AgedDebtor","AgedOutstandingAmount","AgedOutstandingAmountDetail","Attachments","BalanceSheet","BankAccountRef","BankTransactionType","BankingAccount","BankingAccountBalance","BankingAccountBalances","BankingAccounts","BankingTransaction","BankingTransactionCategories","BankingTransactionCategory","BankingTransactionRef","BankingTransactions","BillCreditNoteLineItem","BillCreditNoteLineItemItemReference","BillCreditNoteLineItemTaxRateReference","BillCreditNoteStatus","BillLineItem","BillPaymentLine","BillPaymentLineLink","BillPaymentLineLinkType","BillStatus","BilledToType","BilledToType1","CashFlowStatement","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","CommerceAddress","CommerceAddressType","CommerceCompanyInfo","CommerceCustomer","CommerceCustomerRef","CommerceCustomers","CommerceDispute","CommerceDisputes","CommerceLocation","CommerceLocations","CommerceOrder","CommerceOrderSupplementalData","CommerceOrders","CommercePayment","CommercePaymentMethod","CommercePaymentMethods","CommercePayments","CommerceProduct","CommerceProductCategories","CommerceProductCategory","CommerceProducts","CommerceRecordRef","CommerceReport","CommerceReportComponent","CommerceReportDimension","CommerceReportDimensionItems","CommerceReportError","CommerceReportMeasure","CommerceTransaction","CommerceTransactions","Companies","Company","CompanyRequestBody","Connection","ConnectionSourceType","Connections","Contact","ContactRef","CreateBankAccountTransaction","CreditNoteLineItem","CreditNoteStatus","CustomerStatus","DataConnectionError","DataConnectionStatus","DataIntegrityAmounts","DataIntegrityByAmount","DataIntegrityByCount","DataIntegrityConnectionID","DataIntegrityDataType","DataIntegrityDates","DataIntegrityDetail","DataIntegrityDetails","DataIntegrityMatch","DataIntegrityStatus","DataIntegrityStatusInfo","DataIntegrityStatuses","DataIntegritySummaries","DataIntegritySummary","DataSource","DataStatus","DataType","DefinitionsitemRef","DirectCostLineItem","DirectIncomeLineItem","DisputeStatus","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedFinancialReport","EnhancedFinancialReportReportItem","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedReportAccountCategory","EnhancedReportInfo","ErrorMessage","ExcelReportTypes","ExcelStatus","File","HalRef","IntegrityStatus","InvoiceLineItem","InvoiceStatus","ItemRef","Items","JournalLine","JournalLineTracking","JournalRef","JournalStatus","LendingCustomerRef","Links","LoanRef","LoanSummary","LoanSummaryIntegrationType","LoanSummaryRecordRef","LoanSummaryRecordRefType","LoanSummaryReportInfo","LoanSummaryReportItem","LoanTransactions","LoanTransactionsReportInfo","LocationRef","Metadata","OrderDiscountAllocation","OrderLineItem","Payment","PaymentAllocationPayment","PaymentLine","PaymentLineLink","PaymentLinkType","PaymentMethodStatus","PaymentRef","PaymentStatus","PaymentType","PeriodUnit","PhoneNumber","PhoneNumberType","ProductInventory","ProductInventoryLocation","ProductPrice","ProductRef","ProductVariant","ProductVariantRef","ProductVariantStatus","ProfitAndLossReport","ProjectRef","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","RecordRef","ReportBasis","ReportComponentMeasure","ReportInfo","ReportInput","ReportItems","ReportItemsLoanTransactionType","ReportLine","Security","ServiceCharge","ServiceChargeType","SourceRef","SupplementalData","SupplierRef","SupplierStatus","TaxComponentAllocation","TaxComponentRef","TaxRateRef","Tracking","TrackingCategoryRef","TransactionCategory","TransactionCategoryRef","TransactionCategoryStatus","TransactionCode","TransactionSourceRef","TransactionSourceType","TransactionType","TransferAccount","Validation","ValidationItem","WebLink","WebLinkType"] +__all__ = ["AccountBalance","AccountBalanceAmounts","AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategoryLevel","AccountIdentifierType","AccountIdentifiers","AccountInstitution","AccountRef","AccountStatus","AccountTransactionLine","AccountType","AccountingAccount","AccountingAccountTransaction","AccountingAccountTransactionStatus","AccountingAccountTransactions","AccountingAccountValidDataTypeLinks","AccountingAccounts","AccountingAddress","AccountingAddressType","AccountingAgedCreditorReport","AccountingAgedDebtorReport","AccountingAttachment","AccountingBalanceSheet","AccountingBankAccount","AccountingBankAccountType","AccountingBankAccounts","AccountingBankTransaction","AccountingBankTransactions","AccountingBill","AccountingBillCreditNote","AccountingBillCreditNotes","AccountingBillPayment","AccountingBillPayments","AccountingBillPurchaseOrderReference","AccountingBillWithholdingTax","AccountingBills","AccountingCashFlowStatement","AccountingCompanyInfo","AccountingCreateAccountResponse","AccountingCreateBankTransactions","AccountingCreateBankTransactionsResponse","AccountingCreateDirectCostResponse","AccountingCreatePaymentResponse","AccountingCreateSupplierResponse","AccountingCreateTransferResponse","AccountingCreditNote","AccountingCreditNotes","AccountingCustomer","AccountingCustomerRef","AccountingCustomers","AccountingDirectCost","AccountingDirectCosts","AccountingDirectIncome","AccountingDirectIncomes","AccountingInvoice","AccountingInvoiceSalesOrderReference","AccountingInvoices","AccountingJournal","AccountingJournalEntries","AccountingJournalEntry","AccountingJournals","AccountingPayment","AccountingPaymentAllocation","AccountingPaymentAllocationAllocation","AccountingPayments","AccountingProfitAndLossReport","AccountingSupplier","AccountingSuppliers","AccountingTransfer","AccountingTransferContactRef","AccountingTransfers","Accounts","AccountsPayableTracking","AccountsReceivableTracking","AccountsReceivableTrackingRecordReference","AgedCreditor","AgedCurrencyOutstanding","AgedDebtor","AgedOutstandingAmount","AgedOutstandingAmountDetail","Attachments","BalanceSheet","BankAccountRef","BankTransactionType","BankingAccount","BankingAccountBalance","BankingAccountBalances","BankingAccounts","BankingTransaction","BankingTransactionCategories","BankingTransactionCategory","BankingTransactionRef","BankingTransactions","BillCreditNoteLineItem","BillCreditNoteLineItemItemReference","BillCreditNoteLineItemTaxRateReference","BillCreditNoteStatus","BillLineItem","BillLineItemRecordLineReference","BillLineItemRecordLineReferenceDataType","BillPaymentLine","BillPaymentLineLink","BillPaymentLineLinkType","BillStatus","BilledToType","BilledToType1","CashFlowStatement","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","CommerceAddress","CommerceAddressType","CommerceCompanyInfo","CommerceCustomer","CommerceCustomerRef","CommerceCustomers","CommerceDispute","CommerceDisputes","CommerceLocation","CommerceLocations","CommerceOrder","CommerceOrders","CommercePayment","CommercePaymentMethod","CommercePaymentMethodStatus","CommercePaymentMethods","CommercePayments","CommerceProduct","CommerceProductCategories","CommerceProductCategory","CommerceProducts","CommerceRecordRef","CommerceReport","CommerceReportComponent","CommerceReportDimension","CommerceReportDimensionItems","CommerceReportError","CommerceReportMeasure","CommerceTransaction","CommerceTransactions","Companies","Company","CompanyRequestBody","Connection","ConnectionSourceType","Connections","Contact","ContactRef","CreateBankAccountTransaction","CreditNoteLineItem","CreditNoteStatus","CustomerStatus","DataConnectionError","DataConnectionStatus","DataIntegrityAmounts","DataIntegrityByAmount","DataIntegrityByCount","DataIntegrityConnectionID","DataIntegrityDataType","DataIntegrityDates","DataIntegrityDetail","DataIntegrityDetails","DataIntegrityMatch","DataIntegrityStatus","DataIntegrityStatusInfo","DataIntegrityStatuses","DataIntegritySummaries","DataIntegritySummary","DataSource","DataStatus","DataStatusDataTypes","DataType","DefinitionsitemRef","DirectCostLineItem","DirectIncomeLineItem","DisputeStatus","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedFinancialReport","EnhancedFinancialReportReportItem","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedReportAccountCategory","EnhancedReportInfo","ErrorMessage","ExcelReportTypes","ExcelStatus","File","HalRef","IntegrityStatus","InvoiceLineItem","InvoiceStatus","ItemRef","Items","JournalLine","JournalLineTracking","JournalRef","JournalStatus","LendingCustomerRef","Links","LoanRef","LoanSummary","LoanSummaryIntegrationType","LoanSummaryRecordRef","LoanSummaryRecordRefType","LoanSummaryReportInfo","LoanSummaryReportItem","LoanTransactions","LoanTransactionsReportInfo","LocationRef","Metadata","OrderDiscountAllocation","OrderLineItem","Payment","PaymentAllocationPayment","PaymentLine","PaymentLineLink","PaymentLinkType","PaymentMethodRef","PaymentRef","PaymentStatus","PaymentType","PeriodUnit","PhoneNumber","PhoneNumberType","ProductInventory","ProductInventoryLocation","ProductPrice","ProductRef","ProductVariant","ProductVariantRef","ProductVariantStatus","ProfitAndLossReport","ProjectRef","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","RecordRef","ReportBasis","ReportComponentMeasure","ReportInfo","ReportInput","ReportItems","ReportItemsLoanTransactionType","ReportLine","Security","ServiceCharge","ServiceChargeType","SourceRef","SupplementalData","SupplierRef","SupplierStatus","TaxComponentAllocation","TaxComponentRef","TaxRateRef","Tracking","TrackingCategoryRef","TransactionCategory","TransactionCategoryRef","TransactionCategoryStatus","TransactionCode","TransactionSourceRef","TransactionSourceType","TransactionType","TransferAccount","Validation","ValidationItem","WebLink","WebLinkType"] diff --git a/lending/src/codatlending/models/shared/accountbalance.py b/lending/src/codatlending/models/shared/accountbalance.py index 4641e95fd..a21ce60e1 100755 --- a/lending/src/codatlending/models/shared/accountbalance.py +++ b/lending/src/codatlending/models/shared/accountbalance.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountBalance: available: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('available'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountbalanceamounts.py b/lending/src/codatlending/models/shared/accountbalanceamounts.py index 85fda41bf..4f17e33c1 100755 --- a/lending/src/codatlending/models/shared/accountbalanceamounts.py +++ b/lending/src/codatlending/models/shared/accountbalanceamounts.py @@ -9,15 +9,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountBalanceAmounts: r"""Depending on the data provided by the underlying bank, not all balances are always available.""" - available: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('available'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + available: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('available'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The balance available in the account, including any pending transactions. This doesn't include additional funds available from any overdrafts.""" current: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The balance of the account only including cleared transactions.""" - limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('limit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('limit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The minimum allowed balance for the account. For example, a $100.00 overdraft would show as a limit of `-100.00`.""" diff --git a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py index a22a19c8d..76a65434d 100755 --- a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py +++ b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountCategoriesUpdatedWebhook: r"""Webhook request body for account categories updated.""" diff --git a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py index 0e41f370b..a05c488d6 100755 --- a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py +++ b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountCategoriesUpdatedWebhookData: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountcategorylevel.py b/lending/src/codatlending/models/shared/accountcategorylevel.py index 484f6c5ef..775594e28 100755 --- a/lending/src/codatlending/models/shared/accountcategorylevel.py +++ b/lending/src/codatlending/models/shared/accountcategorylevel.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountCategoryLevel: r"""An object containing an ordered list of account category levels.""" diff --git a/lending/src/codatlending/models/shared/accountidentifiers.py b/lending/src/codatlending/models/shared/accountidentifiers.py index 8be458e2e..7b88e39fc 100755 --- a/lending/src/codatlending/models/shared/accountidentifiers.py +++ b/lending/src/codatlending/models/shared/accountidentifiers.py @@ -9,13 +9,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountIdentifiers: r"""An object containing bank account identification information.""" type: shared_accountidentifiertype.AccountIdentifierType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""Type of account""" - bank_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankCode'), 'exclude': lambda f: f is None }}) + bank_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankCode') }}) r"""The local (usually national) routing number for the account. This is known by different names in different countries: @@ -23,15 +22,15 @@ class AccountIdentifiers: * routing number (Canada, USA) * sort code (UK) """ - bic: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bic'), 'exclude': lambda f: f is None }}) + bic: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bic') }}) r"""The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.""" - iban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iban'), 'exclude': lambda f: f is None }}) + iban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iban') }}) r"""The international bank account number (IBAN) for the account, if known.""" - masked_account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('maskedAccountNumber'), 'exclude': lambda f: f is None }}) + masked_account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('maskedAccountNumber') }}) r"""A portion of the actual account `number` to help account identification where number is tokenised (Plaid only)""" - number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number'), 'exclude': lambda f: f is None }}) + number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) r"""The account number for the account. When combined with the`bankCode`, this is usually enough to uniquely identify an account within a jurisdiction.""" - subtype: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subtype'), 'exclude': lambda f: f is None }}) + subtype: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subtype') }}) r"""Detailed account category""" diff --git a/lending/src/codatlending/models/shared/accountingaccount.py b/lending/src/codatlending/models/shared/accountingaccount.py index e6fa7e842..aeb81b4d7 100755 --- a/lending/src/codatlending/models/shared/accountingaccount.py +++ b/lending/src/codatlending/models/shared/accountingaccount.py @@ -5,14 +5,14 @@ from ..shared import accountstatus as shared_accountstatus from ..shared import accounttype as shared_accounttype from ..shared import metadata as shared_metadata +from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccountValidDataTypeLinks: r"""When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data. @@ -56,16 +56,15 @@ class AccountingAccountValidDataTypeLinks: If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. """ - links: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links'), 'exclude': lambda f: f is None }}) + links: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links') }}) r"""Supported `dataTypes` that the record can be linked to.""" - property: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('property'), 'exclude': lambda f: f is None }}) + property: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('property') }}) r"""The property from the account that can be linked.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccount: r"""> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. @@ -88,7 +87,7 @@ class AccountingAccount: At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided. To determine the list of allowed categories for a specific integration, you can: - - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). + - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). - Refer to the integration's own documentation. > **Accounts with no category** @@ -106,16 +105,16 @@ class AccountingAccount: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - current_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + current_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Current balance in the account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description for the account.""" - fully_qualified_category: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedCategory'), 'exclude': lambda f: f is None }}) + fully_qualified_category: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedCategory') }}) r"""Full category of the account. For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. """ - fully_qualified_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedName'), 'exclude': lambda f: f is None }}) + fully_qualified_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fullyQualifiedName') }}) r"""Full name of the account, for example: - `Cash On Hand` - `Rents Held In Trust` @@ -127,16 +126,21 @@ class AccountingAccount: r"""Confirms whether the account is a bank account or not.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the account.""" - nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode'), 'exclude': lambda f: f is None }}) + nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode') }}) r"""Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_accountstatus.AccountStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the account""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ type: Optional[shared_accounttype.AccountType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) r"""Type of account""" - valid_datatype_links: Optional[list[AccountingAccountValidDataTypeLinks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validDatatypeLinks'), 'exclude': lambda f: f is None }}) - r"""The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks).""" + valid_datatype_links: Optional[List[AccountingAccountValidDataTypeLinks]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validDatatypeLinks') }}) + r"""The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/lending-api#/schemas/ValidDataTypeLinks).""" diff --git a/lending/src/codatlending/models/shared/accountingaccounts.py b/lending/src/codatlending/models/shared/accountingaccounts.py index befdc19bc..d04035a1a 100755 --- a/lending/src/codatlending/models/shared/accountingaccounts.py +++ b/lending/src/codatlending/models/shared/accountingaccounts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccounts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingaccount.AccountingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingaccount.AccountingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingaccounttransaction.py b/lending/src/codatlending/models/shared/accountingaccounttransaction.py index 4e873b837..7cfa1e907 100755 --- a/lending/src/codatlending/models/shared/accountingaccounttransaction.py +++ b/lending/src/codatlending/models/shared/accountingaccounttransaction.py @@ -9,7 +9,7 @@ from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum -from typing import Optional +from typing import List, Optional class AccountingAccountTransactionStatus(str, Enum): r"""The status of the account transaction.""" @@ -20,10 +20,9 @@ class AccountingAccountTransactionStatus(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccountTransaction: - r"""> **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions). + r"""> **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). > View the coverage for account transactions in the Data coverage explorer. @@ -39,7 +38,7 @@ class AccountingAccountTransaction: * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. * Transfers: for example, transferring money between two bank accounts. - Account transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer). + Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). """ bank_account_ref: Optional[shared_bankaccountref.BankAccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankAccountRef'), 'exclude': lambda f: f is None }}) r"""Links to the Account transactions data type.""" @@ -52,7 +51,7 @@ class AccountingAccountTransaction: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -102,18 +101,18 @@ class AccountingAccountTransaction: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier of the direct cost (unique to the company).""" - lines: Optional[list[shared_accounttransactionline.AccountTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_accounttransactionline.AccountTransactionLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines') }}) r"""Array of account transaction lines.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Additional information about the account transaction, if available.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[AccountingAccountTransactionStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""The status of the account transaction.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total amount of the account transactions, inclusive of tax.""" - transaction_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionId'), 'exclude': lambda f: f is None }}) + transaction_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionId') }}) r"""Identifier of the transaction (unique to the company).""" diff --git a/lending/src/codatlending/models/shared/accountingaccounttransactions.py b/lending/src/codatlending/models/shared/accountingaccounttransactions.py index 40e940e11..5565b9746 100755 --- a/lending/src/codatlending/models/shared/accountingaccounttransactions.py +++ b/lending/src/codatlending/models/shared/accountingaccounttransactions.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAccountTransactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingaccounttransaction.AccountingAccountTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingaccounttransaction.AccountingAccountTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingaddress.py b/lending/src/codatlending/models/shared/accountingaddress.py index 63e13cfcb..654f404d3 100755 --- a/lending/src/codatlending/models/shared/accountingaddress.py +++ b/lending/src/codatlending/models/shared/accountingaddress.py @@ -9,22 +9,21 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAddress: type: shared_accountingaddresstype.AccountingAddressType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of the address""" - city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) + city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city') }}) r"""City of the customer address.""" - country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country'), 'exclude': lambda f: f is None }}) + country: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country') }}) r"""Country of the customer address.""" - line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1'), 'exclude': lambda f: f is None }}) + line1: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line1') }}) r"""Line 1 of the customer address.""" - line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2'), 'exclude': lambda f: f is None }}) + line2: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('line2') }}) r"""Line 2 of the customer address.""" - postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode'), 'exclude': lambda f: f is None }}) + postal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postalCode') }}) r"""Postal code or zip code.""" - region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) + region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region') }}) r"""Region of the customer address.""" diff --git a/lending/src/codatlending/models/shared/accountingagedcreditorreport.py b/lending/src/codatlending/models/shared/accountingagedcreditorreport.py index 73d45df67..5d454ef26 100755 --- a/lending/src/codatlending/models/shared/accountingagedcreditorreport.py +++ b/lending/src/codatlending/models/shared/accountingagedcreditorreport.py @@ -5,11 +5,10 @@ from ..shared import agedcreditor as shared_agedcreditor from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAgedCreditorReport: r"""The Aged Creditors report shows the total balance owed by a business to its suppliers over time. @@ -22,7 +21,7 @@ class AccountingAgedCreditorReport: ## Underlying data - The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). + The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. @@ -45,7 +44,7 @@ class AccountingAgedCreditorReport: The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes. """ - data: Optional[list[shared_agedcreditor.AgedCreditor]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[List[shared_agedcreditor.AgedCreditor]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) r"""Array of aged creditor.""" generated: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generated'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/accountingageddebtorreport.py b/lending/src/codatlending/models/shared/accountingageddebtorreport.py index fd58fa8b6..0c46b8db6 100755 --- a/lending/src/codatlending/models/shared/accountingageddebtorreport.py +++ b/lending/src/codatlending/models/shared/accountingageddebtorreport.py @@ -5,11 +5,10 @@ from ..shared import ageddebtor as shared_ageddebtor from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAgedDebtorReport: r"""The Aged Debtors report shows the total outstanding balance due from customers to the business over time. @@ -22,7 +21,7 @@ class AccountingAgedDebtorReport: ## Underlying data - The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment). + The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. @@ -45,7 +44,7 @@ class AccountingAgedDebtorReport: The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes. """ - data: Optional[list[shared_ageddebtor.AgedDebtor]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[List[shared_ageddebtor.AgedDebtor]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) r"""Array of aged debtors.""" generated: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generated'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/accountingattachment.py b/lending/src/codatlending/models/shared/accountingattachment.py index 9a0c1811c..5eb48deb2 100755 --- a/lending/src/codatlending/models/shared/accountingattachment.py +++ b/lending/src/codatlending/models/shared/accountingattachment.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingAttachment: r"""The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. @@ -17,7 +16,7 @@ class AccountingAttachment: > > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. - Unlike other data types, Codat doesn't support sync settings for attachments. + Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. Note that different integrations have different requirements to file size and extension of attachments. @@ -29,7 +28,7 @@ class AccountingAttachment: View the coverage for accounts in the Data coverage explorer. """ - content_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contentType'), 'exclude': lambda f: f is None }}) + content_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contentType') }}) r"""File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**. Supported file types vary per platform. @@ -55,14 +54,14 @@ class AccountingAttachment: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - file_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileSize'), 'exclude': lambda f: f is None }}) + file_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileSize') }}) r"""File size in bytes. For example, if this reads **46153**, then the file size is 46kb.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the attachment, unique for the company in the accounting platform.""" include_when_sent: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('includeWhenSent'), 'exclude': lambda f: f is None }}) r"""If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting platform allows this.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the attachment file.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbalancesheet.py b/lending/src/codatlending/models/shared/accountingbalancesheet.py index 11660eaf6..c55ef6163 100755 --- a/lending/src/codatlending/models/shared/accountingbalancesheet.py +++ b/lending/src/codatlending/models/shared/accountingbalancesheet.py @@ -5,11 +5,10 @@ from ..shared import balancesheet as shared_balancesheet from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBalanceSheet: r"""> View the coverage for balance sheet in the Data coverage explorer. @@ -40,7 +39,7 @@ class AccountingBalanceSheet: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - reports: list[shared_balancesheet.BalanceSheet] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) + reports: List[shared_balancesheet.BalanceSheet] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) r"""An array of balance sheet reports.""" earliest_available_month: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('earliestAvailableMonth'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/accountingbankaccount.py b/lending/src/codatlending/models/shared/accountingbankaccount.py index 124507bb0..60b3b104a 100755 --- a/lending/src/codatlending/models/shared/accountingbankaccount.py +++ b/lending/src/codatlending/models/shared/accountingbankaccount.py @@ -4,6 +4,7 @@ import dataclasses from ..shared import accountingbankaccounttype as shared_accountingbankaccounttype from ..shared import metadata as shared_metadata +from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -11,14 +12,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankAccount: r"""> **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > - > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account) + > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/schemas/Account) > View the coverage for bank accounts in the Data coverage explorer. @@ -31,9 +31,9 @@ class AccountingBankAccount: * The currency and balance of the account. * The sort code and account number. """ - account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) + account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName') }}) r"""Name of the bank account in the accounting platform.""" - account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountNumber'), 'exclude': lambda f: f is None }}) + account_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountNumber') }}) r"""Account number for the bank account. Xero integrations @@ -47,9 +47,9 @@ class AccountingBankAccount: For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For Debit accounts, positive balances are assets, and positive transactions **increase** assets. """ - available_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('availableBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + available_balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('availableBalance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example.""" - balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Balance of the bank account.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -60,27 +60,32 @@ class AccountingBankAccount: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - i_ban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iBan'), 'exclude': lambda f: f is None }}) + i_ban: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('iBan') }}) r"""International bank account number of the account. Often used when making or receiving international payments.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the account, unique for the company in the accounting platform.""" - institution: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution'), 'exclude': lambda f: f is None }}) + institution: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution') }}) r"""The institution of the bank account.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode'), 'exclude': lambda f: f is None }}) + nominal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('nominalCode') }}) r"""Code used to identify each nominal account for a business.""" - overdraft_limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('overdraftLimit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + overdraft_limit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('overdraftLimit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Pre-arranged overdraft limit of the account. The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. """ - sort_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortCode'), 'exclude': lambda f: f is None }}) + sort_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sortCode') }}) r"""Sort code for the bank account. Xero integrations The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. """ source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ diff --git a/lending/src/codatlending/models/shared/accountingbankaccounts.py b/lending/src/codatlending/models/shared/accountingbankaccounts.py index 848587abb..1268bf00f 100755 --- a/lending/src/codatlending/models/shared/accountingbankaccounts.py +++ b/lending/src/codatlending/models/shared/accountingbankaccounts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankAccounts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbankaccount.AccountingBankAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbankaccount.AccountingBankAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbanktransaction.py b/lending/src/codatlending/models/shared/accountingbanktransaction.py index fa0729679..0d5b63dd8 100755 --- a/lending/src/codatlending/models/shared/accountingbanktransaction.py +++ b/lending/src/codatlending/models/shared/accountingbanktransaction.py @@ -10,14 +10,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankTransaction: r"""> **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > - > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions) + > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions) > View the coverage for bank transactions in the Data coverage explorer. @@ -30,9 +29,12 @@ class AccountingBankTransaction: * Current account balance. * Transaction type, for example, credit, debit, or transfer. """ - account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId'), 'exclude': lambda f: f is None }}) + account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId') }}) + r"""Unique identifier to the `accountId` the bank transactions originates from.""" amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The amount transacted in the bank transaction.""" balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The remaining balance in the account with ID `accountId`.""" cleared_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('clearedOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -54,12 +56,15 @@ class AccountingBankTransaction: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) + r"""Description of the bank transaction.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Identifier for the bank transaction, unique to the company in the accounting platform.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) reconciled: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reconciled'), 'exclude': lambda f: f is None }}) + r"""`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting platform.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) transaction_type: Optional[shared_banktransactiontype.BankTransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionType'), 'exclude': lambda f: f is None }}) - r"""Type of transaction for the bank statement line""" + r"""Type of transaction for the bank statement line.""" diff --git a/lending/src/codatlending/models/shared/accountingbanktransactions.py b/lending/src/codatlending/models/shared/accountingbanktransactions.py index 206a2c186..092d8fcb2 100755 --- a/lending/src/codatlending/models/shared/accountingbanktransactions.py +++ b/lending/src/codatlending/models/shared/accountingbanktransactions.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBankTransactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbanktransaction.AccountingBankTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbanktransaction.AccountingBankTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbill.py b/lending/src/codatlending/models/shared/accountingbill.py index bf1abae78..1c6506d1a 100755 --- a/lending/src/codatlending/models/shared/accountingbill.py +++ b/lending/src/codatlending/models/shared/accountingbill.py @@ -11,40 +11,39 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillPurchaseOrderReference: id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the purchase order, unique for the company in the accounting platform.""" - purchase_order_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderNumber'), 'exclude': lambda f: f is None }}) + purchase_order_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderNumber') }}) r"""Friendly reference for the purchase order, commonly generated by the accounting platform.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillWithholdingTax: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""Amount of tax withheld.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name assigned to withheld tax.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBill: r"""> **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. > - > See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills. + > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. View the coverage for bills in the Data coverage explorer. @@ -58,7 +57,7 @@ class AccountingBill: Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. - You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model. + You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. """ issue_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate') }}) status: shared_billstatus.BillStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) @@ -69,7 +68,7 @@ class AccountingBill: r"""Amount of tax on the bill.""" total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount of the bill, including tax.""" - amount_due: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amountDue'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount_due: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amountDue'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount outstanding on the bill.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -80,7 +79,7 @@ class AccountingBill: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -110,16 +109,16 @@ class AccountingBill: due_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dueDate'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the bill, unique for the company in the accounting platform.""" - line_items: Optional[list[shared_billlineitem.BillLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_billlineitem.BillLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""Array of Bill line items.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any private, company notes about the bill, such as payment information.""" - payment_allocations: Optional[list[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" - purchase_order_refs: Optional[list[AccountingBillPurchaseOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderRefs'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + purchase_order_refs: Optional[List[AccountingBillPurchaseOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderRefs') }}) + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""User-friendly reference for the bill.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -129,6 +128,6 @@ class AccountingBill: """ supplier_ref: Optional[shared_supplierref.SupplierRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierRef'), 'exclude': lambda f: f is None }}) r"""Reference to the supplier the record relates to.""" - withholding_tax: Optional[list[AccountingBillWithholdingTax]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[AccountingBillWithholdingTax]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/lending/src/codatlending/models/shared/accountingbillcreditnote.py b/lending/src/codatlending/models/shared/accountingbillcreditnote.py index a4fbfcdef..bb955f737 100755 --- a/lending/src/codatlending/models/shared/accountingbillcreditnote.py +++ b/lending/src/codatlending/models/shared/accountingbillcreditnote.py @@ -12,16 +12,15 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillCreditNote: r"""> **Bill credit notes or credit notes?** > - > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). + > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). View the coverage for bill credit notes in the Data coverage explorer. @@ -29,11 +28,11 @@ class AccountingBillCreditNote: A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills. - In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier). + In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier). A bill credit note includes details of: * The original and remaining credit. - * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/accounting-api#/schemas/Bill). + * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill). * The supplier that issued the bill credit note. """ discount_percentage: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -69,7 +68,7 @@ class AccountingBillCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - bill_credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('billCreditNoteNumber'), 'exclude': lambda f: f is None }}) + bill_credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('billCreditNoteNumber') }}) r"""Friendly reference for the bill credit note.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -80,7 +79,7 @@ class AccountingBillCreditNote: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -130,13 +129,13 @@ class AccountingBillCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: Optional[list[shared_billcreditnotelineitem.BillCreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_billcreditnotelineitem.BillCreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information about the bill credit note.""" - payment_allocations: Optional[list[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" remaining_credit: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('remainingCredit'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Amount of the bill credit note that is still outstanding.""" @@ -148,6 +147,6 @@ class AccountingBillCreditNote: """ supplier_ref: Optional[shared_supplierref.SupplierRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierRef'), 'exclude': lambda f: f is None }}) r"""Reference to the supplier the record relates to.""" - withholding_tax: Optional[list[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/lending/src/codatlending/models/shared/accountingbillcreditnotes.py b/lending/src/codatlending/models/shared/accountingbillcreditnotes.py index 624b70999..24f200e76 100755 --- a/lending/src/codatlending/models/shared/accountingbillcreditnotes.py +++ b/lending/src/codatlending/models/shared/accountingbillcreditnotes.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillCreditNotes: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbillcreditnote.AccountingBillCreditNote]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbillcreditnote.AccountingBillCreditNote]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbillpayment.py b/lending/src/codatlending/models/shared/accountingbillpayment.py index cd94e4e1b..24bb4c10c 100755 --- a/lending/src/codatlending/models/shared/accountingbillpayment.py +++ b/lending/src/codatlending/models/shared/accountingbillpayment.py @@ -5,29 +5,29 @@ from ..shared import accountref as shared_accountref from ..shared import billpaymentline as shared_billpaymentline from ..shared import metadata as shared_metadata +from ..shared import paymentmethodref as shared_paymentmethodref from ..shared import supplementaldata as shared_supplementaldata from ..shared import supplierref as shared_supplierref from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillPayment: r"""> **Bill payments or payments?** > > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment. > - > See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). + > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). > View the coverage for bill payments in the Data coverage explorer. ## Overview - Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)). + Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)). A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to: @@ -44,9 +44,9 @@ class AccountingBillPayment: - Who the payment has been paid to, the _supplier_. - The types of bill payments, the _line items_. - Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model. + Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. - Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). --- @@ -172,7 +172,7 @@ class AccountingBillPayment: account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -201,14 +201,14 @@ class AccountingBillPayment: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the bill payment, unique for the company in the accounting platform.""" - lines: Optional[list[shared_billpaymentline.BillPaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_billpaymentline.BillPaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines') }}) r"""An array of bill payment lines.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Additional information associated with the payment.""" - payment_method_ref: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""Additional information associated with the payment.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbillpayments.py b/lending/src/codatlending/models/shared/accountingbillpayments.py index f2a35e8ae..9ec803977 100755 --- a/lending/src/codatlending/models/shared/accountingbillpayments.py +++ b/lending/src/codatlending/models/shared/accountingbillpayments.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBillPayments: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbillpayment.AccountingBillPayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbillpayment.AccountingBillPayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingbills.py b/lending/src/codatlending/models/shared/accountingbills.py index 5b2030959..47a6afeee 100755 --- a/lending/src/codatlending/models/shared/accountingbills.py +++ b/lending/src/codatlending/models/shared/accountingbills.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingBills: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingbill.AccountingBill]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingbill.AccountingBill]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingcashflowstatement.py b/lending/src/codatlending/models/shared/accountingcashflowstatement.py index a10aeac50..7143bc812 100755 --- a/lending/src/codatlending/models/shared/accountingcashflowstatement.py +++ b/lending/src/codatlending/models/shared/accountingcashflowstatement.py @@ -7,11 +7,10 @@ from ..shared import reportinput as shared_reportinput from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCashFlowStatement: r"""> View the coverage for cash flow statement in the Data coverage explorer. @@ -41,7 +40,7 @@ class AccountingCashFlowStatement: r"""Accounting method used when aggregating the report data. In this case, `Cash`.""" report_input: shared_reportinput.ReportInput = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInput') }}) r"""Accounting method used to prepare the cash flow statement.""" - reports: list[shared_cashflowstatement.CashFlowStatement] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) + reports: List[shared_cashflowstatement.CashFlowStatement] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) r"""Array of cash flow statements.""" earliest_available_month: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('earliestAvailableMonth'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/accountingcompanyinfo.py b/lending/src/codatlending/models/shared/accountingcompanyinfo.py index 8dc690984..2ffb9d43e 100755 --- a/lending/src/codatlending/models/shared/accountingcompanyinfo.py +++ b/lending/src/codatlending/models/shared/accountingcompanyinfo.py @@ -4,14 +4,14 @@ import dataclasses from ..shared import accountingaddress as shared_accountingaddress from ..shared import phonenumber as shared_phonenumber +from ..shared import supplementaldata as shared_supplementaldata from ..shared import weblink as shared_weblink from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCompanyInfo: r"""> View the coverage for company info in the Data coverage explorer. @@ -22,15 +22,15 @@ class AccountingCompanyInfo: > > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. """ - accounting_platform_ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingPlatformRef'), 'exclude': lambda f: f is None }}) + accounting_platform_ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountingPlatformRef') }}) r"""Identifier or reference for the company in the accounting platform.""" - addresses: Optional[list[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) r"""An array of Addresses.""" - base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency'), 'exclude': lambda f: f is None }}) + base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency') }}) r"""Currency set in the accounting platform of the linked company. Used by the currency rate.""" - company_legal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyLegalName'), 'exclude': lambda f: f is None }}) + company_legal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyLegalName') }}) r"""Registered legal name of the linked company.""" - company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) + company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName') }}) r"""Name of the linked company.""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -95,18 +95,23 @@ class AccountingCompanyInfo: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - phone_numbers: Optional[list[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) + phone_numbers: Optional[List[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers') }}) r"""An array of phone numbers.""" - registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) + registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.""" - source_urls: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) + source_urls: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls') }}) r"""URL addresses for the accounting source. For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). """ - tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ + tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber') }}) r"""Company tax number.""" - web_links: Optional[list[shared_weblink.WebLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) + web_links: Optional[List[shared_weblink.WebLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks') }}) r"""An array of weblinks.""" diff --git a/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py b/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py index 7ef90ce77..3c4162fab 100755 --- a/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateAccountResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -46,7 +45,8 @@ class AccountingCreateAccountResponse: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateAccountResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingaccount.AccountingAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. View the coverage for accounts in the Data coverage explorer. @@ -90,7 +90,7 @@ class AccountingCreateAccountResponse: At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided. To determine the list of allowed categories for a specific integration, you can: - - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model). + - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). - Refer to the integration's own documentation. > **Accounts with no category** @@ -101,10 +101,15 @@ class AccountingCreateAccountResponse: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/accountingcreatebankaccountresponse.py b/lending/src/codatlending/models/shared/accountingcreatebankaccountresponse.py deleted file mode 100755 index c94607f02..000000000 --- a/lending/src/codatlending/models/shared/accountingcreatebankaccountresponse.py +++ /dev/null @@ -1,99 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import accountingbankaccount as shared_accountingbankaccount -from ..shared import datatype as shared_datatype -from ..shared import pushoperationchange as shared_pushoperationchange -from ..shared import pushoperationstatus as shared_pushoperationstatus -from ..shared import validation as shared_validation -from codatlending import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class AccountingCreateBankAccountResponse: - company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) - r"""Unique identifier for your SMB in Codat.""" - data_connection_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionKey') }}) - r"""Unique identifier for a company's data connection.""" - push_operation_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey') }}) - r"""A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.""" - requested_on_utc: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requestedOnUtc') }}) - r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - - ``` - 2020-10-08T22:40:50Z - 2021-01-01T00:00:00 - ``` - - - - When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - - - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - - Unqualified local time: `2021-11-15T01:00:00` - - UTC time offsets: `2021-11-15T01:00:00-05:00` - - > Time zones - > - > Not all dates from Codat will contain information about time zones. - > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - """ - status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The current status of the push operation.""" - status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) - r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" - completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) - r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - - ``` - 2020-10-08T22:40:50Z - 2021-01-01T00:00:00 - ``` - - - - When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - - - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - - Unqualified local time: `2021-11-15T01:00:00` - - UTC time offsets: `2021-11-15T01:00:00-05:00` - - > Time zones - > - > Not all dates from Codat will contain information about time zones. - > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - """ - data: Optional[shared_accountingbankaccount.AccountingBankAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) - r"""> **Accessing Bank Accounts through Banking API** - > - > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. - > - > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account) - - > View the coverage for bank accounts in the Data coverage explorer. - - ## Overview - - A list of bank accounts associated with a company and a specific data connection. - - Bank accounts data includes: - * The name and ID of the account in the accounting platform. - * The currency and balance of the account. - * The sort code and account number. - """ - data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" - validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) - r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" - - diff --git a/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py b/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py index 0f5302419..7ee671f5d 100755 --- a/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py +++ b/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py @@ -5,14 +5,14 @@ from ..shared import createbankaccounttransaction as shared_createbankaccounttransaction from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateBankTransactions: account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId'), 'exclude': lambda f: f is None }}) - transactions: Optional[list[shared_createbankaccounttransaction.CreateBankAccountTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a bank account.""" + transactions: Optional[List[shared_createbankaccounttransaction.CreateBankAccountTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py b/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py index dfb2d3b8c..63fec7a6f 100755 --- a/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateBankTransactionsResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -46,7 +45,8 @@ class AccountingCreateBankTransactionsResponse: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -72,10 +72,15 @@ class AccountingCreateBankTransactionsResponse: data: Optional[shared_accountingcreatebanktransactions.AccountingCreateBankTransactions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py b/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py index 44d2b35f5..380abf1fc 100755 --- a/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateDirectCostResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -46,7 +45,8 @@ class AccountingCreateDirectCostResponse: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,7 +69,7 @@ class AccountingCreateDirectCostResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingdirectcost.AccountingDirectCost] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingdirectcost.AccountingDirectCost] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms. > View the coverage for direct costs in the Data coverage explorer. @@ -84,14 +84,19 @@ class AccountingCreateDirectCostResponse: * Withdrawing money from a bank account * Writing a cheque - Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/accountingcreatepaymentresponse.py b/lending/src/codatlending/models/shared/accountingcreatepaymentresponse.py new file mode 100755 index 000000000..14eebb7a3 --- /dev/null +++ b/lending/src/codatlending/models/shared/accountingcreatepaymentresponse.py @@ -0,0 +1,766 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import accountingpayment as shared_accountingpayment +from ..shared import datatype as shared_datatype +from ..shared import pushoperationchange as shared_pushoperationchange +from ..shared import pushoperationstatus as shared_pushoperationstatus +from ..shared import validation as shared_validation +from codatlending import utils +from dataclasses_json import Undefined, dataclass_json +from typing import List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AccountingCreatePaymentResponse: + company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) + r"""Unique identifier for your SMB in Codat.""" + data_connection_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionKey') }}) + r"""Unique identifier for a company's data connection.""" + push_operation_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey') }}) + r"""A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.""" + requested_on_utc: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requestedOnUtc') }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""The current status of the push operation.""" + status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" + completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + data: Optional[shared_accountingpayment.AccountingPayment] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) + r"""> **Payments or bill payments?** + > + > In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills. + + > View the coverage for payments in the Data coverage explorer. + + ## Overview + + Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). + + A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to: + + - A payment made against an invoice, like a credit card, cheque, or cash payment. + - An allocation of a customer's credit note, either to an invoice or maybe a refund. + - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account. + + Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details. + + In Codat, a payment contains details of: + + - When the payment was recorded in the accounting system. + - How much it is for and in what currency that amount is in. + - Who the payment was _paid by_ – the _customer_. + - The payment method used. + - The breakdown of the types of payments – the _line items_. + + Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + + ## Payment types + + ## Payment of an invoice + + A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties: + + - An _amount_ that indicates the amount of the invoice that was paid. This is always positive. + - A **links** array containing one element with the following properties: + - A **type** that indicates the type of **link**, in this case an `Invoice`. + - An **id** that contains the ID of the invoice that was paid. + - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`. + + The **amount** field on the **line** equals the **totalAmount** on the payment. + + ## Payment of multiple invoices + + A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books: + + - The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice). + - The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available. + + Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment. + + ## Payments and refunds on account + + A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties: + + - A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive. + - A **links** array containing one element with the following properties: + - A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`. + - The **id** containing the ID of the customer. + - The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund. + + It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above. + + ## Using a credit note to pay an invoice + + The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties: + + - An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other. + - A **links** array containing two elements: + - The first **link** has: + - A **type** that indicates the type of **link**, in this case an `Invoice`. + - An **id** that contains the ID of the invoice that was paid. + - The second **link** has: + - A **type** that indicates the type of **link**, in this case a `CreditNote`. + - An **id** that contains the ID of the credit note used by this payment. + + The **amount** field on the **line** equals the **totalAmount** on the payment. + + ## Refunding a credit note + + A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties: + + - An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund. + - A **links** array that contains one element with the following properties: + - A **type** that indicates the type of **link**, in this case a `CreditNote`. + - An **id** that contains the ID of the credit note that was refunded. + + The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable. + + ## Refunding a payment + + If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records: + + - One for the incoming over payment. + - Another for the outgoing refund. + + The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties: + + - An **amount** that indicates the amount that was refunded. This is always negative. + - A **links** array that contains one element with the following properties: + - A **type** that indicates the type of **link**, in this case a `Payment`. + - An **id** that contains the ID of the payment that was refunded. + + The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable. + + The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice. + + For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines: + + - One for £1,000 linked to the invoice that was paid. + - Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment. + + The **line** linked to the payment has the following properties: + + - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund. + - A **links** array containing one element with the following properties: + - A **type** that indicates the type of **link**, in this case a `Refund`. + - An **id** that contains the ID of the payment that refunded this line. + + > **Support for linked payments** + > + > Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account. + + ## Foreign currencies + + There are two types of currency rate that are included in the payments data type: + + Payment currency rate: + + - Base currency of the accounts receivable account. + - Foreign currency of the payment. + + Payment line link currency rate: + + - Base currency of the item the link represents. + - Foreign currency of the payment. + + These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either: + + - The base currency for the accounts receivable account. + - The currency of the item. + + ```json title=\"Currency rate example\" + { + \"id\": \"123\", + \"note\": \"\" + \"totalAmount\": 99.99, + \"currency\": \"GBP\", + \"lines\": [ + { + \"amount\": 99.99, + \"links\": [ + { + \"type\": \"Invoice\", + \"id\": \"178\", + \"amount\": -50, + \"currencyRate\": 1.9998, + } + ] + } + ] + } + ``` + + + + ## Example data + + > **Object properties** + > + > For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments). + + ## Simple examples + + ```json title=\"Payment for invoice\" + { + \"totalAmount\": 1000, + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Allocation of credit note\" + { + \"totalAmount\": 0, + \"lines\": [ + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Payment of invoice and payment on account\" + { + \"totalAmount\": 2000, + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"PaymentOnAccount\", + \"id\" : \"y\", + \"amount\" : -1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Refund of credit note\" + { + \"totalAmount\": -1000, + \"lines\": [ + { + \"amount\" : -1000, + \"links\" : [ + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Refund on accounts receivable account\" + { + \"totalAmount\": -1000, + \"lines\": [ + { + \"amount\" : -1000, + \"links\" : [ + { + \"type\" : \"PaymentOnAccount\", + \"id\" : \"y\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Linked refund on accounts receivable account\" + { + \"id\" : \"payment-001\", + \"totalAmount\": 1000, + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Refund\", + \"id\" : \"refund-001\", + \"amount\" : -1000 + } + ] + } + ] + } + { + \"id\" : \"refund-001\", + \"totalAmount\": -1000, + \"lines\": [ + { + \"amount\" : -1000, + \"links\" : [ + { + \"type\" : \"Payment\", + \"id\" : \"payment-001\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Using a credit note and cash to pay an invoice\" + { + \"totalAmount\": 250, + \"lines\": [ + { + \"amount\": 0, + \"links\": [ + { + \"type\": \"Invoice\", + \"id\": \"x\", + \"amount\": -750 + }, + { + \"type\": \"CreditNote\", + \"id\": \"y\", + \"amount\": 750 + } + ] + }, + { + \"amount\": 250, + \"links\": [ + { + \"type\": \"Invoice\", + \"id\": \"x\", + \"amount\": -250 + } + ] + } + ] + } + ``` + + + + ## Complex examples + + ```json title=\"Use two credit notes and 1000 in to \"bank\" (cash, cheque etc.) to pay invoice\" + { + \"totalAmount\": 1000, + \"lines\": [ + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + } + ] + }, + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"z\", + \"amount\" : 1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Pay an invoice with two credit notes and cash, with 1000 left 'on account'\" + { + \"totalAmount\": 2000, + \"lines\": [ + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + } + ] + }, + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"z\", + \"amount\" : 1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"PaymentOnAccount\", + \"id\" : \"customer-001\", + \"amount\" : -1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Two credit notes pay two invoices with no allocation amount specified\" + { + \"totalAmount\": 0, + \"lines\": [ + { + \"amount\" : 0, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"w\", + \"amount\" : -1000 + }, + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"z\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash\" + { + \"totalAmount\": 2000, + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"w\", + \"amount\" : -1000 + }, + { + \"type\" : \"Invoice\", + \"id\" : \"x\", + \"amount\" : -1000 + }, + { + \"type\" : \"Invoice\", + \"id\" : \"u\", + \"amount\" : -1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"y\", + \"amount\" : 1000 + }, + { + \"type\" : \"CreditNote\", + \"id\" : \"z\", + \"amount\" : 1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Refund\", + \"id\" : \"refund-001\", + \"amount\" : -1000 + } + ] + } + ] + } + { + \"id\" : \"refund-001\", + \"totalAmount\": -1000, + \"lines\": [ + { + \"amount\" : -1000, + \"links\" : [ + { + \"type\" : \"Payment\", + \"id\" : \"payment-001\", + \"amount\" : 1000 + } + ] + } + ] + } + ``` + + + + In this example, a payment on account is used to pay the same invoice in January and again in February. + + ```json title=\"January\" + { + \"id\": \"001\", + \"totalAmount\": 5000, + \"date\" : \"1901-01-01\", + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"Invoice-x\", + \"amount\" : -1000 + } + ] + }, + { + \"amount\" : 4000, + \"links\" : [ + { + \"type\" : \"PaymentOnAccount\", + \"id\" : \"PaymentOnAccount-y\", + \"amount\" : -4000 + } + ] + } + ] + } + ``` + + + + ```json title=\"February\" + { + \"id\": \"001\", + \"totalAmount\": 5000, + \"date\" : \"1901-02-01\", + \"lines\": [ + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"Invoice-x\", + \"amount\" : -1000 + } + ] + }, + { + \"amount\" : 1000, + \"links\" : [ + { + \"type\" : \"Invoice\", + \"id\" : \"Invoice-y\", + \"amount\" : -1000 + } + ] + }, + { + \"amount\" : 3000, + \"links\" : [ + { + \"type\" : \"PaymentOnAccount\", + \"id\" : \"PaymentOnAccount-y\", + \"amount\" : -3000 + } + ] + } + ] + } + ``` + + + + ```json title=\"Two credit notes and some cash pay two invoices with no allocations specified\" + { + \"totalAmount\": 500, + \"lines\": [ + { + \"amount\": 500, + \"links\": [{ + \"type\": \"Invoice\", + \"id\": \"a\", + \"amount\": -1000 + }, { + \"type\": \"Invoice\", + \"id\": \"b\", + \"amount\": -1000 + }, { + \"type\": \"CreditNote\", + \"id\": \"y\", + \"amount\": 750 + },{ + \"type\": \"CreditNote\", + \"id\": \"z\", + \"amount\": 750 + } + ] + } + ] + } + ``` + """ + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ + validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) + r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" + + diff --git a/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py b/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py index 66514c97b..28f041a56 100755 --- a/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateSupplierResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -46,7 +45,8 @@ class AccountingCreateSupplierResponse: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,19 +69,24 @@ class AccountingCreateSupplierResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingsupplier.AccountingSupplier] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingsupplier.AccountingSupplier] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> View the coverage for suppliers in the Data coverage explorer. ## Overview - From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill). + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py b/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py index 2b6aa8fca..c9e2c5b17 100755 --- a/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py @@ -9,11 +9,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreateTransferResponse: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -46,7 +45,8 @@ class AccountingCreateTransferResponse: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -69,17 +69,22 @@ class AccountingCreateTransferResponse: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - data: Optional[shared_accountingtransfer.AccountingTransfer] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_accountingtransfer.AccountingTransfer] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) r"""> View the coverage for transfers in the Data coverage explorer. - A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/accountingcreditnote.py b/lending/src/codatlending/models/shared/accountingcreditnote.py index 958e23c61..5769e0455 100755 --- a/lending/src/codatlending/models/shared/accountingcreditnote.py +++ b/lending/src/codatlending/models/shared/accountingcreditnote.py @@ -12,11 +12,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreditNote: r"""> View the coverage for credit notes in the Data coverage explorer. @@ -25,7 +24,7 @@ class AccountingCreditNote: Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely. - In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. + In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. It contains details of: * The amount of credit remaining and its status. @@ -37,6 +36,7 @@ class AccountingCreditNote: remaining_credit: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('remainingCredit'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Unused balance of totalAmount originally raised.""" status: shared_creditnotestatus.CreditNoteStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""Current state of the credit note.""" sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Value of the credit note, including discounts and excluding tax.""" total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -46,7 +46,9 @@ class AccountingCreditNote: total_tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Any tax applied to the credit note amount.""" additional_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Additional tax amount applied to credit note.""" additional_tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Percentage rate of any additional tax applied to the credit note.""" allocated_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocatedOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -68,7 +70,7 @@ class AccountingCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('creditNoteNumber'), 'exclude': lambda f: f is None }}) + credit_note_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('creditNoteNumber') }}) r"""Friendly reference for the credit note.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -79,7 +81,7 @@ class AccountingCreditNote: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -130,12 +132,12 @@ class AccountingCreditNote: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: Optional[list[shared_creditnotelineitem.CreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_creditnotelineitem.CreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information about the credit note. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting platform to the customer.""" - payment_allocations: Optional[list[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -143,6 +145,6 @@ class AccountingCreditNote: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - withholding_tax: Optional[list[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/lending/src/codatlending/models/shared/accountingcreditnotes.py b/lending/src/codatlending/models/shared/accountingcreditnotes.py index 7e0c7a4ca..85ce7a111 100755 --- a/lending/src/codatlending/models/shared/accountingcreditnotes.py +++ b/lending/src/codatlending/models/shared/accountingcreditnotes.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCreditNotes: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingcreditnote.AccountingCreditNote]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingcreditnote.AccountingCreditNote]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingcustomer.py b/lending/src/codatlending/models/shared/accountingcustomer.py index 2d667c81b..9d789b8a8 100755 --- a/lending/src/codatlending/models/shared/accountingcustomer.py +++ b/lending/src/codatlending/models/shared/accountingcustomer.py @@ -9,11 +9,10 @@ from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCustomer: r"""> View the coverage for customers in the Data coverage explorer. @@ -22,17 +21,17 @@ class AccountingCustomer: A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). - Customers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice). + Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). """ status: shared_customerstatus.CustomerStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of customer.""" - addresses: Optional[list[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) r"""An array of Addresses.""" - contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName'), 'exclude': lambda f: f is None }}) + contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName') }}) r"""Name of the main contact for the identified customer.""" - contacts: Optional[list[shared_contact.Contact]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contacts'), 'exclude': lambda f: f is None }}) + contacts: Optional[List[shared_contact.Contact]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contacts') }}) r"""An array of Contacts.""" - customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName'), 'exclude': lambda f: f is None }}) + customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName') }}) r"""Name of the customer as recorded in the accounting system, typically the company name.""" default_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultCurrency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -43,15 +42,15 @@ class AccountingCustomer: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress'), 'exclude': lambda f: f is None }}) + email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress') }}) r"""Email address the customer can be contacted by.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the customer, unique to the company in the accounting platform.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""Phone number the customer can be contacted by.""" - registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) + registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Company number. In the UK, this is typically the Companies House company registration number.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -59,7 +58,7 @@ class AccountingCustomer: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber'), 'exclude': lambda f: f is None }}) + tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber') }}) r"""Company tax number.""" diff --git a/lending/src/codatlending/models/shared/accountingcustomerref.py b/lending/src/codatlending/models/shared/accountingcustomerref.py index 6a53f2903..249516303 100755 --- a/lending/src/codatlending/models/shared/accountingcustomerref.py +++ b/lending/src/codatlending/models/shared/accountingcustomerref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCustomerRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""`id` from the Customers data type""" - company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) + company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName') }}) r"""`customerName` from the Customer data type""" diff --git a/lending/src/codatlending/models/shared/accountingcustomers.py b/lending/src/codatlending/models/shared/accountingcustomers.py index f2a90eeda..8ce50d73b 100755 --- a/lending/src/codatlending/models/shared/accountingcustomers.py +++ b/lending/src/codatlending/models/shared/accountingcustomers.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingCustomers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingcustomer.AccountingCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingcustomer.AccountingCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingdirectcost.py b/lending/src/codatlending/models/shared/accountingdirectcost.py index 2dccfaf3b..c9a03d28f 100755 --- a/lending/src/codatlending/models/shared/accountingdirectcost.py +++ b/lending/src/codatlending/models/shared/accountingdirectcost.py @@ -10,11 +10,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectCost: r"""> **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms. @@ -31,7 +30,7 @@ class AccountingDirectCost: * Withdrawing money from a bank account * Writing a cheque - Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). """ currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -63,9 +62,9 @@ class AccountingDirectCost: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: list[shared_directcostlineitem.DirectCostLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) + line_items: List[shared_directcostlineitem.DirectCostLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line items.""" - payment_allocations: list[shared_accountingpaymentallocation.AccountingPaymentAllocation] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) + payment_allocations: List[shared_accountingpaymentallocation.AccountingPaymentAllocation] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""The total amount of the direct costs, excluding any taxes.""" @@ -75,7 +74,7 @@ class AccountingDirectCost: r"""The amount of the direct costs, inclusive of tax.""" contact_ref: Optional[shared_contactref.ContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) r"""The customer or supplier for the transfer, if available.""" - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -106,9 +105,9 @@ class AccountingDirectCost: r"""Identifier of the direct cost, unique for the company.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""A note attached to the direct cost.""" - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""User-friendly reference for the direct cost.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingdirectcosts.py b/lending/src/codatlending/models/shared/accountingdirectcosts.py index 16ddb78ab..7dea1cea8 100755 --- a/lending/src/codatlending/models/shared/accountingdirectcosts.py +++ b/lending/src/codatlending/models/shared/accountingdirectcosts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectCosts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingdirectcost.AccountingDirectCost]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingdirectcost.AccountingDirectCost]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingdirectincome.py b/lending/src/codatlending/models/shared/accountingdirectincome.py index 54fe03dec..e835fbedb 100755 --- a/lending/src/codatlending/models/shared/accountingdirectincome.py +++ b/lending/src/codatlending/models/shared/accountingdirectincome.py @@ -10,11 +10,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectIncome: r"""> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting platforms. @@ -31,7 +30,7 @@ class AccountingDirectIncome: - Refunding an item in cash to a contact. - Depositing money into a bank account. - Direct incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). """ currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -63,9 +62,9 @@ class AccountingDirectIncome: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - line_items: list[shared_directincomelineitem.DirectIncomeLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) + line_items: List[shared_directincomelineitem.DirectIncomeLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line items.""" - payment_allocations: list[shared_accountingpaymentallocation.AccountingPaymentAllocation] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) + payment_allocations: List[shared_accountingpaymentallocation.AccountingPaymentAllocation] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""The total amount of the direct incomes, excluding any taxes.""" tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -74,7 +73,7 @@ class AccountingDirectIncome: r"""The amount of the direct incomes, inclusive of tax.""" contact_ref: Optional[shared_contactref.ContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) r"""The customer or supplier for the transfer, if available.""" - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -105,8 +104,9 @@ class AccountingDirectIncome: r"""Identifier of the direct income, unique for the company.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) + r"""An optional note on the direct income that can be used to assign the direct income with a reference ID in your application.""" + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""User-friendly reference for the direct income.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingdirectincomes.py b/lending/src/codatlending/models/shared/accountingdirectincomes.py index b9c78e1f3..d3db5a660 100755 --- a/lending/src/codatlending/models/shared/accountingdirectincomes.py +++ b/lending/src/codatlending/models/shared/accountingdirectincomes.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingDirectIncomes: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingdirectincome.AccountingDirectIncome]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingdirectincome.AccountingDirectIncome]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountinginvoice.py b/lending/src/codatlending/models/shared/accountinginvoice.py index 610ab5cef..44fe11575 100755 --- a/lending/src/codatlending/models/shared/accountinginvoice.py +++ b/lending/src/codatlending/models/shared/accountinginvoice.py @@ -4,6 +4,7 @@ import dataclasses from ..shared import accountingcustomerref as shared_accountingcustomerref from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation +from ..shared import datatype as shared_datatype from ..shared import invoicelineitem as shared_invoicelineitem from ..shared import invoicestatus as shared_invoicestatus from ..shared import items as shared_items @@ -12,34 +13,34 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoiceSalesOrderReference: - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to a record in `dataType`.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoice: r"""> **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice. > - > See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills. + > See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills. View the coverage for invoices in the Data coverage explorer. ## Overview - An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer). + An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer). In Codat, an invoice contains details of: @@ -47,11 +48,11 @@ class AccountingInvoice: - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. - Who the invoice has been raised to; the _customer_. - The breakdown of what the invoice is for; the _line items_. - - Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. + - Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. > **Invoice PDF downloads** > - > You can download a PDF version of an invoice for supported integrations. + > You can download a PDF version of an invoice for supported integrations. > > The filename will be invoice-{number}.pdf. @@ -96,7 +97,9 @@ class AccountingInvoice: total_tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax on the invoice.""" additional_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Additional tax amount applied to invoice.""" additional_tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalTaxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Percentage rate of any additional tax applied to the invoice.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -106,7 +109,7 @@ class AccountingInvoice: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -134,7 +137,7 @@ class AccountingInvoice: | **RUB** | ₽20 | 0.015 | $0.30 | """ customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.""" due_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -159,13 +162,13 @@ class AccountingInvoice: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the invoice, unique to the company in the accounting platform.""" - invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber'), 'exclude': lambda f: f is None }}) + invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber') }}) r"""Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.""" - line_items: Optional[list[shared_invoicelineitem.InvoiceLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems'), 'exclude': lambda f: f is None }}) + line_items: Optional[List[shared_invoicelineitem.InvoiceLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) r"""An array of line items.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information about the invoice. Where possible, Codat links to a data field in the accounting platform that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting platform to the customer.""" paid_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paidOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -188,20 +191,20 @@ class AccountingInvoice: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - payment_allocations: Optional[list[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations'), 'exclude': lambda f: f is None }}) + payment_allocations: Optional[List[shared_accountingpaymentallocation.AccountingPaymentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentAllocations') }}) r"""An array of payment allocations.""" - sales_order_refs: Optional[list[AccountingInvoiceSalesOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('salesOrderRefs'), 'exclude': lambda f: f is None }}) + sales_order_refs: Optional[List[AccountingInvoiceSalesOrderReference]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('salesOrderRefs') }}) r"""List of references to related Sales orders.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the invoice excluding any taxes.""" supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of discounts applied to the invoice.""" - withholding_tax: Optional[list[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax'), 'exclude': lambda f: f is None }}) + withholding_tax: Optional[List[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) diff --git a/lending/src/codatlending/models/shared/accountinginvoices.py b/lending/src/codatlending/models/shared/accountinginvoices.py index 04ca6a446..40dd19dea 100755 --- a/lending/src/codatlending/models/shared/accountinginvoices.py +++ b/lending/src/codatlending/models/shared/accountinginvoices.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingInvoices: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountinginvoice.AccountingInvoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountinginvoice.AccountingInvoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingjournal.py b/lending/src/codatlending/models/shared/accountingjournal.py index b00fdc644..ee6bf633a 100755 --- a/lending/src/codatlending/models/shared/accountingjournal.py +++ b/lending/src/codatlending/models/shared/accountingjournal.py @@ -10,16 +10,15 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournal: - r"""> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type + r"""> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type > View the coverage for journals in the Data coverage explorer. ## Overview - In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. + In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. @@ -61,22 +60,22 @@ class AccountingJournal: r"""If the journal has child journals, this value is true. If it doesn’t, it is false.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Journal ID.""" - journal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalCode'), 'exclude': lambda f: f is None }}) + journal_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalCode') }}) r"""Native journal number or code.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Journal name. The maximum length for a journal name is 256 characters. All characters above that number will be truncated. """ - parent_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parentId'), 'exclude': lambda f: f is None }}) + parent_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parentId') }}) r"""Parent journal ID. If the journal is a parent journal, this value is not present. """ source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_journalstatus.JournalStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Current journal status.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of the journal.""" diff --git a/lending/src/codatlending/models/shared/accountingjournalentries.py b/lending/src/codatlending/models/shared/accountingjournalentries.py index 9c33be0d8..5248df3b2 100755 --- a/lending/src/codatlending/models/shared/accountingjournalentries.py +++ b/lending/src/codatlending/models/shared/accountingjournalentries.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournalEntries: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingjournalentry.AccountingJournalEntry]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingjournalentry.AccountingJournalEntry]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingjournalentry.py b/lending/src/codatlending/models/shared/accountingjournalentry.py index cb38445a0..8dd374649 100755 --- a/lending/src/codatlending/models/shared/accountingjournalentry.py +++ b/lending/src/codatlending/models/shared/accountingjournalentry.py @@ -9,20 +9,19 @@ from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournalEntry: - r"""> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type + r"""> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type > View the coverage for journal entries in the Data coverage explorer. ## Overview - A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. + A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. A journal entry line item is a single transaction line on the journal entry. For example: @@ -60,11 +59,11 @@ class AccountingJournalEntry: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Optional description of the journal entry.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the journal entry for the company in the accounting platform.""" - journal_lines: Optional[list[shared_journalline.JournalLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalLines'), 'exclude': lambda f: f is None }}) + journal_lines: Optional[List[shared_journalline.JournalLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalLines') }}) r"""An array of journal lines.""" journal_ref: Optional[shared_journalref.JournalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journalRef'), 'exclude': lambda f: f is None }}) r"""Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).""" diff --git a/lending/src/codatlending/models/shared/accountingjournals.py b/lending/src/codatlending/models/shared/accountingjournals.py index fc3a4371d..3ed082f37 100755 --- a/lending/src/codatlending/models/shared/accountingjournals.py +++ b/lending/src/codatlending/models/shared/accountingjournals.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingJournals: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingjournal.AccountingJournal]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingjournal.AccountingJournal]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingpayment.py b/lending/src/codatlending/models/shared/accountingpayment.py index dbdeb01b9..5d90f9f55 100755 --- a/lending/src/codatlending/models/shared/accountingpayment.py +++ b/lending/src/codatlending/models/shared/accountingpayment.py @@ -6,26 +6,26 @@ from ..shared import accountref as shared_accountref from ..shared import metadata as shared_metadata from ..shared import paymentline as shared_paymentline +from ..shared import paymentmethodref as shared_paymentmethodref from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingPayment: r"""> **Payments or bill payments?** > - > In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills. + > In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills. > View the coverage for payments in the Data coverage explorer. ## Overview - Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). + Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to: @@ -43,7 +43,7 @@ class AccountingPayment: - The payment method used. - The breakdown of the types of payments – the _line items_. - Payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). ## Payment types @@ -728,7 +728,7 @@ class AccountingPayment: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -758,14 +758,15 @@ class AccountingPayment: customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the payment, unique to the company in the accounting platform.""" - lines: Optional[list[shared_paymentline.PaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines'), 'exclude': lambda f: f is None }}) + lines: Optional[List[shared_paymentline.PaymentLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lines') }}) r"""An array of payment lines.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Any additional information associated with the payment.""" - payment_method_ref: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + r"""The payment method the record is linked to in the accounting or commerce platform.""" + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""Friendly reference for the payment.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingpaymentallocation.py b/lending/src/codatlending/models/shared/accountingpaymentallocation.py index f91df5bd0..fd80e0b63 100755 --- a/lending/src/codatlending/models/shared/accountingpaymentallocation.py +++ b/lending/src/codatlending/models/shared/accountingpaymentallocation.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingPaymentAllocationAllocation: allocated_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocatedOnDate'), 'exclude': lambda f: f is None }}) @@ -43,7 +42,7 @@ class AccountingPaymentAllocationAllocation: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -77,7 +76,6 @@ class AccountingPaymentAllocationAllocation: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingPaymentAllocation: allocation: AccountingPaymentAllocationAllocation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocation') }}) diff --git a/lending/src/codatlending/models/shared/accountingpayments.py b/lending/src/codatlending/models/shared/accountingpayments.py index f46b08978..5a3898d46 100755 --- a/lending/src/codatlending/models/shared/accountingpayments.py +++ b/lending/src/codatlending/models/shared/accountingpayments.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingPayments: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingpayment.AccountingPayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingpayment.AccountingPayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingprofitandlossreport.py b/lending/src/codatlending/models/shared/accountingprofitandlossreport.py index fd570b2a4..b909e9b95 100755 --- a/lending/src/codatlending/models/shared/accountingprofitandlossreport.py +++ b/lending/src/codatlending/models/shared/accountingprofitandlossreport.py @@ -6,11 +6,10 @@ from ..shared import reportbasis as shared_reportbasis from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingProfitAndLossReport: r"""> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles). @@ -40,7 +39,7 @@ class AccountingProfitAndLossReport: r"""Base currency of the company in which the profit and loss report is presented.""" report_basis: shared_reportbasis.ReportBasis = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportBasis') }}) r"""The basis of a report.""" - reports: list[shared_profitandlossreport.ProfitAndLossReport] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) + reports: List[shared_profitandlossreport.ProfitAndLossReport] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports') }}) r"""An array of profit and loss reports.""" earliest_available_month: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('earliestAvailableMonth'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/accountingsupplier.py b/lending/src/codatlending/models/shared/accountingsupplier.py index 7c8fff452..d8503a456 100755 --- a/lending/src/codatlending/models/shared/accountingsupplier.py +++ b/lending/src/codatlending/models/shared/accountingsupplier.py @@ -8,36 +8,35 @@ from ..shared import supplierstatus as shared_supplierstatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingSupplier: r"""> View the coverage for suppliers in the Data coverage explorer. ## Overview - From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill). + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). """ status: shared_supplierstatus.SupplierStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of the supplier.""" - addresses: Optional[list[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_accountingaddress.AccountingAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses') }}) r"""An array of Addresses.""" - contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName'), 'exclude': lambda f: f is None }}) + contact_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactName') }}) r"""Name of the main contact for the supplier.""" - default_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultCurrency'), 'exclude': lambda f: f is None }}) + default_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('defaultCurrency') }}) r"""Default currency the supplier's transactional data is recorded in.""" - email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress'), 'exclude': lambda f: f is None }}) + email_address: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('emailAddress') }}) r"""Email address that the supplier may be contacted on.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier for the supplier, unique to the company in the accounting platform.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""Phone number that the supplier may be contacted on.""" - registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) + registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber') }}) r"""Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) @@ -45,9 +44,9 @@ class AccountingSupplier: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - supplier_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierName'), 'exclude': lambda f: f is None }}) + supplier_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierName') }}) r"""Name of the supplier as recorded in the accounting system, typically the company name.""" - tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber'), 'exclude': lambda f: f is None }}) + tax_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxNumber') }}) r"""Supplier's company tax number.""" diff --git a/lending/src/codatlending/models/shared/accountingsuppliers.py b/lending/src/codatlending/models/shared/accountingsuppliers.py index 401bac5d2..604f18bc4 100755 --- a/lending/src/codatlending/models/shared/accountingsuppliers.py +++ b/lending/src/codatlending/models/shared/accountingsuppliers.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingSuppliers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingsupplier.AccountingSupplier]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingsupplier.AccountingSupplier]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountingtransfer.py b/lending/src/codatlending/models/shared/accountingtransfer.py index a22c637b9..6cc022b73 100755 --- a/lending/src/codatlending/models/shared/accountingtransfer.py +++ b/lending/src/codatlending/models/shared/accountingtransfer.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from ..shared import metadata as shared_metadata from ..shared import recordref as shared_recordref from ..shared import supplementaldata as shared_supplementaldata @@ -9,27 +10,27 @@ from ..shared import transferaccount as shared_transferaccount from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingTransferContactRef: r"""The customer or supplier for the transfer, if available.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a customer or supplier.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingTransfer: r"""> View the coverage for transfers in the Data coverage explorer. - A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). + A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). """ contact_ref: Optional[AccountingTransferContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) r"""The customer or supplier for the transfer, if available.""" @@ -54,11 +55,12 @@ class AccountingTransfer: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - deposited_record_refs: Optional[list[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('depositedRecordRefs'), 'exclude': lambda f: f is None }}) + deposited_record_refs: Optional[List[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('depositedRecordRefs') }}) r"""List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description of the transfer.""" from_: Optional[shared_transferaccount.TransferAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('from'), 'exclude': lambda f: f is None }}) + r"""Account details of the account sending or receiving the transfer.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the transfer.""" metadata: Optional[shared_metadata.Metadata] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) @@ -70,7 +72,8 @@ class AccountingTransfer: It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ to: Optional[shared_transferaccount.TransferAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('to'), 'exclude': lambda f: f is None }}) - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + r"""Account details of the account sending or receiving the transfer.""" + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories this transfer is being tracked against.""" diff --git a/lending/src/codatlending/models/shared/accountingtransfers.py b/lending/src/codatlending/models/shared/accountingtransfers.py index 24b115d5a..8da550544 100755 --- a/lending/src/codatlending/models/shared/accountingtransfers.py +++ b/lending/src/codatlending/models/shared/accountingtransfers.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountingTransfers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_accountingtransfer.AccountingTransfer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_accountingtransfer.AccountingTransfer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountinstitution.py b/lending/src/codatlending/models/shared/accountinstitution.py index 53b0daf8e..f7ec1e686 100755 --- a/lending/src/codatlending/models/shared/accountinstitution.py +++ b/lending/src/codatlending/models/shared/accountinstitution.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountInstitution: r"""The bank or other financial institution providing the account.""" diff --git a/lending/src/codatlending/models/shared/accountref.py b/lending/src/codatlending/models/shared/accountref.py index 63ac1cb3c..748732f3a 100755 --- a/lending/src/codatlending/models/shared/accountref.py +++ b/lending/src/codatlending/models/shared/accountref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountRef: r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" diff --git a/lending/src/codatlending/models/shared/accounts.py b/lending/src/codatlending/models/shared/accounts.py index 00ff5d91e..6e85b8c46 100755 --- a/lending/src/codatlending/models/shared/accounts.py +++ b/lending/src/codatlending/models/shared/accounts.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Accounts: account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountspayabletracking.py b/lending/src/codatlending/models/shared/accountspayabletracking.py index e99ddf2d2..3ea36eba3 100755 --- a/lending/src/codatlending/models/shared/accountspayabletracking.py +++ b/lending/src/codatlending/models/shared/accountspayabletracking.py @@ -8,17 +8,18 @@ from ..shared import trackingcategoryref as shared_trackingcategoryref from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountsPayableTracking: r"""Categories, and a project and customer, against which the item is tracked.""" - category_refs: list[shared_trackingcategoryref.TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + category_refs: List[shared_trackingcategoryref.TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) is_billed_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + r"""Defines if the invoice or credit note is billed/rebilled to a project or customer.""" is_rebilled_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isRebilledTo') }}) + r"""Defines if the invoice or credit note is billed/rebilled to a project or customer.""" customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) project_ref: Optional[shared_projectref.ProjectRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projectRef'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountsreceivabletracking.py b/lending/src/codatlending/models/shared/accountsreceivabletracking.py index c249e5c32..661532839 100755 --- a/lending/src/codatlending/models/shared/accountsreceivabletracking.py +++ b/lending/src/codatlending/models/shared/accountsreceivabletracking.py @@ -8,11 +8,10 @@ from ..shared import trackingcategoryref as shared_trackingcategoryref from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountsReceivableTrackingRecordReference: r"""Links the current record to the underlying record or data type that created it. @@ -28,13 +27,14 @@ class AccountsReceivableTrackingRecordReference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountsReceivableTracking: r"""Categories, and a project and customer, against which the item is tracked.""" - category_refs: list[shared_trackingcategoryref.TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + category_refs: List[shared_trackingcategoryref.TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) is_billed_to: shared_billedtotype1.BilledToType1 = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" is_rebilled_to: shared_billedtotype1.BilledToType1 = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isRebilledTo') }}) + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" customer_ref: Optional[shared_accountingcustomerref.AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) project_ref: Optional[shared_projectref.ProjectRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projectRef'), 'exclude': lambda f: f is None }}) record_ref: Optional[AccountsReceivableTrackingRecordReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accounttransactionline.py b/lending/src/codatlending/models/shared/accounttransactionline.py index 38d6702b9..bd4fdaac2 100755 --- a/lending/src/codatlending/models/shared/accounttransactionline.py +++ b/lending/src/codatlending/models/shared/accounttransactionline.py @@ -10,12 +10,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AccountTransactionLine: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Amount in the bill payment currency.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description of the account transaction.""" record_ref: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) r"""Links the current record to the underlying record or data type that created it. diff --git a/lending/src/codatlending/models/shared/agedcreditor.py b/lending/src/codatlending/models/shared/agedcreditor.py index 2e3c9b7a5..77d78e60d 100755 --- a/lending/src/codatlending/models/shared/agedcreditor.py +++ b/lending/src/codatlending/models/shared/agedcreditor.py @@ -5,14 +5,13 @@ from ..shared import agedcurrencyoutstanding as shared_agedcurrencyoutstanding from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AgedCreditor: - aged_currency_outstanding: Optional[list[shared_agedcurrencyoutstanding.AgedCurrencyOutstanding]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedCurrencyOutstanding'), 'exclude': lambda f: f is None }}) + aged_currency_outstanding: Optional[List[shared_agedcurrencyoutstanding.AgedCurrencyOutstanding]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedCurrencyOutstanding'), 'exclude': lambda f: f is None }}) r"""Array of aged creditors by currency.""" supplier_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierId'), 'exclude': lambda f: f is None }}) r"""Supplier ID of the aged creditor.""" diff --git a/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py b/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py index eb4a5cc29..7d0e46f36 100755 --- a/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py +++ b/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py @@ -5,14 +5,13 @@ from ..shared import agedoutstandingamount as shared_agedoutstandingamount from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AgedCurrencyOutstanding: - aged_outstanding_amounts: Optional[list[shared_agedoutstandingamount.AgedOutstandingAmount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedOutstandingAmounts'), 'exclude': lambda f: f is None }}) + aged_outstanding_amounts: Optional[List[shared_agedoutstandingamount.AgedOutstandingAmount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedOutstandingAmounts'), 'exclude': lambda f: f is None }}) r"""Array of outstanding amounts by period.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. diff --git a/lending/src/codatlending/models/shared/ageddebtor.py b/lending/src/codatlending/models/shared/ageddebtor.py index 95ed6d8ca..59c2f6b02 100755 --- a/lending/src/codatlending/models/shared/ageddebtor.py +++ b/lending/src/codatlending/models/shared/ageddebtor.py @@ -5,14 +5,13 @@ from ..shared import agedcurrencyoutstanding as shared_agedcurrencyoutstanding from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AgedDebtor: - aged_currency_outstanding: Optional[list[shared_agedcurrencyoutstanding.AgedCurrencyOutstanding]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedCurrencyOutstanding'), 'exclude': lambda f: f is None }}) + aged_currency_outstanding: Optional[List[shared_agedcurrencyoutstanding.AgedCurrencyOutstanding]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('agedCurrencyOutstanding'), 'exclude': lambda f: f is None }}) r"""Array of aged debtors by currency.""" customer_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerId'), 'exclude': lambda f: f is None }}) r"""Customer ID of the aged debtor.""" diff --git a/lending/src/codatlending/models/shared/agedoutstandingamount.py b/lending/src/codatlending/models/shared/agedoutstandingamount.py index 4816017b6..f4f2cd6b9 100755 --- a/lending/src/codatlending/models/shared/agedoutstandingamount.py +++ b/lending/src/codatlending/models/shared/agedoutstandingamount.py @@ -6,16 +6,15 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AgedOutstandingAmount: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The amount outstanding.""" - details: Optional[list[shared_agedoutstandingamountdetail.AgedOutstandingAmountDetail]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) + details: Optional[List[shared_agedoutstandingamountdetail.AgedOutstandingAmountDetail]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) r"""Array of details.""" from_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fromDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/agedoutstandingamountdetail.py b/lending/src/codatlending/models/shared/agedoutstandingamountdetail.py index 8015c7bb8..9aa982943 100755 --- a/lending/src/codatlending/models/shared/agedoutstandingamountdetail.py +++ b/lending/src/codatlending/models/shared/agedoutstandingamountdetail.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class AgedOutstandingAmountDetail: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/attachments.py b/lending/src/codatlending/models/shared/attachments.py index 843cbd033..dfbf97f9c 100755 --- a/lending/src/codatlending/models/shared/attachments.py +++ b/lending/src/codatlending/models/shared/attachments.py @@ -5,13 +5,12 @@ from ..shared import accountingattachment as shared_accountingattachment from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Attachments: - attachments: Optional[list[shared_accountingattachment.AccountingAttachment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachments'), 'exclude': lambda f: f is None }}) + attachments: Optional[List[shared_accountingattachment.AccountingAttachment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachments') }}) diff --git a/lending/src/codatlending/models/shared/balancesheet.py b/lending/src/codatlending/models/shared/balancesheet.py index cb1c510ed..f8e90c5db 100755 --- a/lending/src/codatlending/models/shared/balancesheet.py +++ b/lending/src/codatlending/models/shared/balancesheet.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BalanceSheet: net_assets: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('netAssets'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) diff --git a/lending/src/codatlending/models/shared/bankaccountref.py b/lending/src/codatlending/models/shared/bankaccountref.py index b728f0da4..4fab9780a 100755 --- a/lending/src/codatlending/models/shared/bankaccountref.py +++ b/lending/src/codatlending/models/shared/bankaccountref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankAccountRef: r"""Links to the Account transactions data type.""" diff --git a/lending/src/codatlending/models/shared/bankingaccount.py b/lending/src/codatlending/models/shared/bankingaccount.py index 56d2bb3d5..a206c4b49 100755 --- a/lending/src/codatlending/models/shared/bankingaccount.py +++ b/lending/src/codatlending/models/shared/bankingaccount.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingAccount: r"""This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts. @@ -38,9 +37,9 @@ class BankingAccount: For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For Debit accounts, positive balances are assets, and positive transactions **increase** assets. """ - holder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('holder'), 'exclude': lambda f: f is None }}) + holder: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('holder') }}) r"""The name of the person or company who holds the account.""" - informal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('informalName'), 'exclude': lambda f: f is None }}) + informal_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('informalName') }}) r"""The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankingaccountbalance.py b/lending/src/codatlending/models/shared/bankingaccountbalance.py index 4a81a7aed..65a7d5c87 100755 --- a/lending/src/codatlending/models/shared/bankingaccountbalance.py +++ b/lending/src/codatlending/models/shared/bankingaccountbalance.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingAccountBalance: r"""The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction. @@ -18,7 +17,7 @@ class BankingAccountBalance: > **How often should I pull Account Balances?** > - > Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/banking-api#/schemas/Account) data type. + > Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type. > > Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer. """ diff --git a/lending/src/codatlending/models/shared/bankingaccountbalances.py b/lending/src/codatlending/models/shared/bankingaccountbalances.py index 4d2622339..4f218cf4b 100755 --- a/lending/src/codatlending/models/shared/bankingaccountbalances.py +++ b/lending/src/codatlending/models/shared/bankingaccountbalances.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingAccountBalances: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_bankingaccountbalance.BankingAccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_bankingaccountbalance.BankingAccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankingaccounts.py b/lending/src/codatlending/models/shared/bankingaccounts.py index 8fe148e76..44d652c68 100755 --- a/lending/src/codatlending/models/shared/bankingaccounts.py +++ b/lending/src/codatlending/models/shared/bankingaccounts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingAccounts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_bankingaccount.BankingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_bankingaccount.BankingAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankingtransaction.py b/lending/src/codatlending/models/shared/bankingtransaction.py index be44f2961..58f9264ed 100755 --- a/lending/src/codatlending/models/shared/bankingtransaction.py +++ b/lending/src/codatlending/models/shared/bankingtransaction.py @@ -11,7 +11,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingTransaction: r"""The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. @@ -51,9 +50,9 @@ class BankingTransaction: """ code: Optional[shared_transactioncode.TransactionCode] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('code'), 'exclude': lambda f: f is None }}) r"""Code to identify the underlying transaction.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""The description of the bank transaction.""" - merchant_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('merchantName'), 'exclude': lambda f: f is None }}) + merchant_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('merchantName') }}) r"""The name of the merchant.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) posted_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postedDate'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankingtransactioncategories.py b/lending/src/codatlending/models/shared/bankingtransactioncategories.py index 4b863da45..d86d25d2f 100755 --- a/lending/src/codatlending/models/shared/bankingtransactioncategories.py +++ b/lending/src/codatlending/models/shared/bankingtransactioncategories.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingTransactionCategories: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_bankingtransactioncategory.BankingTransactionCategory]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_bankingtransactioncategory.BankingTransactionCategory]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankingtransactioncategory.py b/lending/src/codatlending/models/shared/bankingtransactioncategory.py index 837900783..b8e1dfa61 100755 --- a/lending/src/codatlending/models/shared/bankingtransactioncategory.py +++ b/lending/src/codatlending/models/shared/bankingtransactioncategory.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingTransactionCategory: r"""Status of the bank transaction category.""" @@ -20,9 +19,10 @@ class BankingTransactionCategory: has_children: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hasChildren'), 'exclude': lambda f: f is None }}) r"""A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - parent_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parentId'), 'exclude': lambda f: f is None }}) + parent_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parentId') }}) r"""The unique identifier of the parent bank transaction category.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_transactioncategorystatus.TransactionCategoryStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""The status of the transaction category.""" diff --git a/lending/src/codatlending/models/shared/bankingtransactionref.py b/lending/src/codatlending/models/shared/bankingtransactionref.py index e78148342..a70d354f0 100755 --- a/lending/src/codatlending/models/shared/bankingtransactionref.py +++ b/lending/src/codatlending/models/shared/bankingtransactionref.py @@ -9,13 +9,16 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingTransactionRef: account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the bank transaction's account.""" account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) + r"""Name given to account.""" amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Bank transaction amount.""" data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the bank transaction's connection.""" date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -38,6 +41,8 @@ class BankingTransactionRef: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + r"""Description given to bank transaction.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the bank transaction.""" diff --git a/lending/src/codatlending/models/shared/bankingtransactions.py b/lending/src/codatlending/models/shared/bankingtransactions.py index 309c93913..782c968c7 100755 --- a/lending/src/codatlending/models/shared/bankingtransactions.py +++ b/lending/src/codatlending/models/shared/bankingtransactions.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BankingTransactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_bankingtransaction.BankingTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_bankingtransaction.BankingTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/banktransactiontype.py b/lending/src/codatlending/models/shared/banktransactiontype.py index a68d8322b..22e04c691 100755 --- a/lending/src/codatlending/models/shared/banktransactiontype.py +++ b/lending/src/codatlending/models/shared/banktransactiontype.py @@ -4,7 +4,7 @@ from enum import Enum class BankTransactionType(str, Enum): - r"""Type of transaction for the bank statement line""" + r"""Type of transaction for the bank statement line.""" UNKNOWN = 'Unknown' CREDIT = 'Credit' DEBIT = 'Debit' diff --git a/lending/src/codatlending/models/shared/billcreditnotelineitem.py b/lending/src/codatlending/models/shared/billcreditnotelineitem.py index c23ba3cbe..91e12c060 100755 --- a/lending/src/codatlending/models/shared/billcreditnotelineitem.py +++ b/lending/src/codatlending/models/shared/billcreditnotelineitem.py @@ -8,24 +8,22 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BillCreditNoteLineItemItemReference: r"""Reference to the item the line is linked to.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""Unique identifier for the item in the accounting platform.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the item in the accounting platform.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BillCreditNoteLineItemTaxRateReference: r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -50,7 +48,6 @@ class BillCreditNoteLineItemTaxRateReference: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BillCreditNoteLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -59,17 +56,17 @@ class BillCreditNoteLineItem: r"""Unit price of the goods or service.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of each line item. For example, the goods or service for which credit has been received.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Value of any discounts applied.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate of any discount applied to the line item.""" item_ref: Optional[BillCreditNoteLineItemItemReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of credit associated with the line item, including discounts but excluding tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax associated with the line item.""" tax_rate_ref: Optional[BillCreditNoteLineItemTaxRateReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -83,11 +80,11 @@ class BillCreditNoteLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line item, including discounts and tax.""" tracking: Optional[shared_accountspayabletracking.AccountsPayableTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories to which the line item is linked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/lending/src/codatlending/models/shared/billedtotype.py b/lending/src/codatlending/models/shared/billedtotype.py index 7784c4386..b069bd0ed 100755 --- a/lending/src/codatlending/models/shared/billedtotype.py +++ b/lending/src/codatlending/models/shared/billedtotype.py @@ -4,6 +4,7 @@ from enum import Enum class BilledToType(str, Enum): + r"""Defines if the invoice or credit note is billed/rebilled to a project or customer.""" UNKNOWN = 'Unknown' NOT_APPLICABLE = 'NotApplicable' CUSTOMER = 'Customer' diff --git a/lending/src/codatlending/models/shared/billedtotype1.py b/lending/src/codatlending/models/shared/billedtotype1.py index 6eeaacfb6..74ae06837 100755 --- a/lending/src/codatlending/models/shared/billedtotype1.py +++ b/lending/src/codatlending/models/shared/billedtotype1.py @@ -4,6 +4,7 @@ from enum import Enum class BilledToType1(str, Enum): + r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" UNKNOWN = 'Unknown' NOT_APPLICABLE = 'NotApplicable' PROJECT = 'Project' diff --git a/lending/src/codatlending/models/shared/billlineitem.py b/lending/src/codatlending/models/shared/billlineitem.py index edf32e63c..a93d7be7c 100755 --- a/lending/src/codatlending/models/shared/billlineitem.py +++ b/lending/src/codatlending/models/shared/billlineitem.py @@ -10,11 +10,29 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from enum import Enum +from typing import List, Optional + +class BillLineItemRecordLineReferenceDataType(str, Enum): + r"""Allowed name of the 'dataType'.""" + PURCHASE_ORDERS = 'purchaseOrders' @dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class BillLineItemRecordLineReference: + r"""Reference to the purchase order line this line was generated from.""" + data_type: Optional[BillLineItemRecordLineReferenceDataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Allowed name of the 'dataType'.""" + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""'id' of the underlying record.""" + line_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineNumber'), 'exclude': lambda f: f is None }}) + r"""Line number of the underlying record.""" + + + +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class BillLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -23,20 +41,26 @@ class BillLineItem: r"""Price of each unit of goods or services.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of the goods or services received.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of any discounts applied. Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. """ - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) + r"""Percentage rate of any discount applied to the bill.""" is_direct_cost: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDirectCost'), 'exclude': lambda f: f is None }}) + r"""The bill is a direct cost if `True`.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + line_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineNumber') }}) + r"""The bill line's number.""" + purchase_order_line_ref: Optional[BillLineItemRecordLineReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderLineRef'), 'exclude': lambda f: f is None }}) + r"""Reference to the purchase order line this line was generated from.""" + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of the line, inclusive of discounts but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax for the line.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -50,11 +74,11 @@ class BillLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line, including tax.""" tracking: Optional[shared_accountspayabletracking.AccountsPayableTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Collection of categories against which this item is tracked.""" diff --git a/lending/src/codatlending/models/shared/billpaymentline.py b/lending/src/codatlending/models/shared/billpaymentline.py index 50f554eb3..c0f7b4249 100755 --- a/lending/src/codatlending/models/shared/billpaymentline.py +++ b/lending/src/codatlending/models/shared/billpaymentline.py @@ -6,11 +6,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BillPaymentLine: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -36,6 +35,6 @@ class BillPaymentLine: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - links: Optional[list[shared_billpaymentlinelink.BillPaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links'), 'exclude': lambda f: f is None }}) + links: Optional[List[shared_billpaymentlinelink.BillPaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links') }}) diff --git a/lending/src/codatlending/models/shared/billpaymentlinelink.py b/lending/src/codatlending/models/shared/billpaymentlinelink.py index ae1932244..a14bd2ade 100755 --- a/lending/src/codatlending/models/shared/billpaymentlinelink.py +++ b/lending/src/codatlending/models/shared/billpaymentlinelink.py @@ -10,18 +10,17 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class BillPaymentLineLink: type: shared_billpaymentlinelinktype.BillPaymentLineLinkType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""Types of links to bill payment lines.""" - amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount by which the balance of the linked entity is altered, in the currency of the linked entity. - A negative link amount reduces the outstanding amount on the accounts payable account. - A positive link amount increases the outstanding amount on the accounts payable account. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -48,7 +47,7 @@ class BillPaymentLineLink: | **EUR** | €20 | 1.134 | $22.68 | | **RUB** | ₽20 | 0.015 | $0.30 | """ - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""Unique identifier of the transaction represented by the link.""" diff --git a/lending/src/codatlending/models/shared/cashflowstatement.py b/lending/src/codatlending/models/shared/cashflowstatement.py index 963d00cfd..1bbfb6e9a 100755 --- a/lending/src/codatlending/models/shared/cashflowstatement.py +++ b/lending/src/codatlending/models/shared/cashflowstatement.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CashFlowStatement: cash_payments: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cashPayments'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py b/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py index 5b40f4500..97d0d3c68 100755 --- a/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py +++ b/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitReachedWebhook: r"""Webhook request body for a client that has reached their rate limit.""" diff --git a/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py b/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py index d3da638ef..cf9e5c442 100755 --- a/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py +++ b/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitReachedWebhookData: daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py b/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py index 5bae01fc5..3bcf56590 100755 --- a/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py +++ b/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitResetWebhook: r"""Webhook request body for a client that has had their rate limit reset.""" diff --git a/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py b/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py index 18e468bc5..94b7ee970 100755 --- a/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py +++ b/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ClientRateLimitResetWebhookData: daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) @@ -34,7 +33,7 @@ class ClientRateLimitResetWebhookData: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - quota_remaining: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('QuotaRemaining'), 'exclude': lambda f: f is None }}) + quota_remaining: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('QuotaRemaining') }}) r"""Total number of request remaining for your client.""" reset_reason: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ResetReason'), 'exclude': lambda f: f is None }}) r"""The reason for your rate limit quota being reset.""" diff --git a/lending/src/codatlending/models/shared/commerceaddress.py b/lending/src/codatlending/models/shared/commerceaddress.py index b97a4258d..8f45c4b3c 100755 --- a/lending/src/codatlending/models/shared/commerceaddress.py +++ b/lending/src/codatlending/models/shared/commerceaddress.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceAddress: city: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('city'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercecompanyinfo.py b/lending/src/codatlending/models/shared/commercecompanyinfo.py index 4f2bc440e..217b9e547 100755 --- a/lending/src/codatlending/models/shared/commercecompanyinfo.py +++ b/lending/src/codatlending/models/shared/commercecompanyinfo.py @@ -8,11 +8,10 @@ from ..shared import weblink as shared_weblink from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCompanyInfo: r"""In the Codat system, company information includes standard commercial details about @@ -20,9 +19,9 @@ class CommerceCompanyInfo: Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=companyInfo) for this data type. """ - account_balances: Optional[list[shared_accountbalance.AccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountBalances'), 'exclude': lambda f: f is None }}) + account_balances: Optional[List[shared_accountbalance.AccountBalance]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountBalances'), 'exclude': lambda f: f is None }}) r"""The available and current cash balances for the company's accounts""" - addresses: Optional[list[shared_commerceaddress.CommerceAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_commerceaddress.CommerceAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) r"""Addresses associated with the company""" base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -61,14 +60,14 @@ class CommerceCompanyInfo: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - phone_numbers: Optional[list[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) + phone_numbers: Optional[List[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phoneNumbers'), 'exclude': lambda f: f is None }}) r"""Phone numbers associated with the company""" registration_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('registrationNumber'), 'exclude': lambda f: f is None }}) r"""The registration number of the company""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - source_urls: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) + source_urls: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceUrls'), 'exclude': lambda f: f is None }}) r"""URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system""" - web_links: Optional[list[shared_weblink.WebLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) + web_links: Optional[List[shared_weblink.WebLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('webLinks'), 'exclude': lambda f: f is None }}) r"""Weblinks associated with the company""" diff --git a/lending/src/codatlending/models/shared/commercecustomer.py b/lending/src/codatlending/models/shared/commercecustomer.py index fa5e31544..1b9983498 100755 --- a/lending/src/codatlending/models/shared/commercecustomer.py +++ b/lending/src/codatlending/models/shared/commercecustomer.py @@ -5,11 +5,10 @@ from ..shared import commerceaddress as shared_commerceaddress from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomer: r"""When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn. @@ -18,7 +17,7 @@ class CommerceCustomer: """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - addresses: Optional[list[shared_commerceaddress.CommerceAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) + addresses: Optional[List[shared_commerceaddress.CommerceAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }}) r"""Addresses of the customer""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -49,7 +48,7 @@ class CommerceCustomer: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) r"""Any additional information about the customer""" - phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""A phone number.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercecustomerref.py b/lending/src/codatlending/models/shared/commercecustomerref.py index 5ce540636..5a6c1e1e3 100755 --- a/lending/src/codatlending/models/shared/commercecustomerref.py +++ b/lending/src/codatlending/models/shared/commercecustomerref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomerRef: r"""Reference to the customer that placed the order.""" diff --git a/lending/src/codatlending/models/shared/commercecustomers.py b/lending/src/codatlending/models/shared/commercecustomers.py index 2f8bd9bd2..70f695aaf 100755 --- a/lending/src/codatlending/models/shared/commercecustomers.py +++ b/lending/src/codatlending/models/shared/commercecustomers.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceCustomers: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercecustomer.CommerceCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercecustomer.CommerceCustomer]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercedispute.py b/lending/src/codatlending/models/shared/commercedispute.py index 26887ea23..f5aa1f76a 100755 --- a/lending/src/codatlending/models/shared/commercedispute.py +++ b/lending/src/codatlending/models/shared/commercedispute.py @@ -6,11 +6,10 @@ from ..shared import transactionsourceref as shared_transactionsourceref from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Any, Optional +from typing import Any, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceDispute: r"""A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: @@ -54,7 +53,7 @@ class CommerceDispute: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - disputed_transactions: Optional[list[shared_transactionsourceref.TransactionSourceRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disputedTransactions'), 'exclude': lambda f: f is None }}) + disputed_transactions: Optional[List[shared_transactionsourceref.TransactionSourceRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disputedTransactions'), 'exclude': lambda f: f is None }}) r"""Link to the source event(s) which triggered this transaction.""" due_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/commercedisputes.py b/lending/src/codatlending/models/shared/commercedisputes.py index 01baddf8f..0a370093a 100755 --- a/lending/src/codatlending/models/shared/commercedisputes.py +++ b/lending/src/codatlending/models/shared/commercedisputes.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceDisputes: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercedispute.CommerceDispute]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercedispute.CommerceDispute]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercelocation.py b/lending/src/codatlending/models/shared/commercelocation.py index 04af6d79b..c303ba610 100755 --- a/lending/src/codatlending/models/shared/commercelocation.py +++ b/lending/src/codatlending/models/shared/commercelocation.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceLocation: r"""The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. diff --git a/lending/src/codatlending/models/shared/commercelocations.py b/lending/src/codatlending/models/shared/commercelocations.py index ac0369ee1..bd7679d6e 100755 --- a/lending/src/codatlending/models/shared/commercelocations.py +++ b/lending/src/codatlending/models/shared/commercelocations.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceLocations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercelocation.CommerceLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercelocation.CommerceLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commerceorder.py b/lending/src/codatlending/models/shared/commerceorder.py index 7c4103f1c..a4aaa03ce 100755 --- a/lending/src/codatlending/models/shared/commerceorder.py +++ b/lending/src/codatlending/models/shared/commerceorder.py @@ -7,27 +7,14 @@ from ..shared import orderlineitem as shared_orderlineitem from ..shared import paymentref as shared_paymentref from ..shared import servicecharge as shared_servicecharge +from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class CommerceOrderSupplementalData: - r"""Supplemental data is additional data you can include in our standard data types. - - It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. - """ - content: Optional[dict[str, dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content'), 'exclude': lambda f: f is None }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceOrder: r"""Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). @@ -91,25 +78,25 @@ class CommerceOrder: location_ref: Optional[shared_locationref.LocationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locationRef'), 'exclude': lambda f: f is None }}) r"""Reference to the geographic location where the order was placed.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - order_line_items: Optional[list[shared_orderlineitem.OrderLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderLineItems'), 'exclude': lambda f: f is None }}) + order_line_items: Optional[List[shared_orderlineitem.OrderLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderLineItems'), 'exclude': lambda f: f is None }}) order_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('orderNumber'), 'exclude': lambda f: f is None }}) r"""Friendly reference for the order in the commerce or point of sale platform.""" - payments: Optional[list[shared_paymentref.PaymentRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) - service_charges: Optional[list[shared_servicecharge.ServiceCharge]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('serviceCharges'), 'exclude': lambda f: f is None }}) + payments: Optional[List[shared_paymentref.PaymentRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) + service_charges: Optional[List[shared_servicecharge.ServiceCharge]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('serviceCharges'), 'exclude': lambda f: f is None }}) source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - supplemental_data: Optional[CommerceOrderSupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of the order, including tax, net of any discounts and refunds.""" + r"""Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.""" total_discount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDiscount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of discount applied to the order.""" + r"""Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).""" total_gratuity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalGratuity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Extra amount added to a bill.""" + r"""Extra amount added to the order.""" total_refund: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalRefund'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount refunded issued by a merchant on an order (always a negative value).""" + r"""Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.""" total_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total amount of tax applied to the order.""" diff --git a/lending/src/codatlending/models/shared/commerceorders.py b/lending/src/codatlending/models/shared/commerceorders.py index 135a09560..5ce3d3cf2 100755 --- a/lending/src/codatlending/models/shared/commerceorders.py +++ b/lending/src/codatlending/models/shared/commerceorders.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceOrders: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commerceorder.CommerceOrder]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commerceorder.CommerceOrder]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercepayment.py b/lending/src/codatlending/models/shared/commercepayment.py index 42cc5cd15..e1a760d3e 100755 --- a/lending/src/codatlending/models/shared/commercepayment.py +++ b/lending/src/codatlending/models/shared/commercepayment.py @@ -2,15 +2,16 @@ from __future__ import annotations import dataclasses +from ..shared import paymentmethodref as shared_paymentmethodref from ..shared import paymentstatus as shared_paymentstatus +from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Any, Optional +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePayment: r"""Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. @@ -77,11 +78,17 @@ class CommercePayment: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - payment_method_ref: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + r"""The payment method the record is linked to in the accounting or commerce platform.""" payment_provider: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentProvider'), 'exclude': lambda f: f is None }}) r"""Service provider of the payment, if applicable.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_paymentstatus.PaymentStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the payment.""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ diff --git a/lending/src/codatlending/models/shared/commercepaymentmethod.py b/lending/src/codatlending/models/shared/commercepaymentmethod.py index 1483acb09..c0f3cc512 100755 --- a/lending/src/codatlending/models/shared/commercepaymentmethod.py +++ b/lending/src/codatlending/models/shared/commercepaymentmethod.py @@ -2,14 +2,19 @@ from __future__ import annotations import dataclasses -from ..shared import paymentmethodstatus as shared_paymentmethodstatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json +from enum import Enum from typing import Optional +class CommercePaymentMethodStatus(str, Enum): + r"""Status of the Payment Method.""" + UNKNOWN = 'Unknown' + ACTIVE = 'Active' + ARCHIVED = 'Archived' -@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class CommercePaymentMethod: r"""A Payment Method represents the payment method(s) used to make payments. @@ -22,7 +27,7 @@ class CommercePaymentMethod: name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""The name of the PaymentMethod""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) - status: Optional[shared_paymentmethodstatus.PaymentMethodStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) - r"""Status of the Payment Method""" + status: Optional[CommercePaymentMethodStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""Status of the Payment Method.""" diff --git a/lending/src/codatlending/models/shared/commercepaymentmethods.py b/lending/src/codatlending/models/shared/commercepaymentmethods.py index 88b4ad8d0..f6ee4f0d6 100755 --- a/lending/src/codatlending/models/shared/commercepaymentmethods.py +++ b/lending/src/codatlending/models/shared/commercepaymentmethods.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePaymentMethods: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercepaymentmethod.CommercePaymentMethod]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercepaymentmethod.CommercePaymentMethod]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercepayments.py b/lending/src/codatlending/models/shared/commercepayments.py index 5f7875077..b949858a7 100755 --- a/lending/src/codatlending/models/shared/commercepayments.py +++ b/lending/src/codatlending/models/shared/commercepayments.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommercePayments: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercepayment.CommercePayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercepayment.CommercePayment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commerceproduct.py b/lending/src/codatlending/models/shared/commerceproduct.py index 439681aaa..e73b16ac6 100755 --- a/lending/src/codatlending/models/shared/commerceproduct.py +++ b/lending/src/codatlending/models/shared/commerceproduct.py @@ -3,13 +3,13 @@ from __future__ import annotations import dataclasses from ..shared import productvariant as shared_productvariant +from ..shared import supplementaldata as shared_supplementaldata from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProduct: r"""A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. @@ -19,15 +19,20 @@ class CommerceProduct: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" categorization: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categorization'), 'exclude': lambda f: f is None }}) - r"""Retail category that the product is assigned to""" + r"""Retail category that the product is assigned to e.g. `Hardware`.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""Description of the product recorded in the commerce or point of sale platform.""" is_gift_card: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isGiftCard'), 'exclude': lambda f: f is None }}) r"""Whether the product represents a gift card or voucher that - can be redeemed in the commerce or POS platform + can be redeemed in the commerce or POS platform. """ name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product in the commerce or POS system""" - variants: Optional[list[shared_productvariant.ProductVariant]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('variants'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ + variants: Optional[List[shared_productvariant.ProductVariant]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('variants'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commerceproductcategories.py b/lending/src/codatlending/models/shared/commerceproductcategories.py index 3e02e95fc..2c3e6c720 100755 --- a/lending/src/codatlending/models/shared/commerceproductcategories.py +++ b/lending/src/codatlending/models/shared/commerceproductcategories.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProductCategories: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commerceproductcategory.CommerceProductCategory]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commerceproductcategory.CommerceProductCategory]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commerceproductcategory.py b/lending/src/codatlending/models/shared/commerceproductcategory.py index 76a460abb..e3f25c395 100755 --- a/lending/src/codatlending/models/shared/commerceproductcategory.py +++ b/lending/src/codatlending/models/shared/commerceproductcategory.py @@ -5,18 +5,17 @@ from ..shared import commercerecordref as shared_commercerecordref from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProductCategory: r"""Product categories are used to classify a group of products together, either by type (e.g. \\"Furniture\\"), or sometimes by tax profile. Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for this data type. """ - ancestor_refs: Optional[list[shared_commercerecordref.CommerceRecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ancestorRefs'), 'exclude': lambda f: f is None }}) + ancestor_refs: Optional[List[shared_commercerecordref.CommerceRecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ancestorRefs'), 'exclude': lambda f: f is None }}) r"""A collection of parent product categories implicitly ordered with the immediate parent last in the list.""" has_children: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hasChildren'), 'exclude': lambda f: f is None }}) r"""A boolean indicating whether there are other product categories beneath this one in the hierarchy.""" diff --git a/lending/src/codatlending/models/shared/commerceproducts.py b/lending/src/codatlending/models/shared/commerceproducts.py index f405313c8..f400f1221 100755 --- a/lending/src/codatlending/models/shared/commerceproducts.py +++ b/lending/src/codatlending/models/shared/commerceproducts.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceProducts: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commerceproduct.CommerceProduct]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commerceproduct.CommerceProduct]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercerecordref.py b/lending/src/codatlending/models/shared/commercerecordref.py index 92ca18c84..8144ee076 100755 --- a/lending/src/codatlending/models/shared/commercerecordref.py +++ b/lending/src/codatlending/models/shared/commercerecordref.py @@ -7,7 +7,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceRecordRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) diff --git a/lending/src/codatlending/models/shared/commercereport.py b/lending/src/codatlending/models/shared/commercereport.py index db7568225..b0f959214 100755 --- a/lending/src/codatlending/models/shared/commercereport.py +++ b/lending/src/codatlending/models/shared/commercereport.py @@ -8,11 +8,10 @@ from ..shared import commercereportmeasure as shared_commercereportmeasure from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReport: r"""## Structure @@ -57,10 +56,10 @@ class CommerceReport: ## Dimensions """ - dimensions: Optional[list[shared_commercereportdimension.CommerceReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) - errors: Optional[list[shared_commercereporterror.CommerceReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - measures: Optional[list[shared_commercereportmeasure.CommerceReportMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) - report_data: Optional[list[shared_commercereportcomponent.CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportData'), 'exclude': lambda f: f is None }}) - report_info: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) + dimensions: Optional[List[shared_commercereportdimension.CommerceReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) + errors: Optional[List[shared_commercereporterror.CommerceReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) + measures: Optional[List[shared_commercereportmeasure.CommerceReportMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) + report_data: Optional[List[shared_commercereportcomponent.CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportData'), 'exclude': lambda f: f is None }}) + report_info: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercereportcomponent.py b/lending/src/codatlending/models/shared/commercereportcomponent.py index c702281ed..6020735d1 100755 --- a/lending/src/codatlending/models/shared/commercereportcomponent.py +++ b/lending/src/codatlending/models/shared/commercereportcomponent.py @@ -5,18 +5,21 @@ from ..shared import reportcomponentmeasure as shared_reportcomponentmeasure from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReportComponent: - components: Optional[list[CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('components'), 'exclude': lambda f: f is None }}) + components: Optional[List[CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('components'), 'exclude': lambda f: f is None }}) dimension: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimension'), 'exclude': lambda f: f is None }}) + r"""The component's dimension.""" dimension_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensionDisplayName'), 'exclude': lambda f: f is None }}) + r"""The component's display name.""" item: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('item'), 'exclude': lambda f: f is None }}) + r"""The component's item number.""" item_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemDisplayName'), 'exclude': lambda f: f is None }}) - measures: Optional[list[shared_reportcomponentmeasure.ReportComponentMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) + r"""The component's item display name.""" + measures: Optional[List[shared_reportcomponentmeasure.ReportComponentMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercereportdimension.py b/lending/src/codatlending/models/shared/commercereportdimension.py index 2c4498051..67b10764a 100755 --- a/lending/src/codatlending/models/shared/commercereportdimension.py +++ b/lending/src/codatlending/models/shared/commercereportdimension.py @@ -4,25 +4,27 @@ import dataclasses from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReportDimensionItems: index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) + r"""The dimension's items index.""" @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReportDimension: display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) + r"""The dimension's display name.""" index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) - items: Optional[list[CommerceReportDimensionItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) + r"""The dimension's index.""" + items: Optional[List[CommerceReportDimensionItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""The dimension's type.""" diff --git a/lending/src/codatlending/models/shared/commercereporterror.py b/lending/src/codatlending/models/shared/commercereporterror.py index 3eb5b42d7..af421235d 100755 --- a/lending/src/codatlending/models/shared/commercereporterror.py +++ b/lending/src/codatlending/models/shared/commercereporterror.py @@ -4,15 +4,17 @@ import dataclasses from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReportError: - details: Optional[dict[str, list[str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) + details: Optional[Dict[str, List[str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) + r"""Additional details on the error.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) + r"""Message returned by error.""" type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""The type of error.""" diff --git a/lending/src/codatlending/models/shared/commercereportmeasure.py b/lending/src/codatlending/models/shared/commercereportmeasure.py index e76742935..9feba37ca 100755 --- a/lending/src/codatlending/models/shared/commercereportmeasure.py +++ b/lending/src/codatlending/models/shared/commercereportmeasure.py @@ -8,12 +8,15 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceReportMeasure: display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) + r"""The measure's display name.""" index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) + r"""The measure's index.""" type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""The measure's type.""" units: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('units'), 'exclude': lambda f: f is None }}) + r"""The measure's units e.g. percentage (%).""" diff --git a/lending/src/codatlending/models/shared/commercetransaction.py b/lending/src/codatlending/models/shared/commercetransaction.py index b3360eb7f..860b48421 100755 --- a/lending/src/codatlending/models/shared/commercetransaction.py +++ b/lending/src/codatlending/models/shared/commercetransaction.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import supplementaldata as shared_supplementaldata from ..shared import transactionsourceref as shared_transactionsourceref from ..shared import transactiontype as shared_transactiontype from codatlending import utils @@ -11,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceTransaction: r"""Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees. @@ -82,6 +82,11 @@ class CommerceTransaction: source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) sub_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subType'), 'exclude': lambda f: f is None }}) r"""Non-standardised transaction type data from the commerce platform""" + supplemental_data: Optional[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + r"""Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + """ total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The total transaction amount""" transaction_source_ref: Optional[shared_transactionsourceref.TransactionSourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionSourceRef'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/commercetransactions.py b/lending/src/codatlending/models/shared/commercetransactions.py index 0a7e83030..ab9b64925 100755 --- a/lending/src/codatlending/models/shared/commercetransactions.py +++ b/lending/src/codatlending/models/shared/commercetransactions.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CommerceTransactions: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_commercetransaction.CommerceTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_commercetransaction.CommerceTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/companies.py b/lending/src/codatlending/models/shared/companies.py index d36d6fc5f..279df7a12 100755 --- a/lending/src/codatlending/models/shared/companies.py +++ b/lending/src/codatlending/models/shared/companies.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Companies: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_company.Company]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_company.Company]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/company.py b/lending/src/codatlending/models/shared/company.py index b1c5ec332..ad8ef239f 100755 --- a/lending/src/codatlending/models/shared/company.py +++ b/lending/src/codatlending/models/shared/company.py @@ -5,11 +5,10 @@ from ..shared import connection as shared_connection from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Company: r"""In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. @@ -46,7 +45,8 @@ class Company: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ created_by_user_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdByUserName'), 'exclude': lambda f: f is None }}) - data_connections: Optional[list[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections'), 'exclude': lambda f: f is None }}) + r"""Name of user that created the company in Codat.""" + data_connections: Optional[List[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnections'), 'exclude': lambda f: f is None }}) description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""Additional information about the company. This can be used to store foreign IDs, references, etc.""" last_sync: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSync'), 'exclude': lambda f: f is None }}) @@ -71,6 +71,9 @@ class Company: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ platform: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platform'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + r"""`platformKeys` name used when creating the company. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ diff --git a/lending/src/codatlending/models/shared/companyrequestbody.py b/lending/src/codatlending/models/shared/companyrequestbody.py index 436151714..440b1b5fd 100755 --- a/lending/src/codatlending/models/shared/companyrequestbody.py +++ b/lending/src/codatlending/models/shared/companyrequestbody.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CompanyRequestBody: name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/lending/src/codatlending/models/shared/connection.py b/lending/src/codatlending/models/shared/connection.py index 79031cd15..1284142d5 100755 --- a/lending/src/codatlending/models/shared/connection.py +++ b/lending/src/codatlending/models/shared/connection.py @@ -7,7 +7,7 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum -from typing import Any, Optional +from typing import Any, Dict, List, Optional class ConnectionSourceType(str, Enum): r"""The type of platform of the connection.""" @@ -19,7 +19,6 @@ class ConnectionSourceType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Connection: r"""A connection represents a [company's](https://docs.codat.io/lending-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. @@ -61,7 +60,9 @@ class Connection: integration_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationKey') }}) r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" link_url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('linkUrl') }}) + r"""The link URL your customers can use to authorize access to their business application.""" platform_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformName') }}) + r"""Name of integration connected to company.""" source_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceId') }}) r"""A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.""" source_type: ConnectionSourceType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) @@ -69,8 +70,8 @@ class Connection: status: shared_dataconnectionstatus.DataConnectionStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current authorization status of the data connection.""" additional_properties: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('additionalProperties'), 'exclude': lambda f: f is None }}) - connection_info: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionInfo'), 'exclude': lambda f: f is None }}) - data_connection_errors: Optional[list[shared_dataconnectionerror.DataConnectionError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionErrors'), 'exclude': lambda f: f is None }}) + connection_info: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionInfo'), 'exclude': lambda f: f is None }}) + data_connection_errors: Optional[List[shared_dataconnectionerror.DataConnectionError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionErrors'), 'exclude': lambda f: f is None }}) last_sync: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSync'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/connections.py b/lending/src/codatlending/models/shared/connections.py index 4300ecde8..063e65f0a 100755 --- a/lending/src/codatlending/models/shared/connections.py +++ b/lending/src/codatlending/models/shared/connections.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Connections: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_connection.Connection]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/contact.py b/lending/src/codatlending/models/shared/contact.py index 9c4acec8a..f821a40da 100755 --- a/lending/src/codatlending/models/shared/contact.py +++ b/lending/src/codatlending/models/shared/contact.py @@ -7,17 +7,16 @@ from ..shared import phonenumber as shared_phonenumber from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Contact: status: shared_customerstatus.CustomerStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Status of customer.""" address: Optional[shared_accountingaddress.AccountingAddress] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('address'), 'exclude': lambda f: f is None }}) - email: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email'), 'exclude': lambda f: f is None }}) + email: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) r"""Email of a contact for a customer.""" modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -40,9 +39,9 @@ class Contact: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of a contact for a customer.""" - phone: Optional[list[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone'), 'exclude': lambda f: f is None }}) + phone: Optional[List[shared_phonenumber.PhoneNumber]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('phone') }}) r"""An array of Phone numbers.""" diff --git a/lending/src/codatlending/models/shared/contactref.py b/lending/src/codatlending/models/shared/contactref.py index 40e46965b..74002551c 100755 --- a/lending/src/codatlending/models/shared/contactref.py +++ b/lending/src/codatlending/models/shared/contactref.py @@ -2,17 +2,19 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ContactRef: r"""The customer or supplier for the transfer, if available.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a customer or supplier.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" diff --git a/lending/src/codatlending/models/shared/createbankaccounttransaction.py b/lending/src/codatlending/models/shared/createbankaccounttransaction.py index 61aa96518..efb3569a3 100755 --- a/lending/src/codatlending/models/shared/createbankaccounttransaction.py +++ b/lending/src/codatlending/models/shared/createbankaccounttransaction.py @@ -9,11 +9,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreateBankAccountTransaction: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The amount transacted in the bank transaction.""" balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The remaining balance in the account with ID `accountId`.""" date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -36,6 +37,8 @@ class CreateBankAccountTransaction: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + r"""Description of the bank transaction.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Identifier for the bank account transaction, unique for the company in the accounting platform.""" diff --git a/lending/src/codatlending/models/shared/creditnotelineitem.py b/lending/src/codatlending/models/shared/creditnotelineitem.py index a953648b0..0cc2f69ab 100755 --- a/lending/src/codatlending/models/shared/creditnotelineitem.py +++ b/lending/src/codatlending/models/shared/creditnotelineitem.py @@ -10,11 +10,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class CreditNoteLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -23,18 +22,19 @@ class CreditNoteLineItem: r"""Unit price of the goods or service.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of each line item. For example, the goods or service for which credit has been issued.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Value of any discounts applied.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate of any discount applied to the line item.""" is_direct_income: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDirectIncome'), 'exclude': lambda f: f is None }}) + r"""The credit note is a direct income if `True`.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of credit associated with the line item, including discounts but excluding tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax associated with the line item.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -48,11 +48,11 @@ class CreditNoteLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line item, including discounts and tax.""" tracking: Optional[shared_accountsreceivabletracking.AccountsReceivableTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories to which the line item is linked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/lending/src/codatlending/models/shared/creditnotestatus.py b/lending/src/codatlending/models/shared/creditnotestatus.py index df12ba166..adbebfef0 100755 --- a/lending/src/codatlending/models/shared/creditnotestatus.py +++ b/lending/src/codatlending/models/shared/creditnotestatus.py @@ -4,6 +4,7 @@ from enum import Enum class CreditNoteStatus(str, Enum): + r"""Current state of the credit note.""" UNKNOWN = 'Unknown' DRAFT = 'Draft' SUBMITTED = 'Submitted' diff --git a/lending/src/codatlending/models/shared/dataconnectionerror.py b/lending/src/codatlending/models/shared/dataconnectionerror.py index b2bfa1562..e824f70d4 100755 --- a/lending/src/codatlending/models/shared/dataconnectionerror.py +++ b/lending/src/codatlending/models/shared/dataconnectionerror.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataConnectionError: errored_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('erroredOnUtc'), 'exclude': lambda f: f is None }}) @@ -33,7 +32,10 @@ class DataConnectionError: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) + r"""A brief message about the error.""" status_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) + r"""The HTTP status code returned by the error.""" status_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusText'), 'exclude': lambda f: f is None }}) + r"""A non-numeric status code/text.""" diff --git a/lending/src/codatlending/models/shared/dataintegrityamounts.py b/lending/src/codatlending/models/shared/dataintegrityamounts.py index fdd657848..798310300 100755 --- a/lending/src/codatlending/models/shared/dataintegrityamounts.py +++ b/lending/src/codatlending/models/shared/dataintegrityamounts.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityAmounts: r"""Only returned for transactions. For accounts, there is nothing returned.""" diff --git a/lending/src/codatlending/models/shared/dataintegritybyamount.py b/lending/src/codatlending/models/shared/dataintegritybyamount.py index ad7404fa8..89477e1ce 100755 --- a/lending/src/codatlending/models/shared/dataintegritybyamount.py +++ b/lending/src/codatlending/models/shared/dataintegritybyamount.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityByAmount: currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritybycount.py b/lending/src/codatlending/models/shared/dataintegritybycount.py index a96c627b5..aad30b16e 100755 --- a/lending/src/codatlending/models/shared/dataintegritybycount.py +++ b/lending/src/codatlending/models/shared/dataintegritybycount.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityByCount: matched: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matched'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegrityconnectionid.py b/lending/src/codatlending/models/shared/dataintegrityconnectionid.py index c82c9b30a..302163dcb 100755 --- a/lending/src/codatlending/models/shared/dataintegrityconnectionid.py +++ b/lending/src/codatlending/models/shared/dataintegrityconnectionid.py @@ -4,16 +4,15 @@ import dataclasses from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityConnectionID: - source: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) + source: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('source'), 'exclude': lambda f: f is None }}) r"""An array of strings. The connection IDs for the type specified in the url.""" - target: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('target'), 'exclude': lambda f: f is None }}) + target: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('target'), 'exclude': lambda f: f is None }}) r"""An array of strings. The connection IDs for the type being matched to.""" diff --git a/lending/src/codatlending/models/shared/dataintegritydates.py b/lending/src/codatlending/models/shared/dataintegritydates.py index 8eff420e9..6b68d3941 100755 --- a/lending/src/codatlending/models/shared/dataintegritydates.py +++ b/lending/src/codatlending/models/shared/dataintegritydates.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityDates: r"""Only returned for transactions. For accounts, there is nothing returned.""" diff --git a/lending/src/codatlending/models/shared/dataintegritydetail.py b/lending/src/codatlending/models/shared/dataintegritydetail.py index ef58062a5..94e27cd00 100755 --- a/lending/src/codatlending/models/shared/dataintegritydetail.py +++ b/lending/src/codatlending/models/shared/dataintegritydetail.py @@ -6,11 +6,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityDetail: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) @@ -51,7 +50,7 @@ class DataIntegrityDetail: r"""The transaction description.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""ID GUID of the transaction.""" - matches: Optional[list[shared_dataintegritymatch.DataIntegrityMatch]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matches'), 'exclude': lambda f: f is None }}) + matches: Optional[List[shared_dataintegritymatch.DataIntegrityMatch]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matches'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) r"""The data type of the record.""" diff --git a/lending/src/codatlending/models/shared/dataintegritydetails.py b/lending/src/codatlending/models/shared/dataintegritydetails.py index 9423b4e12..4805fea1c 100755 --- a/lending/src/codatlending/models/shared/dataintegritydetails.py +++ b/lending/src/codatlending/models/shared/dataintegritydetails.py @@ -6,17 +6,19 @@ from ..shared import links as shared_links from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityDetails: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_dataintegritydetail.DataIntegrityDetail]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_dataintegritydetail.DataIntegrityDetail]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritymatch.py b/lending/src/codatlending/models/shared/dataintegritymatch.py index 480e0eef4..4086c03a0 100755 --- a/lending/src/codatlending/models/shared/dataintegritymatch.py +++ b/lending/src/codatlending/models/shared/dataintegritymatch.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityMatch: amount: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritystatus.py b/lending/src/codatlending/models/shared/dataintegritystatus.py index 900c5944e..79c134119 100755 --- a/lending/src/codatlending/models/shared/dataintegritystatus.py +++ b/lending/src/codatlending/models/shared/dataintegritystatus.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityStatus: amounts: Optional[shared_dataintegrityamounts.DataIntegrityAmounts] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amounts'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritystatuses.py b/lending/src/codatlending/models/shared/dataintegritystatuses.py index 22e538f8a..a0e0ca7c8 100755 --- a/lending/src/codatlending/models/shared/dataintegritystatuses.py +++ b/lending/src/codatlending/models/shared/dataintegritystatuses.py @@ -5,13 +5,12 @@ from ..shared import dataintegritystatus as shared_dataintegritystatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityStatuses: - metadata: Optional[list[shared_dataintegritystatus.DataIntegrityStatus]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) + metadata: Optional[List[shared_dataintegritystatus.DataIntegrityStatus]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritystatusinfo.py b/lending/src/codatlending/models/shared/dataintegritystatusinfo.py index 0789c3171..d59d5454d 100755 --- a/lending/src/codatlending/models/shared/dataintegritystatusinfo.py +++ b/lending/src/codatlending/models/shared/dataintegritystatusinfo.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegrityStatusInfo: current_status: Optional[shared_integritystatus.IntegrityStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritysummaries.py b/lending/src/codatlending/models/shared/dataintegritysummaries.py index 175ff5af0..4e3ad4dd3 100755 --- a/lending/src/codatlending/models/shared/dataintegritysummaries.py +++ b/lending/src/codatlending/models/shared/dataintegritysummaries.py @@ -5,13 +5,12 @@ from ..shared import dataintegritysummary as shared_dataintegritysummary from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegritySummaries: - summaries: Optional[list[shared_dataintegritysummary.DataIntegritySummary]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summaries'), 'exclude': lambda f: f is None }}) + summaries: Optional[List[shared_dataintegritysummary.DataIntegritySummary]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summaries'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/dataintegritysummary.py b/lending/src/codatlending/models/shared/dataintegritysummary.py index 724f888ff..8fdfa243e 100755 --- a/lending/src/codatlending/models/shared/dataintegritysummary.py +++ b/lending/src/codatlending/models/shared/dataintegritysummary.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataIntegritySummary: by_amount: Optional[shared_dataintegritybyamount.DataIntegrityByAmount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byAmount'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/datasource.py b/lending/src/codatlending/models/shared/datasource.py index 3049275fa..c6e65b31f 100755 --- a/lending/src/codatlending/models/shared/datasource.py +++ b/lending/src/codatlending/models/shared/datasource.py @@ -5,14 +5,13 @@ from ..shared import accounts as shared_accounts from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DataSource: - accounts: Optional[list[shared_accounts.Accounts]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[List[shared_accounts.Accounts]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) r"""An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.""" diff --git a/lending/src/codatlending/models/shared/datastatus.py b/lending/src/codatlending/models/shared/datastatus.py index fa8079d84..0cac937f4 100755 --- a/lending/src/codatlending/models/shared/datastatus.py +++ b/lending/src/codatlending/models/shared/datastatus.py @@ -4,16 +4,63 @@ import dataclasses from codatlending import utils from dataclasses_json import Undefined, dataclass_json +from enum import Enum from typing import Optional +class DataStatusDataTypes(str, Enum): + r"""Available Data types""" + ACCOUNT_TRANSACTIONS = 'accountTransactions' + BALANCE_SHEET = 'balanceSheet' + BANK_ACCOUNTS = 'bankAccounts' + BANK_TRANSACTIONS = 'bankTransactions' + BILL_CREDIT_NOTES = 'billCreditNotes' + BILL_PAYMENTS = 'billPayments' + BILLS = 'bills' + CASH_FLOW_STATEMENT = 'cashFlowStatement' + CHART_OF_ACCOUNTS = 'chartOfAccounts' + COMPANY = 'company' + CREDIT_NOTES = 'creditNotes' + CUSTOMERS = 'customers' + DIRECT_COSTS = 'directCosts' + DIRECT_INCOMES = 'directIncomes' + INVOICES = 'invoices' + ITEMS = 'items' + JOURNAL_ENTRIES = 'journalEntries' + JOURNALS = 'journals' + PAYMENT_METHODS = 'paymentMethods' + PAYMENTS = 'payments' + PROFIT_AND_LOSS = 'profitAndLoss' + PURCHASE_ORDERS = 'purchaseOrders' + SALES_ORDERS = 'salesOrders' + SUPPLIERS = 'suppliers' + TAX_RATES = 'taxRates' + TRACKING_CATEGORIES = 'trackingCategories' + TRANSFERS = 'transfers' + BANKING_ACCOUNT_BALANCES = 'banking-accountBalances' + BANKING_ACCOUNTS = 'banking-accounts' + BANKING_TRANSACTION_CATEGORIES = 'banking-transactionCategories' + BANKING_TRANSACTIONS = 'banking-transactions' + COMMERCE_COMPANY_INFO = 'commerce-companyInfo' + COMMERCE_CUSTOMERS = 'commerce-customers' + COMMERCE_DISPUTES = 'commerce-disputes' + COMMERCE_LOCATIONS = 'commerce-locations' + COMMERCE_ORDERS = 'commerce-orders' + COMMERCE_PAYMENT_METHODS = 'commerce-paymentMethods' + COMMERCE_PAYMENTS = 'commerce-payments' + COMMERCE_PRODUCT_CATEGORIES = 'commerce-productCategories' + COMMERCE_PRODUCTS = 'commerce-products' + COMMERCE_TAX_COMPONENTS = 'commerce-taxComponents' + COMMERCE_TRANSACTIONS = 'commerce-transactions' -@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataStatus: r"""Describes the state of data in the Codat cache for a company and data type""" current_status: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus') }}) - data_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""The current status of the dataset in Codat's cache.""" + data_type: DataStatusDataTypes = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Available Data types""" last_successful_sync: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastSuccessfulSync') }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -36,6 +83,8 @@ class DataStatus: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ latest_successful_sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('latestSuccessfulSyncId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the most recent successful sync of data type.""" latest_sync_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('latestSyncId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for most recent sync of data type.""" diff --git a/lending/src/codatlending/models/shared/definitionsitemref.py b/lending/src/codatlending/models/shared/definitionsitemref.py index fa519f8a4..c4b135f3e 100755 --- a/lending/src/codatlending/models/shared/definitionsitemref.py +++ b/lending/src/codatlending/models/shared/definitionsitemref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DefinitionsitemRef: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/directcostlineitem.py b/lending/src/codatlending/models/shared/directcostlineitem.py index 1796ca7b5..ec421bbcb 100755 --- a/lending/src/codatlending/models/shared/directcostlineitem.py +++ b/lending/src/codatlending/models/shared/directcostlineitem.py @@ -10,11 +10,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectCostLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -28,17 +27,17 @@ class DirectCostLineItem: """ account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of the goods or services.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount amount for the line before tax.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount percentage for the line before tax.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of the line, inclusive of discounts but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax for the line.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -52,10 +51,10 @@ class DirectCostLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line, including tax.""" tracking: Optional[shared_tracking.Tracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Collection of categories against which this direct cost is tracked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/lending/src/codatlending/models/shared/directincomelineitem.py b/lending/src/codatlending/models/shared/directincomelineitem.py index eaa1c6040..e89f12647 100755 --- a/lending/src/codatlending/models/shared/directincomelineitem.py +++ b/lending/src/codatlending/models/shared/directincomelineitem.py @@ -9,11 +9,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class DirectIncomeLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -27,17 +26,17 @@ class DirectIncomeLineItem: """ account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""A user-friendly name of the goods or services.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount amount for the line before tax.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Discount percentage for the line before tax.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The amount of the line, inclusive of discounts, but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The amount of tax for the line. Note: If the platform does not provide this information, the quantity will be mapped as 0.00. """ @@ -53,9 +52,9 @@ class DirectIncomeLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""The total amount of the line, including tax.""" - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""An array of categories against which this direct cost is tracked.""" diff --git a/lending/src/codatlending/models/shared/enhancedcashflowitem.py b/lending/src/codatlending/models/shared/enhancedcashflowitem.py index 56d467665..cc8d2ece0 100755 --- a/lending/src/codatlending/models/shared/enhancedcashflowitem.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowitem.py @@ -5,14 +5,13 @@ from ..shared import enhancedcashflowtransaction as shared_enhancedcashflowtransaction from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedCashFlowItem: - transactions: Optional[list[shared_enhancedcashflowtransaction.EnhancedCashFlowTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) + transactions: Optional[List[shared_enhancedcashflowtransaction.EnhancedCashFlowTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) r"""An array of transaction data.""" diff --git a/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py b/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py index 0e34513bb..2df7a2c31 100755 --- a/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py @@ -12,7 +12,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedCashFlowTransaction: account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) @@ -20,6 +19,14 @@ class EnhancedCashFlowTransaction: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The bank transaction amount.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) + r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. + + ## Unknown currencies + + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. + + There are only a very small number of edge cases where this currency code is returned by the Codat system. + """ date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py b/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py index a512a2e29..b5e023d90 100755 --- a/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py @@ -7,11 +7,10 @@ from ..shared import reportinfo as shared_reportinfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedCashFlowTransactions: r"""> **Categorization engine** @@ -20,9 +19,9 @@ class EnhancedCashFlowTransactions: The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. """ - data_sources: Optional[list[shared_datasource.DataSource]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSources'), 'exclude': lambda f: f is None }}) + data_sources: Optional[List[shared_datasource.DataSource]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSources'), 'exclude': lambda f: f is None }}) report_info: Optional[shared_reportinfo.ReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - r"""Report additional information, which is specific to Assess reports""" - report_items: Optional[list[shared_enhancedcashflowitem.EnhancedCashFlowItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + r"""Report additional information, which is specific to Lending API reports.""" + report_items: Optional[List[shared_enhancedcashflowitem.EnhancedCashFlowItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/enhancedfinancialreport.py b/lending/src/codatlending/models/shared/enhancedfinancialreport.py index ef565b25e..fd7063017 100755 --- a/lending/src/codatlending/models/shared/enhancedfinancialreport.py +++ b/lending/src/codatlending/models/shared/enhancedfinancialreport.py @@ -7,11 +7,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedFinancialReportReportItem: account_category: Optional[shared_enhancedreportaccountcategory.EnhancedReportAccountCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountCategory'), 'exclude': lambda f: f is None }}) @@ -47,11 +46,10 @@ class EnhancedFinancialReportReportItem: @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedFinancialReport: report_info: Optional[shared_enhancedreportinfo.EnhancedReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[list[EnhancedFinancialReportReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[List[EnhancedFinancialReportReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""An array of report items.""" diff --git a/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py b/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py index 501f7e9c8..1875ab4d0 100755 --- a/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py +++ b/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py @@ -8,14 +8,14 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedInvoiceReportItem: amount_due: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amountDue'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Invoice's total amount due.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -48,8 +48,9 @@ class EnhancedInvoiceReportItem: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""ID of the invoice, which may be a GUID but it may be something else depending on the accounting platdform""" + r"""ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform.""" invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber'), 'exclude': lambda f: f is None }}) + r"""Invoice number.""" issue_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -93,7 +94,7 @@ class EnhancedInvoiceReportItem: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - payments: Optional[list[shared_payment.Payment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) + payments: Optional[List[shared_payment.Payment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_invoicestatus.InvoiceStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Current state of the invoice: @@ -105,5 +106,6 @@ class EnhancedInvoiceReportItem: - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. """ total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""Invoice's total amount.""" diff --git a/lending/src/codatlending/models/shared/enhancedinvoicesreport.py b/lending/src/codatlending/models/shared/enhancedinvoicesreport.py index 6752ddc1c..3bbe44f61 100755 --- a/lending/src/codatlending/models/shared/enhancedinvoicesreport.py +++ b/lending/src/codatlending/models/shared/enhancedinvoicesreport.py @@ -6,16 +6,15 @@ from ..shared import reportinfo as shared_reportinfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedInvoicesReport: r"""The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting platform have actually been paid by matching with the bank statement.""" report_info: Optional[shared_reportinfo.ReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - r"""Report additional information, which is specific to Assess reports""" - report_items: Optional[list[shared_enhancedinvoicereportitem.EnhancedInvoiceReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + r"""Report additional information, which is specific to Lending API reports.""" + report_items: Optional[List[shared_enhancedinvoicereportitem.EnhancedInvoiceReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py b/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py index 6c3cb2dac..f4ebd2b10 100755 --- a/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py +++ b/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py @@ -5,14 +5,13 @@ from ..shared import accountcategorylevel as shared_accountcategorylevel from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedReportAccountCategory: - levels: Optional[list[shared_accountcategorylevel.AccountCategoryLevel]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) + levels: Optional[List[shared_accountcategorylevel.AccountCategoryLevel]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Returns a status of \\"Suggested\\" or \\"Confirmed\\". If an account has a confirmed category, it will replace any suggested category returned.""" diff --git a/lending/src/codatlending/models/shared/enhancedreportinfo.py b/lending/src/codatlending/models/shared/enhancedreportinfo.py index 4688f5736..f2dfbef95 100755 --- a/lending/src/codatlending/models/shared/enhancedreportinfo.py +++ b/lending/src/codatlending/models/shared/enhancedreportinfo.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class EnhancedReportInfo: company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/errormessage.py b/lending/src/codatlending/models/shared/errormessage.py index ee3a5a79b..49a7bd5f4 100755 --- a/lending/src/codatlending/models/shared/errormessage.py +++ b/lending/src/codatlending/models/shared/errormessage.py @@ -8,14 +8,19 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ErrorMessage: can_be_retried: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('canBeRetried'), 'exclude': lambda f: f is None }}) + r"""`True` if the error occurred transiently and can be retried.""" correlation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('correlationId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier used to propagate to all downstream services and determine the source of the error.""" detailed_error_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detailedErrorCode'), 'exclude': lambda f: f is None }}) + r"""Machine readable error code used to automate processes based on the code returned.""" error: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('error'), 'exclude': lambda f: f is None }}) + r"""A brief description of the error.""" service: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('service'), 'exclude': lambda f: f is None }}) + r"""Codat's service the returned the error.""" status_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) + r"""The HTTP status code returned by the error.""" diff --git a/lending/src/codatlending/models/shared/excelstatus.py b/lending/src/codatlending/models/shared/excelstatus.py index c90c2c93a..98cd97500 100755 --- a/lending/src/codatlending/models/shared/excelstatus.py +++ b/lending/src/codatlending/models/shared/excelstatus.py @@ -9,12 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ExcelStatus: error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) r"""Error details in case the report generation request was unsuccessful.""" - file_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileSize'), 'exclude': lambda f: f is None }}) + file_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileSize') }}) r"""The file size in Bytes is populated upon successful generation of the report.""" in_progress: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inProgress'), 'exclude': lambda f: f is None }}) r"""When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.""" diff --git a/lending/src/codatlending/models/shared/file.py b/lending/src/codatlending/models/shared/file.py index 4b3fe21d1..49d4d9285 100755 --- a/lending/src/codatlending/models/shared/file.py +++ b/lending/src/codatlending/models/shared/file.py @@ -8,12 +8,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class File: - display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) - file_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileName'), 'exclude': lambda f: f is None }}) - source_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType'), 'exclude': lambda f: f is None }}) + display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) + r"""An optional display name for the file.""" + file_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileName') }}) + r"""The file's name.""" + source_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) + r"""The source of the file uploaded.""" uploaded: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('uploaded'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/halref.py b/lending/src/codatlending/models/shared/halref.py index 6e0a92fb0..35780507a 100755 --- a/lending/src/codatlending/models/shared/halref.py +++ b/lending/src/codatlending/models/shared/halref.py @@ -8,9 +8,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class HalRef: href: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('href'), 'exclude': lambda f: f is None }}) + r"""Uri hypertext reference.""" diff --git a/lending/src/codatlending/models/shared/invoicelineitem.py b/lending/src/codatlending/models/shared/invoicelineitem.py index 558f4594e..c6a188d33 100755 --- a/lending/src/codatlending/models/shared/invoicelineitem.py +++ b/lending/src/codatlending/models/shared/invoicelineitem.py @@ -10,11 +10,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class InvoiceLineItem: quantity: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -23,18 +22,19 @@ class InvoiceLineItem: r"""Price of each unit of goods or services.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Friendly name of the goods or services provided.""" - discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of any discounts applied.""" - discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + discount_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate (from 0 to 100) of any discounts applied to the unit amount.""" is_direct_income: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDirectIncome'), 'exclude': lambda f: f is None }}) + r"""The invoice is a direct income if `True`.""" item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) r"""Reference to the item the line is linked to.""" - sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + sub_total: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of the line, inclusive of discounts but exclusive of tax.""" - tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount of tax for the line.""" tax_rate_ref: Optional[shared_taxrateref.TaxRateRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxRateRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. @@ -48,11 +48,11 @@ class InvoiceLineItem: - Invoice line items - Items """ - total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.""" tracking: Optional[shared_accountsreceivabletracking.AccountsReceivableTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""Categories, and a project and customer, against which the item is tracked.""" - tracking_category_refs: Optional[list[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs'), 'exclude': lambda f: f is None }}) + tracking_category_refs: Optional[List[shared_trackingcategoryref.TrackingCategoryRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('trackingCategoryRefs') }}) r"""Reference to the tracking categories to which the line item is linked. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/lending/src/codatlending/models/shared/itemref.py b/lending/src/codatlending/models/shared/itemref.py index 641604678..d51c18366 100755 --- a/lending/src/codatlending/models/shared/itemref.py +++ b/lending/src/codatlending/models/shared/itemref.py @@ -8,13 +8,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ItemRef: r"""Reference to the item the line is linked to.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""Unique identifier for the item in the accounting platform.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the item in the accounting platform.""" diff --git a/lending/src/codatlending/models/shared/items.py b/lending/src/codatlending/models/shared/items.py index 693099547..73ba98d92 100755 --- a/lending/src/codatlending/models/shared/items.py +++ b/lending/src/codatlending/models/shared/items.py @@ -8,10 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Items: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""Amount of tax withheld.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name assigned to withheld tax.""" diff --git a/lending/src/codatlending/models/shared/journalline.py b/lending/src/codatlending/models/shared/journalline.py index 472aeb32b..d3cdc53ed 100755 --- a/lending/src/codatlending/models/shared/journalline.py +++ b/lending/src/codatlending/models/shared/journalline.py @@ -7,30 +7,28 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class JournalLineTracking: r"""List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)""" - record_refs: Optional[list[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs'), 'exclude': lambda f: f is None }}) + record_refs: Optional[List[shared_recordref.RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class JournalLine: net_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('netAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" - currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) + currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""Currency for the journal line item.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""Description of the journal line item.""" tracking: Optional[JournalLineTracking] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tracking'), 'exclude': lambda f: f is None }}) r"""List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)""" diff --git a/lending/src/codatlending/models/shared/journalref.py b/lending/src/codatlending/models/shared/journalref.py index 409a3087f..a2f13a088 100755 --- a/lending/src/codatlending/models/shared/journalref.py +++ b/lending/src/codatlending/models/shared/journalref.py @@ -8,13 +8,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class JournalRef: r"""Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""GUID of the underlying journal.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of journal""" diff --git a/lending/src/codatlending/models/shared/lendingcustomerref.py b/lending/src/codatlending/models/shared/lendingcustomerref.py index 96f2ba8f0..13ebcda1f 100755 --- a/lending/src/codatlending/models/shared/lendingcustomerref.py +++ b/lending/src/codatlending/models/shared/lendingcustomerref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LendingCustomerRef: - customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName'), 'exclude': lambda f: f is None }}) - r"""`customerName` from the Customer data type""" + customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName') }}) + r"""`customerName` from the Customer data type.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""`id` from the Customers data type""" + r"""`id` from the Customers data type.""" diff --git a/lending/src/codatlending/models/shared/links.py b/lending/src/codatlending/models/shared/links.py index 0662f149e..d7f906cfd 100755 --- a/lending/src/codatlending/models/shared/links.py +++ b/lending/src/codatlending/models/shared/links.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Links: current: shared_halref.HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current') }}) diff --git a/lending/src/codatlending/models/shared/loanref.py b/lending/src/codatlending/models/shared/loanref.py index 6cbb73b6b..9b16a97f6 100755 --- a/lending/src/codatlending/models/shared/loanref.py +++ b/lending/src/codatlending/models/shared/loanref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanRef: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/loansummary.py b/lending/src/codatlending/models/shared/loansummary.py index 5c9be8722..c7690ddfa 100755 --- a/lending/src/codatlending/models/shared/loansummary.py +++ b/lending/src/codatlending/models/shared/loansummary.py @@ -6,15 +6,14 @@ from ..shared import loansummaryreportitem as shared_loansummaryreportitem from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanSummary: report_info: Optional[shared_loansummaryreportinfo.LoanSummaryReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[list[shared_loansummaryreportitem.LoanSummaryReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[List[shared_loansummaryreportitem.LoanSummaryReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""Returns a summary of all loan activity for that integration type""" diff --git a/lending/src/codatlending/models/shared/loansummaryrecordref.py b/lending/src/codatlending/models/shared/loansummaryrecordref.py index 692cca94c..e8f367e6d 100755 --- a/lending/src/codatlending/models/shared/loansummaryrecordref.py +++ b/lending/src/codatlending/models/shared/loansummaryrecordref.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanSummaryRecordRef: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/loansummaryreportinfo.py b/lending/src/codatlending/models/shared/loansummaryreportinfo.py index c19c0b28b..1a5701b75 100755 --- a/lending/src/codatlending/models/shared/loansummaryreportinfo.py +++ b/lending/src/codatlending/models/shared/loansummaryreportinfo.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanSummaryReportInfo: company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/loansummaryreportitem.py b/lending/src/codatlending/models/shared/loansummaryreportitem.py index 3bfc731ec..538e70413 100755 --- a/lending/src/codatlending/models/shared/loansummaryreportitem.py +++ b/lending/src/codatlending/models/shared/loansummaryreportitem.py @@ -10,13 +10,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanSummaryReportItem: balance: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""The description of the object being referred to. E.g. the account.""" + lender_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lenderName'), 'exclude': lambda f: f is None }}) + r"""The name of lender providing the loan.""" record_ref: Optional[shared_loansummaryrecordref.LoanSummaryRecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) start_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('startDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: diff --git a/lending/src/codatlending/models/shared/loantransactions.py b/lending/src/codatlending/models/shared/loantransactions.py index 59639d6b5..6c17c4ed5 100755 --- a/lending/src/codatlending/models/shared/loantransactions.py +++ b/lending/src/codatlending/models/shared/loantransactions.py @@ -6,17 +6,16 @@ from ..shared import reportitems as shared_reportitems from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Any, Optional +from typing import Any, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanTransactions: - errors: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) + errors: Optional[List[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) r"""If there are no errors, an empty array is returned.""" report_info: Optional[shared_loantransactionsreportinfo.LoanTransactionsReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[list[shared_reportitems.ReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[List[shared_reportitems.ReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""Contains object of reporting properties. The loan ref will reference a different object depending on the integration type.""" diff --git a/lending/src/codatlending/models/shared/loantransactionsreportinfo.py b/lending/src/codatlending/models/shared/loantransactionsreportinfo.py index 39359018b..b211bf9e5 100755 --- a/lending/src/codatlending/models/shared/loantransactionsreportinfo.py +++ b/lending/src/codatlending/models/shared/loantransactionsreportinfo.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LoanTransactionsReportInfo: company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/locationref.py b/lending/src/codatlending/models/shared/locationref.py index c7c99584b..87835ffc9 100755 --- a/lending/src/codatlending/models/shared/locationref.py +++ b/lending/src/codatlending/models/shared/locationref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class LocationRef: r"""Reference to the geographic location where the order was placed.""" diff --git a/lending/src/codatlending/models/shared/metadata.py b/lending/src/codatlending/models/shared/metadata.py index ca49246c0..e9257b9f7 100755 --- a/lending/src/codatlending/models/shared/metadata.py +++ b/lending/src/codatlending/models/shared/metadata.py @@ -8,10 +8,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Metadata: - is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted'), 'exclude': lambda f: f is None }}) + is_deleted: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isDeleted') }}) r"""Indicates whether the record has been deleted in the third-party system this record originated from.""" diff --git a/lending/src/codatlending/models/shared/orderdiscountallocation.py b/lending/src/codatlending/models/shared/orderdiscountallocation.py index 7906b3c3a..ebef55fb4 100755 --- a/lending/src/codatlending/models/shared/orderdiscountallocation.py +++ b/lending/src/codatlending/models/shared/orderdiscountallocation.py @@ -9,12 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderDiscountAllocation: name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the discount in the commerce or point of sale platform.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of discount applied.""" + r"""Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).""" diff --git a/lending/src/codatlending/models/shared/orderlineitem.py b/lending/src/codatlending/models/shared/orderlineitem.py index 35acf89f2..d8048becd 100755 --- a/lending/src/codatlending/models/shared/orderlineitem.py +++ b/lending/src/codatlending/models/shared/orderlineitem.py @@ -9,33 +9,32 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class OrderLineItem: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - discount_allocations: Optional[list[shared_orderdiscountallocation.OrderDiscountAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAllocations'), 'exclude': lambda f: f is None }}) + discount_allocations: Optional[List[shared_orderdiscountallocation.OrderDiscountAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAllocations'), 'exclude': lambda f: f is None }}) product_ref: Optional[shared_productref.ProductRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('productRef'), 'exclude': lambda f: f is None }}) r"""Reference that links the line item to the correct product details.""" product_variant_ref: Optional[shared_productvariantref.ProductVariantRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('productVariantRef'), 'exclude': lambda f: f is None }}) r"""Reference that links the line item to the specific version of product that has been ordered.""" quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Number of units of the product sold. - For refunds, quantity is a negative value. + For refunds, quantity is negative. """ - taxes: Optional[list[shared_taxcomponentallocation.TaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) + taxes: Optional[List[shared_taxcomponentallocation.TaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) r"""Taxes breakdown as applied to order lines.""" tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Percentage rate (from 0 to 100) of any sale tax applied to the unit amount.""" + r"""Percentage rate (from 0 to 100) of any sales tax applied to the unit price.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total price of the line item, including discounts, tax and minus any refunds.""" + r"""Total amount of the line item, including discounts and tax.""" total_tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalTaxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total amount of tax applied to the line item.""" + r"""Total amount of tax applied to the line item, factoring in any discounts.""" unit_price: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitPrice'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Price per unit of goods or service.""" + r"""Price per unit of goods or services, excluding discounts and tax.""" diff --git a/lending/src/codatlending/models/shared/payment.py b/lending/src/codatlending/models/shared/payment.py index 006b62132..93f9047ea 100755 --- a/lending/src/codatlending/models/shared/payment.py +++ b/lending/src/codatlending/models/shared/payment.py @@ -6,15 +6,15 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Payment: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - banking_transaction_refs: Optional[list[shared_bankingtransactionref.BankingTransactionRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankingTransactionRefs'), 'exclude': lambda f: f is None }}) + r"""Payment amount.""" + banking_transaction_refs: Optional[List[shared_bankingtransactionref.BankingTransactionRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankingTransactionRefs'), 'exclude': lambda f: f is None }}) currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -24,7 +24,7 @@ class Payment: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -73,7 +73,8 @@ class Payment: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform""" + r"""ID of the invoice, which may be a GUID but it may be something else depending on the accounting platform.""" payment_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentType'), 'exclude': lambda f: f is None }}) + r"""The type of payment.""" diff --git a/lending/src/codatlending/models/shared/paymentallocationpayment.py b/lending/src/codatlending/models/shared/paymentallocationpayment.py index 829d08705..48b218f0d 100755 --- a/lending/src/codatlending/models/shared/paymentallocationpayment.py +++ b/lending/src/codatlending/models/shared/paymentallocationpayment.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentAllocationPayment: account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) @@ -24,7 +23,7 @@ class PaymentAllocationPayment: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. @@ -53,7 +52,7 @@ class PaymentAllocationPayment: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Identifier of the allocated payment.""" - note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note'), 'exclude': lambda f: f is None }}) + note: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('note') }}) r"""Notes attached to the allocated payment.""" paid_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paidOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -76,7 +75,7 @@ class PaymentAllocationPayment: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference'), 'exclude': lambda f: f is None }}) + reference: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reference') }}) r"""Reference to the allocated payment.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Total amount that was paid.""" diff --git a/lending/src/codatlending/models/shared/paymentline.py b/lending/src/codatlending/models/shared/paymentline.py index 6e6fc07e1..1d9b1f5c2 100755 --- a/lending/src/codatlending/models/shared/paymentline.py +++ b/lending/src/codatlending/models/shared/paymentline.py @@ -6,11 +6,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentLine: amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) @@ -36,6 +35,6 @@ class PaymentLine: > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - links: Optional[list[shared_paymentlinelink.PaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links'), 'exclude': lambda f: f is None }}) + links: Optional[List[shared_paymentlinelink.PaymentLineLink]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('links') }}) diff --git a/lending/src/codatlending/models/shared/paymentlinelink.py b/lending/src/codatlending/models/shared/paymentlinelink.py index 21d4b444a..187eac5b3 100755 --- a/lending/src/codatlending/models/shared/paymentlinelink.py +++ b/lending/src/codatlending/models/shared/paymentlinelink.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentLineLink: type: shared_paymentlinktype.PaymentLinkType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) @@ -26,12 +25,12 @@ class PaymentLineLink: `Manual Journal` `Discount` - ID refers to the payment """ - amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Amount by which the balance of the linked entity is altered, in the currency of the linked entity. A negative link amount _reduces_ the outstanding amount on the accounts receivable account. A positive link amount _increases_ the outstanding amount on the accounts receivable account. """ - currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + currency_rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. diff --git a/lending/src/codatlending/models/shared/paymentmethodref.py b/lending/src/codatlending/models/shared/paymentmethodref.py new file mode 100755 index 000000000..8ccf0b8a2 --- /dev/null +++ b/lending/src/codatlending/models/shared/paymentmethodref.py @@ -0,0 +1,19 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatlending import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class PaymentMethodRef: + r"""The payment method the record is linked to in the accounting or commerce platform.""" + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""The unique identifier of the location being referenced.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Name of the location being referenced.""" + + diff --git a/lending/src/codatlending/models/shared/paymentmethodstatus.py b/lending/src/codatlending/models/shared/paymentmethodstatus.py deleted file mode 100755 index 9a8cecaa7..000000000 --- a/lending/src/codatlending/models/shared/paymentmethodstatus.py +++ /dev/null @@ -1,10 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -from enum import Enum - -class PaymentMethodStatus(str, Enum): - r"""Status of the Payment Method""" - ACTIVE = 'Active' - ARCHIVED = 'Archived' - UNKNOWN = 'Unknown' diff --git a/lending/src/codatlending/models/shared/paymentref.py b/lending/src/codatlending/models/shared/paymentref.py index f8378c06c..a58176903 100755 --- a/lending/src/codatlending/models/shared/paymentref.py +++ b/lending/src/codatlending/models/shared/paymentref.py @@ -11,12 +11,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PaymentRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Payment Amount (including gratuity).""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -75,7 +74,7 @@ class PaymentRef: source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_paymentstatus.PaymentStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Status of the payment.""" - type: Optional[shared_paymenttype.PaymentType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[shared_paymenttype.PaymentType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""Type of payment.""" diff --git a/lending/src/codatlending/models/shared/phonenumber.py b/lending/src/codatlending/models/shared/phonenumber.py index 7221f1aba..f7bd640ff 100755 --- a/lending/src/codatlending/models/shared/phonenumber.py +++ b/lending/src/codatlending/models/shared/phonenumber.py @@ -5,13 +5,13 @@ from ..shared import phonenumbertype as shared_phonenumbertype from codatlending import utils from dataclasses_json import Undefined, dataclass_json +from typing import Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PhoneNumber: - number: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) + number: Optional[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('number') }}) r"""A phone number.""" type: shared_phonenumbertype.PhoneNumberType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of phone number""" diff --git a/lending/src/codatlending/models/shared/productinventory.py b/lending/src/codatlending/models/shared/productinventory.py index d223c6580..fed37ec01 100755 --- a/lending/src/codatlending/models/shared/productinventory.py +++ b/lending/src/codatlending/models/shared/productinventory.py @@ -6,15 +6,15 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductInventory: r"""Information about the total inventory as well as the locations inventory is in.""" - locations: Optional[list[shared_productinventorylocation.ProductInventoryLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locations'), 'exclude': lambda f: f is None }}) - total_quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalQuantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + locations: Optional[List[shared_productinventorylocation.ProductInventoryLocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locations'), 'exclude': lambda f: f is None }}) + total_quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalQuantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) + r"""The total quantity of stock remaining across locations.""" diff --git a/lending/src/codatlending/models/shared/productinventorylocation.py b/lending/src/codatlending/models/shared/productinventorylocation.py index f85157ea1..ce7281b13 100755 --- a/lending/src/codatlending/models/shared/productinventorylocation.py +++ b/lending/src/codatlending/models/shared/productinventorylocation.py @@ -10,11 +10,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductInventoryLocation: location_ref: Optional[shared_locationref.LocationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locationRef'), 'exclude': lambda f: f is None }}) r"""Reference to the geographic location where the order was placed.""" quantity: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quantity'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The quantity of stock remaining at location.""" diff --git a/lending/src/codatlending/models/shared/productprice.py b/lending/src/codatlending/models/shared/productprice.py index 7079effab..677ce6525 100755 --- a/lending/src/codatlending/models/shared/productprice.py +++ b/lending/src/codatlending/models/shared/productprice.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductPrice: currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) @@ -22,5 +21,6 @@ class ProductPrice: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ unit_price: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitPrice'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The product variant's unit price.""" diff --git a/lending/src/codatlending/models/shared/productref.py b/lending/src/codatlending/models/shared/productref.py index 650da76cd..275cc1b07 100755 --- a/lending/src/codatlending/models/shared/productref.py +++ b/lending/src/codatlending/models/shared/productref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductRef: r"""Reference that links the line item to the correct product details.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - r"""The unique identitifer of the product being referenced.""" + r"""The unique identifier of the product being referenced.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product being referenced.""" diff --git a/lending/src/codatlending/models/shared/productvariant.py b/lending/src/codatlending/models/shared/productvariant.py index b30b3131e..eb2750103 100755 --- a/lending/src/codatlending/models/shared/productvariant.py +++ b/lending/src/codatlending/models/shared/productvariant.py @@ -8,11 +8,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductVariant: r"""Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors.""" @@ -48,7 +47,7 @@ class ProductVariant: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product recorded in the commerce or point of sale platform.""" - prices: Optional[list[shared_productprice.ProductPrice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prices'), 'exclude': lambda f: f is None }}) + prices: Optional[List[shared_productprice.ProductPrice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prices'), 'exclude': lambda f: f is None }}) r"""Prices for the product variants in different currencies.""" shipping_required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shippingRequired'), 'exclude': lambda f: f is None }}) r"""Indicates whether or not the product requires physical delivery.""" @@ -56,6 +55,7 @@ class ProductVariant: r"""SKU (stock keeping unit) of the variant, as defined by the merchant.""" source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_productvariantstatus.ProductVariantStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""The status of the product variant.""" unit_of_measure: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitOfMeasure'), 'exclude': lambda f: f is None }}) r"""Unit of measure for the variant, such as `kg` or `meters`.""" vat_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('vatPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/productvariantref.py b/lending/src/codatlending/models/shared/productvariantref.py index a81633620..e7da09e7a 100755 --- a/lending/src/codatlending/models/shared/productvariantref.py +++ b/lending/src/codatlending/models/shared/productvariantref.py @@ -8,12 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProductVariantRef: r"""Reference that links the line item to the specific version of product that has been ordered.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - r"""The unique identitifer of the product variant being referenced.""" + r"""The unique identifier of the product variant being referenced.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) r"""Name of the product variant being referenced.""" diff --git a/lending/src/codatlending/models/shared/productvariantstatus.py b/lending/src/codatlending/models/shared/productvariantstatus.py index 5f073db6a..f54446a78 100755 --- a/lending/src/codatlending/models/shared/productvariantstatus.py +++ b/lending/src/codatlending/models/shared/productvariantstatus.py @@ -4,6 +4,7 @@ from enum import Enum class ProductVariantStatus(str, Enum): + r"""The status of the product variant.""" UNKNOWN = 'Unknown' PUBLISHED = 'Published' UNPUBLISHED = 'Unpublished' diff --git a/lending/src/codatlending/models/shared/profitandlossreport.py b/lending/src/codatlending/models/shared/profitandlossreport.py index 217a3e825..97d8f9253 100755 --- a/lending/src/codatlending/models/shared/profitandlossreport.py +++ b/lending/src/codatlending/models/shared/profitandlossreport.py @@ -10,7 +10,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProfitAndLossReport: gross_profit: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('grossProfit'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) diff --git a/lending/src/codatlending/models/shared/projectref.py b/lending/src/codatlending/models/shared/projectref.py index dadffe0c2..4b77ca443 100755 --- a/lending/src/codatlending/models/shared/projectref.py +++ b/lending/src/codatlending/models/shared/projectref.py @@ -8,10 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ProjectRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the project reference.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""The project's name.""" diff --git a/lending/src/codatlending/models/shared/pulloperation.py b/lending/src/codatlending/models/shared/pulloperation.py index 268839eb6..55e792581 100755 --- a/lending/src/codatlending/models/shared/pulloperation.py +++ b/lending/src/codatlending/models/shared/pulloperation.py @@ -2,11 +2,14 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from codatlending import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum +from typing import Optional class PullOperationStatus(str, Enum): + r"""The current status of the pull operation.""" INITIAL = 'Initial' QUEUED = 'Queued' FETCHING = 'Fetching' @@ -33,19 +36,25 @@ class PullOperationStatus(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PullOperation: r"""Information about a queued, in progress or completed pull operation. *Formally called `dataset`* """ company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) + r"""Unique identifier of the company associated to this pull operation.""" connection_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionId') }}) - data_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Unique identifier of the connection associated to this pull operation.""" + data_type: shared_datatype.DataType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""Available Data types""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""Unique identifier of the pull operation.""" is_completed: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isCompleted') }}) + r"""`True` if the pull operation completed successfully.""" is_errored: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isErrored') }}) + r"""`True` if the pull operation entered an error state.""" progress: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('progress') }}) + r"""An integer signifying the progress of the pull operation.""" requested: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requested') }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -68,5 +77,29 @@ class PullOperation: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: PullOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + r"""The current status of the pull operation.""" + completed: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completed'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about a transient or persistent error.""" diff --git a/lending/src/codatlending/models/shared/pulloperations.py b/lending/src/codatlending/models/shared/pulloperations.py index 7c828b054..cce0e7ccb 100755 --- a/lending/src/codatlending/models/shared/pulloperations.py +++ b/lending/src/codatlending/models/shared/pulloperations.py @@ -6,17 +6,19 @@ from ..shared import pulloperation as shared_pulloperation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PullOperations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_pulloperation.PullOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_pulloperation.PullOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/pushchangetype.py b/lending/src/codatlending/models/shared/pushchangetype.py index 88e1a3ec7..55cd1990f 100755 --- a/lending/src/codatlending/models/shared/pushchangetype.py +++ b/lending/src/codatlending/models/shared/pushchangetype.py @@ -4,6 +4,7 @@ from enum import Enum class PushChangeType(str, Enum): + r"""Type of change being applied to record in third party platform.""" UNKNOWN = 'Unknown' CREATED = 'Created' MODIFIED = 'Modified' diff --git a/lending/src/codatlending/models/shared/pushfieldvalidation.py b/lending/src/codatlending/models/shared/pushfieldvalidation.py index 3f6870117..a38030610 100755 --- a/lending/src/codatlending/models/shared/pushfieldvalidation.py +++ b/lending/src/codatlending/models/shared/pushfieldvalidation.py @@ -8,11 +8,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushFieldValidation: details: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details') }}) + r"""Details on the validation issue.""" field: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('field'), 'exclude': lambda f: f is None }}) - ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ref'), 'exclude': lambda f: f is None }}) + r"""Field name that resulted in the validation issue.""" + ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ref') }}) + r"""Unique reference identifier for the validation issue.""" diff --git a/lending/src/codatlending/models/shared/pushoperation.py b/lending/src/codatlending/models/shared/pushoperation.py index ed8e01aae..25a9caa38 100755 --- a/lending/src/codatlending/models/shared/pushoperation.py +++ b/lending/src/codatlending/models/shared/pushoperation.py @@ -8,11 +8,10 @@ from ..shared import validation as shared_validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperation: company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) @@ -45,7 +44,8 @@ class PushOperation: status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) - changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) + r"""Push status code.""" + changes: Optional[List[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: @@ -70,10 +70,15 @@ class PushOperation: """ data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is None }}) - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is None }}) - r"""Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.""" + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + r"""A message about the error.""" + timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + r"""Number of minutes the push operation must complete within before it times out.""" + timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + r"""Number of seconds the push operation must complete within before it times out. + + Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + """ validation: Optional[shared_validation.Validation] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" diff --git a/lending/src/codatlending/models/shared/pushoperationchange.py b/lending/src/codatlending/models/shared/pushoperationchange.py index 73bf7a38d..72ec1573d 100755 --- a/lending/src/codatlending/models/shared/pushoperationchange.py +++ b/lending/src/codatlending/models/shared/pushoperationchange.py @@ -10,11 +10,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperationChange: - attachment_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId'), 'exclude': lambda f: f is None }}) + attachment_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId') }}) + r"""Unique identifier for the attachment created otherwise null.""" record_ref: Optional[shared_pushoperationref.PushOperationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) type: Optional[shared_pushchangetype.PushChangeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""Type of change being applied to record in third party platform.""" diff --git a/lending/src/codatlending/models/shared/pushoperationref.py b/lending/src/codatlending/models/shared/pushoperationref.py index bfb04a702..865b3abd2 100755 --- a/lending/src/codatlending/models/shared/pushoperationref.py +++ b/lending/src/codatlending/models/shared/pushoperationref.py @@ -9,11 +9,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperationRef: data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) r"""Available Data types""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a push operation.""" diff --git a/lending/src/codatlending/models/shared/pushoperations.py b/lending/src/codatlending/models/shared/pushoperations.py index 67d365f49..dad57c66f 100755 --- a/lending/src/codatlending/models/shared/pushoperations.py +++ b/lending/src/codatlending/models/shared/pushoperations.py @@ -6,17 +6,19 @@ from ..shared import pushoperation as shared_pushoperation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOperations: links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) + r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) + r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_pushoperation.PushOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + r"""Total number of items.""" + results: Optional[List[shared_pushoperation.PushOperation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/pushoption.py b/lending/src/codatlending/models/shared/pushoption.py index 8f84c8c93..9a7be7c9c 100755 --- a/lending/src/codatlending/models/shared/pushoption.py +++ b/lending/src/codatlending/models/shared/pushoption.py @@ -8,19 +8,22 @@ from ..shared import pushvalidationinfo as shared_pushvalidationinfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOption: display_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) + r"""The property's display name.""" required: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required') }}) + r"""The property is required if `True`.""" type: shared_pushoptiontype.PushOptionType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + r"""The option type.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) - options: Optional[list[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) - properties: Optional[dict[str, shared_pushoptionproperty.PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties'), 'exclude': lambda f: f is None }}) + r"""A description of the property.""" + options: Optional[List[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) + properties: Optional[Dict[str, shared_pushoptionproperty.PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) validation: Optional[shared_pushvalidationinfo.PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/pushoptionchoice.py b/lending/src/codatlending/models/shared/pushoptionchoice.py index 42e160364..785fd3d70 100755 --- a/lending/src/codatlending/models/shared/pushoptionchoice.py +++ b/lending/src/codatlending/models/shared/pushoptionchoice.py @@ -9,13 +9,16 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOptionChoice: description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + r"""A description of the property.""" display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) + r"""The property's display name.""" required: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required'), 'exclude': lambda f: f is None }}) + r"""The property is required if `True`.""" type: Optional[shared_pushoptiontype.PushOptionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + r"""The option type.""" value: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value'), 'exclude': lambda f: f is None }}) r"""Allowed value for field.""" diff --git a/lending/src/codatlending/models/shared/pushoptionproperty.py b/lending/src/codatlending/models/shared/pushoptionproperty.py index b6eb8b4f5..50ce9d133 100755 --- a/lending/src/codatlending/models/shared/pushoptionproperty.py +++ b/lending/src/codatlending/models/shared/pushoptionproperty.py @@ -7,19 +7,22 @@ from ..shared import pushvalidationinfo as shared_pushvalidationinfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import Dict, List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushOptionProperty: description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) + r"""A description of the property.""" display_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) + r"""The property's display name.""" required: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required') }}) + r"""The property is required if `True`.""" type: shared_pushoptiontype.PushOptionType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) - options: Optional[list[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) - properties: Optional[dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties'), 'exclude': lambda f: f is None }}) + r"""The option type.""" + options: Optional[List[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) + properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) validation: Optional[shared_pushvalidationinfo.PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/pushoptiontype.py b/lending/src/codatlending/models/shared/pushoptiontype.py index 2de78dadf..f069e2d84 100755 --- a/lending/src/codatlending/models/shared/pushoptiontype.py +++ b/lending/src/codatlending/models/shared/pushoptiontype.py @@ -4,6 +4,7 @@ from enum import Enum class PushOptionType(str, Enum): + r"""The option type.""" ARRAY = 'Array' OBJECT = 'Object' STRING = 'String' diff --git a/lending/src/codatlending/models/shared/pushvalidationinfo.py b/lending/src/codatlending/models/shared/pushvalidationinfo.py index c0b334e5c..5fe00da4e 100755 --- a/lending/src/codatlending/models/shared/pushvalidationinfo.py +++ b/lending/src/codatlending/models/shared/pushvalidationinfo.py @@ -5,14 +5,13 @@ from ..shared import pushfieldvalidation as shared_pushfieldvalidation from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class PushValidationInfo: - information: Optional[list[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information'), 'exclude': lambda f: f is None }}) - warnings: Optional[list[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is None }}) + information: Optional[List[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information') }}) + warnings: Optional[List[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) diff --git a/lending/src/codatlending/models/shared/recordref.py b/lending/src/codatlending/models/shared/recordref.py index 3d0335ab3..839d6fb33 100755 --- a/lending/src/codatlending/models/shared/recordref.py +++ b/lending/src/codatlending/models/shared/recordref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class RecordRef: r"""Links the current record to the underlying record or data type that created it. diff --git a/lending/src/codatlending/models/shared/reportcomponentmeasure.py b/lending/src/codatlending/models/shared/reportcomponentmeasure.py index 4456027e1..0ad66570d 100755 --- a/lending/src/codatlending/models/shared/reportcomponentmeasure.py +++ b/lending/src/codatlending/models/shared/reportcomponentmeasure.py @@ -9,11 +9,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ReportComponentMeasure: index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) + r"""The measure's index.""" measure_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measureDisplayName'), 'exclude': lambda f: f is None }}) + r"""The measure's display name.""" value: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + r"""The measure's value.""" diff --git a/lending/src/codatlending/models/shared/reportinfo.py b/lending/src/codatlending/models/shared/reportinfo.py index f02313490..623b9748c 100755 --- a/lending/src/codatlending/models/shared/reportinfo.py +++ b/lending/src/codatlending/models/shared/reportinfo.py @@ -8,20 +8,19 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ReportInfo: - r"""Report additional information, which is specific to Assess reports""" + r"""Report additional information, which is specific to Lending API reports.""" company_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyName'), 'exclude': lambda f: f is None }}) r"""The name of the company being queried.""" generated_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generatedDate'), 'exclude': lambda f: f is None }}) - r"""Date the report was generated""" + r"""Date the report was generated.""" page_number: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber'), 'exclude': lambda f: f is None }}) r"""The number of the page queried.""" page_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize'), 'exclude': lambda f: f is None }}) r"""The number of transactions returned per page.""" report_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportName'), 'exclude': lambda f: f is None }}) - r"""Name of the report""" + r"""Name of the report.""" total_results: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults'), 'exclude': lambda f: f is None }}) r"""The total number of transactions available for a company for the period specified in the query string.""" diff --git a/lending/src/codatlending/models/shared/reportitems.py b/lending/src/codatlending/models/shared/reportitems.py index e1f673671..d09195270 100755 --- a/lending/src/codatlending/models/shared/reportitems.py +++ b/lending/src/codatlending/models/shared/reportitems.py @@ -11,6 +11,7 @@ from typing import Optional class ReportItemsLoanTransactionType(str, Enum): + r"""The type of loan transaction.""" INVESTMENT = 'Investment' REPAYMENT = 'Repayment' INTEREST = 'Interest' @@ -18,7 +19,6 @@ class ReportItemsLoanTransactionType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ReportItems: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) @@ -45,7 +45,10 @@ class ReportItems: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ item_ref: Optional[shared_definitionsitemref.DefinitionsitemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) + lender_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lenderName'), 'exclude': lambda f: f is None }}) + r"""The name of lender providing the loan.""" loan_ref: Optional[shared_loanref.LoanRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanRef'), 'exclude': lambda f: f is None }}) loan_transaction_type: Optional[ReportItemsLoanTransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanTransactionType'), 'exclude': lambda f: f is None }}) + r"""The type of loan transaction.""" diff --git a/lending/src/codatlending/models/shared/reportline.py b/lending/src/codatlending/models/shared/reportline.py index 16dd3fd41..f18469c2f 100755 --- a/lending/src/codatlending/models/shared/reportline.py +++ b/lending/src/codatlending/models/shared/reportline.py @@ -5,20 +5,19 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ReportLine: value: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Numerical value of the line item.""" - account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId'), 'exclude': lambda f: f is None }}) + account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId') }}) r"""Identifier for the account, unique for the company in the accounting platform.""" - items: Optional[list[ReportLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) + items: Optional[List[ReportLine]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items') }}) r"""An array of ReportLine items.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the report line item.""" diff --git a/lending/src/codatlending/models/shared/security.py b/lending/src/codatlending/models/shared/security.py index a72246378..1d57f5faa 100755 --- a/lending/src/codatlending/models/shared/security.py +++ b/lending/src/codatlending/models/shared/security.py @@ -4,7 +4,6 @@ import dataclasses - @dataclasses.dataclass class Security: auth_header: str = dataclasses.field(metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'Authorization' }}) diff --git a/lending/src/codatlending/models/shared/servicecharge.py b/lending/src/codatlending/models/shared/servicecharge.py index 741beb5f5..38ca8228e 100755 --- a/lending/src/codatlending/models/shared/servicecharge.py +++ b/lending/src/codatlending/models/shared/servicecharge.py @@ -7,11 +7,10 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ServiceCharge: description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) @@ -20,12 +19,12 @@ class ServiceCharge: r"""The number of times the charge is charged.""" tax_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Amount of the service charge that is tax.""" - taxes: Optional[list[shared_taxcomponentallocation.TaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) + taxes: Optional[List[shared_taxcomponentallocation.TaxComponentAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxes'), 'exclude': lambda f: f is None }}) r"""Taxes breakdown as applied to service charges.""" tax_percentage: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxPercentage'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Percentage rate (from 0 to 100) of any tax applied to the service charge.""" total_amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) - r"""Total service charge, including taxes.""" + r"""Total amount of the service charge, including tax.""" type: Optional[shared_servicechargetype.ServiceChargeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) r"""The type of the service charge.""" diff --git a/lending/src/codatlending/models/shared/sourceref.py b/lending/src/codatlending/models/shared/sourceref.py index 4fcb4e211..4dc53db1e 100755 --- a/lending/src/codatlending/models/shared/sourceref.py +++ b/lending/src/codatlending/models/shared/sourceref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SourceRef: r"""A source reference containing the `sourceType` object \\"Banking\\".""" diff --git a/lending/src/codatlending/models/shared/supplementaldata.py b/lending/src/codatlending/models/shared/supplementaldata.py index fadc848db..ae9a7890e 100755 --- a/lending/src/codatlending/models/shared/supplementaldata.py +++ b/lending/src/codatlending/models/shared/supplementaldata.py @@ -4,17 +4,16 @@ import dataclasses from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Any, Optional +from typing import Any, Dict, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupplementalData: r"""Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. """ - content: Optional[dict[str, dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content'), 'exclude': lambda f: f is None }}) + content: Optional[Dict[str, Dict[str, Any]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content') }}) diff --git a/lending/src/codatlending/models/shared/supplierref.py b/lending/src/codatlending/models/shared/supplierref.py index 664ef01d8..890c6932e 100755 --- a/lending/src/codatlending/models/shared/supplierref.py +++ b/lending/src/codatlending/models/shared/supplierref.py @@ -8,13 +8,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class SupplierRef: r"""Reference to the supplier the record relates to.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""The supplier's unique ID""" - supplier_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierName'), 'exclude': lambda f: f is None }}) + supplier_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierName') }}) r"""The supplier's name""" diff --git a/lending/src/codatlending/models/shared/taxcomponentallocation.py b/lending/src/codatlending/models/shared/taxcomponentallocation.py index 050ad22e5..3d5f04acf 100755 --- a/lending/src/codatlending/models/shared/taxcomponentallocation.py +++ b/lending/src/codatlending/models/shared/taxcomponentallocation.py @@ -10,10 +10,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxComponentAllocation: - rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) + rate: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('rate'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder }}) r"""Tax amount on order line sale as available from source commerce platform.""" tax_component_ref: Optional[shared_taxcomponentref.TaxComponentRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxComponentRef'), 'exclude': lambda f: f is None }}) r"""Taxes rates reference object depending on the rates being available on source commerce package.""" diff --git a/lending/src/codatlending/models/shared/taxcomponentref.py b/lending/src/codatlending/models/shared/taxcomponentref.py index 38f4ed674..613bb6463 100755 --- a/lending/src/codatlending/models/shared/taxcomponentref.py +++ b/lending/src/codatlending/models/shared/taxcomponentref.py @@ -7,7 +7,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxComponentRef: r"""Taxes rates reference object depending on the rates being available on source commerce package.""" diff --git a/lending/src/codatlending/models/shared/taxrateref.py b/lending/src/codatlending/models/shared/taxrateref.py index 2c050edc1..b8915a7a2 100755 --- a/lending/src/codatlending/models/shared/taxrateref.py +++ b/lending/src/codatlending/models/shared/taxrateref.py @@ -9,7 +9,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TaxRateRef: r"""Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. diff --git a/lending/src/codatlending/models/shared/tracking.py b/lending/src/codatlending/models/shared/tracking.py index 17f47b12a..77f8f7d79 100755 --- a/lending/src/codatlending/models/shared/tracking.py +++ b/lending/src/codatlending/models/shared/tracking.py @@ -5,14 +5,13 @@ from ..shared import recordref as shared_recordref from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Tracking: - record_refs: list[shared_recordref.RecordRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) + record_refs: List[shared_recordref.RecordRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) invoice_to: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceTo'), 'exclude': lambda f: f is None }}) r"""Links the current record to the underlying record or data type that created it. diff --git a/lending/src/codatlending/models/shared/trackingcategoryref.py b/lending/src/codatlending/models/shared/trackingcategoryref.py index 5e8e5055c..b8e96b57e 100755 --- a/lending/src/codatlending/models/shared/trackingcategoryref.py +++ b/lending/src/codatlending/models/shared/trackingcategoryref.py @@ -8,7 +8,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TrackingCategoryRef: r"""References a category against which the item is tracked. @@ -16,6 +15,8 @@ class TrackingCategoryRef: Deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + r"""Unique identifier to the tracking category.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name of tracking category.""" diff --git a/lending/src/codatlending/models/shared/transactioncategory.py b/lending/src/codatlending/models/shared/transactioncategory.py index d3e17b209..dd1f4f08d 100755 --- a/lending/src/codatlending/models/shared/transactioncategory.py +++ b/lending/src/codatlending/models/shared/transactioncategory.py @@ -5,16 +5,15 @@ from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TransactionCategory: confidence: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confidence'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Returns the confidence of the suggested category for the transaction. The value is between 0 and 100.""" - levels: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) + levels: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) r"""The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level).""" diff --git a/lending/src/codatlending/models/shared/transactioncategoryref.py b/lending/src/codatlending/models/shared/transactioncategoryref.py index b6bb9bed2..615f3a113 100755 --- a/lending/src/codatlending/models/shared/transactioncategoryref.py +++ b/lending/src/codatlending/models/shared/transactioncategoryref.py @@ -8,13 +8,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TransactionCategoryRef: r"""An object of bank transaction category reference data.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""The unique category reference id for the bank transaction.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""The category name reference for the bank transaction.""" diff --git a/lending/src/codatlending/models/shared/transactioncategorystatus.py b/lending/src/codatlending/models/shared/transactioncategorystatus.py index 96d7e222e..0ffcd8693 100755 --- a/lending/src/codatlending/models/shared/transactioncategorystatus.py +++ b/lending/src/codatlending/models/shared/transactioncategorystatus.py @@ -4,6 +4,7 @@ from enum import Enum class TransactionCategoryStatus(str, Enum): + r"""The status of the transaction category.""" UNKNOWN = 'Unknown' ACTIVE = 'Active' ARCHIVED = 'Archived' diff --git a/lending/src/codatlending/models/shared/transactionsourceref.py b/lending/src/codatlending/models/shared/transactionsourceref.py index eda80c3f6..6bac47373 100755 --- a/lending/src/codatlending/models/shared/transactionsourceref.py +++ b/lending/src/codatlending/models/shared/transactionsourceref.py @@ -8,11 +8,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TransactionSourceRef: id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""The unique identitifer of the record being referenced""" type: shared_transactionsourcetype.TransactionSourceType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + r"""The type of source the transaction arose.""" diff --git a/lending/src/codatlending/models/shared/transactionsourcetype.py b/lending/src/codatlending/models/shared/transactionsourcetype.py index 90c7bd583..7efe4d8de 100755 --- a/lending/src/codatlending/models/shared/transactionsourcetype.py +++ b/lending/src/codatlending/models/shared/transactionsourcetype.py @@ -4,6 +4,7 @@ from enum import Enum class TransactionSourceType(str, Enum): + r"""The type of source the transaction arose.""" FEE = 'Fee' ORDER = 'Order' PAYMENT = 'Payment' diff --git a/lending/src/codatlending/models/shared/transferaccount.py b/lending/src/codatlending/models/shared/transferaccount.py index a3f2835e4..c921dbcf5 100755 --- a/lending/src/codatlending/models/shared/transferaccount.py +++ b/lending/src/codatlending/models/shared/transferaccount.py @@ -10,9 +10,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class TransferAccount: + r"""Account details of the account sending or receiving the transfer.""" account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/validation.py b/lending/src/codatlending/models/shared/validation.py index 78272e6eb..9eb278a39 100755 --- a/lending/src/codatlending/models/shared/validation.py +++ b/lending/src/codatlending/models/shared/validation.py @@ -5,15 +5,14 @@ from ..shared import validationitem as shared_validationitem from codatlending import utils from dataclasses_json import Undefined, dataclass_json -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class Validation: r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" - errors: Optional[list[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - warnings: Optional[list[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is None }}) + errors: Optional[List[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors') }}) + warnings: Optional[List[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) diff --git a/lending/src/codatlending/models/shared/validationitem.py b/lending/src/codatlending/models/shared/validationitem.py index fdc1eca13..a72ef1372 100755 --- a/lending/src/codatlending/models/shared/validationitem.py +++ b/lending/src/codatlending/models/shared/validationitem.py @@ -8,11 +8,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class ValidationItem: - item_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId'), 'exclude': lambda f: f is None }}) - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) - validator_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName'), 'exclude': lambda f: f is None }}) + item_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId') }}) + r"""Unique identifier for a validation item.""" + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) + r"""A message outlining validation item's issue.""" + validator_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName') }}) + r"""Name of validator.""" diff --git a/lending/src/codatlending/models/shared/weblink.py b/lending/src/codatlending/models/shared/weblink.py index 78fd6ae94..0209ecfea 100755 --- a/lending/src/codatlending/models/shared/weblink.py +++ b/lending/src/codatlending/models/shared/weblink.py @@ -15,7 +15,6 @@ class WebLinkType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) - @dataclasses.dataclass class WebLink: r"""Weblink associated with the company.""" diff --git a/lending/src/codatlending/models/webhooks/account_categories_updated.py b/lending/src/codatlending/models/webhooks/account_categories_updated.py index b6a270f5b..0e103b30c 100755 --- a/lending/src/codatlending/models/webhooks/account_categories_updated.py +++ b/lending/src/codatlending/models/webhooks/account_categories_updated.py @@ -6,11 +6,13 @@ from typing import Optional - @dataclasses.dataclass class AccountCategoriesUpdatedResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py b/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py index 8ce5abf44..20c411599 100755 --- a/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py +++ b/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py @@ -6,11 +6,13 @@ from typing import Optional - @dataclasses.dataclass class ClientRateLimitReachedResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py b/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py index df91ac429..7e4b65419 100755 --- a/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py +++ b/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py @@ -6,11 +6,13 @@ from typing import Optional - @dataclasses.dataclass class ClientRateLimitResetResponse: content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/lending/src/codatlending/sales_customers.py b/lending/src/codatlending/sales_customers.py index 34c8f05f9..f67585a8e 100755 --- a/lending/src/codatlending/sales_customers.py +++ b/lending/src/codatlending/sales_customers.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceCustomerRequest, retries: Optional[ r"""Get customer The *Get customer* endpoint returns a single customer for a given customerId. - [Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for integrations that support getting a specific customer. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceCustomerRequest, retries: Optional[ url = utils.generate_url(operations.GetCommerceCustomerRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceCustomerRequest, retries: Optional[ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceCustomersRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceCustomersResponse: r"""List customers - The *List customers* endpoint returns a list of [customers](https://docs.codat.io/commerce-api#/schemas/Customer) for a given company's connection. + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. - [Customers](https://docs.codat.io/commerce-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceCustomersRequest, retries: Option headers = {} query_params = utils.get_query_params(operations.ListCommerceCustomersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceCustomersRequest, retries: Option def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_disputes.py b/lending/src/codatlending/sales_disputes.py index efe15afb8..b89f0b8ea 100755 --- a/lending/src/codatlending/sales_disputes.py +++ b/lending/src/codatlending/sales_disputes.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceDisputeRequest, retries: Optional[u r"""Get dispute The *Get dispute* endpoint returns a single dispute for a given disputeId. - [Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for integrations that support getting a specific dispute. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceDisputeRequest, retries: Optional[u url = utils.generate_url(operations.GetCommerceDisputeRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceDisputeRequest, retries: Optional[u def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceDisputesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceDisputesResponse: r"""List disputes - The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) for a given company's connection. + The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection. - [Disputes](https://docs.codat.io/commerce-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceDisputesRequest, retries: Optiona headers = {} query_params = utils.get_query_params(operations.ListCommerceDisputesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceDisputesRequest, retries: Optiona def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_locations.py b/lending/src/codatlending/sales_locations.py index 030c66882..6ed4760e4 100755 --- a/lending/src/codatlending/sales_locations.py +++ b/lending/src/codatlending/sales_locations.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceLocationRequest, retries: Optional[ r"""Get location The *Get location* endpoint returns a single location for a given locationId. - [Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed. + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for integrations that support getting a specific location. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceLocationRequest, retries: Optional[ url = utils.generate_url(operations.GetCommerceLocationRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceLocationRequest, retries: Optional[ def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceLocationsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceLocationsResponse: r"""List locations - The *List locations* endpoint returns a list of [locations](https://docs.codat.io/commerce-api#/schemas/Location) for a given company's connection. + The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection. - [Locations](https://docs.codat.io/commerce-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/commerce-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/commerce-api#/schemas/Order) were placed. + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -80,7 +80,7 @@ def list(self, request: operations.ListCommerceLocationsRequest, retries: Option url = utils.generate_url(operations.ListCommerceLocationsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-locations', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -94,7 +94,7 @@ def list(self, request: operations.ListCommerceLocationsRequest, retries: Option def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_metrics.py b/lending/src/codatlending/sales_metrics.py index b1dda55bc..a55dcb64d 100755 --- a/lending/src/codatlending/sales_metrics.py +++ b/lending/src/codatlending/sales_metrics.py @@ -50,7 +50,7 @@ def get_customer_retention(self, request: operations.GetCommerceCustomerRetentio headers = {} query_params = utils.get_query_params(operations.GetCommerceCustomerRetentionMetricsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -64,7 +64,7 @@ def get_customer_retention(self, request: operations.GetCommerceCustomerRetentio def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -121,7 +121,7 @@ def get_lifetime_value(self, request: operations.GetCommerceLifetimeValueMetrics headers = {} query_params = utils.get_query_params(operations.GetCommerceLifetimeValueMetricsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -135,7 +135,7 @@ def get_lifetime_value(self, request: operations.GetCommerceLifetimeValueMetrics def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -193,7 +193,7 @@ def get_revenue(self, request: operations.GetCommerceRevenueMetricsRequest, retr headers = {} query_params = utils.get_query_params(operations.GetCommerceRevenueMetricsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -207,7 +207,7 @@ def get_revenue(self, request: operations.GetCommerceRevenueMetricsRequest, retr def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_orders.py b/lending/src/codatlending/sales_orders.py index 827572c9f..e592f27f1 100755 --- a/lending/src/codatlending/sales_orders.py +++ b/lending/src/codatlending/sales_orders.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceOrderRequest, retries: Optional[uti r"""Get order The *Get order* endpoint returns a single order for a given orderId. - [Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company. + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for integrations that support getting a specific order. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceOrderRequest, retries: Optional[uti url = utils.generate_url(operations.GetCommerceOrderRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceOrderRequest, retries: Optional[uti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceOrdersRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceOrdersResponse: r"""List orders - The *List orders* endpoint returns a list of [orders](https://docs.codat.io/commerce-api#/schemas/Order) for a given company's connection. + The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection. - [Orders](https://docs.codat.io/commerce-api#/schemas/Order) contain the transaction details for all products sold by the company. + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceOrdersRequest, retries: Optional[ headers = {} query_params = utils.get_query_params(operations.ListCommerceOrdersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceOrdersRequest, retries: Optional[ def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_payment_methods.py b/lending/src/codatlending/sales_payment_methods.py index b5791306b..7b12468be 100755 --- a/lending/src/codatlending/sales_payment_methods.py +++ b/lending/src/codatlending/sales_payment_methods.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommercePaymentMethodRequest, retries: Opti r"""Get payment method The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. - [Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for integrations that support getting a specific payment method. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommercePaymentMethodRequest, retries: Opti url = utils.generate_url(operations.GetCommercePaymentMethodRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommercePaymentMethodRequest, retries: Opti def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommercePaymentMethodsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommercePaymentMethodsResponse: r"""List payment methods - The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) for a given company's connection. + The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection. - [Payment methods](https://docs.codat.io/commerce-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommercePaymentMethodsRequest, retries: O headers = {} query_params = utils.get_query_params(operations.ListCommercePaymentMethodsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommercePaymentMethodsRequest, retries: O def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_payments.py b/lending/src/codatlending/sales_payments.py index 5012b60be..ee6dcf452 100755 --- a/lending/src/codatlending/sales_payments.py +++ b/lending/src/codatlending/sales_payments.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommercePaymentRequest, retries: Optional[u r"""Get payment The *Get payment* endpoint returns a single payment for a given paymentId. - [Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for integrations that support getting a specific payment. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommercePaymentRequest, retries: Optional[u url = utils.generate_url(operations.GetCommercePaymentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommercePaymentRequest, retries: Optional[u def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommercePaymentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommercePaymentsResponse: r"""List payments - The *List payments* endpoint returns a list of [payments](https://docs.codat.io/commerce-api#/schemas/Payment) for a given company's connection. + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. - [Payments](https://docs.codat.io/commerce-api#/schemas/Payment) contain details of all payments made by customers to the company. + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommercePaymentsRequest, retries: Optiona headers = {} query_params = utils.get_query_params(operations.ListCommercePaymentsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommercePaymentsRequest, retries: Optiona def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_product_categories.py b/lending/src/codatlending/sales_product_categories.py index dc74824d7..1b6505f95 100755 --- a/lending/src/codatlending/sales_product_categories.py +++ b/lending/src/codatlending/sales_product_categories.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceProductCategoryRequest, retries: Op r"""Get product category The *Get product* endpoint returns a single product for a given productId. - [Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile. + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for integrations that support getting a specific product. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceProductCategoryRequest, retries: Op url = utils.generate_url(operations.GetCommerceProductCategoryRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceProductCategoryRequest, retries: Op def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceProductCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceProductCategoriesResponse: r"""List product categories - The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) for a given company's connection. + The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection. - [Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile. + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceProductCategoriesRequest, retries headers = {} query_params = utils.get_query_params(operations.ListCommerceProductCategoriesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceProductCategoriesRequest, retries def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_products.py b/lending/src/codatlending/sales_products.py index 66f6f7202..a684626dd 100755 --- a/lending/src/codatlending/sales_products.py +++ b/lending/src/codatlending/sales_products.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceProductRequest, retries: Optional[u r"""Get product The *Get product* endpoint returns a single product for a given productId. - [Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale. + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for integrations that support getting a specific product. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceProductRequest, retries: Optional[u url = utils.generate_url(operations.GetCommerceProductRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceProductRequest, retries: Optional[u def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceProductsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceProductsResponse: r"""List products - The *List products* endpoint returns a list of [products](https://docs.codat.io/commerce-api#/schemas/Product) for a given company's connection. + The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection. - [Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale. + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceProductsRequest, retries: Optiona headers = {} query_params = utils.get_query_params(operations.ListCommerceProductsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceProductsRequest, retries: Optiona def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_reports.py b/lending/src/codatlending/sales_reports.py index b4bc85488..bd23cfd33 100755 --- a/lending/src/codatlending/sales_reports.py +++ b/lending/src/codatlending/sales_reports.py @@ -44,7 +44,7 @@ def get_orders(self, request: operations.GetCommerceOrdersReportRequest, retries headers = {} query_params = utils.get_query_params(operations.GetCommerceOrdersReportRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -58,7 +58,7 @@ def get_orders(self, request: operations.GetCommerceOrdersReportRequest, retries def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -117,7 +117,7 @@ def get_refunds(self, request: operations.GetCommerceRefundsReportRequest, retri headers = {} query_params = utils.get_query_params(operations.GetCommerceRefundsReportRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -131,7 +131,7 @@ def get_refunds(self, request: operations.GetCommerceRefundsReportRequest, retri def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sales_transactions.py b/lending/src/codatlending/sales_transactions.py index 14a88b959..5dd5dd80f 100755 --- a/lending/src/codatlending/sales_transactions.py +++ b/lending/src/codatlending/sales_transactions.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetCommerceTransactionRequest, retries: Option r"""Get transaction The *Get transaction* endpoint returns a single transaction for a given transactionId. - [Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for integrations that support getting a specific transaction. @@ -27,7 +27,7 @@ def get(self, request: operations.GetCommerceTransactionRequest, retries: Option url = utils.generate_url(operations.GetCommerceTransactionRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetCommerceTransactionRequest, retries: Option def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListCommerceTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCommerceTransactionsResponse: r"""List transactions - The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) for a given company's connection. + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. - [Transactions](https://docs.codat.io/commerce-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListCommerceTransactionsRequest, retries: Opt headers = {} query_params = utils.get_query_params(operations.ListCommerceTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListCommerceTransactionsRequest, retries: Opt def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/sdk.py b/lending/src/codatlending/sdk.py index 7b073e4aa..8127a13ba 100755 --- a/lending/src/codatlending/sdk.py +++ b/lending/src/codatlending/sdk.py @@ -20,6 +20,7 @@ from .transactions import Transactions from codatlending import utils from codatlending.models import shared +from typing import Dict class CodatLending: r"""Lending API: Our Lending API helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce platforms they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. @@ -81,7 +82,7 @@ def __init__(self, security: shared.Security = None, server_idx: int = None, server_url: str = None, - url_params: dict[str, str] = None, + url_params: Dict[str, str] = None, client: requests_http.Session = None, retry_config: utils.RetryConfig = None ) -> None: @@ -94,7 +95,7 @@ def __init__(self, :param server_url: The server URL to use for all operations :type server_url: str :param url_params: Parameters to optionally template the server URL with - :type url_params: dict[str, str] + :type url_params: Dict[str, str] :param client: The requests.Session HTTP client to use for all operations :type client: requests_http.Session :param retry_config: The utils.RetryConfig to use globally @@ -103,8 +104,10 @@ def __init__(self, if client is None: client = requests_http.Session() + security_client = utils.configure_security_client(client, security) + if server_url is not None: if url_params is not None: server_url = utils.template_url(server_url, url_params) diff --git a/lending/src/codatlending/sdkconfiguration.py b/lending/src/codatlending/sdkconfiguration.py index b454116fa..9f5651f21 100755 --- a/lending/src/codatlending/sdkconfiguration.py +++ b/lending/src/codatlending/sdkconfiguration.py @@ -2,8 +2,9 @@ import requests from dataclasses import dataclass - +from typing import Dict, Tuple from .utils.retries import RetryConfig +from .utils import utils SERVERS = [ @@ -20,13 +21,14 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '3.0.0' - sdk_version: str = '4.2.0' - gen_version: str = '2.122.1' + sdk_version: str = '5.0.0' + gen_version: str = '2.159.2' + user_agent: str = 'speakeasy-sdk/python 5.0.0 2.159.2 3.0.0 codat-lending' retry_config: RetryConfig = None - def get_server_details(self) -> tuple[str, dict[str, str]]: + def get_server_details(self) -> Tuple[str, Dict[str, str]]: if self.server_url: - return self.server_url.removesuffix('/'), {} + return utils.remove_suffix(self.server_url, '/'), {} if self.server_idx is None: self.server_idx = 0 diff --git a/lending/src/codatlending/transactions_account_transactions.py b/lending/src/codatlending/transactions_account_transactions.py index dfbdf8f64..359b19e8d 100755 --- a/lending/src/codatlending/transactions_account_transactions.py +++ b/lending/src/codatlending/transactions_account_transactions.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingAccountTransactionRequest, retrie r"""Get account transaction The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. - [Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingAccountTransactionRequest, retrie url = utils.generate_url(operations.GetAccountingAccountTransactionRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingAccountTransactionRequest, retrie def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingAccountTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingAccountTransactionsResponse: r"""List account transactions - The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection. + The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection. - [Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingAccountTransactionsRequest, ret headers = {} query_params = utils.get_query_params(operations.ListAccountingAccountTransactionsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingAccountTransactionsRequest, ret def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/transactions_direct_costs.py b/lending/src/codatlending/transactions_direct_costs.py index 992c00a5f..baae15cae 100755 --- a/lending/src/codatlending/transactions_direct_costs.py +++ b/lending/src/codatlending/transactions_direct_costs.py @@ -21,7 +21,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectCostAt r"""Download direct cost attachment The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment. """ @@ -33,7 +33,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectCostAt headers['Accept'] = accept_header_override.value else: headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -47,7 +47,7 @@ def download_attachment(self, request: operations.DownloadAccountingDirectCostAt def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -59,7 +59,7 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): - res.data = http_res.content + res.data = http_res else: raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404, 429]: @@ -76,7 +76,7 @@ def get(self, request: operations.GetAccountingDirectCostRequest, retries: Optio r"""Get direct cost The *Get direct cost* endpoint returns a single direct cost for a given directCostId. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost. @@ -87,7 +87,7 @@ def get(self, request: operations.GetAccountingDirectCostRequest, retries: Optio url = utils.generate_url(operations.GetAccountingDirectCostRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -101,7 +101,7 @@ def get(self, request: operations.GetAccountingDirectCostRequest, retries: Optio def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -131,7 +131,7 @@ def get_attachment(self, request: operations.GetAccountingDirectCostAttachmentRe r"""Get direct cost attachment The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment. """ @@ -140,7 +140,7 @@ def get_attachment(self, request: operations.GetAccountingDirectCostAttachmentRe url = utils.generate_url(operations.GetAccountingDirectCostAttachmentRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -154,7 +154,7 @@ def get_attachment(self, request: operations.GetAccountingDirectCostAttachmentRe def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -182,9 +182,9 @@ def do_request(): def list(self, request: operations.ListAccountingDirectCostsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingDirectCostsResponse: r"""List direct costs - The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection. + The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -194,7 +194,7 @@ def list(self, request: operations.ListAccountingDirectCostsRequest, retries: Op headers = {} query_params = utils.get_query_params(operations.ListAccountingDirectCostsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -208,7 +208,7 @@ def list(self, request: operations.ListAccountingDirectCostsRequest, retries: Op def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -238,7 +238,7 @@ def list_attachments(self, request: operations.ListAccountingDirectCostAttachmen r"""List direct cost attachments The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. - [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments. """ @@ -247,7 +247,7 @@ def list_attachments(self, request: operations.ListAccountingDirectCostAttachmen url = utils.generate_url(operations.ListAccountingDirectCostAttachmentsRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -261,7 +261,7 @@ def list_attachments(self, request: operations.ListAccountingDirectCostAttachmen def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/transactions_journal_entries.py b/lending/src/codatlending/transactions_journal_entries.py index 27903e3ab..d73abd811 100755 --- a/lending/src/codatlending/transactions_journal_entries.py +++ b/lending/src/codatlending/transactions_journal_entries.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingJournalEntryRequest, retries: Opt r"""Get journal entry The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. - [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingJournalEntryRequest, retries: Opt url = utils.generate_url(operations.GetAccountingJournalEntryRequest, base_url, '/companies/{companyId}/data/journalEntries/{journalEntryId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingJournalEntryRequest, retries: Opt def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingJournalEntriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingJournalEntriesResponse: r"""List journal entries - The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection. + The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection. - [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingJournalEntriesRequest, retries: headers = {} query_params = utils.get_query_params(operations.ListAccountingJournalEntriesRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingJournalEntriesRequest, retries: def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/transactions_journals.py b/lending/src/codatlending/transactions_journals.py index e0392040f..f06e1fa89 100755 --- a/lending/src/codatlending/transactions_journals.py +++ b/lending/src/codatlending/transactions_journals.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingJournalRequest, retries: Optional r"""Get journal The *Get journal* endpoint returns a single journal for a given journalId. - [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company. + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingJournalRequest, retries: Optional url = utils.generate_url(operations.GetAccountingJournalRequest, base_url, '/companies/{companyId}/data/journals/{journalId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingJournalRequest, retries: Optional def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingJournalsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingJournalsResponse: r"""List journals - The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection. + The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection. - [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company. + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingJournalsRequest, retries: Optio headers = {} query_params = utils.get_query_params(operations.ListAccountingJournalsRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingJournalsRequest, retries: Optio def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/transactions_transfers.py b/lending/src/codatlending/transactions_transfers.py index 97f5bfd81..db768a006 100755 --- a/lending/src/codatlending/transactions_transfers.py +++ b/lending/src/codatlending/transactions_transfers.py @@ -16,7 +16,7 @@ def get(self, request: operations.GetAccountingTransferRequest, retries: Optiona r"""Get transfer The *Get transfer* endpoint returns a single transfer for a given transferId. - [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer. @@ -27,7 +27,7 @@ def get(self, request: operations.GetAccountingTransferRequest, retries: Optiona url = utils.generate_url(operations.GetAccountingTransferRequest, base_url, '/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}', request) headers = {} headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -41,7 +41,7 @@ def get(self, request: operations.GetAccountingTransferRequest, retries: Optiona def do_request(): return client.request('GET', url, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', @@ -69,9 +69,9 @@ def do_request(): def list(self, request: operations.ListAccountingTransfersRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingTransfersResponse: r"""List transfers - The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection. + The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. - [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). """ @@ -81,7 +81,7 @@ def list(self, request: operations.ListAccountingTransfersRequest, retries: Opti headers = {} query_params = utils.get_query_params(operations.ListAccountingTransfersRequest, request) headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' + headers['user-agent'] = self.sdk_configuration.user_agent client = self.sdk_configuration.security_client @@ -95,7 +95,7 @@ def list(self, request: operations.ListAccountingTransfersRequest, retries: Opti def do_request(): return client.request('GET', url, params=query_params, headers=headers) - + http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', '429', diff --git a/lending/src/codatlending/utils/retries.py b/lending/src/codatlending/utils/retries.py index 2138c1b5e..25f49a1f2 100755 --- a/lending/src/codatlending/utils/retries.py +++ b/lending/src/codatlending/utils/retries.py @@ -2,6 +2,7 @@ import random import time +from typing import List import requests @@ -32,9 +33,9 @@ def __init__(self, strategy: str, backoff: BackoffStrategy, retry_connection_err class Retries: config: RetryConfig - status_codes: list[str] + status_codes: List[str] - def __init__(self, config: RetryConfig, status_codes: list[str]): + def __init__(self, config: RetryConfig, status_codes: List[str]): self.config = config self.status_codes = status_codes diff --git a/lending/src/codatlending/utils/utils.py b/lending/src/codatlending/utils/utils.py index 05eafba6c..ccfad9f7a 100755 --- a/lending/src/codatlending/utils/utils.py +++ b/lending/src/codatlending/utils/utils.py @@ -3,12 +3,14 @@ import base64 import json import re +import sys from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass from datetime import date, datetime from decimal import Decimal from email.message import Message from enum import Enum -from typing import Any, Callable, Optional, Tuple, Union, get_args, get_origin +from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, + get_args, get_origin) from xmlrpc.client import boolean import dateutil.parser @@ -18,14 +20,14 @@ class SecurityClient: client: requests.Session - query_params: dict[str, str] = {} + query_params: Dict[str, str] = {} def __init__(self, client: requests.Session): self.client = client def request(self, method, url, **kwargs): params = kwargs.get('params', {}) - kwargs["params"] = self.query_params | params + kwargs["params"] = {**self.query_params, **params} return self.client.request(method, url, **kwargs) @@ -68,7 +70,7 @@ def _parse_security_option(client: SecurityClient, option: dataclass): client, metadata, getattr(option, opt_field.name)) -def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme: any): +def _parse_security_scheme(client: SecurityClient, scheme_metadata: Dict, scheme: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -92,7 +94,7 @@ def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme client, scheme_metadata, scheme_metadata, scheme) -def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, security_metadata: dict, value: any): +def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, security_metadata: Dict, value: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -144,7 +146,7 @@ def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, - gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: + gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> str: path_param_fields: Tuple[Field, ...] = fields(clazz) for field in path_param_fields: request_metadata = field.metadata.get('request') @@ -173,16 +175,16 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass '{' + key + '}', value, 1) else: if param_metadata.get('style', 'simple') == 'simple': - if isinstance(param, list): - pp_vals: list[str] = [] + if isinstance(param, List): + pp_vals: List[str] = [] for pp_val in param: if pp_val is None: continue pp_vals.append(_val_to_string(pp_val)) path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, dict): - pp_vals: list[str] = [] + elif isinstance(param, Dict): + pp_vals: List[str] = [] for pp_key in param: if param[pp_key] is None: continue @@ -195,7 +197,7 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) elif not isinstance(param, (str, int, float, complex, bool, Decimal)): - pp_vals: list[str] = [] + pp_vals: List[str] = [] param_fields: Tuple[Field, ...] = fields(param) for param_field in param_fields: param_value_metadata = param_field.metadata.get( @@ -221,14 +223,14 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass path = path.replace( '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) - return server_url.removesuffix("/") + path + return remove_suffix(server_url, '/') + path def is_optional(field): return get_origin(field) is Union and type(None) in get_args(field) -def template_url(url_with_params: str, params: dict[str, str]) -> str: +def template_url(url_with_params: str, params: Dict[str, str]) -> str: for key, value in params.items(): url_with_params = url_with_params.replace( '{' + key + '}', value) @@ -236,9 +238,9 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: return url_with_params -def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[ - str, list[str]]: - params: dict[str, list[str]] = {} +def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> Dict[ + str, List[str]]: + params: Dict[str, List[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) for field in param_fields: @@ -268,24 +270,24 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[ else: style = metadata.get('style', 'form') if style == 'deepObject': - params = params | _get_deep_object_query_params( - metadata, f_name, value) + params = {**params, **_get_deep_object_query_params( + metadata, f_name, value)} elif style == 'form': - params = params | _get_delimited_query_params( - metadata, f_name, value, ",") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, ",")} elif style == 'pipeDelimited': - params = params | _get_delimited_query_params( - metadata, f_name, value, "|") + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, "|")} else: raise Exception('not yet implemented') return params -def get_headers(headers_params: dataclass) -> dict[str, str]: +def get_headers(headers_params: dataclass) -> Dict[str, str]: if headers_params is None: return {} - headers: dict[str, str] = {} + headers: Dict[str, str] = {} param_fields: Tuple[Field, ...] = fields(headers_params) for field in param_fields: @@ -302,8 +304,8 @@ def get_headers(headers_params: dataclass) -> dict[str, str]: return headers -def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[str, str]: - params: dict[str, str] = {} +def _get_serialized_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, str]: + params: Dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': @@ -312,8 +314,8 @@ def _get_serialized_params(metadata: dict, field_name: str, obj: any) -> dict[st return params -def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_deep_object_query_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -329,7 +331,7 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> if obj_val is None: continue - if isinstance(obj_val, list): + if isinstance(obj_val, List): for val in obj_val: if val is None: continue @@ -347,12 +349,12 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> params[ f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ _val_to_string(obj_val)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): for key, value in obj.items(): if value is None: continue - if isinstance(value, list): + if isinstance(value, List): for val in value: if val is None: continue @@ -378,8 +380,8 @@ def _get_query_param_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delimiter: str) -> dict[ - str, list[str]]: +def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delimiter: str) -> Dict[ + str, List[str]]: return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) @@ -392,17 +394,22 @@ def _get_delimited_query_params(metadata: dict, field_name: str, obj: any, delim } -def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[ +def serialize_request_body(request: dataclass, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ str, any, any]: if request is None: - return None, None, None + if not nullable and optional: + return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], - request) + request, encoder) request_val = getattr(request, request_field_name) + if request_val is None: + if not nullable and optional: + return None, None, None + request_fields: Tuple[Field, ...] = fields(request) request_metadata = None @@ -418,9 +425,9 @@ def serialize_request_body(request: dataclass, request_field_name: str, serializ request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: +def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request), None + return media_type, marshal_json(request, encoder), None if re.match(r'multipart\/.*', media_type) is not None: return serialize_multipart_form(media_type, request) if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: @@ -434,8 +441,8 @@ def serialize_content_type(field_name: str, media_type: str, request: dataclass) f"invalid request body type {type(request)} for mediaType {media_type}") -def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: - form: list[list[any]] = [] +def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, List[List[any]]]: + form: List[List[any]] = [] request_fields = fields(request) for field in request_fields: @@ -476,7 +483,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, else: field_name = field_metadata.get( "field_name", field.name) - if isinstance(val, list): + if isinstance(val, List): for value in val: if value is None: continue @@ -487,8 +494,8 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, return media_type, None, form -def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: +def serialize_dict(original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]]) -> Dict[ + str, List[str]]: if existing is None: existing = [] @@ -508,8 +515,8 @@ def serialize_dict(original: dict, explode: bool, field_name, existing: Optional return existing -def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: - form: dict[str, list[str]] = {} +def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: + form: Dict[str, List[str]] = {} if is_dataclass(data): for field in fields(data): @@ -527,12 +534,12 @@ def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: form[field_name] = [marshal_json(val)] else: if metadata.get('style', 'form') == 'form': - form = form | _populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name, ",") + form = {**form, **_populate_form( + field_name, metadata.get('explode', True), val, _get_form_field_name, ",")} else: raise Exception( f'Invalid form style for field {field.name}') - elif isinstance(data, dict): + elif isinstance(data, Dict): for key, value in data.items(): form[key] = [_val_to_string(value)] else: @@ -551,8 +558,8 @@ def _get_form_field_name(obj_field: Field) -> str: def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ - dict[str, list[str]]: - params: dict[str, list[str]] = {} + Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -578,7 +585,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): if value is None: @@ -591,7 +598,7 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if len(items) > 0: params[field_name] = [delimiter.join(items)] - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -645,7 +652,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join(items) - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): @@ -660,7 +667,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join([str(item) for item in items]) - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -677,7 +684,7 @@ def _serialize_header(explode: bool, obj: any) -> str: return '' -def unmarshal_json(data, typ): +def unmarshal_json(data, typ, decoder=None): unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) @@ -686,15 +693,19 @@ def unmarshal_json(data, typ): except AttributeError as attr_err: raise AttributeError( f'unable to unmarshal {data} as {typ}') from attr_err - return out.res + + return out.res if decoder is None else decoder(out.res) -def marshal_json(val): +def marshal_json(val, encoder=None): marshal = make_dataclass('Marshal', [('res', type(val))], bases=(DataClassJsonMixin,)) marshaller = marshal(res=val) json_dict = marshaller.to_dict() - return json.dumps(json_dict["res"]) + + val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) + + return json.dumps(val) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -768,6 +779,56 @@ def decimaldecoder(val): return Decimal(str(val)) +def map_encoder(optional: bool, value_encoder: Callable): + def map_encode(val: Dict): + if optional and val is None: + return None + + encoded = {} + for key, value in val.items(): + encoded[key] = value_encoder(value) + + return encoded + + return map_encode + + +def map_decoder(value_decoder: Callable): + def map_decode(val: Dict): + decoded = {} + for key, value in val.items(): + decoded[key] = value_decoder(value) + + return decoded + + return map_decode + + +def list_encoder(optional: bool, value_encoder: Callable): + def list_encode(val: List): + if optional and val is None: + return None + + encoded = [] + for value in val: + encoded.append(value_encoder(value)) + + return encoded + + return list_encode + + +def list_decoder(value_decoder: Callable): + def list_decode(val: List): + decoded = [] + for value in val: + decoded.append(value_decoder(value)) + + return decoded + + return list_decode + + def get_field_name(name): def override(_, _field_name=name): return _field_name @@ -786,7 +847,7 @@ def _val_to_string(val): return str(val) -def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: dict[str, dict[str, dict[str, Any]]]): +def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: Dict[str, Dict[str, Dict[str, Any]]]): if value is None and gbls is not None: if 'parameters' in gbls: if param_type in gbls['parameters']: @@ -796,3 +857,16 @@ def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: d value = global_value return value + + +def decoder_with_discriminator(field_name): + def decode_fx(obj): + kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) + return unmarshal_json(json.dumps(obj), kls) + return decode_fx + + +def remove_suffix(input_string, suffix): + if suffix and input_string.endswith(suffix): + return input_string[:-len(suffix)] + return input_string