diff --git a/lending/.gitattributes b/lending/.gitattributes old mode 100755 new mode 100644 diff --git a/lending/README.md b/lending/README.md index 0bdcd6cd4..6996782b4 100644 --- a/lending/README.md +++ b/lending/README.md @@ -4,19 +4,23 @@ Lending helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from the operating systems they are already using. You can use that data for automating decisioning and surfacing new insights on the customer, all via one API. - + ## SDK Installation ```bash pip install codat-lending ``` - + ## Example Usage - + +## SDK Example Usage + +### Example + ```python import codatlending -from codatlending.models import operations, shared +from codatlending.models import shared s = codatlending.CodatLending( security=shared.Security( @@ -24,36 +28,22 @@ s = codatlending.CodatLending( ), ) -req = operations.ListAccountingBankAccountTransactionsRequest( - 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, +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', ) -res = s.accounting_bank_data.list_transactions(req) +res = s.companies.create(req) -if res.accounting_bank_transactions is not None: +if res.company is not None: # handle response pass ``` - + - + ## Available Resources and Operations - -### [accounting_bank_data](docs/sdks/accountingbankdata/README.md) - -* [list_transactions](docs/sdks/accountingbankdata/README.md#list_transactions) - List bank account transactions - -### [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) * [create](docs/sdks/companies/README.md#create) - Create company @@ -62,11 +52,6 @@ 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 -### [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) * [create](docs/sdks/connections/README.md#create) - Create connection @@ -75,290 +60,517 @@ 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 -### [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 +### [transactions.account_transactions](docs/sdks/accounttransactions/README.md) -### [excel_reports](docs/sdks/excelreports/README.md) +* [get](docs/sdks/accounttransactions/README.md#get) - Get account transaction +* [list](docs/sdks/accounttransactions/README.md#list) - List account transactions -* [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 +### [transactions.direct_costs](docs/sdks/codatlendingdirectcosts/README.md) -### [file_upload](docs/sdks/fileupload/README.md) +* [download_attachment](docs/sdks/codatlendingdirectcosts/README.md#download_attachment) - Download direct cost attachment +* [get](docs/sdks/codatlendingdirectcosts/README.md#get) - Get direct cost +* [get_attachment](docs/sdks/codatlendingdirectcosts/README.md#get_attachment) - Get direct cost attachment +* [list](docs/sdks/codatlendingdirectcosts/README.md#list) - List direct costs +* [list_attachments](docs/sdks/codatlendingdirectcosts/README.md#list_attachments) - List direct cost attachments -* [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 +### [transactions.transfers](docs/sdks/codatlendingtransfers/README.md) -### [liabilities](docs/sdks/liabilities/README.md) +* [get](docs/sdks/codatlendingtransfers/README.md#get) - Get transfer +* [list](docs/sdks/codatlendingtransfers/README.md#list) - List transfers -* [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 +### [transactions.journal_entries](docs/sdks/journalentries/README.md) + +* [get](docs/sdks/journalentries/README.md#get) - Get journal entry +* [list](docs/sdks/journalentries/README.md#list) - List journal entries + +### [transactions.journals](docs/sdks/journals/README.md) + +* [get](docs/sdks/journals/README.md#get) - Get journal +* [list](docs/sdks/journals/README.md#list) - List journals + +### [accounting_bank_data](docs/sdks/codatlendingaccountingbankdata/README.md) + +* [list_transactions](docs/sdks/codatlendingaccountingbankdata/README.md#list_transactions) - List bank account transactions + +### [accounting_bank_data.accounts](docs/sdks/accounts/README.md) + +* [get](docs/sdks/accounts/README.md#get) - Get bank account +* [list](docs/sdks/accounts/README.md#list) - List bank accounts + + +### [banking.account_balances](docs/sdks/accountbalances/README.md) + +* [list](docs/sdks/accountbalances/README.md#list) - List account balances + +### [banking.accounts](docs/sdks/codatlendingaccounts/README.md) + +* [get](docs/sdks/codatlendingaccounts/README.md#get) - Get account +* [list](docs/sdks/codatlendingaccounts/README.md#list) - List accounts + +### [banking.transaction_categories](docs/sdks/transactioncategories/README.md) + +* [get](docs/sdks/transactioncategories/README.md#get) - Get transaction category +* [list](docs/sdks/transactioncategories/README.md#list) - List transaction categories +### [banking.transactions](docs/sdks/codatlendingbankingtransactions/README.md) -### [accounts_payable.bill_credit_notes](docs/sdks/accountspayablebillcreditnotes/README.md) +* [get](docs/sdks/codatlendingbankingtransactions/README.md#get) - Get bank transaction +* [list](docs/sdks/codatlendingbankingtransactions/README.md#list) - List transactions -* [get](docs/sdks/accountspayablebillcreditnotes/README.md#get) - Get bill credit note -* [list](docs/sdks/accountspayablebillcreditnotes/README.md#list) - List bill credit notes +### [banking.categorized_statement](docs/sdks/categorizedstatement/README.md) -### [accounts_payable.bill_payments](docs/sdks/accountspayablebillpayments/README.md) +* [get](docs/sdks/categorizedstatement/README.md#get) - Get categorized bank statement -* [get](docs/sdks/accountspayablebillpayments/README.md#get) - Get bill payment -* [list](docs/sdks/accountspayablebillpayments/README.md#list) - List bill payments -### [accounts_payable.bills](docs/sdks/accountspayablebills/README.md) +### [accounts_payable.bills](docs/sdks/bills/README.md) -* [download_attachment](docs/sdks/accountspayablebills/README.md#download_attachment) - Download bill attachment -* [get](docs/sdks/accountspayablebills/README.md#get) - Get bill -* [get_attachment](docs/sdks/accountspayablebills/README.md#get_attachment) - Get bill attachment -* [list](docs/sdks/accountspayablebills/README.md#list) - List bills -* [list_attachments](docs/sdks/accountspayablebills/README.md#list_attachments) - List bill attachments +* [download_attachment](docs/sdks/bills/README.md#download_attachment) - Download bill attachment +* [get](docs/sdks/bills/README.md#get) - Get bill +* [get_attachment](docs/sdks/bills/README.md#get_attachment) - Get bill attachment +* [list](docs/sdks/bills/README.md#list) - List bills +* [list_attachments](docs/sdks/bills/README.md#list_attachments) - List bill attachments -### [accounts_payable.suppliers](docs/sdks/accountspayablesuppliers/README.md) +### [accounts_payable.suppliers](docs/sdks/suppliers/README.md) -* [download_attachment](docs/sdks/accountspayablesuppliers/README.md#download_attachment) - Download supplier attachment -* [get](docs/sdks/accountspayablesuppliers/README.md#get) - Get supplier -* [get_attachment](docs/sdks/accountspayablesuppliers/README.md#get_attachment) - Get supplier attachment -* [list](docs/sdks/accountspayablesuppliers/README.md#list) - List suppliers -* [list_attachments](docs/sdks/accountspayablesuppliers/README.md#list_attachments) - List supplier attachments +* [download_attachment](docs/sdks/suppliers/README.md#download_attachment) - Download supplier attachment +* [get](docs/sdks/suppliers/README.md#get) - Get supplier +* [get_attachment](docs/sdks/suppliers/README.md#get_attachment) - Get supplier attachment +* [list](docs/sdks/suppliers/README.md#list) - List suppliers +* [list_attachments](docs/sdks/suppliers/README.md#list_attachments) - List supplier attachments +### [accounts_payable.bill_credit_notes](docs/sdks/billcreditnotes/README.md) -### [accounts_receivable.credit_notes](docs/sdks/accountsreceivablecreditnotes/README.md) +* [get](docs/sdks/billcreditnotes/README.md#get) - Get bill credit note +* [list](docs/sdks/billcreditnotes/README.md#list) - List bill credit notes -* [get](docs/sdks/accountsreceivablecreditnotes/README.md#get) - Get credit note -* [list](docs/sdks/accountsreceivablecreditnotes/README.md#list) - List credit notes +### [accounts_payable.bill_payments](docs/sdks/billpayments/README.md) -### [accounts_receivable.customers](docs/sdks/accountsreceivablecustomers/README.md) +* [get](docs/sdks/billpayments/README.md#get) - Get bill payment +* [list](docs/sdks/billpayments/README.md#list) - List bill payments -* [download_attachment](docs/sdks/accountsreceivablecustomers/README.md#download_attachment) - Download customer attachment -* [get](docs/sdks/accountsreceivablecustomers/README.md#get) - Get customer -* [get_attachment](docs/sdks/accountsreceivablecustomers/README.md#get_attachment) - Get customer attachment -* [list](docs/sdks/accountsreceivablecustomers/README.md#list) - List customers -* [list_attachments](docs/sdks/accountsreceivablecustomers/README.md#list_attachments) - List customer attachments -### [accounts_receivable.direct_incomes](docs/sdks/accountsreceivabledirectincomes/README.md) +### [sales.customers](docs/sdks/codatlendingcustomers/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 -* [get_attachment](docs/sdks/accountsreceivabledirectincomes/README.md#get_attachment) - Get direct income attachment -* [list](docs/sdks/accountsreceivabledirectincomes/README.md#list) - List direct incomes -* [list_attachments](docs/sdks/accountsreceivabledirectincomes/README.md#list_attachments) - List direct income attachments +* [get](docs/sdks/codatlendingcustomers/README.md#get) - Get customer +* [list](docs/sdks/codatlendingcustomers/README.md#list) - List customers -### [accounts_receivable.invoices](docs/sdks/accountsreceivableinvoices/README.md) +### [sales.disputes](docs/sdks/disputes/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 -* [get](docs/sdks/accountsreceivableinvoices/README.md#get) - Get invoice -* [get_attachment](docs/sdks/accountsreceivableinvoices/README.md#get_attachment) - Get invoice attachment -* [list](docs/sdks/accountsreceivableinvoices/README.md#list) - List invoices -* [list_attachments](docs/sdks/accountsreceivableinvoices/README.md#list_attachments) - List invoice attachments -* [list_reconciled](docs/sdks/accountsreceivableinvoices/README.md#list_reconciled) - List reconciled invoices +* [get](docs/sdks/disputes/README.md#get) - Get dispute +* [list](docs/sdks/disputes/README.md#list) - List disputes -### [accounts_receivable.payments](docs/sdks/accountsreceivablepayments/README.md) +### [sales.locations](docs/sdks/locations/README.md) -* [get](docs/sdks/accountsreceivablepayments/README.md#get) - Get payment -* [list](docs/sdks/accountsreceivablepayments/README.md#list) - List payments +* [get](docs/sdks/locations/README.md#get) - Get location +* [list](docs/sdks/locations/README.md#list) - List locations -### [accounts_receivable.reports](docs/sdks/accountsreceivablereports/README.md) +### [sales.orders](docs/sdks/orders/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 -* [is_aged_creditors_available](docs/sdks/accountsreceivablereports/README.md#is_aged_creditors_available) - Aged creditors report available -* [is_aged_debtors_available](docs/sdks/accountsreceivablereports/README.md#is_aged_debtors_available) - Aged debtors report available +* [get](docs/sdks/orders/README.md#get) - Get order +* [list](docs/sdks/orders/README.md#list) - List orders +### [sales.payment_methods](docs/sdks/paymentmethods/README.md) -### [banking.account_balances](docs/sdks/bankingaccountbalances/README.md) +* [get](docs/sdks/paymentmethods/README.md#get) - Get payment method +* [list](docs/sdks/paymentmethods/README.md#list) - List payment methods -* [list](docs/sdks/bankingaccountbalances/README.md#list) - List account balances +### [sales.payments](docs/sdks/codatlendingsalespayments/README.md) -### [banking.accounts](docs/sdks/bankingaccounts/README.md) +* [get](docs/sdks/codatlendingsalespayments/README.md#get) - Get payment +* [list](docs/sdks/codatlendingsalespayments/README.md#list) - List payments -* [get](docs/sdks/bankingaccounts/README.md#get) - Get account -* [list](docs/sdks/bankingaccounts/README.md#list) - List accounts +### [sales.product_categories](docs/sdks/productcategories/README.md) -### [banking.categorized_statement](docs/sdks/bankingcategorizedstatement/README.md) +* [get](docs/sdks/productcategories/README.md#get) - Get product category +* [list](docs/sdks/productcategories/README.md#list) - List product categories -* [get](docs/sdks/bankingcategorizedstatement/README.md#get) - Get categorized bank statement +### [sales.products](docs/sdks/products/README.md) -### [banking.transaction_categories](docs/sdks/bankingtransactioncategories/README.md) +* [get](docs/sdks/products/README.md#get) - Get product +* [list](docs/sdks/products/README.md#list) - List products -* [get](docs/sdks/bankingtransactioncategories/README.md#get) - Get transaction category -* [list](docs/sdks/bankingtransactioncategories/README.md#list) - List transaction categories +### [sales.transactions](docs/sdks/codatlendingtransactions/README.md) -### [banking.transactions](docs/sdks/bankingtransactions/README.md) +* [get](docs/sdks/codatlendingtransactions/README.md#get) - Get transaction +* [list](docs/sdks/codatlendingtransactions/README.md#list) - List transactions -* [get](docs/sdks/bankingtransactions/README.md#get) - Get bank transaction -* [list](docs/sdks/bankingtransactions/README.md#list) - List transactions +### [sales.metrics](docs/sdks/metrics/README.md) +* [get_customer_retention](docs/sdks/metrics/README.md#get_customer_retention) - Get customer retention metrics +* [get_lifetime_value](docs/sdks/metrics/README.md#get_lifetime_value) - Get lifetime value metrics +* [get_revenue](docs/sdks/metrics/README.md#get_revenue) - Get commerce revenue metrics -### [financial_statements.accounts](docs/sdks/financialstatementsaccounts/README.md) +### [sales.reports](docs/sdks/codatlendingreports/README.md) -* [get](docs/sdks/financialstatementsaccounts/README.md#get) - Get account -* [list](docs/sdks/financialstatementsaccounts/README.md#list) - List accounts +* [get_orders](docs/sdks/codatlendingreports/README.md#get_orders) - Get orders report +* [get_refunds](docs/sdks/codatlendingreports/README.md#get_refunds) - Get refunds report -### [financial_statements.balance_sheet](docs/sdks/financialstatementsbalancesheet/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 + + +### [accounts_receivable.customers](docs/sdks/customers/README.md) + +* [download_attachment](docs/sdks/customers/README.md#download_attachment) - Download customer attachment +* [get](docs/sdks/customers/README.md#get) - Get customer +* [get_attachment](docs/sdks/customers/README.md#get_attachment) - Get customer attachment +* [list](docs/sdks/customers/README.md#list) - List customers +* [list_attachments](docs/sdks/customers/README.md#list_attachments) - List customer attachments + +### [accounts_receivable.direct_incomes](docs/sdks/directincomes/README.md) + +* [download_attachment](docs/sdks/directincomes/README.md#download_attachment) - Download direct income attachment +* [get](docs/sdks/directincomes/README.md#get) - Get direct income +* [get_attachment](docs/sdks/directincomes/README.md#get_attachment) - Get direct income attachment +* [list](docs/sdks/directincomes/README.md#list) - List direct incomes +* [list_attachments](docs/sdks/directincomes/README.md#list_attachments) - List direct income attachments + +### [accounts_receivable.invoices](docs/sdks/invoices/README.md) + +* [download_attachment](docs/sdks/invoices/README.md#download_attachment) - Download invoice attachment +* [download_pdf](docs/sdks/invoices/README.md#download_pdf) - Get invoice as PDF +* [get](docs/sdks/invoices/README.md#get) - Get invoice +* [get_attachment](docs/sdks/invoices/README.md#get_attachment) - Get invoice attachment +* [list](docs/sdks/invoices/README.md#list) - List invoices +* [list_attachments](docs/sdks/invoices/README.md#list_attachments) - List invoice attachments +* [list_reconciled](docs/sdks/invoices/README.md#list_reconciled) - List reconciled invoices -* [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 +### [accounts_receivable.credit_notes](docs/sdks/creditnotes/README.md) + +* [get](docs/sdks/creditnotes/README.md#get) - Get credit note +* [list](docs/sdks/creditnotes/README.md#list) - List credit notes + +### [accounts_receivable.payments](docs/sdks/payments/README.md) + +* [get](docs/sdks/payments/README.md#get) - Get payment +* [list](docs/sdks/payments/README.md#list) - List payments + +### [accounts_receivable.reports](docs/sdks/reports/README.md) + +* [get_aged_creditors](docs/sdks/reports/README.md#get_aged_creditors) - Aged creditors report +* [get_aged_debtors](docs/sdks/reports/README.md#get_aged_debtors) - Aged debtors report +* [is_aged_creditors_available](docs/sdks/reports/README.md#is_aged_creditors_available) - Aged creditors report available +* [is_aged_debtors_available](docs/sdks/reports/README.md#is_aged_debtors_available) - Aged debtors report available + +### [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 -### [financial_statements.cash_flow](docs/sdks/financialstatementscashflow/README.md) -* [get](docs/sdks/financialstatementscashflow/README.md#get) - Get cash flow statement +### [loan_writeback.bank_accounts](docs/sdks/bankaccounts/README.md) -### [financial_statements.profit_and_loss](docs/sdks/financialstatementsprofitandloss/README.md) +* [create](docs/sdks/bankaccounts/README.md#create) - Create bank account +* [get_create_update_model](docs/sdks/bankaccounts/README.md#get_create_update_model) - Get create/update bank account model -* [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 +### [loan_writeback.bank_transactions](docs/sdks/banktransactions/README.md) +* [create](docs/sdks/banktransactions/README.md#create) - Create bank account transactions +* [get_create_model](docs/sdks/banktransactions/README.md#get_create_model) - Get create bank account transactions model -### [loan_writeback.accounts](docs/sdks/loanwritebackaccounts/README.md) +### [loan_writeback.accounts](docs/sdks/codatlendingloanwritebackaccounts/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 +* [create](docs/sdks/codatlendingloanwritebackaccounts/README.md#create) - Create account +* [get_create_model](docs/sdks/codatlendingloanwritebackaccounts/README.md#get_create_model) - Get create account model -### [loan_writeback.bank_transactions](docs/sdks/loanwritebackbanktransactions/README.md) +### [loan_writeback.direct_costs](docs/sdks/directcosts/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 +* [create](docs/sdks/directcosts/README.md#create) - Create direct cost +* [get_create_model](docs/sdks/directcosts/README.md#get_create_model) - Get create direct cost model -### [loan_writeback.create_operations](docs/sdks/loanwritebackcreateoperations/README.md) +### [loan_writeback.payments](docs/sdks/codatlendingpayments/README.md) -* [get](docs/sdks/loanwritebackcreateoperations/README.md#get) - Get create operation -* [list](docs/sdks/loanwritebackcreateoperations/README.md#list) - List create operations +* [create](docs/sdks/codatlendingpayments/README.md#create) - Create payment +* [get_create_model](docs/sdks/codatlendingpayments/README.md#get_create_model) - Get create payment model -### [loan_writeback.direct_costs](docs/sdks/loanwritebackdirectcosts/README.md) +### [loan_writeback.suppliers](docs/sdks/codatlendingsuppliers/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 +* [create](docs/sdks/codatlendingsuppliers/README.md#create) - Create supplier +* [get_create_update_model](docs/sdks/codatlendingsuppliers/README.md#get_create_update_model) - Get create/update supplier model -### [loan_writeback.payments](docs/sdks/loanwritebackpayments/README.md) +### [loan_writeback.transfers](docs/sdks/transfers/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 +* [create](docs/sdks/transfers/README.md#create) - Create transfer +* [get_create_model](docs/sdks/transfers/README.md#get_create_model) - Get create transfer model -### [loan_writeback.suppliers](docs/sdks/loanwritebacksuppliers/README.md) +### [loan_writeback.create_operations](docs/sdks/createoperations/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 +* [get](docs/sdks/createoperations/README.md#get) - Get create operation +* [list](docs/sdks/createoperations/README.md#list) - List create operations -### [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 +### [financial_statements.accounts](docs/sdks/codatlendingfinancialstatementsaccounts/README.md) + +* [get](docs/sdks/codatlendingfinancialstatementsaccounts/README.md#get) - Get account +* [list](docs/sdks/codatlendingfinancialstatementsaccounts/README.md#list) - List accounts + +### [financial_statements.balance_sheet](docs/sdks/balancesheet/README.md) + +* [get](docs/sdks/balancesheet/README.md#get) - Get balance sheet +* [get_categorized_accounts](docs/sdks/balancesheet/README.md#get_categorized_accounts) - Get categorized balance sheet statement + +### [financial_statements.cash_flow](docs/sdks/cashflow/README.md) + +* [get](docs/sdks/cashflow/README.md#get) - Get cash flow statement + +### [financial_statements.profit_and_loss](docs/sdks/profitandloss/README.md) + +* [get](docs/sdks/profitandloss/README.md#get) - Get profit and loss +* [get_categorized_accounts](docs/sdks/profitandloss/README.md#get_categorized_accounts) - Get categorized profit and loss statement ### [manage_data](docs/sdks/managedata/README.md) * [get_status](docs/sdks/managedata/README.md#get_status) - Get data status -### [manage_data.pull_operations](docs/sdks/managedatapulloperations/README.md) +### [manage_data.refresh](docs/sdks/refresh/README.md) + +* [all_data_types](docs/sdks/refresh/README.md#all_data_types) - Refresh all data +* [data_type](docs/sdks/refresh/README.md#data_type) - Refresh data type + +### [manage_data.pull_operations](docs/sdks/pulloperations/README.md) + +* [get](docs/sdks/pulloperations/README.md#get) - Get pull operation +* [list](docs/sdks/pulloperations/README.md#list) - List pull operations + +### [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 + +### [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 + +### [excel_reports](docs/sdks/excelreports/README.md) -* [get](docs/sdks/managedatapulloperations/README.md#get) - Get pull operation -* [list](docs/sdks/managedatapulloperations/README.md#list) - List pull operations +* [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 + -### [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 + +## Retries -### [sales.customers](docs/sdks/salescustomers/README.md) +Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. -* [get](docs/sdks/salescustomers/README.md#get) - Get customer -* [list](docs/sdks/salescustomers/README.md#list) - List customers +To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: +```python +import codatlending +from codatlending.models import shared +from codatlending.utils import BackoffStrategy, RetryConfig + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) -### [sales.disputes](docs/sdks/salesdisputes/README.md) +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) -* [get](docs/sdks/salesdisputes/README.md#get) - Get dispute -* [list](docs/sdks/salesdisputes/README.md#list) - List disputes +res = s.companies.create(req, + RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)) -### [sales.locations](docs/sdks/saleslocations/README.md) +if res.company is not None: + # handle response + pass +``` -* [get](docs/sdks/saleslocations/README.md#get) - Get location -* [list](docs/sdks/saleslocations/README.md#list) - List locations +If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: +```python +import codatlending +from codatlending.models import shared +from codatlending.utils import BackoffStrategy, RetryConfig -### [sales.metrics](docs/sdks/salesmetrics/README.md) +s = codatlending.CodatLending( + retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False) + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) + +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) + +res = s.companies.create(req) + +if res.company is not None: + # handle response + pass +``` + + + +## Error Handling + +Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type. + +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 400,401,402,403,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | + +### Example + +```python +import codatlending +from codatlending.models import shared + +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) -* [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 +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) -### [sales.orders](docs/sdks/salesorders/README.md) +res = None +try: + res = s.companies.create(req) +except errors.ErrorMessage as e: + print(e) # handle exception + raise(e) +except errors.SDKError as e: + print(e) # handle exception + raise(e) + +if res.company is not None: + # handle response + pass +``` + -* [get](docs/sdks/salesorders/README.md#get) - Get order -* [list](docs/sdks/salesorders/README.md#list) - List orders + +## Server Selection -### [sales.payment_methods](docs/sdks/salespaymentmethods/README.md) +### Select Server by Index -* [get](docs/sdks/salespaymentmethods/README.md#get) - Get payment method -* [list](docs/sdks/salespaymentmethods/README.md#list) - List payment methods +You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: -### [sales.payments](docs/sdks/salespayments/README.md) +| # | Server | Variables | +| - | ------ | --------- | +| 0 | `https://api.codat.io` | None | -* [get](docs/sdks/salespayments/README.md#get) - Get payment -* [list](docs/sdks/salespayments/README.md#list) - List payments +#### Example -### [sales.product_categories](docs/sdks/salesproductcategories/README.md) +```python +import codatlending +from codatlending.models import shared -* [get](docs/sdks/salesproductcategories/README.md#get) - Get product category -* [list](docs/sdks/salesproductcategories/README.md#list) - List product categories +s = codatlending.CodatLending( + server_idx=0, + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) -### [sales.products](docs/sdks/salesproducts/README.md) +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) -* [get](docs/sdks/salesproducts/README.md#get) - Get product -* [list](docs/sdks/salesproducts/README.md#list) - List products +res = s.companies.create(req) -### [sales.reports](docs/sdks/salesreports/README.md) +if res.company is not None: + # handle response + pass +``` -* [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) +### Override Server URL Per-Client -* [get](docs/sdks/salestransactions/README.md#get) - Get transaction -* [list](docs/sdks/salestransactions/README.md#list) - List transactions +The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: +```python +import codatlending +from codatlending.models import shared +s = codatlending.CodatLending( + server_url="https://api.codat.io", + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) -### [transactions.account_transactions](docs/sdks/transactionsaccounttransactions/README.md) +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) -* [get](docs/sdks/transactionsaccounttransactions/README.md#get) - Get account transaction -* [list](docs/sdks/transactionsaccounttransactions/README.md#list) - List account transactions +res = s.companies.create(req) -### [transactions.direct_costs](docs/sdks/transactionsdirectcosts/README.md) +if res.company is not None: + # handle response + pass +``` + -* [download_attachment](docs/sdks/transactionsdirectcosts/README.md#download_attachment) - Download direct cost attachment -* [get](docs/sdks/transactionsdirectcosts/README.md#get) - Get direct cost -* [get_attachment](docs/sdks/transactionsdirectcosts/README.md#get_attachment) - Get direct cost attachment -* [list](docs/sdks/transactionsdirectcosts/README.md#list) - List direct costs -* [list_attachments](docs/sdks/transactionsdirectcosts/README.md#list_attachments) - List direct cost attachments + +## Custom HTTP Client -### [transactions.journal_entries](docs/sdks/transactionsjournalentries/README.md) +The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. -* [get](docs/sdks/transactionsjournalentries/README.md#get) - Get journal entry -* [list](docs/sdks/transactionsjournalentries/README.md#list) - List journal entries +For example, you could specify a header for every request that this sdk makes as follows: +```python +import codatlending +import requests -### [transactions.journals](docs/sdks/transactionsjournals/README.md) +http_client = requests.Session() +http_client.headers.update({'x-custom-header': 'someValue'}) +s = codatlending.CodatLending(client: http_client) +``` + -* [get](docs/sdks/transactionsjournals/README.md#get) - Get journal -* [list](docs/sdks/transactionsjournals/README.md#list) - List journals + +## Authentication -### [transactions.transfers](docs/sdks/transactionstransfers/README.md) +### Per-Client Security Schemes -* [get](docs/sdks/transactionstransfers/README.md#get) - Get transfer -* [list](docs/sdks/transactionstransfers/README.md#list) - List transfers - +This SDK supports the following security scheme globally: +| Name | Type | Scheme | +| ------------- | ------------- | ------------- | +| `auth_header` | apiKey | API key | +You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example: +```python +import codatlending +from codatlending.models import shared - +s = codatlending.CodatLending( + security=shared.Security( + auth_header="Basic BASE_64_ENCODED(API_KEY)", + ), +) +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', +) +res = s.companies.create(req) - +if res.company is not None: + # handle response + pass +``` + diff --git a/lending/RELEASES.md b/lending/RELEASES.md index 2b68547b5..d87400c41 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -58,4 +58,14 @@ Based on: ### 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 +- [PyPI v5.0.0] https://pypi.org/project/codat-lending/5.0.0 - lending + +## 2023-12-05 11:19:01 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Lending.yaml +- Speakeasy CLI 1.125.1 (2.210.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v6.0.0] lending +### Releases +- [PyPI v6.0.0] https://pypi.org/project/codat-lending/6.0.0 - lending \ No newline at end of file diff --git a/lending/USAGE.md b/lending/USAGE.md old mode 100755 new mode 100644 index 0399dc88b..4a53d6fe4 --- a/lending/USAGE.md +++ b/lending/USAGE.md @@ -1,9 +1,7 @@ - - - + ```python import codatlending -from codatlending.models import operations, shared +from codatlending.models import shared s = codatlending.CodatLending( security=shared.Security( @@ -11,19 +9,15 @@ s = codatlending.CodatLending( ), ) -req = operations.ListAccountingBankAccountTransactionsRequest( - 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, +req = shared.CompanyRequestBody( + description='Requested early access to the new financing scheme.', + name='Bank of Dave', ) -res = s.accounting_bank_data.list_transactions(req) +res = s.companies.create(req) -if res.accounting_bank_transactions is not None: +if res.company is not None: # handle response pass ``` - \ No newline at end of file + \ No newline at end of file diff --git a/lending/docs/models/shared/errormessage.md b/lending/docs/models/errors/errormessage.md old mode 100755 new mode 100644 similarity index 99% rename from lending/docs/models/shared/errormessage.md rename to lending/docs/models/errors/errormessage.md index 2d1289c0d..a2631711d --- a/lending/docs/models/shared/errormessage.md +++ b/lending/docs/models/errors/errormessage.md @@ -1,5 +1,7 @@ # ErrorMessage +The request made is not valid. + ## Fields diff --git a/lending/docs/models/operations/createaccountrequest.md b/lending/docs/models/operations/createaccountrequest.md old mode 100755 new mode 100644 index 49447fd16..f8733acf4 --- a/lending/docs/models/operations/createaccountrequest.md +++ b/lending/docs/models/operations/createaccountrequest.md @@ -3,10 +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: | 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 +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `account_prototype` | [Optional[shared.AccountPrototype]](../../models/shared/accountprototype.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 old mode 100755 new mode 100644 index 6054a88d3..c7af1c660 --- a/lending/docs/models/operations/createaccountresponse.md +++ b/lending/docs/models/operations/createaccountresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `accounting_create_account_response` | [Optional[shared.AccountingCreateAccountResponse]](../../models/shared/accountingcreateaccountresponse.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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 new file mode 100644 index 000000000..64446a789 --- /dev/null +++ b/lending/docs/models/operations/createbankaccountrequest.md @@ -0,0 +1,12 @@ +# 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: | 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/createbankaccountresponse.md b/lending/docs/models/operations/createbankaccountresponse.md new file mode 100644 index 000000000..bdfd9879d --- /dev/null +++ b/lending/docs/models/operations/createbankaccountresponse.md @@ -0,0 +1,11 @@ +# 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: | 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_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/createbanktransactionsrequest.md b/lending/docs/models/operations/createbanktransactionsrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/createbanktransactionsresponse.md b/lending/docs/models/operations/createbanktransactionsresponse.md old mode 100755 new mode 100644 index 380f2afe2..864dbed9b --- a/lending/docs/models/operations/createbanktransactionsresponse.md +++ b/lending/docs/models/operations/createbanktransactionsresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `accounting_create_bank_transactions_response` | [Optional[shared.AccountingCreateBankTransactionsResponse]](../../models/shared/accountingcreatebanktransactionsresponse.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index b780d6bc9..509542849 --- a/lending/docs/models/operations/createcompanyresponse.md +++ b/lending/docs/models/operations/createcompanyresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index b315a6d5e..0998495bf --- a/lending/docs/models/operations/createconnectionrequest.md +++ b/lending/docs/models/operations/createconnectionrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[operations.CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | +| `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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/createconnectionresponse.md b/lending/docs/models/operations/createconnectionresponse.md old mode 100755 new mode 100644 index 6cf898dc4..4f38451fa --- a/lending/docs/models/operations/createconnectionresponse.md +++ b/lending/docs/models/operations/createconnectionresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index 83c3e4e2b..9593136bf --- a/lending/docs/models/operations/createdirectcostrequest.md +++ b/lending/docs/models/operations/createdirectcostrequest.md @@ -3,10 +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: | 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 +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `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 | +| `direct_cost_prototype` | [Optional[shared.DirectCostPrototype]](../../models/shared/directcostprototype.md) | :heavy_minus_sign: | N/A | | +| `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 old mode 100755 new mode 100644 index 188ffc0d9..215a426ac --- a/lending/docs/models/operations/createdirectcostresponse.md +++ b/lending/docs/models/operations/createdirectcostresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | `accounting_create_direct_cost_response` | [Optional[shared.AccountingCreateDirectCostResponse]](../../models/shared/accountingcreatedirectcostresponse.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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/createpaymentresponse.md b/lending/docs/models/operations/createpaymentresponse.md old mode 100755 new mode 100644 index 884118f35..1a9d76675 --- a/lending/docs/models/operations/createpaymentresponse.md +++ b/lending/docs/models/operations/createpaymentresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/createsupplierresponse.md b/lending/docs/models/operations/createsupplierresponse.md old mode 100755 new mode 100644 index b5e23e0c4..8c33382dd --- a/lending/docs/models/operations/createsupplierresponse.md +++ b/lending/docs/models/operations/createsupplierresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `accounting_create_supplier_response` | [Optional[shared.AccountingCreateSupplierResponse]](../../models/shared/accountingcreatesupplierresponse.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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/createtransferresponse.md b/lending/docs/models/operations/createtransferresponse.md old mode 100755 new mode 100644 index da7042728..d96833f97 --- a/lending/docs/models/operations/createtransferresponse.md +++ b/lending/docs/models/operations/createtransferresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `accounting_create_transfer_response` | [Optional[shared.AccountingCreateTransferResponse]](../../models/shared/accountingcreatetransferresponse.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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/deletecompanyresponse.md b/lending/docs/models/operations/deletecompanyresponse.md old mode 100755 new mode 100644 index f3f21c2cb..7dfc00111 --- a/lending/docs/models/operations/deletecompanyresponse.md +++ b/lending/docs/models/operations/deletecompanyresponse.md @@ -6,6 +6,5 @@ | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/deleteconnectionresponse.md b/lending/docs/models/operations/deleteconnectionresponse.md old mode 100755 new mode 100644 index 30889c508..373abf82a --- a/lending/docs/models/operations/deleteconnectionresponse.md +++ b/lending/docs/models/operations/deleteconnectionresponse.md @@ -6,6 +6,5 @@ | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md b/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md old mode 100755 new mode 100644 index 644708da9..db7189898 --- a/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingbillattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md b/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md old mode 100755 new mode 100644 index da44170b9..3f7466036 --- a/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingcustomerattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md b/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md old mode 100755 new mode 100644 index 11d6fff49..9bea1041a --- a/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingdirectcostattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md old mode 100755 new mode 100644 index 382354666..7b080ab64 --- a/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md b/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md old mode 100755 new mode 100644 index 06496c9d6..2d3e6887b --- a/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountinginvoiceattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md b/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md old mode 100755 new mode 100644 index 6eea19d5a..f2a319ecc --- a/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md +++ b/lending/docs/models/operations/downloadaccountinginvoicepdfresponse.md @@ -8,4 +8,4 @@ | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md b/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md old mode 100755 new mode 100644 index ac8ed815c..dd5c94ce9 --- a/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md +++ b/lending/docs/models/operations/downloadaccountingsupplierattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadexcelreportresponse.md b/lending/docs/models/operations/downloadexcelreportresponse.md old mode 100755 new mode 100644 index 1a7be1331..293308933 --- a/lending/docs/models/operations/downloadexcelreportresponse.md +++ b/lending/docs/models/operations/downloadexcelreportresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `body` | *Optional[bytes]* | :heavy_minus_sign: | 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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/downloadfilesresponse.md b/lending/docs/models/operations/downloadfilesresponse.md old mode 100755 new mode 100644 index 27c4c1133..e31aefed9 --- a/lending/docs/models/operations/downloadfilesresponse.md +++ b/lending/docs/models/operations/downloadfilesresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/generateexcelreportresponse.md b/lending/docs/models/operations/generateexcelreportresponse.md old mode 100755 new mode 100644 index 0d700555e..09b9c1a14 --- a/lending/docs/models/operations/generateexcelreportresponse.md +++ b/lending/docs/models/operations/generateexcelreportresponse.md @@ -6,7 +6,6 @@ | 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. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index c5ce041fe..ba321529b --- a/lending/docs/models/operations/generateloansummaryrequest.md +++ b/lending/docs/models/operations/generateloansummaryrequest.md @@ -3,7 +3,7 @@ ## 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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.SourceType](../../models/operations/sourcetype.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 old mode 100755 new mode 100644 index fa984829f..d379473ef --- a/lending/docs/models/operations/generateloansummaryresponse.md +++ b/lending/docs/models/operations/generateloansummaryresponse.md @@ -6,6 +6,5 @@ | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/generateloantransactionsrequest.md b/lending/docs/models/operations/generateloantransactionsrequest.md old mode 100755 new mode 100644 index ad270be24..c8c763ce3 --- a/lending/docs/models/operations/generateloantransactionsrequest.md +++ b/lending/docs/models/operations/generateloantransactionsrequest.md @@ -3,7 +3,7 @@ ## 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 +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.QueryParamSourceType](../../models/operations/queryparamsourcetype.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 old mode 100755 new mode 100644 index 7c9dc16a4..f6fd0707c --- a/lending/docs/models/operations/generateloantransactionsresponse.md +++ b/lending/docs/models/operations/generateloantransactionsresponse.md @@ -6,6 +6,5 @@ | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getaccountingaccountrequest.md b/lending/docs/models/operations/getaccountingaccountrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingaccountresponse.md b/lending/docs/models/operations/getaccountingaccountresponse.md old mode 100755 new mode 100644 index 21f40fd94..21efd0ff3 --- a/lending/docs/models/operations/getaccountingaccountresponse.md +++ b/lending/docs/models/operations/getaccountingaccountresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_account` | [Optional[shared.AccountingAccount]](../../models/shared/accountingaccount.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingaccounttransactionresponse.md b/lending/docs/models/operations/getaccountingaccounttransactionresponse.md old mode 100755 new mode 100644 index 9f8379e52..1ab3c9259 --- a/lending/docs/models/operations/getaccountingaccounttransactionresponse.md +++ b/lending/docs/models/operations/getaccountingaccounttransactionresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `accounting_account_transaction` | [Optional[shared.AccountingAccountTransaction]](../../models/shared/accountingaccounttransaction.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md b/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md old mode 100755 new mode 100644 index 8991b8732..14729f475 --- a/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md +++ b/lending/docs/models/operations/getaccountingagedcreditorsreportresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `accounting_aged_creditor_report` | [Optional[shared.AccountingAgedCreditorReport]](../../models/shared/accountingagedcreditorreport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md b/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md old mode 100755 new mode 100644 index 897226e65..dcaab4225 --- a/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md +++ b/lending/docs/models/operations/getaccountingageddebtorsreportresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `accounting_aged_debtor_report` | [Optional[shared.AccountingAgedDebtorReport]](../../models/shared/accountingageddebtorreport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbalancesheetresponse.md b/lending/docs/models/operations/getaccountingbalancesheetresponse.md old mode 100755 new mode 100644 index 1e24b7455..06e8fedb2 --- a/lending/docs/models/operations/getaccountingbalancesheetresponse.md +++ b/lending/docs/models/operations/getaccountingbalancesheetresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_balance_sheet` | [Optional[shared.AccountingBalanceSheet]](../../models/shared/accountingbalancesheet.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbankaccountresponse.md b/lending/docs/models/operations/getaccountingbankaccountresponse.md old mode 100755 new mode 100644 index 6f5df92ca..4ab36f8ca --- a/lending/docs/models/operations/getaccountingbankaccountresponse.md +++ b/lending/docs/models/operations/getaccountingbankaccountresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_bank_account` | [Optional[shared.AccountingBankAccount]](../../models/shared/accountingbankaccount.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbillattachmentresponse.md b/lending/docs/models/operations/getaccountingbillattachmentresponse.md old mode 100755 new mode 100644 index 6f588ccc9..d2a76a6a6 --- a/lending/docs/models/operations/getaccountingbillattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingbillattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md b/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md old mode 100755 new mode 100644 index debad7e33..dc8a73cf5 --- a/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md +++ b/lending/docs/models/operations/getaccountingbillcreditnoteresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `accounting_bill_credit_note` | [Optional[shared.AccountingBillCreditNote]](../../models/shared/accountingbillcreditnote.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbillpaymentresponse.md b/lending/docs/models/operations/getaccountingbillpaymentresponse.md old mode 100755 new mode 100644 index 6de8c1725..e3913589f --- a/lending/docs/models/operations/getaccountingbillpaymentresponse.md +++ b/lending/docs/models/operations/getaccountingbillpaymentresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_bill_payment` | [Optional[shared.AccountingBillPayment]](../../models/shared/accountingbillpayment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingbillresponse.md b/lending/docs/models/operations/getaccountingbillresponse.md old mode 100755 new mode 100644 index 76e174b35..8cd37f400 --- a/lending/docs/models/operations/getaccountingbillresponse.md +++ b/lending/docs/models/operations/getaccountingbillresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_bill` | [Optional[shared.AccountingBill]](../../models/shared/accountingbill.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingcashflowstatementresponse.md b/lending/docs/models/operations/getaccountingcashflowstatementresponse.md old mode 100755 new mode 100644 index d1a32f3e5..242b1a20e --- a/lending/docs/models/operations/getaccountingcashflowstatementresponse.md +++ b/lending/docs/models/operations/getaccountingcashflowstatementresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `accounting_cash_flow_statement` | [Optional[shared.AccountingCashFlowStatement]](../../models/shared/accountingcashflowstatement.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingcreditnoteresponse.md b/lending/docs/models/operations/getaccountingcreditnoteresponse.md old mode 100755 new mode 100644 index cd045bac3..055b9556d --- a/lending/docs/models/operations/getaccountingcreditnoteresponse.md +++ b/lending/docs/models/operations/getaccountingcreditnoteresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_credit_note` | [Optional[shared.AccountingCreditNote]](../../models/shared/accountingcreditnote.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md b/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md old mode 100755 new mode 100644 index f4dbfbbc7..77409638f --- a/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingcustomerattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingcustomerresponse.md b/lending/docs/models/operations/getaccountingcustomerresponse.md old mode 100755 new mode 100644 index 418ea583a..0c8e95bb3 --- a/lending/docs/models/operations/getaccountingcustomerresponse.md +++ b/lending/docs/models/operations/getaccountingcustomerresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_customer` | [Optional[shared.AccountingCustomer]](../../models/shared/accountingcustomer.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md b/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md old mode 100755 new mode 100644 index 700b50e78..cdca82580 --- a/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingdirectcostattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingdirectcostresponse.md b/lending/docs/models/operations/getaccountingdirectcostresponse.md old mode 100755 new mode 100644 index 1852ebd86..7e9eb08d6 --- a/lending/docs/models/operations/getaccountingdirectcostresponse.md +++ b/lending/docs/models/operations/getaccountingdirectcostresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_direct_cost` | [Optional[shared.AccountingDirectCost]](../../models/shared/accountingdirectcost.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md b/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md old mode 100755 new mode 100644 index 9d782bdf4..fb2721f0a --- a/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingdirectincomeattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingdirectincomeresponse.md b/lending/docs/models/operations/getaccountingdirectincomeresponse.md old mode 100755 new mode 100644 index d2518111b..51b656161 --- a/lending/docs/models/operations/getaccountingdirectincomeresponse.md +++ b/lending/docs/models/operations/getaccountingdirectincomeresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_direct_income` | [Optional[shared.AccountingDirectIncome]](../../models/shared/accountingdirectincome.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md b/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md old mode 100755 new mode 100644 index b2954f405..f04371063 --- a/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md +++ b/lending/docs/models/operations/getaccountinginvoiceattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountinginvoiceresponse.md b/lending/docs/models/operations/getaccountinginvoiceresponse.md old mode 100755 new mode 100644 index 9fd142d0e..5c99bb362 --- a/lending/docs/models/operations/getaccountinginvoiceresponse.md +++ b/lending/docs/models/operations/getaccountinginvoiceresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_invoice` | [Optional[shared.AccountingInvoice]](../../models/shared/accountinginvoice.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingjournalentryresponse.md b/lending/docs/models/operations/getaccountingjournalentryresponse.md old mode 100755 new mode 100644 index 264b25924..63d1b47fe --- a/lending/docs/models/operations/getaccountingjournalentryresponse.md +++ b/lending/docs/models/operations/getaccountingjournalentryresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_journal_entry` | [Optional[shared.AccountingJournalEntry]](../../models/shared/accountingjournalentry.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingjournalresponse.md b/lending/docs/models/operations/getaccountingjournalresponse.md old mode 100755 new mode 100644 index 38bd57e12..4ae024bed --- a/lending/docs/models/operations/getaccountingjournalresponse.md +++ b/lending/docs/models/operations/getaccountingjournalresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_journal` | [Optional[shared.AccountingJournal]](../../models/shared/accountingjournal.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingpaymentresponse.md b/lending/docs/models/operations/getaccountingpaymentresponse.md old mode 100755 new mode 100644 index 5b970083c..96289bce9 --- a/lending/docs/models/operations/getaccountingpaymentresponse.md +++ b/lending/docs/models/operations/getaccountingpaymentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_payment` | [Optional[shared.AccountingPayment]](../../models/shared/accountingpayment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingprofileresponse.md b/lending/docs/models/operations/getaccountingprofileresponse.md old mode 100755 new mode 100644 index 9c66314d3..6b23e5992 --- a/lending/docs/models/operations/getaccountingprofileresponse.md +++ b/lending/docs/models/operations/getaccountingprofileresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_company_info` | [Optional[shared.AccountingCompanyInfo]](../../models/shared/accountingcompanyinfo.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingprofitandlossresponse.md b/lending/docs/models/operations/getaccountingprofitandlossresponse.md old mode 100755 new mode 100644 index a9085798d..47aaedaf4 --- a/lending/docs/models/operations/getaccountingprofitandlossresponse.md +++ b/lending/docs/models/operations/getaccountingprofitandlossresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `accounting_profit_and_loss_report` | [Optional[shared.AccountingProfitAndLossReport]](../../models/shared/accountingprofitandlossreport.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md b/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md old mode 100755 new mode 100644 index 57b3e78d9..4ebf09730 --- a/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md +++ b/lending/docs/models/operations/getaccountingsupplierattachmentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_attachment` | [Optional[shared.AccountingAttachment]](../../models/shared/accountingattachment.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingsupplierresponse.md b/lending/docs/models/operations/getaccountingsupplierresponse.md old mode 100755 new mode 100644 index 25222ce39..395342b65 --- a/lending/docs/models/operations/getaccountingsupplierresponse.md +++ b/lending/docs/models/operations/getaccountingsupplierresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_supplier` | [Optional[shared.AccountingSupplier]](../../models/shared/accountingsupplier.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getaccountingtransferresponse.md b/lending/docs/models/operations/getaccountingtransferresponse.md old mode 100755 new mode 100644 index 3edde3921..6f9c18a36 --- a/lending/docs/models/operations/getaccountingtransferresponse.md +++ b/lending/docs/models/operations/getaccountingtransferresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_transfer` | [Optional[shared.AccountingTransfer]](../../models/shared/accountingtransfer.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getbankingaccountresponse.md b/lending/docs/models/operations/getbankingaccountresponse.md old mode 100755 new mode 100644 index f4344d841..cf033f58a --- a/lending/docs/models/operations/getbankingaccountresponse.md +++ b/lending/docs/models/operations/getbankingaccountresponse.md @@ -8,4 +8,4 @@ | `banking_account` | [Optional[shared.BankingAccount]](../../models/shared/bankingaccount.md) | :heavy_minus_sign: | Success | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getbankingtransactioncategoryresponse.md b/lending/docs/models/operations/getbankingtransactioncategoryresponse.md old mode 100755 new mode 100644 index 2e12a27cb..cb0d5536a --- a/lending/docs/models/operations/getbankingtransactioncategoryresponse.md +++ b/lending/docs/models/operations/getbankingtransactioncategoryresponse.md @@ -8,4 +8,4 @@ | `banking_transaction_category` | [Optional[shared.BankingTransactionCategory]](../../models/shared/bankingtransactioncategory.md) | :heavy_minus_sign: | Success | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getbankingtransactionresponse.md b/lending/docs/models/operations/getbankingtransactionresponse.md old mode 100755 new mode 100644 index 11b63206f..bc353e9d3 --- a/lending/docs/models/operations/getbankingtransactionresponse.md +++ b/lending/docs/models/operations/getbankingtransactionresponse.md @@ -8,4 +8,4 @@ | `banking_transaction` | [Optional[shared.BankingTransaction]](../../models/shared/bankingtransaction.md) | :heavy_minus_sign: | Success | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md b/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md old mode 100755 new mode 100644 index 8a5ee2e75..efccc5639 --- a/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedbalancesheetstatementresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcategorizedbankstatementresponse.md b/lending/docs/models/operations/getcategorizedbankstatementresponse.md old mode 100755 new mode 100644 index 9e7f7a850..d32151d1b --- a/lending/docs/models/operations/getcategorizedbankstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedbankstatementresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md b/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md old mode 100755 new mode 100644 index 822bf822f..9f6b62196 --- a/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md +++ b/lending/docs/models/operations/getcategorizedprofitandlossstatementresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercecustomerresponse.md b/lending/docs/models/operations/getcommercecustomerresponse.md old mode 100755 new mode 100644 index 08c14c6e7..6e1ff93dd --- a/lending/docs/models/operations/getcommercecustomerresponse.md +++ b/lending/docs/models/operations/getcommercecustomerresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customer` | [Optional[shared.CommerceCustomer]](../../models/shared/commercecustomer.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md b/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md old mode 100755 new mode 100644 index da408428c..a1f129162 --- a/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md +++ b/lending/docs/models/operations/getcommercecustomerretentionmetricsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercedisputeresponse.md b/lending/docs/models/operations/getcommercedisputeresponse.md old mode 100755 new mode 100644 index 3526bfe2f..71245124b --- a/lending/docs/models/operations/getcommercedisputeresponse.md +++ b/lending/docs/models/operations/getcommercedisputeresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_dispute` | [Optional[shared.CommerceDispute]](../../models/shared/commercedispute.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md b/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md old mode 100755 new mode 100644 index ef6ebd238..90930c193 --- a/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md +++ b/lending/docs/models/operations/getcommercelifetimevaluemetricsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercelocationresponse.md b/lending/docs/models/operations/getcommercelocationresponse.md old mode 100755 new mode 100644 index b798ae049..75d4cad33 --- a/lending/docs/models/operations/getcommercelocationresponse.md +++ b/lending/docs/models/operations/getcommercelocationresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_location` | [Optional[shared.CommerceLocation]](../../models/shared/commercelocation.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommerceorderresponse.md b/lending/docs/models/operations/getcommerceorderresponse.md old mode 100755 new mode 100644 index 48fdadff9..4984ab997 --- a/lending/docs/models/operations/getcommerceorderresponse.md +++ b/lending/docs/models/operations/getcommerceorderresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_order` | [Optional[shared.CommerceOrder]](../../models/shared/commerceorder.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommerceordersreportresponse.md b/lending/docs/models/operations/getcommerceordersreportresponse.md old mode 100755 new mode 100644 index f7c628a69..96a07014e --- a/lending/docs/models/operations/getcommerceordersreportresponse.md +++ b/lending/docs/models/operations/getcommerceordersreportresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercepaymentmethodresponse.md b/lending/docs/models/operations/getcommercepaymentmethodresponse.md old mode 100755 new mode 100644 index 0917904b0..bb1056144 --- a/lending/docs/models/operations/getcommercepaymentmethodresponse.md +++ b/lending/docs/models/operations/getcommercepaymentmethodresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `commerce_payment_method` | [Optional[shared.CommercePaymentMethod]](../../models/shared/commercepaymentmethod.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercepaymentresponse.md b/lending/docs/models/operations/getcommercepaymentresponse.md old mode 100755 new mode 100644 index 53e4f188b..f074c4cf7 --- a/lending/docs/models/operations/getcommercepaymentresponse.md +++ b/lending/docs/models/operations/getcommercepaymentresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payment` | [Optional[shared.CommercePayment]](../../models/shared/commercepayment.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommerceproductcategoryresponse.md b/lending/docs/models/operations/getcommerceproductcategoryresponse.md old mode 100755 new mode 100644 index 40ffc3d5a..9bdc948e8 --- a/lending/docs/models/operations/getcommerceproductcategoryresponse.md +++ b/lending/docs/models/operations/getcommerceproductcategoryresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `commerce_product_category` | [Optional[shared.CommerceProductCategory]](../../models/shared/commerceproductcategory.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommerceproductresponse.md b/lending/docs/models/operations/getcommerceproductresponse.md old mode 100755 new mode 100644 index c45a8463b..bf0dc972e --- a/lending/docs/models/operations/getcommerceproductresponse.md +++ b/lending/docs/models/operations/getcommerceproductresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_product` | [Optional[shared.CommerceProduct]](../../models/shared/commerceproduct.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommerceprofileresponse.md b/lending/docs/models/operations/getcommerceprofileresponse.md old mode 100755 new mode 100644 index 460ba6730..19f41e3b2 --- a/lending/docs/models/operations/getcommerceprofileresponse.md +++ b/lending/docs/models/operations/getcommerceprofileresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_company_info` | [Optional[shared.CommerceCompanyInfo]](../../models/shared/commercecompanyinfo.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercerefundsreportresponse.md b/lending/docs/models/operations/getcommercerefundsreportresponse.md old mode 100755 new mode 100644 index 13ecda6aa..b847c422a --- a/lending/docs/models/operations/getcommercerefundsreportresponse.md +++ b/lending/docs/models/operations/getcommercerefundsreportresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercerevenuemetricsresponse.md b/lending/docs/models/operations/getcommercerevenuemetricsresponse.md old mode 100755 new mode 100644 index 2f0636fb4..1a20b8772 --- a/lending/docs/models/operations/getcommercerevenuemetricsresponse.md +++ b/lending/docs/models/operations/getcommercerevenuemetricsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_report` | [Optional[shared.CommerceReport]](../../models/shared/commercereport.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcommercetransactionresponse.md b/lending/docs/models/operations/getcommercetransactionresponse.md old mode 100755 new mode 100644 index a9ac47847..fb5c5a162 --- a/lending/docs/models/operations/getcommercetransactionresponse.md +++ b/lending/docs/models/operations/getcommercetransactionresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transaction` | [Optional[shared.CommerceTransaction]](../../models/shared/commercetransaction.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcompanyresponse.md b/lending/docs/models/operations/getcompanyresponse.md old mode 100755 new mode 100644 index 2f82e6ca0..98fd19b23 --- a/lending/docs/models/operations/getcompanyresponse.md +++ b/lending/docs/models/operations/getcompanyresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getconnectionresponse.md b/lending/docs/models/operations/getconnectionresponse.md old mode 100755 new mode 100644 index c308aece1..4dd62a7a6 --- a/lending/docs/models/operations/getconnectionresponse.md +++ b/lending/docs/models/operations/getconnectionresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md b/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md old mode 100755 new mode 100644 index fcf97c882..38f89e28d --- a/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md +++ b/lending/docs/models/operations/getcreatebanktransactionsmodelresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md b/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md old mode 100755 new mode 100644 index fa5a05fa4..9ba81a42b --- a/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md +++ b/lending/docs/models/operations/getcreatechartofaccountsmodelresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md b/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md old mode 100755 new mode 100644 index a429645ff..3a160f9d3 --- a/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md +++ b/lending/docs/models/operations/getcreatedirectcostsmodelresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreateoperationresponse.md b/lending/docs/models/operations/getcreateoperationresponse.md old mode 100755 new mode 100644 index 9bcc91f06..cf2290abc --- a/lending/docs/models/operations/getcreateoperationresponse.md +++ b/lending/docs/models/operations/getcreateoperationresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_operation` | [Optional[shared.PushOperation]](../../models/shared/pushoperation.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreatepaymentsmodelrequest.md b/lending/docs/models/operations/getcreatepaymentmodelrequest.md old mode 100755 new mode 100644 similarity index 96% rename from lending/docs/models/operations/getcreatepaymentsmodelrequest.md rename to lending/docs/models/operations/getcreatepaymentmodelrequest.md index 8faf65f28..9ac7fb857 --- a/lending/docs/models/operations/getcreatepaymentsmodelrequest.md +++ b/lending/docs/models/operations/getcreatepaymentmodelrequest.md @@ -1,4 +1,4 @@ -# GetCreatePaymentsModelRequest +# GetCreatePaymentModelRequest ## Fields diff --git a/lending/docs/models/operations/getcreatepaymentsmodelresponse.md b/lending/docs/models/operations/getcreatepaymentmodelresponse.md old mode 100755 new mode 100644 similarity index 79% rename from lending/docs/models/operations/getcreatepaymentsmodelresponse.md rename to lending/docs/models/operations/getcreatepaymentmodelresponse.md index 9556e6f57..bd1749cda --- a/lending/docs/models/operations/getcreatepaymentsmodelresponse.md +++ b/lending/docs/models/operations/getcreatepaymentmodelresponse.md @@ -1,4 +1,4 @@ -# GetCreatePaymentsModelResponse +# GetCreatePaymentModelResponse ## Fields @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreatetransfersmodelresponse.md b/lending/docs/models/operations/getcreatetransfersmodelresponse.md old mode 100755 new mode 100644 index a397fd038..d34bf41a7 --- a/lending/docs/models/operations/getcreatetransfersmodelresponse.md +++ b/lending/docs/models/operations/getcreatetransfersmodelresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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/getcreateupdatebankaccountsmodelrequest.md new file mode 100644 index 000000000..0e8ab966f --- /dev/null +++ b/lending/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md @@ -0,0 +1,9 @@ +# GetCreateUpdateBankAccountsModelRequest + + +## Fields + +| 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 | \ No newline at end of file diff --git a/lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md b/lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md new file mode 100644 index 000000000..e16f15d3f --- /dev/null +++ b/lending/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md @@ -0,0 +1,11 @@ +# GetCreateUpdateBankAccountsModelResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | +| `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_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md b/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md old mode 100755 new mode 100644 index 42a840c64..aa1ade440 --- a/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md +++ b/lending/docs/models/operations/getcreateupdatesuppliersmodelresponse.md @@ -6,7 +6,6 @@ | 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. | | `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getdataintegritystatusresponse.md b/lending/docs/models/operations/getdataintegritystatusresponse.md old mode 100755 new mode 100644 index 511b309c6..62a73ed81 --- a/lending/docs/models/operations/getdataintegritystatusresponse.md +++ b/lending/docs/models/operations/getdataintegritystatusresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getdataintegritysummariesresponse.md b/lending/docs/models/operations/getdataintegritysummariesresponse.md old mode 100755 new mode 100644 index e46ca3ff2..6b482e773 --- a/lending/docs/models/operations/getdataintegritysummariesresponse.md +++ b/lending/docs/models/operations/getdataintegritysummariesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getdatastatusresponse.md b/lending/docs/models/operations/getdatastatusresponse.md old mode 100755 new mode 100644 index 18bcc12b7..ecc77b87b --- a/lending/docs/models/operations/getdatastatusresponse.md +++ b/lending/docs/models/operations/getdatastatusresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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. | +| `data_statuses` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md b/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md old mode 100755 new mode 100644 index ba144607b..de9e6035a --- a/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md +++ b/lending/docs/models/operations/getexcelreportgenerationstatusresponse.md @@ -6,7 +6,6 @@ | 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. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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/getloansummaryqueryparamsourcetype.md old mode 100755 new mode 100644 similarity index 83% rename from lending/docs/models/operations/generateloantransactionssourcetype.md rename to lending/docs/models/operations/getloansummaryqueryparamsourcetype.md index 95870b04d..812ff102e --- a/lending/docs/models/operations/generateloantransactionssourcetype.md +++ b/lending/docs/models/operations/getloansummaryqueryparamsourcetype.md @@ -1,4 +1,4 @@ -# GenerateLoanTransactionsSourceType +# GetLoanSummaryQueryParamSourceType Data source type. diff --git a/lending/docs/models/operations/getloansummaryrequest.md b/lending/docs/models/operations/getloansummaryrequest.md old mode 100755 new mode 100644 index 655f0cca8..b2624e65c --- a/lending/docs/models/operations/getloansummaryrequest.md +++ b/lending/docs/models/operations/getloansummaryrequest.md @@ -3,7 +3,7 @@ ## Fields -| 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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.GetLoanSummaryQueryParamSourceType](../../models/operations/getloansummaryqueryparamsourcetype.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 old mode 100755 new mode 100644 index b007d1c19..73ef54be6 --- a/lending/docs/models/operations/getloansummaryresponse.md +++ b/lending/docs/models/operations/getloansummaryresponse.md @@ -6,7 +6,6 @@ | 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. | | `loan_summary` | [Optional[shared.LoanSummary]](../../models/shared/loansummary.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/getpulloperationrequest.md b/lending/docs/models/operations/getpulloperationrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/getpulloperationresponse.md b/lending/docs/models/operations/getpulloperationresponse.md old mode 100755 new mode 100644 index 41674afa9..6ed2cf572 --- a/lending/docs/models/operations/getpulloperationresponse.md +++ b/lending/docs/models/operations/getpulloperationresponse.md @@ -6,7 +6,6 @@ | 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. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md b/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md old mode 100755 new mode 100644 index 66957e137..62747642d --- a/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md +++ b/lending/docs/models/operations/isagedcreditorsreportavailableresponse.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/isageddebtorsreportavailableresponse.md b/lending/docs/models/operations/isageddebtorsreportavailableresponse.md old mode 100755 new mode 100644 index 41db2ecf6..cd377dcb4 --- a/lending/docs/models/operations/isageddebtorsreportavailableresponse.md +++ b/lending/docs/models/operations/isageddebtorsreportavailableresponse.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingaccountsresponse.md b/lending/docs/models/operations/listaccountingaccountsresponse.md old mode 100755 new mode 100644 index 191e47635..ef6ea086f --- a/lending/docs/models/operations/listaccountingaccountsresponse.md +++ b/lending/docs/models/operations/listaccountingaccountsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_accounts` | [Optional[shared.AccountingAccounts]](../../models/shared/accountingaccounts.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md b/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md old mode 100755 new mode 100644 index d7456a285..5f6f2ac79 --- a/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md +++ b/lending/docs/models/operations/listaccountingaccounttransactionsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `accounting_account_transactions` | [Optional[shared.AccountingAccountTransactions]](../../models/shared/accountingaccounttransactions.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbankaccountsresponse.md b/lending/docs/models/operations/listaccountingbankaccountsresponse.md old mode 100755 new mode 100644 index d895a812f..a992cd19a --- a/lending/docs/models/operations/listaccountingbankaccountsresponse.md +++ b/lending/docs/models/operations/listaccountingbankaccountsresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_bank_accounts` | [Optional[shared.AccountingBankAccounts]](../../models/shared/accountingbankaccounts.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md b/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md old mode 100755 new mode 100644 index d2e5668ed..6c0aef69d --- a/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md +++ b/lending/docs/models/operations/listaccountingbankaccounttransactionsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `accounting_bank_transactions` | [Optional[shared.AccountingBankTransactions]](../../models/shared/accountingbanktransactions.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbillattachmentsresponse.md b/lending/docs/models/operations/listaccountingbillattachmentsresponse.md old mode 100755 new mode 100644 index 9f4183fbb..1a78ee1b4 --- a/lending/docs/models/operations/listaccountingbillattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingbillattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md b/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md old mode 100755 new mode 100644 index 8381de169..5a7f1e1d9 --- a/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md +++ b/lending/docs/models/operations/listaccountingbillcreditnotesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `accounting_bill_credit_notes` | [Optional[shared.AccountingBillCreditNotes]](../../models/shared/accountingbillcreditnotes.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbillpaymentsresponse.md b/lending/docs/models/operations/listaccountingbillpaymentsresponse.md old mode 100755 new mode 100644 index bf93b9f5a..c55fc930c --- a/lending/docs/models/operations/listaccountingbillpaymentsresponse.md +++ b/lending/docs/models/operations/listaccountingbillpaymentsresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `accounting_bill_payments` | [Optional[shared.AccountingBillPayments]](../../models/shared/accountingbillpayments.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingbillsresponse.md b/lending/docs/models/operations/listaccountingbillsresponse.md old mode 100755 new mode 100644 index 90c5c8257..c9e7e70a1 --- a/lending/docs/models/operations/listaccountingbillsresponse.md +++ b/lending/docs/models/operations/listaccountingbillsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_bills` | [Optional[shared.AccountingBills]](../../models/shared/accountingbills.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingcreditnotesresponse.md b/lending/docs/models/operations/listaccountingcreditnotesresponse.md old mode 100755 new mode 100644 index a056a8d4e..262728c01 --- a/lending/docs/models/operations/listaccountingcreditnotesresponse.md +++ b/lending/docs/models/operations/listaccountingcreditnotesresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_credit_notes` | [Optional[shared.AccountingCreditNotes]](../../models/shared/accountingcreditnotes.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md b/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md old mode 100755 new mode 100644 index 7fa1dbc7d..4a74d482c --- a/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingcustomerattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingcustomersresponse.md b/lending/docs/models/operations/listaccountingcustomersresponse.md old mode 100755 new mode 100644 index cfe47f7c2..975d41562 --- a/lending/docs/models/operations/listaccountingcustomersresponse.md +++ b/lending/docs/models/operations/listaccountingcustomersresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_customers` | [Optional[shared.AccountingCustomers]](../../models/shared/accountingcustomers.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md b/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md old mode 100755 new mode 100644 index b75e29f96..914897a20 --- a/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectcostattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingdirectcostsresponse.md b/lending/docs/models/operations/listaccountingdirectcostsresponse.md old mode 100755 new mode 100644 index b7c72f2f2..431311794 --- a/lending/docs/models/operations/listaccountingdirectcostsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectcostsresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `accounting_direct_costs` | [Optional[shared.AccountingDirectCosts]](../../models/shared/accountingdirectcosts.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md b/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md old mode 100755 new mode 100644 index 82ad154b6..75aec5e14 --- a/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingdirectincomeattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingdirectincomesresponse.md b/lending/docs/models/operations/listaccountingdirectincomesresponse.md old mode 100755 new mode 100644 index 98f03e415..b7f9b5da5 --- a/lending/docs/models/operations/listaccountingdirectincomesresponse.md +++ b/lending/docs/models/operations/listaccountingdirectincomesresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `accounting_direct_incomes` | [Optional[shared.AccountingDirectIncomes]](../../models/shared/accountingdirectincomes.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md b/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md old mode 100755 new mode 100644 index 1cfa9fd17..f33be14df --- a/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountinginvoiceattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountinginvoicesresponse.md b/lending/docs/models/operations/listaccountinginvoicesresponse.md old mode 100755 new mode 100644 index 1a19285df..7bb769a10 --- a/lending/docs/models/operations/listaccountinginvoicesresponse.md +++ b/lending/docs/models/operations/listaccountinginvoicesresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_invoices` | [Optional[shared.AccountingInvoices]](../../models/shared/accountinginvoices.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingjournalentriesresponse.md b/lending/docs/models/operations/listaccountingjournalentriesresponse.md old mode 100755 new mode 100644 index d689481b1..569014d77 --- a/lending/docs/models/operations/listaccountingjournalentriesresponse.md +++ b/lending/docs/models/operations/listaccountingjournalentriesresponse.md @@ -7,6 +7,5 @@ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `accounting_journal_entries` | [Optional[shared.AccountingJournalEntries]](../../models/shared/accountingjournalentries.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingjournalsresponse.md b/lending/docs/models/operations/listaccountingjournalsresponse.md old mode 100755 new mode 100644 index 65759133b..8dd02ce4c --- a/lending/docs/models/operations/listaccountingjournalsresponse.md +++ b/lending/docs/models/operations/listaccountingjournalsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_journals` | [Optional[shared.AccountingJournals]](../../models/shared/accountingjournals.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingpaymentsresponse.md b/lending/docs/models/operations/listaccountingpaymentsresponse.md old mode 100755 new mode 100644 index 22d40ae77..86d1e31f8 --- a/lending/docs/models/operations/listaccountingpaymentsresponse.md +++ b/lending/docs/models/operations/listaccountingpaymentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_payments` | [Optional[shared.AccountingPayments]](../../models/shared/accountingpayments.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md b/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md old mode 100755 new mode 100644 index af3d1ab79..454aff77a --- a/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md +++ b/lending/docs/models/operations/listaccountingsupplierattachmentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `attachments` | [Optional[shared.Attachments]](../../models/shared/attachments.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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingsuppliersresponse.md b/lending/docs/models/operations/listaccountingsuppliersresponse.md old mode 100755 new mode 100644 index 183e5d5e0..1fb2c96ac --- a/lending/docs/models/operations/listaccountingsuppliersresponse.md +++ b/lending/docs/models/operations/listaccountingsuppliersresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_suppliers` | [Optional[shared.AccountingSuppliers]](../../models/shared/accountingsuppliers.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listaccountingtransfersresponse.md b/lending/docs/models/operations/listaccountingtransfersresponse.md old mode 100755 new mode 100644 index 73ca94e77..ba6faafb1 --- a/lending/docs/models/operations/listaccountingtransfersresponse.md +++ b/lending/docs/models/operations/listaccountingtransfersresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `accounting_transfers` | [Optional[shared.AccountingTransfers]](../../models/shared/accountingtransfers.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listbankingaccountbalancesresponse.md b/lending/docs/models/operations/listbankingaccountbalancesresponse.md old mode 100755 new mode 100644 index 4f4f23e77..d7e3ef307 --- a/lending/docs/models/operations/listbankingaccountbalancesresponse.md +++ b/lending/docs/models/operations/listbankingaccountbalancesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `banking_account_balances` | [Optional[shared.BankingAccountBalances]](../../models/shared/bankingaccountbalances.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listbankingaccountsresponse.md b/lending/docs/models/operations/listbankingaccountsresponse.md old mode 100755 new mode 100644 index 93294bcb9..fb4d0ff48 --- a/lending/docs/models/operations/listbankingaccountsresponse.md +++ b/lending/docs/models/operations/listbankingaccountsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_accounts` | [Optional[shared.BankingAccounts]](../../models/shared/bankingaccounts.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md b/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md old mode 100755 new mode 100644 index 77ebb0a54..951141390 --- a/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md +++ b/lending/docs/models/operations/listbankingtransactioncategoriesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `banking_transaction_categories` | [Optional[shared.BankingTransactionCategories]](../../models/shared/bankingtransactioncategories.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listbankingtransactionsresponse.md b/lending/docs/models/operations/listbankingtransactionsresponse.md old mode 100755 new mode 100644 index 2eefc367e..a8ff29e72 --- a/lending/docs/models/operations/listbankingtransactionsresponse.md +++ b/lending/docs/models/operations/listbankingtransactionsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `banking_transactions` | [Optional[shared.BankingTransactions]](../../models/shared/bankingtransactions.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: | Your `query` parameter was not correctly formed | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercecustomersresponse.md b/lending/docs/models/operations/listcommercecustomersresponse.md old mode 100755 new mode 100644 index 8b8a57ef6..7bca90ffb --- a/lending/docs/models/operations/listcommercecustomersresponse.md +++ b/lending/docs/models/operations/listcommercecustomersresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_customers` | [Optional[shared.CommerceCustomers]](../../models/shared/commercecustomers.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercedisputesresponse.md b/lending/docs/models/operations/listcommercedisputesresponse.md old mode 100755 new mode 100644 index ad2949ad6..ed2317f82 --- a/lending/docs/models/operations/listcommercedisputesresponse.md +++ b/lending/docs/models/operations/listcommercedisputesresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_disputes` | [Optional[shared.CommerceDisputes]](../../models/shared/commercedisputes.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercelocationsresponse.md b/lending/docs/models/operations/listcommercelocationsresponse.md old mode 100755 new mode 100644 index c56356007..6078a5f26 --- a/lending/docs/models/operations/listcommercelocationsresponse.md +++ b/lending/docs/models/operations/listcommercelocationsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_locations` | [Optional[shared.CommerceLocations]](../../models/shared/commercelocations.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommerceordersresponse.md b/lending/docs/models/operations/listcommerceordersresponse.md old mode 100755 new mode 100644 index de4b9eccb..447087ea2 --- a/lending/docs/models/operations/listcommerceordersresponse.md +++ b/lending/docs/models/operations/listcommerceordersresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_orders` | [Optional[shared.CommerceOrders]](../../models/shared/commerceorders.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercepaymentmethodsresponse.md b/lending/docs/models/operations/listcommercepaymentmethodsresponse.md old mode 100755 new mode 100644 index 1dfcf08cb..2f123cf79 --- a/lending/docs/models/operations/listcommercepaymentmethodsresponse.md +++ b/lending/docs/models/operations/listcommercepaymentmethodsresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `commerce_payment_methods` | [Optional[shared.CommercePaymentMethods]](../../models/shared/commercepaymentmethods.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercepaymentsresponse.md b/lending/docs/models/operations/listcommercepaymentsresponse.md old mode 100755 new mode 100644 index 6534b615e..29a9a249b --- a/lending/docs/models/operations/listcommercepaymentsresponse.md +++ b/lending/docs/models/operations/listcommercepaymentsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_payments` | [Optional[shared.CommercePayments]](../../models/shared/commercepayments.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommerceproductcategoriesresponse.md b/lending/docs/models/operations/listcommerceproductcategoriesresponse.md old mode 100755 new mode 100644 index 7f59194be..93f60720a --- a/lending/docs/models/operations/listcommerceproductcategoriesresponse.md +++ b/lending/docs/models/operations/listcommerceproductcategoriesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `commerce_product_categories` | [Optional[shared.CommerceProductCategories]](../../models/shared/commerceproductcategories.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommerceproductsresponse.md b/lending/docs/models/operations/listcommerceproductsresponse.md old mode 100755 new mode 100644 index c8b2b1c0d..6a3502c70 --- a/lending/docs/models/operations/listcommerceproductsresponse.md +++ b/lending/docs/models/operations/listcommerceproductsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_products` | [Optional[shared.CommerceProducts]](../../models/shared/commerceproducts.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcommercetransactionsresponse.md b/lending/docs/models/operations/listcommercetransactionsresponse.md old mode 100755 new mode 100644 index b5f60c346..6169ec184 --- a/lending/docs/models/operations/listcommercetransactionsresponse.md +++ b/lending/docs/models/operations/listcommercetransactionsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `commerce_transactions` | [Optional[shared.CommerceTransactions]](../../models/shared/commercetransactions.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listcompaniesrequest.md b/lending/docs/models/operations/listcompaniesrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcompaniesresponse.md b/lending/docs/models/operations/listcompaniesresponse.md old mode 100755 new mode 100644 index d9c512cea..42b07950c --- a/lending/docs/models/operations/listcompaniesresponse.md +++ b/lending/docs/models/operations/listcompaniesresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listconnectionsresponse.md b/lending/docs/models/operations/listconnectionsresponse.md old mode 100755 new mode 100644 index 0de0ad796..dacec2f64 --- a/lending/docs/models/operations/listconnectionsresponse.md +++ b/lending/docs/models/operations/listconnectionsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | OK | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listcreateoperationsresponse.md b/lending/docs/models/operations/listcreateoperationsresponse.md old mode 100755 new mode 100644 index 0540ee668..897287138 --- a/lending/docs/models/operations/listcreateoperationsresponse.md +++ b/lending/docs/models/operations/listcreateoperationsresponse.md @@ -6,7 +6,6 @@ | 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 `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listdataintegritydetailsresponse.md b/lending/docs/models/operations/listdataintegritydetailsresponse.md old mode 100755 new mode 100644 index e6681428c..50bdbebad --- a/lending/docs/models/operations/listdataintegritydetailsresponse.md +++ b/lending/docs/models/operations/listdataintegritydetailsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listfilesresponse.md b/lending/docs/models/operations/listfilesresponse.md old mode 100755 new mode 100644 index ecb2a827e..f784c469d --- a/lending/docs/models/operations/listfilesresponse.md +++ b/lending/docs/models/operations/listfilesresponse.md @@ -6,7 +6,6 @@ | 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. | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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/listloantransactionsqueryparamsourcetype.md old mode 100755 new mode 100644 similarity index 81% rename from lending/docs/models/operations/listloantransactionssourcetype.md rename to lending/docs/models/operations/listloantransactionsqueryparamsourcetype.md index 0019f1c99..531b2e7f3 --- a/lending/docs/models/operations/listloantransactionssourcetype.md +++ b/lending/docs/models/operations/listloantransactionsqueryparamsourcetype.md @@ -1,4 +1,4 @@ -# ListLoanTransactionsSourceType +# ListLoanTransactionsQueryParamSourceType Data source type. diff --git a/lending/docs/models/operations/listloantransactionsrequest.md b/lending/docs/models/operations/listloantransactionsrequest.md old mode 100755 new mode 100644 index dc1c0a28e..971531a9a --- a/lending/docs/models/operations/listloantransactionsrequest.md +++ b/lending/docs/models/operations/listloantransactionsrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.ListLoanTransactionsQueryParamSourceType](../../models/operations/listloantransactionsqueryparamsourcetype.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 old mode 100755 new mode 100644 index bf5515d58..9038ca435 --- a/lending/docs/models/operations/listloantransactionsresponse.md +++ b/lending/docs/models/operations/listloantransactionsresponse.md @@ -6,7 +6,6 @@ | 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. | | `loan_transactions` | [Optional[shared.LoanTransactions]](../../models/shared/loantransactions.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/listpulloperationsrequest.md b/lending/docs/models/operations/listpulloperationsrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listpulloperationsresponse.md b/lending/docs/models/operations/listpulloperationsresponse.md old mode 100755 new mode 100644 index feff59654..b58dc8961 --- a/lending/docs/models/operations/listpulloperationsresponse.md +++ b/lending/docs/models/operations/listpulloperationsresponse.md @@ -6,7 +6,6 @@ | 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 `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/listreconciledinvoicesresponse.md b/lending/docs/models/operations/listreconciledinvoicesresponse.md old mode 100755 new mode 100644 index 86abcc6a4..1cdb1d92c --- a/lending/docs/models/operations/listreconciledinvoicesresponse.md +++ b/lending/docs/models/operations/listreconciledinvoicesresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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/queryparamsourcetype.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/models/operations/getloansummarysourcetype.md rename to lending/docs/models/operations/queryparamsourcetype.md index f6681e59c..a61218362 --- a/lending/docs/models/operations/getloansummarysourcetype.md +++ b/lending/docs/models/operations/queryparamsourcetype.md @@ -1,4 +1,4 @@ -# GetLoanSummarySourceType +# QueryParamSourceType Data source type. diff --git a/lending/docs/models/operations/refreshalldatatypesrequest.md b/lending/docs/models/operations/refreshalldatatypesrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/refreshalldatatypesresponse.md b/lending/docs/models/operations/refreshalldatatypesresponse.md old mode 100755 new mode 100644 index 0788fc5da..4f79210f0 --- a/lending/docs/models/operations/refreshalldatatypesresponse.md +++ b/lending/docs/models/operations/refreshalldatatypesresponse.md @@ -6,6 +6,5 @@ | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index 257381833..1047c2228 --- a/lending/docs/models/operations/refreshdatatyperequest.md +++ b/lending/docs/models/operations/refreshdatatyperequest.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `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 +| `data_type` | [shared.SchemaDataType](../../models/shared/schemadatatype.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 old mode 100755 new mode 100644 index 5a4e614bb..7be7f61b1 --- a/lending/docs/models/operations/refreshdatatyperesponse.md +++ b/lending/docs/models/operations/refreshdatatyperesponse.md @@ -6,7 +6,6 @@ | 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. | | `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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/sourcetype.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/models/operations/generateloansummarysourcetype.md rename to lending/docs/models/operations/sourcetype.md index 1fb8dfad0..4e702956a --- a/lending/docs/models/operations/generateloansummarysourcetype.md +++ b/lending/docs/models/operations/sourcetype.md @@ -1,4 +1,4 @@ -# GenerateLoanSummarySourceType +# SourceType Data source type. diff --git a/lending/docs/models/operations/unlinkconnectionrequest.md b/lending/docs/models/operations/unlinkconnectionrequest.md old mode 100755 new mode 100644 index 1f83e7cfa..37c72c7bc --- a/lending/docs/models/operations/unlinkconnectionrequest.md +++ b/lending/docs/models/operations/unlinkconnectionrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[UnlinkConnectionUpdateConnection]](../../models/operations/unlinkconnectionupdateconnection.md) | :heavy_minus_sign: | N/A | | -| `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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `request_body` | [Optional[operations.UnlinkConnectionUpdateConnection]](../../models/operations/unlinkconnectionupdateconnection.md) | :heavy_minus_sign: | N/A | | +| `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 old mode 100755 new mode 100644 index 642e8e815..d1754acb5 --- a/lending/docs/models/operations/unlinkconnectionresponse.md +++ b/lending/docs/models/operations/unlinkconnectionresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/operations/unlinkconnectionupdateconnection.md b/lending/docs/models/operations/unlinkconnectionupdateconnection.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/updatecompanyrequest.md b/lending/docs/models/operations/updatecompanyrequest.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/operations/updatecompanyresponse.md b/lending/docs/models/operations/updatecompanyresponse.md old mode 100755 new mode 100644 index b60ed7a56..d299179e8 --- a/lending/docs/models/operations/updatecompanyresponse.md +++ b/lending/docs/models/operations/updatecompanyresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index 3894d4295..2749893c3 --- a/lending/docs/models/operations/uploadfilesrequest.md +++ b/lending/docs/models/operations/uploadfilesrequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `request_body` | [Optional[UploadFilesRequestBody]](../../models/operations/uploadfilesrequestbody.md) | :heavy_minus_sign: | N/A | | -| `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 +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `request_body` | [Optional[operations.UploadFilesRequestBody]](../../models/operations/uploadfilesrequestbody.md) | :heavy_minus_sign: | N/A | | +| `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/uploadfilesrequestbody.md b/lending/docs/models/operations/uploadfilesrequestbody.md old mode 100755 new mode 100644 index fad398470..d23e6a3e5 --- a/lending/docs/models/operations/uploadfilesrequestbody.md +++ b/lending/docs/models/operations/uploadfilesrequestbody.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | | `content` | *bytes* | :heavy_check_mark: | N/A | -| `request_body` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `file_name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/lending/docs/models/operations/uploadfilesresponse.md b/lending/docs/models/operations/uploadfilesresponse.md old mode 100755 new mode 100644 index e0507d288..949de15db --- a/lending/docs/models/operations/uploadfilesresponse.md +++ b/lending/docs/models/operations/uploadfilesresponse.md @@ -6,6 +6,5 @@ | 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: | 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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/models/shared/accountbalance.md b/lending/docs/models/shared/accountbalance.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountbalanceamounts.md b/lending/docs/models/shared/accountbalanceamounts.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountcategoriesupdatedwebhook.md b/lending/docs/models/shared/accountcategoriesupdatedwebhook.md old mode 100755 new mode 100644 index bbc4a17d3..b08fb3db5 --- a/lending/docs/models/shared/accountcategoriesupdatedwebhook.md +++ b/lending/docs/models/shared/accountcategoriesupdatedwebhook.md @@ -5,14 +5,14 @@ Webhook request body for account categories updated. ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[AccountCategoriesUpdatedWebhookData]](../../models/shared/accountcategoriesupdatedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[shared.AccountCategoriesUpdatedWebhookData]](../../models/shared/accountcategoriesupdatedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountcategoriesupdatedwebhookdata.md b/lending/docs/models/shared/accountcategoriesupdatedwebhookdata.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountcategorylevel.md b/lending/docs/models/shared/accountcategorylevel.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountidentifiers.md b/lending/docs/models/shared/accountidentifiers.md old mode 100755 new mode 100644 index b2e36cdac..e6ef32705 --- a/lending/docs/models/shared/accountidentifiers.md +++ b/lending/docs/models/shared/accountidentifiers.md @@ -13,4 +13,4 @@ An object containing bank account identification information. | `masked_account_number` | *Optional[str]* | :heavy_minus_sign: | A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) | | `number` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Detailed account category | -| `type` | [AccountIdentifierType](../../models/shared/accountidentifiertype.md) | :heavy_check_mark: | Type of account | \ No newline at end of file +| `type` | [shared.AccountIdentifierType](../../models/shared/accountidentifiertype.md) | :heavy_check_mark: | Type of account | \ No newline at end of file diff --git a/lending/docs/models/shared/accountidentifiertype.md b/lending/docs/models/shared/accountidentifiertype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingaccount.md b/lending/docs/models/shared/accountingaccount.md old mode 100755 new mode 100644 index d2c342843..2698dd4fb --- a/lending/docs/models/shared/accountingaccount.md +++ b/lending/docs/models/shared/accountingaccount.md @@ -1,32 +1,32 @@ # AccountingAccount -> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. +> **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. +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. +* 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. +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. +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: +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. +- 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. @@ -41,12 +41,12 @@ To determine the list of allowed categories for a specific integration, you can: | `fully_qualified_name` | *Optional[str]* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | | `is_bank_account` | *Optional[bool]* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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 | | `name` | *Optional[str]* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | | `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](/lending-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `status` | [Optional[shared.AccountStatus]](../../models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplemental_data` | [Optional[shared.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[shared.AccountType]](../../models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset | +| `valid_datatype_links` | List[[shared.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 old mode 100755 new mode 100644 index e47ee4ee7..a34b69d28 --- a/lending/docs/models/shared/accountingaccounts.md +++ b/lending/docs/models/shared/accountingaccounts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 9fe78c8d4..ce37a7f50 --- a/lending/docs/models/shared/accountingaccounttransaction.md +++ b/lending/docs/models/shared/accountingaccounttransaction.md @@ -23,16 +23,16 @@ Account transactions is the parent data type of [payments](https://docs.codat.io | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bank_account_ref` | [Optional[BankAccountRef]](../../models/shared/bankaccountref.md) | :heavy_minus_sign: | Links to the Account transactions data type. | | +| `bank_account_ref` | [Optional[shared.BankAccountRef]](../../models/shared/bankaccountref.md) | :heavy_minus_sign: | Links to the Account transactions data type. | | | `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: | Identifier of the direct cost (unique to the company). | | -| `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 | | +| `lines` | List[[shared.AccountTransactionLine](../../models/shared/accounttransactionline.md)] | :heavy_minus_sign: | Array of account transaction lines. | | +| `metadata` | [Optional[shared.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. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[AccountingAccountTransactionStatus]](../../models/shared/accountingaccounttransactionstatus.md) | :heavy_minus_sign: | The status of the account transaction. | | +| `status` | [Optional[shared.Status]](../../models/shared/status.md) | :heavy_minus_sign: | The status of the account transaction. | | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Total amount of the account transactions, inclusive of tax. | | | `transaction_id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the transaction (unique to the company). | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaccounttransactions.md b/lending/docs/models/shared/accountingaccounttransactions.md old mode 100755 new mode 100644 index 223abf4e5..b6a62bc62 --- a/lending/docs/models/shared/accountingaccounttransactions.md +++ b/lending/docs/models/shared/accountingaccounttransactions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingaddress.md b/lending/docs/models/shared/accountingaddress.md old mode 100755 new mode 100644 index 40f5f35f1..d1f4f82ec --- a/lending/docs/models/shared/accountingaddress.md +++ b/lending/docs/models/shared/accountingaddress.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | -| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [AccountingAddressType](../../models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `city` | *Optional[str]* | :heavy_minus_sign: | City of the customer address. | +| `country` | *Optional[str]* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *Optional[str]* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *Optional[str]* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postal_code` | *Optional[str]* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *Optional[str]* | :heavy_minus_sign: | Region of the customer address. | +| `type` | [shared.AccountingAddressType](../../models/shared/accountingaddresstype.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingaddresstype.md b/lending/docs/models/shared/accountingaddresstype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingagedcreditorreport.md b/lending/docs/models/shared/accountingagedcreditorreport.md old mode 100755 new mode 100644 index 02b22e850..99ef76c7f --- a/lending/docs/models/shared/accountingagedcreditorreport.md +++ b/lending/docs/models/shared/accountingagedcreditorreport.md @@ -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[[shared.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 old mode 100755 new mode 100644 index bab1b7c80..a99cbdb85 --- a/lending/docs/models/shared/accountingageddebtorreport.md +++ b/lending/docs/models/shared/accountingageddebtorreport.md @@ -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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingbalancesheet.md b/lending/docs/models/shared/accountingbalancesheet.md old mode 100755 new mode 100644 index 31330441c..8d1fccf0f --- 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[[shared.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 old mode 100755 new mode 100644 index f93c348fc..7648e836f --- a/lending/docs/models/shared/accountingbankaccount.md +++ b/lending/docs/models/shared/accountingbankaccount.md @@ -24,17 +24,17 @@ Bank accounts data includes: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_name` | *Optional[str]* | :heavy_minus_sign: | Name of the bank account in the accounting platform. | | | `account_number` | *Optional[str]* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `account_type` | [Optional[AccountingBankAccountType]](../../models/shared/accountingbankaccounttype.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `account_type` | [Optional[shared.AccountingBankAccountType]](../../models/shared/accountingbankaccounttype.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
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]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Balance of the bank account. | | | `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 | | `i_ban` | *Optional[str]* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting platform. | | | `institution` | *Optional[str]* | :heavy_minus_sign: | The institution of the bank account. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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 | | `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 | -| `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 +| `supplemental_data` | [Optional[shared.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 old mode 100755 new mode 100644 index 20e31a072..5fd1fef0d --- a/lending/docs/models/shared/accountingbankaccounts.md +++ b/lending/docs/models/shared/accountingbankaccounts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/accountingbankaccounttype.md b/lending/docs/models/shared/accountingbankaccounttype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingbanktransaction.md b/lending/docs/models/shared/accountingbanktransaction.md old mode 100755 new mode 100644 index 991d1fce5..eaa4aebe9 --- a/lending/docs/models/shared/accountingbanktransaction.md +++ b/lending/docs/models/shared/accountingbanktransaction.md @@ -31,4 +31,4 @@ Bank transactions include the: | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `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[shared.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 old mode 100755 new mode 100644 index e2d0f30c1..84498bffe --- a/lending/docs/models/shared/accountingbanktransactions.md +++ b/lending/docs/models/shared/accountingbanktransactions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index fb9e4226b..2e88dc930 --- a/lending/docs/models/shared/accountingbill.md +++ b/lending/docs/models/shared/accountingbill.md @@ -31,18 +31,18 @@ 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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.BillLineItem](../../models/shared/billlineitem.md)] | :heavy_minus_sign: | Array of Bill line items. | | +| `metadata` | [Optional[shared.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[[shared.AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `purchase_order_refs` | List[[shared.PurchaseOrderReference](../../models/shared/purchaseorderreference.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. | | +| `status` | [shared.BillStatus](../../models/shared/billstatus.md) | :heavy_check_mark: | Current state of the bill. | | | `sub_total` | *Decimal* | :heavy_check_mark: | Total amount of the bill, excluding any taxes. | | -| `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. | | -| `supplier_ref` | [Optional[SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | +| `supplemental_data` | [Optional[shared.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. | | +| `supplier_ref` | [Optional[shared.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[[shared.WithholdingTax](../../models/shared/withholdingtax.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 old mode 100755 new mode 100644 index 5c20e3abd..a898d02fd --- a/lending/docs/models/shared/accountingbillcreditnote.md +++ b/lending/docs/models/shared/accountingbillcreditnote.md @@ -29,18 +29,18 @@ A bill credit note includes details of: | `discount_percentage` | *Decimal* | :heavy_check_mark: | Percentage rate of any discount applied to the bill credit note. | 0 | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bill credit note that is unique to a company in the accounting platform. | 1509398f-98e2-436d-8a5d-c042e0c74ffc | | `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[[BillCreditNoteLineItem](../../models/shared/billcreditnotelineitem.md)] | :heavy_minus_sign: | An array of line | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.BillCreditNoteLineItem](../../models/shared/billcreditnotelineitem.md)] | :heavy_minus_sign: | An array of line | | +| `metadata` | [Optional[shared.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[[shared.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 | +| `status` | [shared.BillCreditNoteStatus](../../models/shared/billcreditnotestatus.md) | :heavy_check_mark: | Current state of the bill credit note | Paid | | `sub_total` | *Decimal* | :heavy_check_mark: | Total amount of the bill credit note, including discounts but excluding tax. | 805.78 | -| `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. | | -| `supplier_ref` | [Optional[SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | +| `supplemental_data` | [Optional[shared.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. | | +| `supplier_ref` | [Optional[shared.SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | | `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[[shared.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 old mode 100755 new mode 100644 index 483881501..3ffb0a89a --- a/lending/docs/models/shared/accountingbillcreditnotes.md +++ b/lending/docs/models/shared/accountingbillcreditnotes.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index e2aadc51b..cd5285708 --- a/lending/docs/models/shared/accountingbillpayment.md +++ b/lending/docs/models/shared/accountingbillpayment.md @@ -157,18 +157,18 @@ These two rates allow the calculation of currency loss or gain for any of the tr | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | | +| `account_ref` | [Optional[shared.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. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | N/A | 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_` | *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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `lines` | List[[shared.BillPaymentLine](../../models/shared/billpaymentline.md)] | :heavy_minus_sign: | An array of bill payment lines. | | +| `metadata` | [Optional[shared.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[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | N/A | | +| `payment_method_ref` | [Optional[shared.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. | | -| `supplier_ref` | [Optional[SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | N/A | | +| `supplemental_data` | [Optional[shared.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. | | +| `supplier_ref` | [Optional[shared.SupplierRef]](../../models/shared/supplierref.md) | :heavy_minus_sign: | N/A | | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. | 1329.54 | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillpayments.md b/lending/docs/models/shared/accountingbillpayments.md old mode 100755 new mode 100644 index b2d506ffd..6552b4182 --- a/lending/docs/models/shared/accountingbillpayments.md +++ b/lending/docs/models/shared/accountingbillpayments.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index e2cbac161..67af7677a --- a/lending/docs/models/shared/accountingbills.md +++ b/lending/docs/models/shared/accountingbills.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/accountingcashflowstatement.md b/lending/docs/models/shared/accountingcashflowstatement.md old mode 100755 new mode 100644 index 7e2a13364..c6492fcd7 --- a/lending/docs/models/shared/accountingcashflowstatement.md +++ b/lending/docs/models/shared/accountingcashflowstatement.md @@ -22,6 +22,6 @@ A cash flow statement is a financial report that records all cash that is receiv | `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 | -| `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 +| `report_basis` | [shared.ReportBasis](../../models/shared/reportbasis.md) | :heavy_check_mark: | Accounting method used when aggregating the report data. In this case, `Cash`. | | +| `report_input` | [shared.ReportInput](../../models/shared/reportinput.md) | :heavy_check_mark: | Accounting method used to prepare the cash flow statement. | | +| `reports` | List[[shared.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 old mode 100755 new mode 100644 index 09e78b617..d003a4e92 --- a/lending/docs/models/shared/accountingcompanyinfo.md +++ b/lending/docs/models/shared/accountingcompanyinfo.md @@ -1,12 +1,12 @@ # AccountingCompanyInfo -> View the coverage for company info in the Data coverage explorer. +> View the coverage for company profile in the Data coverage explorer. Company info provides standard details about a linked company such as their address, phone number, and company registration. > **Company information or companies?** > -> 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. +> Company profile 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. ## Fields @@ -14,16 +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[[shared.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[[shared.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). | | -| `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. | | +| `supplemental_data` | [Optional[shared.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[[shared.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 old mode 100755 new mode 100644 index 0443246a1..fd449e29f --- 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/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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `changes` | List[[shared.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[shared.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[shared.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` | [shared.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[shared.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 new file mode 100644 index 000000000..be4c5e0fd --- /dev/null +++ b/lending/docs/models/shared/accountingcreatebankaccountresponse.md @@ -0,0 +1,21 @@ +# AccountingCreateBankAccountResponse + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `changes` | List[[shared.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[shared.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/lending-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[shared.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` | [shared.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[shared.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 old mode 100755 new mode 100644 index ccdfbaa73..7133c3515 --- a/lending/docs/models/shared/accountingcreatebanktransactions.md +++ b/lending/docs/models/shared/accountingcreatebanktransactions.md @@ -3,7 +3,7 @@ ## Fields -| 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 +| 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[[shared.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 old mode 100755 new mode 100644 index aaa9e2830..fc467dd32 --- 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[[shared.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` | [Optional[shared.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 | +| `data_type` | [Optional[shared.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` | [shared.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 +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index 453c0e1e5..644daaa2c --- a/lending/docs/models/shared/accountingcreatedirectcostresponse.md +++ b/lending/docs/models/shared/accountingcreatedirectcostresponse.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[[shared.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` | [Optional[shared.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 | +| `data_type` | [Optional[shared.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` | [shared.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 +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index 7ee4b081a..a2e9c0a2d --- a/lending/docs/models/shared/accountingcreatepaymentresponse.md +++ b/lending/docs/models/shared/accountingcreatepaymentresponse.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[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 +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `changes` | List[[shared.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[shared.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[shared.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` | [shared.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[shared.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 old mode 100755 new mode 100644 index db41dbe4e..fbaf043f9 --- 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[[shared.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/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). | | +| `data` | [Optional[shared.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 | +| `data_type` | [Optional[shared.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` | [shared.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 +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index 0bb339e54..88eb6c043 --- 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[[shared.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/lending-api#/schemas/AccountTransaction). | | +| `data` | [Optional[shared.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 | +| `data_type` | [Optional[shared.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` | [shared.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 +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index 1c0c71256..e62e6d0bd --- a/lending/docs/models/shared/accountingcreditnote.md +++ b/lending/docs/models/shared/accountingcreditnote.md @@ -24,21 +24,21 @@ It contains details of: | `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 | | `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 \| | | -| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | +| `customer_ref` | [Optional[shared.AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | | `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 | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.CreditNoteLineItem](../../models/shared/creditnotelineitem.md)] | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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[[shared.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: | Current state of the credit note. | | +| `status` | [shared.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. | | +| `supplemental_data` | [Optional[shared.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[[shared.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 old mode 100755 new mode 100644 index 93f76dc88..07f6d4b24 --- a/lending/docs/models/shared/accountingcreditnotes.md +++ b/lending/docs/models/shared/accountingcreditnotes.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 6fac12f6a..bc93b6bf1 --- a/lending/docs/models/shared/accountingcustomer.md +++ b/lending/docs/models/shared/accountingcustomer.md @@ -14,18 +14,18 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/le | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[shared.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[[shared.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. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting platform. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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 | | `phone` | *Optional[str]* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | -| `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. | | +| `status` | [shared.CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | +| `supplemental_data` | [Optional[shared.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. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingcustomerref.md b/lending/docs/models/shared/accountingcustomerref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingcustomers.md b/lending/docs/models/shared/accountingcustomers.md old mode 100755 new mode 100644 index 792c1e66d..ab2c797dc --- a/lending/docs/models/shared/accountingcustomers.md +++ b/lending/docs/models/shared/accountingcustomers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 8a771f199..428e3e255 --- a/lending/docs/models/shared/accountingdirectcost.md +++ b/lending/docs/models/shared/accountingdirectcost.md @@ -21,19 +21,19 @@ Direct costs is a child data type of [account transactions](https://docs.codat.i | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contact_ref` | [Optional[ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | The customer or supplier for the transfer, if available. | | +| `contact_ref` | [Optional[shared.AccountingDirectCostContactRef]](../../models/shared/accountingdirectcostcontactref.md) | :heavy_minus_sign: | A customer or supplier associated with the direct cost. | | | `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 | | `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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.DirectCostLineItem](../../models/shared/directcostlineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `metadata` | [Optional[shared.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[[shared.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. | | -| `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. | | +| `supplemental_data` | [Optional[shared.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_amount` | *Decimal* | :heavy_check_mark: | The total amount of tax on the direct costs. | | | `total_amount` | *Decimal* | :heavy_check_mark: | The amount of the direct costs, inclusive of tax. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingdirectcostcontactref.md b/lending/docs/models/shared/accountingdirectcostcontactref.md new file mode 100644 index 000000000..f3a660cd5 --- /dev/null +++ b/lending/docs/models/shared/accountingdirectcostcontactref.md @@ -0,0 +1,11 @@ +# AccountingDirectCostContactRef + +A customer or supplier associated with the direct cost. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_type` | [Optional[shared.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/accountingdirectcosts.md b/lending/docs/models/shared/accountingdirectcosts.md old mode 100755 new mode 100644 index 5e8c35625..85849c76f --- a/lending/docs/models/shared/accountingdirectcosts.md +++ b/lending/docs/models/shared/accountingdirectcosts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 1124de41a..c968a6072 --- a/lending/docs/models/shared/accountingdirectincome.md +++ b/lending/docs/models/shared/accountingdirectincome.md @@ -22,19 +22,19 @@ Direct incomes is a child data type of [account transactions](https://docs.codat | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contact_ref` | [Optional[ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | The customer or supplier for the transfer, if available. | | +| `contact_ref` | [Optional[shared.ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | A customer or supplier associated with the direct cost. | | | `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 | | `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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.DirectIncomeLineItem](../../models/shared/directincomelineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `metadata` | [Optional[shared.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: | 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 | | +| `payment_allocations` | List[[shared.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. | | -| `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. | | +| `supplemental_data` | [Optional[shared.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_amount` | *Decimal* | :heavy_check_mark: | The total amount of tax on the direct incomes. | | | `total_amount` | *Decimal* | :heavy_check_mark: | The amount of the direct incomes, inclusive of tax. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingdirectincomes.md b/lending/docs/models/shared/accountingdirectincomes.md old mode 100755 new mode 100644 index 5b5a2573c..f00adef2f --- a/lending/docs/models/shared/accountingdirectincomes.md +++ b/lending/docs/models/shared/accountingdirectincomes.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index c16c2b378..ac8be3d72 --- a/lending/docs/models/shared/accountinginvoice.md +++ b/lending/docs/models/shared/accountinginvoice.md @@ -40,24 +40,24 @@ In Codat, an invoice contains details of: | `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 \| | | -| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | +| `customer_ref` | [Optional[shared.AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | 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]* | :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 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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `line_items` | List[[shared.InvoiceLineItem](../../models/shared/invoicelineitem.md)] | :heavy_minus_sign: | An array of line items. | | +| `metadata` | [Optional[shared.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[[shared.AccountingPaymentAllocation](../../models/shared/accountingpaymentallocation.md)] | :heavy_minus_sign: | An array of payment allocations. | | +| `sales_order_refs` | List[[shared.SalesOrderReference](../../models/shared/salesorderreference.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. | | +| `status` | [shared.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. | | -| `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. | | +| `supplemental_data` | [Optional[shared.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: | 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[[shared.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 old mode 100755 new mode 100644 index 003504aab..56f7ef216 --- a/lending/docs/models/shared/accountinginvoices.md +++ b/lending/docs/models/shared/accountinginvoices.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 deleted file mode 100755 index 44f8a6394..000000000 --- a/lending/docs/models/shared/accountinginvoicesalesorderreference.md +++ /dev/null @@ -1,9 +0,0 @@ -# AccountingInvoiceSalesOrderReference - - -## Fields - -| 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 old mode 100755 new mode 100644 index 94c2a8053..07a29f52f --- a/lending/docs/models/shared/accountingjournal.md +++ b/lending/docs/models/shared/accountingjournal.md @@ -33,10 +33,10 @@ Multiple journals or subjournals are used in the following Codat integrations: | `has_children` | *Optional[bool]* | :heavy_minus_sign: | If the journal has child journals, this value is true. If it doesn’t, it is false. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Journal ID. | | | `journal_code` | *Optional[str]* | :heavy_minus_sign: | Native journal number or code. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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 | | `name` | *Optional[str]* | :heavy_minus_sign: | Journal name.
The maximum length for a journal name is 256 characters. All characters above that number will be truncated. | | | `parent_id` | *Optional[str]* | :heavy_minus_sign: | Parent journal ID.
If the journal is a parent journal, this value is not present. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[JournalStatus]](../../models/shared/journalstatus.md) | :heavy_minus_sign: | Current journal status. | | +| `status` | [Optional[shared.JournalStatus]](../../models/shared/journalstatus.md) | :heavy_minus_sign: | Current journal status. | | | `type` | *Optional[str]* | :heavy_minus_sign: | The type of the journal. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingjournalentries.md b/lending/docs/models/shared/accountingjournalentries.md old mode 100755 new mode 100644 index 21dbff3da..cce6263f1 --- a/lending/docs/models/shared/accountingjournalentries.md +++ b/lending/docs/models/shared/accountingjournalentries.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 6694058a9..af3d7b127 --- a/lending/docs/models/shared/accountingjournalentry.md +++ b/lending/docs/models/shared/accountingjournalentry.md @@ -31,12 +31,12 @@ 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_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 | | +| `journal_lines` | List[[shared.JournalLine](../../models/shared/journalline.md)] | :heavy_minus_sign: | An array of journal lines. | | +| `journal_ref` | [Optional[shared.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[shared.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 | | `posted_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 | -| `record_ref` | [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_ref` | [Optional[shared.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. | | | `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. | | +| `supplemental_data` | [Optional[shared.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. | | | `updated_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 | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingjournals.md b/lending/docs/models/shared/accountingjournals.md old mode 100755 new mode 100644 index b5f852c48..c37ae4314 --- a/lending/docs/models/shared/accountingjournals.md +++ b/lending/docs/models/shared/accountingjournals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index bc4f37f26..d1af5ec1f --- a/lending/docs/models/shared/accountingpayment.md +++ b/lending/docs/models/shared/accountingpayment.md @@ -1,7 +1,7 @@ # AccountingPayment -> **Payments or bill payments?** -> +> **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. @@ -10,7 +10,7 @@ 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 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. @@ -36,9 +36,9 @@ A payment paying a single invoice has one entry in its `lines` array. This **lin - 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`. + - 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. @@ -69,12 +69,12 @@ The payment of an invoice using a credit note has one entry in its **lines** arr - 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 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. @@ -84,14 +84,14 @@ A payment refunding a credit note has one entry in its **lines** array. This **l - 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. + - 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: +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. @@ -100,14 +100,14 @@ The payment issuing the refund has a negative **totalAmount**. This payment also - 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. + - 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. +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: +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. @@ -116,586 +116,586 @@ 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. + - 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: +There are two types of currency rate that are included in the payments data type: -Payment currency rate: +Payment currency rate: - Base currency of the accounts receivable account. - Foreign currency of the payment. -Payment line link currency rate: +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 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, - } - ] - } - ] -} -``` + ```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 - } - ] - } - ] -} -``` + ```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 - } - ] - } - ] -} -``` + ```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 - } - ] - } - ] -} -``` + ```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 + } + ] + } + ] + } + ``` ## Fields | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | | +| `account_ref` | [Optional[shared.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. | | | `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 \| | | -| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | +| `customer_ref` | [Optional[shared.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. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `lines` | List[[shared.PaymentLine](../../models/shared/paymentline.md)] | :heavy_minus_sign: | An array of payment lines. | | +| `metadata` | [Optional[shared.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[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | +| `payment_method_ref` | [Optional[shared.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. | | +| `supplemental_data` | [Optional[shared.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: | Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingpaymentallocation.md b/lending/docs/models/shared/accountingpaymentallocation.md old mode 100755 new mode 100644 index ecfa38a98..57b45b9a4 --- a/lending/docs/models/shared/accountingpaymentallocation.md +++ b/lending/docs/models/shared/accountingpaymentallocation.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `allocation` | [AccountingPaymentAllocationAllocation](../../models/shared/accountingpaymentallocationallocation.md) | :heavy_check_mark: | N/A | -| `payment` | [PaymentAllocationPayment](../../models/shared/paymentallocationpayment.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `allocation` | [shared.Allocation](../../models/shared/allocation.md) | :heavy_check_mark: | N/A | +| `payment` | [shared.PaymentAllocationPayment](../../models/shared/paymentallocationpayment.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingpayments.md b/lending/docs/models/shared/accountingpayments.md old mode 100755 new mode 100644 index 7057a4914..716cd0c36 --- a/lending/docs/models/shared/accountingpayments.md +++ b/lending/docs/models/shared/accountingpayments.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index b107c2a6e..53865e4ec --- a/lending/docs/models/shared/accountingprofitandlossreport.md +++ b/lending/docs/models/shared/accountingprofitandlossreport.md @@ -31,5 +31,5 @@ Our [Enhanced Financials](https://docs.codat.io/assess/reports/enhanced-financia | `currency` | *str* | :heavy_check_mark: | Base currency of the company in which the profit and loss report is presented. | | | `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 +| `report_basis` | [shared.ReportBasis](../../models/shared/reportbasis.md) | :heavy_check_mark: | The basis of a report. | | +| `reports` | List[[shared.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 old mode 100755 new mode 100644 index 5afe27893..d838f7a25 --- a/lending/docs/models/shared/accountingsupplier.md +++ b/lending/docs/models/shared/accountingsupplier.md @@ -11,17 +11,17 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List[[AccountingAddress](../../models/shared/accountingaddress.md)] | :heavy_minus_sign: | An array of Addresses. | | +| `addresses` | List[[shared.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. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting platform. | | -| `metadata` | [Optional[Metadata]](../../models/shared/metadata.md) | :heavy_minus_sign: | N/A | | +| `metadata` | [Optional[shared.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 | | `phone` | *Optional[str]* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | | `registration_number` | *Optional[str]* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [SupplierStatus](../../models/shared/supplierstatus.md) | :heavy_check_mark: | Status of the supplier. | | -| `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. | | +| `status` | [shared.SupplierStatus](../../models/shared/supplierstatus.md) | :heavy_check_mark: | Status of the supplier. | | +| `supplemental_data` | [Optional[shared.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. | | | `supplier_name` | *Optional[str]* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | | `tax_number` | *Optional[str]* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingsuppliers.md b/lending/docs/models/shared/accountingsuppliers.md old mode 100755 new mode 100644 index 6f45c5a06..923685f22 --- a/lending/docs/models/shared/accountingsuppliers.md +++ b/lending/docs/models/shared/accountingsuppliers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index fe315a055..bf02c6fe6 --- a/lending/docs/models/shared/accountingtransfer.md +++ b/lending/docs/models/shared/accountingtransfer.md @@ -9,15 +9,15 @@ A transfer records the movement of money between two bank accounts, or between a | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contact_ref` | [Optional[AccountingTransferContactRef]](../../models/shared/accountingtransfercontactref.md) | :heavy_minus_sign: | The customer or supplier for the transfer, if available. | | +| `contact_ref` | [Optional[shared.ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | A customer or supplier associated with the direct cost. | | | `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[[shared.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: | Account details of the account sending or receiving the transfer. | | +| `from_` | [Optional[shared.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 | | +| `metadata` | [Optional[shared.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: | 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 +| `supplemental_data` | [Optional[shared.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[shared.TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | +| `tracking_category_refs` | List[[shared.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 deleted file mode 100755 index c63713e81..000000000 --- a/lending/docs/models/shared/accountingtransfercontactref.md +++ /dev/null @@ -1,11 +0,0 @@ -# AccountingTransferContactRef - -The customer or supplier for the transfer, if available. - - -## Fields - -| 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 old mode 100755 new mode 100644 index bbd1bae8c..ceb2b2184 --- a/lending/docs/models/shared/accountingtransfers.md +++ b/lending/docs/models/shared/accountingtransfers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/accountinstitution.md b/lending/docs/models/shared/accountinstitution.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountprototype.md b/lending/docs/models/shared/accountprototype.md new file mode 100644 index 000000000..209fac896 --- /dev/null +++ b/lending/docs/models/shared/accountprototype.md @@ -0,0 +1,19 @@ +# AccountPrototype + + +## Fields + +| 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 | +| `current_balance` | *Optional[Decimal]* | :heavy_minus_sign: | Current balance in the account. | 0 | +| `description` | *Optional[str]* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | +| `fully_qualified_category` | *Optional[str]* | :heavy_minus_sign: | 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. | Asset.Current | +| `fully_qualified_name` | *Optional[str]* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | +| `is_bank_account` | *Optional[bool]* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | +| `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 | +| `status` | [Optional[shared.AccountStatus]](../../models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplemental_data` | [Optional[shared.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[shared.AccountType]](../../models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset | +| `valid_datatype_links` | List[[shared.ValidDataTypeLinks](../../models/shared/validdatatypelinks.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/accountref.md b/lending/docs/models/shared/accountref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accounts.md b/lending/docs/models/shared/accounts.md old mode 100755 new mode 100644 index 3eff08838..a222ec456 --- a/lending/docs/models/shared/accounts.md +++ b/lending/docs/models/shared/accounts.md @@ -11,4 +11,4 @@ | `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 | | `current_balance` | *Optional[Decimal]* | :heavy_minus_sign: | The balance of the bank account. | | | `platform_name` | *Optional[str]* | :heavy_minus_sign: | Name of the banking data source, e.g. "Plaid". | | -| `source_ref` | [Optional[SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | \ No newline at end of file +| `source_ref` | [Optional[shared.SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | \ No newline at end of file diff --git a/lending/docs/models/shared/accountspayabletracking.md b/lending/docs/models/shared/accountspayabletracking.md old mode 100755 new mode 100644 index 818c78ef3..9f576a8ed --- 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: | 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `category_refs` | List[[shared.TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | +| `customer_ref` | [Optional[shared.AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | +| `is_billed_to` | [shared.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` | [shared.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[shared.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 old mode 100755 new mode 100644 index d4b35ec70..1e649a90c --- 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 | -| `customer_ref` | [Optional[AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | 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 +| `category_refs` | List[[shared.TrackingCategoryRef](../../models/shared/trackingcategoryref.md)] | :heavy_check_mark: | N/A | +| `customer_ref` | [Optional[shared.AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | +| `is_billed_to` | [shared.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` | [shared.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[shared.ProjectRef]](../../models/shared/projectref.md) | :heavy_minus_sign: | N/A | +| `record_ref` | [Optional[shared.RecordReference]](../../models/shared/recordreference.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/accountstatus.md b/lending/docs/models/shared/accountstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accounttransactionline.md b/lending/docs/models/shared/accounttransactionline.md old mode 100755 new mode 100644 index 1f9c375ae..6f57118f1 --- a/lending/docs/models/shared/accounttransactionline.md +++ b/lending/docs/models/shared/accounttransactionline.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount in the bill payment currency. | | `description` | *Optional[str]* | :heavy_minus_sign: | Description of the account transaction. | -| `record_ref` | [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. | \ No newline at end of file +| `record_ref` | [Optional[shared.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. | \ No newline at end of file diff --git a/lending/docs/models/shared/accounttype.md b/lending/docs/models/shared/accounttype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/agedcreditor.md b/lending/docs/models/shared/agedcreditor.md old mode 100755 new mode 100644 index c83364a02..198f8b726 --- a/lending/docs/models/shared/agedcreditor.md +++ b/lending/docs/models/shared/agedcreditor.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `aged_currency_outstanding` | List[[shared.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 old mode 100755 new mode 100644 index 8d82a411e..5dd01fa26 --- 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[[shared.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 old mode 100755 new mode 100644 index 6b51d2071..6b32dc704 --- a/lending/docs/models/shared/ageddebtor.md +++ b/lending/docs/models/shared/ageddebtor.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `aged_currency_outstanding` | List[[shared.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 old mode 100755 new mode 100644 index 0c3f2063b..b55d728c5 --- 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[[shared.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/agedoutstandingamountdetail.md b/lending/docs/models/shared/agedoutstandingamountdetail.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingpaymentallocationallocation.md b/lending/docs/models/shared/allocation.md old mode 100755 new mode 100644 similarity index 99% rename from lending/docs/models/shared/accountingpaymentallocationallocation.md rename to lending/docs/models/shared/allocation.md index ddf7bea6d..ef828a563 --- a/lending/docs/models/shared/accountingpaymentallocationallocation.md +++ b/lending/docs/models/shared/allocation.md @@ -1,4 +1,4 @@ -# AccountingPaymentAllocationAllocation +# Allocation ## Fields diff --git a/lending/docs/models/shared/attachments.md b/lending/docs/models/shared/attachments.md old mode 100755 new mode 100644 index 08f31011d..1da792c93 --- a/lending/docs/models/shared/attachments.md +++ b/lending/docs/models/shared/attachments.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `attachments` | List[[AccountingAttachment](../../models/shared/accountingattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `attachments` | List[[shared.AccountingAttachment](../../models/shared/accountingattachment.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/balancesheet.md b/lending/docs/models/shared/balancesheet.md old mode 100755 new mode 100644 index 96596e275..b9b46ac19 --- a/lending/docs/models/shared/balancesheet.md +++ b/lending/docs/models/shared/balancesheet.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `assets` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `assets` | [Optional[shared.ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | | `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 | -| `equity` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | -| `liabilities` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `equity` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | +| `liabilities` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | | `net_assets` | *Decimal* | :heavy_check_mark: | Value of net assets for a company in their base currency. | | \ No newline at end of file diff --git a/lending/docs/models/shared/bankaccountref.md b/lending/docs/models/shared/bankaccountref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/bankingaccount.md b/lending/docs/models/shared/bankingaccount.md old mode 100755 new mode 100644 index 35f13c131..4255e1847 --- a/lending/docs/models/shared/bankingaccount.md +++ b/lending/docs/models/shared/bankingaccount.md @@ -11,14 +11,14 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `balance` | [AccountBalanceAmounts](../../models/shared/accountbalanceamounts.md) | :heavy_check_mark: | Depending on the data provided by the underlying bank, not all balances are always available. | | +| `balance` | [shared.AccountBalanceAmounts](../../models/shared/accountbalanceamounts.md) | :heavy_check_mark: | Depending on the data provided by the underlying bank, not all balances are always available. | | | `currency` | *str* | :heavy_check_mark: | The currency code for the account. | | | `holder` | *Optional[str]* | :heavy_minus_sign: | The name of the person or company who holds the account. | | | `id` | *str* | :heavy_check_mark: | The ID of the account from the provider. | | -| `identifiers` | [AccountIdentifiers](../../models/shared/accountidentifiers.md) | :heavy_check_mark: | An object containing bank account identification information. | | +| `identifiers` | [shared.AccountIdentifiers](../../models/shared/accountidentifiers.md) | :heavy_check_mark: | An object containing bank account identification information. | | | `informal_name` | *Optional[str]* | :heavy_minus_sign: | 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. | | -| `institution` | [AccountInstitution](../../models/shared/accountinstitution.md) | :heavy_check_mark: | The bank or other financial institution providing the account. | | +| `institution` | [shared.AccountInstitution](../../models/shared/accountinstitution.md) | :heavy_check_mark: | The bank or other financial institution providing the account. | | | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `name` | *str* | :heavy_check_mark: | The name of the account according to the provider. | | | `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `type` | [AccountingBankAccountType](../../models/shared/accountingbankaccounttype.md) | :heavy_check_mark: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | \ No newline at end of file +| `type` | [shared.AccountingBankAccountType](../../models/shared/accountingbankaccounttype.md) | :heavy_check_mark: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingaccountbalance.md b/lending/docs/models/shared/bankingaccountbalance.md old mode 100755 new mode 100644 index b869ef8a2..db7bebe1b --- a/lending/docs/models/shared/bankingaccountbalance.md +++ b/lending/docs/models/shared/bankingaccountbalance.md @@ -16,7 +16,7 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_id` | *str* | :heavy_check_mark: | The unique identifier of the account. | | -| `balance` | [AccountBalanceAmounts](../../models/shared/accountbalanceamounts.md) | :heavy_check_mark: | Depending on the data provided by the underlying bank, not all balances are always available. | | +| `balance` | [shared.AccountBalanceAmounts](../../models/shared/accountbalanceamounts.md) | :heavy_check_mark: | Depending on the data provided by the underlying bank, not all balances are always available. | | | `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 | | `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 | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingaccountbalances.md b/lending/docs/models/shared/bankingaccountbalances.md old mode 100755 new mode 100644 index 3d2abca3e..d8648340d --- a/lending/docs/models/shared/bankingaccountbalances.md +++ b/lending/docs/models/shared/bankingaccountbalances.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 3714770e1..dc4c5652f --- a/lending/docs/models/shared/bankingaccounts.md +++ b/lending/docs/models/shared/bankingaccounts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/bankingtransaction.md b/lending/docs/models/shared/bankingtransaction.md old mode 100755 new mode 100644 index 45104122f..0694a1d9d --- a/lending/docs/models/shared/bankingtransaction.md +++ b/lending/docs/models/shared/bankingtransaction.md @@ -14,7 +14,7 @@ View the coverage for banking transactions in the [Data Coverage Explorer](https | `account_id` | *str* | :heavy_check_mark: | The unique identifier of the bank account. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount of the bank transaction. | | | `authorized_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 | -| `code` | [Optional[TransactionCode]](../../models/shared/transactioncode.md) | :heavy_minus_sign: | Code to identify the underlying transaction. | | +| `code` | [Optional[shared.TransactionCode]](../../models/shared/transactioncode.md) | :heavy_minus_sign: | Code to identify the underlying transaction. | | | `currency` | *str* | :heavy_check_mark: | The currency of the bank transaction. | | | `description` | *Optional[str]* | :heavy_minus_sign: | The description of the bank transaction. | | | `id` | *str* | :heavy_check_mark: | The unique identifier of the bank transaction. | | @@ -22,4 +22,4 @@ View the coverage for banking transactions in the [Data Coverage Explorer](https | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `posted_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 | -| `transaction_category_ref` | [Optional[TransactionCategoryRef]](../../models/shared/transactioncategoryref.md) | :heavy_minus_sign: | An object of bank transaction category reference data. | | \ No newline at end of file +| `transaction_category_ref` | [Optional[shared.TransactionCategoryRef]](../../models/shared/transactioncategoryref.md) | :heavy_minus_sign: | An object of bank transaction category reference data. | | \ No newline at end of file diff --git a/lending/docs/models/shared/bankingtransactioncategories.md b/lending/docs/models/shared/bankingtransactioncategories.md old mode 100755 new mode 100644 index 8f08a59c5..45ec710c5 --- a/lending/docs/models/shared/bankingtransactioncategories.md +++ b/lending/docs/models/shared/bankingtransactioncategories.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index e51fd2ad1..6adee2721 --- 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: | The status of the transaction category. | | \ No newline at end of file +| `status` | [Optional[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/bankingtransactions.md b/lending/docs/models/shared/bankingtransactions.md old mode 100755 new mode 100644 index 9f469e988..2579f21d9 --- a/lending/docs/models/shared/bankingtransactions.md +++ b/lending/docs/models/shared/bankingtransactions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billcreditnotelineitem.md b/lending/docs/models/shared/billcreditnotelineitem.md old mode 100755 new mode 100644 index ee1576577..15732613a --- a/lending/docs/models/shared/billcreditnotelineitem.md +++ b/lending/docs/models/shared/billcreditnotelineitem.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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 each line item. For example, the goods or service for which credit has been received. | | `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. | -| `item_ref` | [Optional[BillCreditNoteLineItemItemReference]](../../models/shared/billcreditnotelineitemitemreference.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | +| `item_ref` | [Optional[shared.ItemReference]](../../models/shared/itemreference.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 received. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of credit associated with the line item, including discounts but excluding tax. | | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of tax associated with the line item. | -| `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 | +| `tax_rate_ref` | [Optional[shared.TaxRateReference]](../../models/shared/taxratereference.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` | [Optional[shared.AccountsPayableTracking]](../../models/shared/accountspayabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | +| ~~`tracking_category_refs`~~ | List[[shared.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/billcreditnotestatus.md b/lending/docs/models/shared/billcreditnotestatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billedtotype.md b/lending/docs/models/shared/billedtotype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billedtotype1.md b/lending/docs/models/shared/billedtotype1.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billlineitem.md b/lending/docs/models/shared/billlineitem.md old mode 100755 new mode 100644 index 8559699ad..d0880ad0b --- a/lending/docs/models/shared/billlineitem.md +++ b/lending/docs/models/shared/billlineitem.md @@ -5,19 +5,20 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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: | 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. | +| `item_ref` | [Optional[shared.PropertieItemRef]](../../models/shared/propertieitemref.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. | +| `purchase_order_line_ref` | [Optional[shared.RecordLineReference]](../../models/shared/recordlinereference.md) | :heavy_minus_sign: | N/A | | `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 | +| `tax_rate_ref` | [Optional[shared.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. | -| `unit_amount` | *Decimal* | :heavy_check_mark: | Price of each unit of goods or services. | \ No newline at end of file +| `tracking` | [Optional[shared.AccountsPayableTracking]](../../models/shared/accountspayabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | +| `tracking_category_refs` | List[[shared.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. | +| `unit_of_measurement` | *Optional[str]* | :heavy_minus_sign: | The measurement which defines a unit for this item (e.g. 'kilogram', 'litre'). | \ No newline at end of file diff --git a/lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md b/lending/docs/models/shared/billlineitemdatatype.md old mode 100755 new mode 100644 similarity index 80% rename from lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md rename to lending/docs/models/shared/billlineitemdatatype.md index d9a52b128..959aefaa2 --- a/lending/docs/models/shared/billlineitemrecordlinereferencedatatype.md +++ b/lending/docs/models/shared/billlineitemdatatype.md @@ -1,4 +1,4 @@ -# BillLineItemRecordLineReferenceDataType +# BillLineItemDataType Allowed name of the 'dataType'. diff --git a/lending/docs/models/shared/billlineitemrecordlinereference.md b/lending/docs/models/shared/billlineitemrecordlinereference.md deleted file mode 100755 index 28cbcb0ac..000000000 --- a/lending/docs/models/shared/billlineitemrecordlinereference.md +++ /dev/null @@ -1,12 +0,0 @@ -# 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/billpaymentline.md b/lending/docs/models/shared/billpaymentline.md old mode 100755 new mode 100644 index 2795b0f9f..446cae469 --- 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[[shared.BillPaymentLineLink](../../models/shared/billpaymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/billpaymentlinelink.md b/lending/docs/models/shared/billpaymentlinelink.md old mode 100755 new mode 100644 index 9087af70d..4a979e788 --- a/lending/docs/models/shared/billpaymentlinelink.md +++ b/lending/docs/models/shared/billpaymentlinelink.md @@ -8,4 +8,4 @@ | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | 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]* | :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: | Unique identifier of the transaction represented by the link. | -| `type` | [BillPaymentLineLinkType](../../models/shared/billpaymentlinelinktype.md) | :heavy_check_mark: | Types of links to bill payment lines. | \ No newline at end of file +| `type` | [shared.BillPaymentLineLinkType](../../models/shared/billpaymentlinelinktype.md) | :heavy_check_mark: | Types of links to bill payment lines. | \ No newline at end of file diff --git a/lending/docs/models/shared/billpaymentlinelinktype.md b/lending/docs/models/shared/billpaymentlinelinktype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billstatus.md b/lending/docs/models/shared/billstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/cashflowstatement.md b/lending/docs/models/shared/cashflowstatement.md old mode 100755 new mode 100644 index e9fb6823c..c8fad93cb --- a/lending/docs/models/shared/cashflowstatement.md +++ b/lending/docs/models/shared/cashflowstatement.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cash_payments` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | -| `cash_receipts` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `cash_payments` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | +| `cash_receipts` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | | `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/clientratelimitreachedwebhook.md b/lending/docs/models/shared/clientratelimitreachedwebhook.md old mode 100755 new mode 100644 index 3d7030310..0e1855429 --- a/lending/docs/models/shared/clientratelimitreachedwebhook.md +++ b/lending/docs/models/shared/clientratelimitreachedwebhook.md @@ -5,12 +5,12 @@ Webhook request body for a client that has reached their rate limit. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional[ClientRateLimitReachedWebhookData]](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[shared.ClientRateLimitReachedWebhookData]](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/lending/docs/models/shared/clientratelimitreachedwebhookdata.md b/lending/docs/models/shared/clientratelimitreachedwebhookdata.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/clientratelimitresetwebhook.md b/lending/docs/models/shared/clientratelimitresetwebhook.md old mode 100755 new mode 100644 index 7336566a4..de4352761 --- a/lending/docs/models/shared/clientratelimitresetwebhook.md +++ b/lending/docs/models/shared/clientratelimitresetwebhook.md @@ -5,12 +5,12 @@ Webhook request body for a client that has had their rate limit reset. ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional[ClientRateLimitResetWebhookData]](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[shared.ClientRateLimitResetWebhookData]](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/lending/docs/models/shared/clientratelimitresetwebhookdata.md b/lending/docs/models/shared/clientratelimitresetwebhookdata.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commerceaddress.md b/lending/docs/models/shared/commerceaddress.md old mode 100755 new mode 100644 index cbe5ff6af..a0c582e06 --- a/lending/docs/models/shared/commerceaddress.md +++ b/lending/docs/models/shared/commerceaddress.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `city` | *Optional[str]* | :heavy_minus_sign: | The third line of the address, or city | -| `country` | *Optional[str]* | :heavy_minus_sign: | The country for the address | -| `line1` | *Optional[str]* | :heavy_minus_sign: | The first line of the address | -| `line2` | *Optional[str]* | :heavy_minus_sign: | The second line of the address | -| `postal_code` | *Optional[str]* | :heavy_minus_sign: | The postal (or zip) code for the address | -| `region` | *Optional[str]* | :heavy_minus_sign: | The fourth line of the address, or region | -| `type` | [Optional[CommerceAddressType]](../../models/shared/commerceaddresstype.md) | :heavy_minus_sign: | The type of the address | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `city` | *Optional[str]* | :heavy_minus_sign: | The third line of the address, or city | +| `country` | *Optional[str]* | :heavy_minus_sign: | The country for the address | +| `line1` | *Optional[str]* | :heavy_minus_sign: | The first line of the address | +| `line2` | *Optional[str]* | :heavy_minus_sign: | The second line of the address | +| `postal_code` | *Optional[str]* | :heavy_minus_sign: | The postal (or zip) code for the address | +| `region` | *Optional[str]* | :heavy_minus_sign: | The fourth line of the address, or region | +| `type` | [Optional[shared.CommerceAddressType]](../../models/shared/commerceaddresstype.md) | :heavy_minus_sign: | The type of the address | \ No newline at end of file diff --git a/lending/docs/models/shared/commerceaddresstype.md b/lending/docs/models/shared/commerceaddresstype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercecompanyinfo.md b/lending/docs/models/shared/commercecompanyinfo.md old mode 100755 new mode 100644 index 15b50db10..41ef3d8d1 --- a/lending/docs/models/shared/commercecompanyinfo.md +++ b/lending/docs/models/shared/commercecompanyinfo.md @@ -1,6 +1,6 @@ # CommerceCompanyInfo -In the Codat system, company information includes standard commercial details about +In the Codat system, company profile includes standard commercial details about a linked company, such as their address, phone number, and company registration. Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=companyInfo) for this data type. @@ -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[[shared.AccountBalance](../../models/shared/accountbalance.md)] | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | +| `addresses` | List[[shared.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[[shared.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 | [object Object] | -| `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 | {"url1":"https://connect.sandbox.com/v2/customers","url2":"https://connect.sandbox.com/v2/disputes"} | +| `web_links` | List[[shared.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 old mode 100755 new mode 100644 index da1e6f69e..e4320c899 --- 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[[shared.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/commercecustomerref.md b/lending/docs/models/shared/commercecustomerref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercecustomers.md b/lending/docs/models/shared/commercecustomers.md old mode 100755 new mode 100644 index fa7a58dda..0e197c813 --- a/lending/docs/models/shared/commercecustomers.md +++ b/lending/docs/models/shared/commercecustomers.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 6ec01d1e9..3c6444762 --- 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[[shared.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 | +| `status` | [Optional[shared.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. | 194.12 | \ No newline at end of file diff --git a/lending/docs/models/shared/commercedisputes.md b/lending/docs/models/shared/commercedisputes.md old mode 100755 new mode 100644 index 01325a74d..60d84e084 --- a/lending/docs/models/shared/commercedisputes.md +++ b/lending/docs/models/shared/commercedisputes.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/commercelocation.md b/lending/docs/models/shared/commercelocation.md old mode 100755 new mode 100644 index 4cae9a3c0..d35995c57 --- a/lending/docs/models/shared/commercelocation.md +++ b/lending/docs/models/shared/commercelocation.md @@ -9,10 +9,10 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `address` | [Optional[CommerceAddress]](../../models/shared/commerceaddress.md) | :heavy_minus_sign: | N/A | | -| `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: | Name of this location | | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `address` | [Optional[shared.CommerceAddress]](../../models/shared/commerceaddress.md) | :heavy_minus_sign: | N/A | | +| `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: | Name of this location | | +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/commercelocations.md b/lending/docs/models/shared/commercelocations.md old mode 100755 new mode 100644 index 43dfaa980..4f3b2745a --- a/lending/docs/models/shared/commercelocations.md +++ b/lending/docs/models/shared/commercelocations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 16e92d5e2..a53eae1f7 --- a/lending/docs/models/shared/commerceorder.md +++ b/lending/docs/models/shared/commerceorder.md @@ -14,16 +14,16 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer | `country` | *Optional[str]* | :heavy_minus_sign: | The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.

Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model.

For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint. | GBR | | `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` | *Optional[str]* | :heavy_minus_sign: | N/A | GBP | -| `customer_ref` | [Optional[CommerceCustomerRef]](../../models/shared/commercecustomerref.md) | :heavy_minus_sign: | Reference to the customer that placed the order. | | +| `customer_ref` | [Optional[shared.CommerceCustomerRef]](../../models/shared/commercecustomerref.md) | :heavy_minus_sign: | Reference to the customer that placed the order. | | | `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. | | +| `location_ref` | [Optional[shared.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[[shared.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[[shared.PaymentRef](../../models/shared/paymentref.md)] | :heavy_minus_sign: | N/A | | +| `service_charges` | List[[shared.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[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. | | +| `supplemental_data` | [Optional[shared.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. | | diff --git a/lending/docs/models/shared/commerceorders.md b/lending/docs/models/shared/commerceorders.md old mode 100755 new mode 100644 index 965bcd7c0..1f5075abb --- a/lending/docs/models/shared/commerceorders.md +++ b/lending/docs/models/shared/commerceorders.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/commercepayment.md b/lending/docs/models/shared/commercepayment.md old mode 100755 new mode 100644 index 0150c9949..c656e8d30 --- a/lending/docs/models/shared/commercepayment.md +++ b/lending/docs/models/shared/commercepayment.md @@ -19,8 +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[PaymentMethodRef]](../../models/shared/paymentmethodref.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce platform. | | +| `payment_method_ref` | [Optional[shared.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. | | -| `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 +| `status` | [Optional[shared.PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | +| `supplemental_data` | [Optional[shared.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 old mode 100755 new mode 100644 index a486924c7..f695eaaab --- 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[CommercePaymentMethodStatus]](../../models/shared/commercepaymentmethodstatus.md) | :heavy_minus_sign: | Status of the Payment Method. | | \ 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[shared.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 old mode 100755 new mode 100644 index d9ed0537a..419c044e1 --- a/lending/docs/models/shared/commercepaymentmethods.md +++ b/lending/docs/models/shared/commercepaymentmethods.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercepayments.md b/lending/docs/models/shared/commercepayments.md old mode 100755 new mode 100644 index 1342faa9e..5e7c28497 --- a/lending/docs/models/shared/commercepayments.md +++ b/lending/docs/models/shared/commercepayments.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index c5475c1b9..30728c6b6 --- a/lending/docs/models/shared/commerceproduct.md +++ b/lending/docs/models/shared/commerceproduct.md @@ -15,5 +15,5 @@ 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 | | `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 +| `supplemental_data` | [Optional[shared.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[[shared.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 old mode 100755 new mode 100644 index 529adb2a5..15b98f78a --- a/lending/docs/models/shared/commerceproductcategories.md +++ b/lending/docs/models/shared/commerceproductcategories.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index 75299f937..502366ea0 --- 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[[shared.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 old mode 100755 new mode 100644 index 8ef137024..1af25d0c2 --- a/lending/docs/models/shared/commerceproducts.md +++ b/lending/docs/models/shared/commerceproducts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/commercerecordref.md b/lending/docs/models/shared/commercerecordref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercereport.md b/lending/docs/models/shared/commercereport.md old mode 100755 new mode 100644 index dde2b5c4b..cc62f0048 --- a/lending/docs/models/shared/commercereport.md +++ b/lending/docs/models/shared/commercereport.md @@ -45,10 +45,10 @@ Reports can be rendered as follows (ordering is implicit rather than explicit): ## Fields -| 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `dimensions` | List[[shared.CommerceReportDimension](../../models/shared/commercereportdimension.md)] | :heavy_minus_sign: | N/A | +| `errors` | List[[shared.CommerceReportError](../../models/shared/commercereporterror.md)] | :heavy_minus_sign: | N/A | +| `measures` | List[[shared.CommerceReportMeasure](../../models/shared/commercereportmeasure.md)] | :heavy_minus_sign: | N/A | +| `report_data` | List[[shared.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 old mode 100755 new mode 100644 index bfdb6a8aa..847e22aab --- a/lending/docs/models/shared/commercereportcomponent.md +++ b/lending/docs/models/shared/commercereportcomponent.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `components` | List[[shared.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[[shared.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 old mode 100755 new mode 100644 index d97101c1d..5dcbd3e0e --- a/lending/docs/models/shared/commercereportdimension.md +++ b/lending/docs/models/shared/commercereportdimension.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The dimension's display name. | +| `index` | *Optional[int]* | :heavy_minus_sign: | The dimension's index. | +| `items` | List[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercereporterror.md b/lending/docs/models/shared/commercereporterror.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercereportmeasure.md b/lending/docs/models/shared/commercereportmeasure.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/commercetransaction.md b/lending/docs/models/shared/commercetransaction.md old mode 100755 new mode 100644 index f93909601..d6fd55609 --- a/lending/docs/models/shared/commercetransaction.md +++ b/lending/docs/models/shared/commercetransaction.md @@ -23,7 +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. | | +| `supplemental_data` | [Optional[shared.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 +| `transaction_source_ref` | [Optional[shared.TransactionSourceRef]](../../models/shared/transactionsourceref.md) | :heavy_minus_sign: | Link to the source event which triggered this transaction | | +| `type` | [Optional[shared.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 old mode 100755 new mode 100644 index 2f0ecba32..0d5861ce9 --- a/lending/docs/models/shared/commercetransactions.md +++ b/lending/docs/models/shared/commercetransactions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index eeaacf9de..05e8c5131 --- a/lending/docs/models/shared/companies.md +++ b/lending/docs/models/shared/companies.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index a13a89f7b..93130f04a --- a/lending/docs/models/shared/company.md +++ b/lending/docs/models/shared/company.md @@ -13,7 +13,7 @@ When you create a company, you can specify a `name` and we will automatically ge | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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: | Name of user that created the company in Codat. | | -| `data_connections` | List[[Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | +| `data_connections` | List[[shared.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 | diff --git a/lending/docs/models/shared/companyrequestbody.md b/lending/docs/models/shared/companyrequestbody.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/connection.md b/lending/docs/models/shared/connection.md old mode 100755 new mode 100644 index 5e93e4ddf..b512a9f47 --- a/lending/docs/models/shared/connection.md +++ b/lending/docs/models/shared/connection.md @@ -19,7 +19,7 @@ Before you can use a data connection to pull or push data, the company must gran | `additional_properties` | *Optional[Any]* | :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[[shared.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. | | @@ -27,5 +27,5 @@ Before you can use a data connection to pull or push data, the company must gran | `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 +| `source_type` | [shared.SourceType](../../models/shared/sourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | +| `status` | [shared.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 old mode 100755 new mode 100644 index 87ee809ab..5a69d197d --- a/lending/docs/models/shared/connections.md +++ b/lending/docs/models/shared/connections.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 index c2513a928..dc31b8d08 --- a/lending/docs/models/shared/contact.md +++ b/lending/docs/models/shared/contact.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `address` | [Optional[AccountingAddress]](../../models/shared/accountingaddress.md) | :heavy_minus_sign: | N/A | | +| `address` | [Optional[shared.AccountingAddress]](../../models/shared/accountingaddress.md) | :heavy_minus_sign: | N/A | | | `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. | | -| `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | | \ No newline at end of file +| `phone` | List[[shared.PhoneNumber](../../models/shared/phonenumber.md)] | :heavy_minus_sign: | An array of Phone numbers. | | +| `status` | [shared.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 old mode 100755 new mode 100644 index 8f6603c01..057c85afb --- a/lending/docs/models/shared/contactref.md +++ b/lending/docs/models/shared/contactref.md @@ -1,11 +1,11 @@ # ContactRef -The customer or supplier for the transfer, if available. +A customer or supplier associated with the direct cost. ## Fields -| 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 +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_type` | [Optional[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/creditnotelineitem.md b/lending/docs/models/shared/creditnotelineitem.md old mode 100755 new mode 100644 index 687ee912a..a37f5e046 --- a/lending/docs/models/shared/creditnotelineitem.md +++ b/lending/docs/models/shared/creditnotelineitem.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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 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: | 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. | +| `item_ref` | [Optional[shared.PropertieItemRef]](../../models/shared/propertieitemref.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. | | `tax_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Amount of tax associated with the line item. | -| `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 | +| `tax_rate_ref` | [Optional[shared.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` | [Optional[shared.AccountsReceivableTracking]](../../models/shared/accountsreceivabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | +| ~~`tracking_category_refs`~~ | List[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/customerstatus.md b/lending/docs/models/shared/customerstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataconnectionerror.md b/lending/docs/models/shared/dataconnectionerror.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataconnectionstatus.md b/lending/docs/models/shared/dataconnectionstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegrityamounts.md b/lending/docs/models/shared/dataintegrityamounts.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritybyamount.md b/lending/docs/models/shared/dataintegritybyamount.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritybycount.md b/lending/docs/models/shared/dataintegritybycount.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegrityconnectionid.md b/lending/docs/models/shared/dataintegrityconnectionid.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritydatatype.md b/lending/docs/models/shared/dataintegritydatatype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritydates.md b/lending/docs/models/shared/dataintegritydates.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritydetail.md b/lending/docs/models/shared/dataintegritydetail.md old mode 100755 new mode 100644 index f567c88e1..454170160 --- 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[[shared.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 old mode 100755 new mode 100644 index 2c0ddf84f..a671c0fc2 --- a/lending/docs/models/shared/dataintegritydetails.md +++ b/lending/docs/models/shared/dataintegritydetails.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/dataintegritymatch.md b/lending/docs/models/shared/dataintegritymatch.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/dataintegritystatus.md b/lending/docs/models/shared/dataintegritystatus.md old mode 100755 new mode 100644 index befbf1600..6ac4104dc --- a/lending/docs/models/shared/dataintegritystatus.md +++ b/lending/docs/models/shared/dataintegritystatus.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amounts` | [Optional[DataIntegrityAmounts]](../../models/shared/dataintegrityamounts.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | -| `connection_ids` | [Optional[DataIntegrityConnectionID]](../../models/shared/dataintegrityconnectionid.md) | :heavy_minus_sign: | N/A | -| `dates` | [Optional[DataIntegrityDates]](../../models/shared/dataintegritydates.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | -| `status_info` | [Optional[DataIntegrityStatusInfo]](../../models/shared/dataintegritystatusinfo.md) | :heavy_minus_sign: | N/A | +| `amounts` | [Optional[shared.DataIntegrityAmounts]](../../models/shared/dataintegrityamounts.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | +| `connection_ids` | [Optional[shared.DataIntegrityConnectionID]](../../models/shared/dataintegrityconnectionid.md) | :heavy_minus_sign: | N/A | +| `dates` | [Optional[shared.DataIntegrityDates]](../../models/shared/dataintegritydates.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | +| `status_info` | [Optional[shared.DataIntegrityStatusInfo]](../../models/shared/dataintegritystatusinfo.md) | :heavy_minus_sign: | N/A | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritystatuses.md b/lending/docs/models/shared/dataintegritystatuses.md old mode 100755 new mode 100644 index d556429b8..8a4b39a11 --- a/lending/docs/models/shared/dataintegritystatuses.md +++ b/lending/docs/models/shared/dataintegritystatuses.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `metadata` | List[[DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `metadata` | List[[shared.DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritystatusinfo.md b/lending/docs/models/shared/dataintegritystatusinfo.md old mode 100755 new mode 100644 index 45084df5f..53841513e --- a/lending/docs/models/shared/dataintegritystatusinfo.md +++ b/lending/docs/models/shared/dataintegritystatusinfo.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `current_status` | [Optional[IntegrityStatus]](../../models/shared/integritystatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | | +| `current_status` | [Optional[shared.IntegrityStatus]](../../models/shared/integritystatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | | | `last_matched` | *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_message` | *Optional[str]* | :heavy_minus_sign: | Detailed explanation supporting the status value. | | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritysummaries.md b/lending/docs/models/shared/dataintegritysummaries.md old mode 100755 new mode 100644 index 41d4fd9d6..0588076cf --- a/lending/docs/models/shared/dataintegritysummaries.md +++ b/lending/docs/models/shared/dataintegritysummaries.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `summaries` | List[[DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `summaries` | List[[shared.DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/dataintegritysummary.md b/lending/docs/models/shared/dataintegritysummary.md old mode 100755 new mode 100644 index 7a27de5f7..6f8af88d8 --- a/lending/docs/models/shared/dataintegritysummary.md +++ b/lending/docs/models/shared/dataintegritysummary.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `by_amount` | [Optional[DataIntegrityByAmount]](../../models/shared/dataintegritybyamount.md) | :heavy_minus_sign: | N/A | -| `by_count` | [Optional[DataIntegrityByCount]](../../models/shared/dataintegritybycount.md) | :heavy_minus_sign: | N/A | +| `by_amount` | [Optional[shared.DataIntegrityByAmount]](../../models/shared/dataintegritybyamount.md) | :heavy_minus_sign: | N/A | +| `by_count` | [Optional[shared.DataIntegrityByCount]](../../models/shared/dataintegritybycount.md) | :heavy_minus_sign: | N/A | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. | \ No newline at end of file diff --git a/lending/docs/models/shared/datasource.md b/lending/docs/models/shared/datasource.md old mode 100755 new mode 100644 index 2152d333c..95ec7dc64 --- 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[[shared.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 old mode 100755 new mode 100644 index e835378ab..59519018e --- a/lending/docs/models/shared/datastatus.md +++ b/lending/docs/models/shared/datastatus.md @@ -8,7 +8,7 @@ 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: | The current status of the dataset in Codat's cache. | | -| `data_type` | [DataStatusDataTypes](../../models/shared/datastatusdatatypes.md) | :heavy_check_mark: | Available Data types | invoices | +| `data_type` | [shared.DataTypes](../../models/shared/datatypes.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: | 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/datatype.md b/lending/docs/models/shared/datatype.md old mode 100755 new mode 100644 index 0e358dc70..7a5f16172 --- a/lending/docs/models/shared/datatype.md +++ b/lending/docs/models/shared/datatype.md @@ -22,6 +22,7 @@ Available Data types | `DIRECT_COSTS` | directCosts | | `DIRECT_INCOMES` | directIncomes | | `INVOICES` | invoices | +| `ITEM_RECEIPTS` | itemReceipts | | `ITEMS` | items | | `JOURNAL_ENTRIES` | journalEntries | | `JOURNALS` | journals | diff --git a/lending/docs/models/shared/datastatusdatatypes.md b/lending/docs/models/shared/datatypes.md old mode 100755 new mode 100644 similarity index 97% rename from lending/docs/models/shared/datastatusdatatypes.md rename to lending/docs/models/shared/datatypes.md index bb62bc2d3..ddabcb78f --- a/lending/docs/models/shared/datastatusdatatypes.md +++ b/lending/docs/models/shared/datatypes.md @@ -1,4 +1,4 @@ -# DataStatusDataTypes +# DataTypes Available Data types @@ -22,6 +22,7 @@ Available Data types | `DIRECT_COSTS` | directCosts | | `DIRECT_INCOMES` | directIncomes | | `INVOICES` | invoices | +| `ITEM_RECEIPTS` | itemReceipts | | `ITEMS` | items | | `JOURNAL_ENTRIES` | journalEntries | | `JOURNALS` | journals | diff --git a/lending/docs/models/shared/definitionsitemref.md b/lending/docs/models/shared/definitionsitemref.md deleted file mode 100755 index 7c9170519..000000000 --- a/lending/docs/models/shared/definitionsitemref.md +++ /dev/null @@ -1,10 +0,0 @@ -# DefinitionsitemRef - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The data connection id being referenced. | -| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object, e.g. the Journal entry. | -| `type` | *Optional[str]* | :heavy_minus_sign: | The data type the loan transaction entry was extracted from. | \ No newline at end of file diff --git a/lending/docs/models/shared/directcostlineitem.md b/lending/docs/models/shared/directcostlineitem.md old mode 100755 new mode 100644 index 61b96f81b..93ee8cc2f --- a/lending/docs/models/shared/directcostlineitem.md +++ b/lending/docs/models/shared/directcostlineitem.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Discount amount for the line before tax. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Discount percentage for the line before tax. | -| `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | +| `item_ref` | [Optional[shared.PropertieItemRef]](../../models/shared/propertieitemref.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 received.

Note: If the platform does not provide this information, the quantity will be mapped as 1. | | `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 | +| `tax_rate_ref` | [Optional[shared.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` | [Optional[shared.Tracking]](../../models/shared/tracking.md) | :heavy_minus_sign: | N/A | +| ~~`tracking_category_refs`~~ | List[[shared.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/directcostprototype.md b/lending/docs/models/shared/directcostprototype.md new file mode 100644 index 000000000..37b45df9d --- /dev/null +++ b/lending/docs/models/shared/directcostprototype.md @@ -0,0 +1,19 @@ +# DirectCostPrototype + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contact_ref` | [Optional[shared.DirectCostPrototypeContactRef]](../../models/shared/directcostprototypecontactref.md) | :heavy_minus_sign: | A customer or supplier associated with the direct cost. | | +| `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 | +| `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 \| | | +| `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[[shared.DirectCostLineItem](../../models/shared/directcostlineitem.md)] | :heavy_check_mark: | An array of line items. | | +| `note` | *Optional[str]* | :heavy_minus_sign: | A note attached to the direct cost. | | +| `payment_allocations` | List[[shared.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. | | +| `sub_total` | *Decimal* | :heavy_check_mark: | The total amount of the direct costs, excluding any taxes. | | +| `supplemental_data` | [Optional[shared.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_amount` | *Decimal* | :heavy_check_mark: | The total amount of tax on the direct costs. | | +| `total_amount` | *Decimal* | :heavy_check_mark: | The amount of the direct costs, inclusive of tax. | | \ No newline at end of file diff --git a/lending/docs/models/shared/directcostprototypecontactref.md b/lending/docs/models/shared/directcostprototypecontactref.md new file mode 100644 index 000000000..f810634a0 --- /dev/null +++ b/lending/docs/models/shared/directcostprototypecontactref.md @@ -0,0 +1,11 @@ +# DirectCostPrototypeContactRef + +A customer or supplier associated with the direct cost. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_type` | [Optional[shared.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/directincomelineitem.md b/lending/docs/models/shared/directincomelineitem.md old mode 100755 new mode 100644 index 55507edc8..e4100e843 --- a/lending/docs/models/shared/directincomelineitem.md +++ b/lending/docs/models/shared/directincomelineitem.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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: | A user-friendly name of the goods or services. | | `discount_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Discount amount for the line before tax. | | `discount_percentage` | *Optional[Decimal]* | :heavy_minus_sign: | Discount percentage for the line before tax. | -| `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | +| `item_ref` | [Optional[shared.PropertieItemRef]](../../models/shared/propertieitemref.md) | :heavy_minus_sign: | Reference to the item the line is linked to. | | `quantity` | *Decimal* | :heavy_check_mark: | The number of units of goods or services received.

Note: If the platform does not provide this information, the quantity will be mapped as 1. | | `sub_total` | *Optional[Decimal]* | :heavy_minus_sign: | The amount of the line, inclusive of discounts, but exclusive of tax. | | `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 | +| `tax_rate_ref` | [Optional[shared.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[[shared.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/disputestatus.md b/lending/docs/models/shared/disputestatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/enhancedcashflowitem.md b/lending/docs/models/shared/enhancedcashflowitem.md old mode 100755 new mode 100644 index 99b05b723..ca307dde4 --- a/lending/docs/models/shared/enhancedcashflowitem.md +++ b/lending/docs/models/shared/enhancedcashflowitem.md @@ -3,6 +3,6 @@ ## Fields -| 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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `transactions` | List[[shared.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 old mode 100755 new mode 100644 index 11af4ff6e..05d7e8e77 --- a/lending/docs/models/shared/enhancedcashflowtransaction.md +++ b/lending/docs/models/shared/enhancedcashflowtransaction.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_ref` | [Optional[AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | An account reference containing the account id and name. | | +| `account_ref` | [Optional[shared.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: | 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. | | | `platform_name` | *Optional[str]* | :heavy_minus_sign: | Returns the payment processor responsible for the transaction. | | -| `source_ref` | [Optional[SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | -| `transaction_category` | [Optional[TransactionCategory]](../../models/shared/transactioncategory.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `source_ref` | [Optional[shared.SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | +| `transaction_category` | [Optional[shared.TransactionCategory]](../../models/shared/transactioncategory.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/enhancedcashflowtransactions.md b/lending/docs/models/shared/enhancedcashflowtransactions.md old mode 100755 new mode 100644 index 05a5a3682..bbc462ff4 --- a/lending/docs/models/shared/enhancedcashflowtransactions.md +++ b/lending/docs/models/shared/enhancedcashflowtransactions.md @@ -9,8 +9,8 @@ The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o ## Fields -| 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 Lending API reports. | -| `report_items` | List[[EnhancedCashFlowItem](../../models/shared/enhancedcashflowitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `data_sources` | List[[shared.DataSource](../../models/shared/datasource.md)] | :heavy_minus_sign: | N/A | +| `report_info` | [Optional[shared.ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[shared.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 old mode 100755 new mode 100644 index 23d82874b..b421a3db8 --- a/lending/docs/models/shared/enhancedfinancialreport.md +++ b/lending/docs/models/shared/enhancedfinancialreport.md @@ -3,7 +3,7 @@ ## Fields -| 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `report_info` | [Optional[shared.EnhancedReportInfo]](../../models/shared/enhancedreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.ReportItem](../../models/shared/reportitem.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 old mode 100755 new mode 100644 index 3047eea69..c56f4ec34 --- a/lending/docs/models/shared/enhancedinvoicereportitem.md +++ b/lending/docs/models/shared/enhancedinvoicereportitem.md @@ -7,14 +7,14 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `customer_ref` | [Optional[shared.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 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[[shared.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. | | +| `status` | [Optional[shared.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: | 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 old mode 100755 new mode 100644 index e64964c88..24bdd5935 --- a/lending/docs/models/shared/enhancedinvoicesreport.md +++ b/lending/docs/models/shared/enhancedinvoicesreport.md @@ -5,7 +5,7 @@ The enhanced invoices report takes the key elements of the Invoices report verif ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `report_info` | [Optional[shared.ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[shared.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 old mode 100755 new mode 100644 index 5655c1db2..270b6bfa5 --- 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[[shared.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/enhancedreportinfo.md b/lending/docs/models/shared/enhancedreportinfo.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/excelreporttypes.md b/lending/docs/models/shared/excelreporttypes.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/excelstatus.md b/lending/docs/models/shared/excelstatus.md old mode 100755 new mode 100644 index c8486102d..6b5e3ef00 --- a/lending/docs/models/shared/excelstatus.md +++ b/lending/docs/models/shared/excelstatus.md @@ -11,5 +11,5 @@ | `last_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 | | `last_invocation_id` | *Optional[str]* | :heavy_minus_sign: | A unique ID generated for this request. | | | `queued` | *Optional[str]* | :heavy_minus_sign: | The date and time of when a successful request was queued for the most recent report. | | -| `report_type` | [Optional[ExcelReportTypes]](../../models/shared/excelreporttypes.md) | :heavy_minus_sign: | The type of the report requested in the query string. | | +| `report_type` | [Optional[shared.ExcelReportTypes]](../../models/shared/excelreporttypes.md) | :heavy_minus_sign: | The type of the report requested in the query string. | | | `success` | *Optional[bool]* | :heavy_minus_sign: | True if the requested report was successfully queued and false if the requested report was not able to be queued. | | \ No newline at end of file diff --git a/lending/docs/models/shared/file.md b/lending/docs/models/shared/file.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/halref.md b/lending/docs/models/shared/halref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/integritystatus.md b/lending/docs/models/shared/integritystatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/invoicelineitem.md b/lending/docs/models/shared/invoicelineitem.md old mode 100755 new mode 100644 index 7915e991b..ac5f0ac4f --- a/lending/docs/models/shared/invoicelineitem.md +++ b/lending/docs/models/shared/invoicelineitem.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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 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: | 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. | +| `item_ref` | [Optional[shared.PropertieItemRef]](../../models/shared/propertieitemref.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. | | `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 | +| `tax_rate_ref` | [Optional[shared.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` | [Optional[shared.AccountsReceivableTracking]](../../models/shared/accountsreceivabletracking.md) | :heavy_minus_sign: | Categories, and a project and customer, against which the item is tracked. | +| ~~`tracking_category_refs`~~ | List[[shared.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/invoicestatus.md b/lending/docs/models/shared/invoicestatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/itemref.md b/lending/docs/models/shared/itemref.md old mode 100755 new mode 100644 index 29f0e145d..2166a1084 --- a/lending/docs/models/shared/itemref.md +++ b/lending/docs/models/shared/itemref.md @@ -1,11 +1,10 @@ # ItemRef -Reference to the item the line is linked to. - ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the item in the accounting platform. | -| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the item in the accounting platform. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The data connection id being referenced. | +| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object, e.g. the Journal entry. | +| `type` | *Optional[str]* | :heavy_minus_sign: | The data type the loan transaction entry was extracted from. | \ No newline at end of file diff --git a/lending/docs/models/shared/billcreditnotelineitemitemreference.md b/lending/docs/models/shared/itemreference.md old mode 100755 new mode 100644 similarity index 96% rename from lending/docs/models/shared/billcreditnotelineitemitemreference.md rename to lending/docs/models/shared/itemreference.md index aa9e225c3..6f562e713 --- a/lending/docs/models/shared/billcreditnotelineitemitemreference.md +++ b/lending/docs/models/shared/itemreference.md @@ -1,4 +1,4 @@ -# BillCreditNoteLineItemItemReference +# ItemReference Reference to the item the line is linked to. diff --git a/lending/docs/models/shared/items.md b/lending/docs/models/shared/items.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/journalline.md b/lending/docs/models/shared/journalline.md old mode 100755 new mode 100644 index 689da407c..cb5702e44 --- a/lending/docs/models/shared/journalline.md +++ b/lending/docs/models/shared/journalline.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `account_ref` | [Optional[shared.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. | | `currency` | *Optional[str]* | :heavy_minus_sign: | Currency for the journal line item. | | `description` | *Optional[str]* | :heavy_minus_sign: | Description of the journal line item. | | `net_amount` | *Decimal* | :heavy_check_mark: | Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative. | -| `tracking` | [Optional[JournalLineTracking]](../../models/shared/journallinetracking.md) | :heavy_minus_sign: | List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) | \ No newline at end of file +| `tracking` | [Optional[shared.JournalLineTracking]](../../models/shared/journallinetracking.md) | :heavy_minus_sign: | List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.) | \ No newline at end of file diff --git a/lending/docs/models/shared/journallinetracking.md b/lending/docs/models/shared/journallinetracking.md old mode 100755 new mode 100644 index 91cc6cd30..fee5657c8 --- a/lending/docs/models/shared/journallinetracking.md +++ b/lending/docs/models/shared/journallinetracking.md @@ -5,6 +5,6 @@ List of record refs associated with the tracking information for the line (eg to ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `record_refs` | List[[RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `record_refs` | List[[shared.RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/journalref.md b/lending/docs/models/shared/journalref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/journalstatus.md b/lending/docs/models/shared/journalstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/lendingcustomerref.md b/lending/docs/models/shared/lendingcustomerref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/links.md b/lending/docs/models/shared/links.md old mode 100755 new mode 100644 index 7aad1ea5d..5f80d2652 --- a/lending/docs/models/shared/links.md +++ b/lending/docs/models/shared/links.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `current` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | -| `next` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `self_` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `current` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | +| `next` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `previous` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `self_` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/loanref.md b/lending/docs/models/shared/loanref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/loansummary.md b/lending/docs/models/shared/loansummary.md old mode 100755 new mode 100644 index 2095b55b2..c3d0060af --- a/lending/docs/models/shared/loansummary.md +++ b/lending/docs/models/shared/loansummary.md @@ -3,7 +3,7 @@ ## Fields -| 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `report_info` | [Optional[shared.LoanSummaryReportInfo]](../../models/shared/loansummaryreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.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/loansummaryintegrationtype.md b/lending/docs/models/shared/loansummaryintegrationtype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/loansummaryrecordref.md b/lending/docs/models/shared/loansummaryrecordref.md old mode 100755 new mode 100644 index 77889df21..7c201e554 --- a/lending/docs/models/shared/loansummaryrecordref.md +++ b/lending/docs/models/shared/loansummaryrecordref.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The dataConnectionId the object being referred to is associated with. | -| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object being referred to. | -| `integration_type` | [Optional[LoanSummaryIntegrationType]](../../models/shared/loansummaryintegrationtype.md) | :heavy_minus_sign: | The integration type begin referred to. | -| `record_ref_type` | [Optional[LoanSummaryRecordRefType]](../../models/shared/loansummaryrecordreftype.md) | :heavy_minus_sign: | The datatype being referred to. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The dataConnectionId the object being referred to is associated with. | +| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object being referred to. | +| `integration_type` | [Optional[shared.LoanSummaryIntegrationType]](../../models/shared/loansummaryintegrationtype.md) | :heavy_minus_sign: | The integration type begin referred to. | +| `record_ref_type` | [Optional[shared.LoanSummaryRecordRefType]](../../models/shared/loansummaryrecordreftype.md) | :heavy_minus_sign: | The datatype being referred to. | \ No newline at end of file diff --git a/lending/docs/models/shared/loansummaryrecordreftype.md b/lending/docs/models/shared/loansummaryrecordreftype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/loansummaryreportinfo.md b/lending/docs/models/shared/loansummaryreportinfo.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/loansummaryreportitem.md b/lending/docs/models/shared/loansummaryreportitem.md old mode 100755 new mode 100644 index 7330021b3..09188311f --- a/lending/docs/models/shared/loansummaryreportitem.md +++ b/lending/docs/models/shared/loansummaryreportitem.md @@ -8,7 +8,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 | | +| `record_ref` | [Optional[shared.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. | | | `total_repayments` | *Optional[Decimal]* | :heavy_minus_sign: | The total loan repayments which includes capital plus any interest. | | \ No newline at end of file diff --git a/lending/docs/models/shared/loantransactions.md b/lending/docs/models/shared/loantransactions.md old mode 100755 new mode 100644 index 866b23b34..d5ee58a06 --- a/lending/docs/models/shared/loantransactions.md +++ b/lending/docs/models/shared/loantransactions.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `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_info` | [Optional[shared.LoanTransactionsReportInfo]](../../models/shared/loantransactionsreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.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/loantransactionsreportinfo.md b/lending/docs/models/shared/loantransactionsreportinfo.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/reportitemsloantransactiontype.md b/lending/docs/models/shared/loantransactiontype.md old mode 100755 new mode 100644 similarity index 90% rename from lending/docs/models/shared/reportitemsloantransactiontype.md rename to lending/docs/models/shared/loantransactiontype.md index 548c10b9a..ed339ded5 --- a/lending/docs/models/shared/reportitemsloantransactiontype.md +++ b/lending/docs/models/shared/loantransactiontype.md @@ -1,4 +1,4 @@ -# ReportItemsLoanTransactionType +# LoanTransactionType The type of loan transaction. diff --git a/lending/docs/models/shared/locationref.md b/lending/docs/models/shared/locationref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/metadata.md b/lending/docs/models/shared/metadata.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/orderdiscountallocation.md b/lending/docs/models/shared/orderdiscountallocation.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/orderlineitem.md b/lending/docs/models/shared/orderlineitem.md old mode 100755 new mode 100644 index fa5ad253a..1f64e0e94 --- 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[[shared.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. | | +| `product_ref` | [Optional[shared.ProductRef]](../../models/shared/productref.md) | :heavy_minus_sign: | Reference that links the line item to the correct product details. | | +| `product_variant_ref` | [Optional[shared.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 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. | | +| `taxes` | List[[shared.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 old mode 100755 new mode 100644 index b1d90f1c1..2109b3ea3 --- a/lending/docs/models/shared/payment.md +++ b/lending/docs/models/shared/payment.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Payment amount. | | -| `banking_transaction_refs` | List[[BankingTransactionRef](../../models/shared/bankingtransactionref.md)] | :heavy_minus_sign: | N/A | | +| `banking_transaction_refs` | List[[shared.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 | diff --git a/lending/docs/models/shared/paymentallocationpayment.md b/lending/docs/models/shared/paymentallocationpayment.md old mode 100755 new mode 100644 index dca76f389..627046b0f --- a/lending/docs/models/shared/paymentallocationpayment.md +++ b/lending/docs/models/shared/paymentallocationpayment.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | | +| `account_ref` | [Optional[shared.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. | | | `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 \| | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier of the allocated payment. | | diff --git a/lending/docs/models/shared/paymentline.md b/lending/docs/models/shared/paymentline.md old mode 100755 new mode 100644 index e59a9cb01..614f12c86 --- 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[[shared.PaymentLineLink](../../models/shared/paymentlinelink.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentlinelink.md b/lending/docs/models/shared/paymentlinelink.md old mode 100755 new mode 100644 index 785e93142..543314605 --- a/lending/docs/models/shared/paymentlinelink.md +++ b/lending/docs/models/shared/paymentlinelink.md @@ -8,4 +8,4 @@ | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | 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]* | :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: | Unique identifier of the transaction represented by the link. | -| `type` | [PaymentLinkType](../../models/shared/paymentlinktype.md) | :heavy_check_mark: | Types of payment line links, either:
`Unknown`
`Unlinked` - Not used
`Invoice` - ID refers to the invoice
`CreditNote` - ID refers to the credit note
`Refund` - ID refers to the sibling payment
`Payment` - ID refers to the sibling payment
`PaymentOnAccount` - ID refers to the customer
`Other` - ID refers to the customer
`Manual Journal`
`Discount` - ID refers to the payment | \ No newline at end of file +| `type` | [shared.PaymentLinkType](../../models/shared/paymentlinktype.md) | :heavy_check_mark: | Types of payment line links, either:
`Unknown`
`Unlinked` - Not used
`Invoice` - ID refers to the invoice
`CreditNote` - ID refers to the credit note
`Refund` - ID refers to the sibling payment
`Payment` - ID refers to the sibling payment
`PaymentOnAccount` - ID refers to the customer
`Other` - ID refers to the customer
`Manual Journal`
`Discount` - ID refers to the payment | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentlinktype.md b/lending/docs/models/shared/paymentlinktype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/paymentmethodref.md b/lending/docs/models/shared/paymentmethodref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/paymentref.md b/lending/docs/models/shared/paymentref.md old mode 100755 new mode 100644 index 7e0588b0e..c82502ee6 --- a/lending/docs/models/shared/paymentref.md +++ b/lending/docs/models/shared/paymentref.md @@ -13,5 +13,5 @@ | `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | | `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. | | -| `type` | [Optional[PaymentType]](../../models/shared/paymenttype.md) | :heavy_minus_sign: | Type of payment. | Cash | \ No newline at end of file +| `status` | [Optional[shared.PaymentStatus]](../../models/shared/paymentstatus.md) | :heavy_minus_sign: | Status of the payment. | | +| `type` | [Optional[shared.PaymentType]](../../models/shared/paymenttype.md) | :heavy_minus_sign: | Type of payment. | Cash | \ No newline at end of file diff --git a/lending/docs/models/shared/paymentstatus.md b/lending/docs/models/shared/paymentstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/paymenttype.md b/lending/docs/models/shared/paymenttype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/periodunit.md b/lending/docs/models/shared/periodunit.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/phonenumber.md b/lending/docs/models/shared/phonenumber.md old mode 100755 new mode 100644 index 84a85c5e2..f8d17f4f0 --- a/lending/docs/models/shared/phonenumber.md +++ b/lending/docs/models/shared/phonenumber.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `number` | *Optional[str]* | :heavy_check_mark: | A phone number. | +44 25691 154789 | +| `type` | [shared.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/phonenumbertype.md b/lending/docs/models/shared/phonenumbertype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/productinventory.md b/lending/docs/models/shared/productinventory.md old mode 100755 new mode 100644 index a551e7026..78c25b5f2 --- a/lending/docs/models/shared/productinventory.md +++ b/lending/docs/models/shared/productinventory.md @@ -5,7 +5,7 @@ Information about the total inventory as well as the locations inventory is in. ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `locations` | List[[shared.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 old mode 100755 new mode 100644 index 3ebe8cefa..64389948a --- a/lending/docs/models/shared/productinventorylocation.md +++ b/lending/docs/models/shared/productinventorylocation.md @@ -3,7 +3,7 @@ ## Fields -| 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: | The quantity of stock remaining at location. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `location_ref` | [Optional[shared.LocationRef]](../../models/shared/locationref.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | +| `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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/productref.md b/lending/docs/models/shared/productref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/productvariant.md b/lending/docs/models/shared/productvariant.md old mode 100755 new mode 100644 index 70b360a62..ad2cf38bf --- a/lending/docs/models/shared/productvariant.md +++ b/lending/docs/models/shared/productvariant.md @@ -11,14 +11,14 @@ Represents a variation of a product available for sale, for example an item of c | `barcode` | *Optional[str]* | :heavy_minus_sign: | Unique product number of the variant. This might be a barcode, UPC, ISBN, etc. | 564158468416486458646886484 | | `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 | | `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `inventory` | [Optional[ProductInventory]](../../models/shared/productinventory.md) | :heavy_minus_sign: | Information about the total inventory as well as the locations inventory is in. | | +| `inventory` | [Optional[shared.ProductInventory]](../../models/shared/productinventory.md) | :heavy_minus_sign: | Information about the total inventory as well as the locations inventory is in. | | | `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[[shared.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: | The status of the product variant. | | +| `status` | [Optional[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/productvariantstatus.md b/lending/docs/models/shared/productvariantstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/profitandlossreport.md b/lending/docs/models/shared/profitandlossreport.md old mode 100755 new mode 100644 index ed6a18505..7016b162a --- a/lending/docs/models/shared/profitandlossreport.md +++ b/lending/docs/models/shared/profitandlossreport.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost_of_sales` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | -| `expenses` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `cost_of_sales` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | +| `expenses` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | | `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 | | `gross_profit` | *Decimal* | :heavy_check_mark: | Gross profit of the company in the given date range. | | -| `income` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `income` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | | `net_operating_profit` | *Decimal* | :heavy_check_mark: | Net operating profit of the company in the given date range. | | | `net_other_income` | *Decimal* | :heavy_check_mark: | Net other income of the company in the given date range. | | | `net_profit` | *Decimal* | :heavy_check_mark: | Net profit of the company in the given date range. | | -| `other_expenses` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | -| `other_income` | [Optional[ReportLine]](../../models/shared/reportline.md) | :heavy_minus_sign: | N/A | | +| `other_expenses` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | +| `other_income` | [Optional[shared.ReportLineInput]](../../models/shared/reportlineinput.md) | :heavy_minus_sign: | N/A | | | `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/projectref.md b/lending/docs/models/shared/projectref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/propertieitemref.md b/lending/docs/models/shared/propertieitemref.md new file mode 100644 index 000000000..21b9f6a3e --- /dev/null +++ b/lending/docs/models/shared/propertieitemref.md @@ -0,0 +1,11 @@ +# PropertieItemRef + +Reference to the item the line is linked to. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier for the item in the accounting platform. | +| `name` | *Optional[str]* | :heavy_minus_sign: | Name of the item in the accounting platform. | \ No newline at end of file diff --git a/lending/docs/models/shared/pulloperation.md b/lending/docs/models/shared/pulloperation.md old mode 100755 new mode 100644 index 07104cbd5..3e9b34131 --- a/lending/docs/models/shared/pulloperation.md +++ b/lending/docs/models/shared/pulloperation.md @@ -11,11 +11,12 @@ Information about a queued, in progress or completed pull operation. | `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 | +| `data_type` | *str* | :heavy_check_mark: | The data type you are requesting in a pull operation. | | | `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_completed` | *bool* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | | | `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: | The current status of the pull operation. | Complete | \ No newline at end of file +| `status` | [shared.PullOperationStatus](../../models/shared/pulloperationstatus.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | +| `status_description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/lending/docs/models/shared/pulloperations.md b/lending/docs/models/shared/pulloperations.md old mode 100755 new mode 100644 index e15916751..bc8a8c451 --- a/lending/docs/models/shared/pulloperations.md +++ b/lending/docs/models/shared/pulloperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountingbillpurchaseorderreference.md b/lending/docs/models/shared/purchaseorderreference.md old mode 100755 new mode 100644 similarity index 97% rename from lending/docs/models/shared/accountingbillpurchaseorderreference.md rename to lending/docs/models/shared/purchaseorderreference.md index a482a156c..7f2cd820e --- a/lending/docs/models/shared/accountingbillpurchaseorderreference.md +++ b/lending/docs/models/shared/purchaseorderreference.md @@ -1,4 +1,4 @@ -# AccountingBillPurchaseOrderReference +# PurchaseOrderReference ## Fields diff --git a/lending/docs/models/shared/pushchangetype.md b/lending/docs/models/shared/pushchangetype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/pushfieldvalidation.md b/lending/docs/models/shared/pushfieldvalidation.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/pushoperation.md b/lending/docs/models/shared/pushoperation.md old mode 100755 new mode 100644 index 4e0594ecc..4283714b2 --- 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[[shared.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 | +| `data_type` | [Optional[shared.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` | [shared.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 +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index cf6e86896..3238ecf64 --- a/lending/docs/models/shared/pushoperationchange.md +++ b/lending/docs/models/shared/pushoperationchange.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `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: | Type of change being applied to record in third party platform. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `attachment_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | +| `record_ref` | [Optional[shared.PushOperationRef]](../../models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A | +| `type` | [Optional[shared.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 old mode 100755 new mode 100644 index df895faa0..44929acb0 --- a/lending/docs/models/shared/pushoperationref.md +++ b/lending/docs/models/shared/pushoperationref.md @@ -3,7 +3,7 @@ ## Fields -| 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 for a push operation. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_type` | [Optional[shared.DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `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 old mode 100755 new mode 100644 index 1f224ca9b..be6e80331 --- a/lending/docs/models/shared/pushoperations.md +++ b/lending/docs/models/shared/pushoperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `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[[shared.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/pushoperationstatus.md b/lending/docs/models/shared/pushoperationstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/pushoption.md b/lending/docs/models/shared/pushoption.md old mode 100755 new mode 100644 index 72e02d203..e908d0b28 --- a/lending/docs/models/shared/pushoption.md +++ b/lending/docs/models/shared/pushoption.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [shared.PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 index 0b1c9b987..44e988b26 --- a/lending/docs/models/shared/pushoptionchoice.md +++ b/lending/docs/models/shared/pushoptionchoice.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `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[shared.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 old mode 100755 new mode 100644 index c53a8177f..2bedd19d3 --- a/lending/docs/models/shared/pushoptionproperty.md +++ b/lending/docs/models/shared/pushoptionproperty.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `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 +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *str* | :heavy_check_mark: | A description of the property. | +| `display_name` | *str* | :heavy_check_mark: | The property's display name. | +| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [shared.PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/pushvalidationinfo.md b/lending/docs/models/shared/pushvalidationinfo.md old mode 100755 new mode 100644 index bf2fdc062..110eb3f76 --- a/lending/docs/models/shared/pushvalidationinfo.md +++ b/lending/docs/models/shared/pushvalidationinfo.md @@ -3,7 +3,7 @@ ## Fields -| 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 +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `information` | List[[shared.PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[shared.PushFieldValidation](../../models/shared/pushfieldvalidation.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/lending/docs/models/shared/recordlinereference.md b/lending/docs/models/shared/recordlinereference.md new file mode 100644 index 000000000..17e83d195 --- /dev/null +++ b/lending/docs/models/shared/recordlinereference.md @@ -0,0 +1,12 @@ +# RecordLineReference + +Reference to the purchase order line this line was generated from. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `data_type` | [Optional[shared.BillLineItemDataType]](../../models/shared/billlineitemdatatype.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/recordref.md b/lending/docs/models/shared/recordref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/accountsreceivabletrackingrecordreference.md b/lending/docs/models/shared/recordreference.md old mode 100755 new mode 100644 similarity index 96% rename from lending/docs/models/shared/accountsreceivabletrackingrecordreference.md rename to lending/docs/models/shared/recordreference.md index a4b870ff2..e586fb3ba --- a/lending/docs/models/shared/accountsreceivabletrackingrecordreference.md +++ b/lending/docs/models/shared/recordreference.md @@ -1,4 +1,4 @@ -# AccountsReceivableTrackingRecordReference +# RecordReference Links the current record to the underlying record or data type that created it. diff --git a/lending/docs/models/shared/reportbasis.md b/lending/docs/models/shared/reportbasis.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/reportcomponentmeasure.md b/lending/docs/models/shared/reportcomponentmeasure.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/reportinfo.md b/lending/docs/models/shared/reportinfo.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/reportinput.md b/lending/docs/models/shared/reportinput.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/enhancedfinancialreportreportitem.md b/lending/docs/models/shared/reportitem.md old mode 100755 new mode 100644 similarity index 99% rename from lending/docs/models/shared/enhancedfinancialreportreportitem.md rename to lending/docs/models/shared/reportitem.md index bb9a0358d..0f15d03b9 --- a/lending/docs/models/shared/enhancedfinancialreportreportitem.md +++ b/lending/docs/models/shared/reportitem.md @@ -1,11 +1,11 @@ -# EnhancedFinancialReportReportItem +# ReportItem ## Fields | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_category` | [Optional[EnhancedReportAccountCategory]](../../models/shared/enhancedreportaccountcategory.md) | :heavy_minus_sign: | N/A | | +| `account_category` | [Optional[shared.EnhancedReportAccountCategory]](../../models/shared/enhancedreportaccountcategory.md) | :heavy_minus_sign: | N/A | | | `account_id` | *Optional[str]* | :heavy_minus_sign: | The unique account ID. | | | `account_name` | *Optional[str]* | :heavy_minus_sign: | Name of the account. | | | `balance` | *Optional[Decimal]* | :heavy_minus_sign: | Balance of the account as reported on the profit and loss or Balance sheet. | | diff --git a/lending/docs/models/shared/reportitems.md b/lending/docs/models/shared/reportitems.md old mode 100755 new mode 100644 index 61560f5ca..8f17b0c20 --- a/lending/docs/models/shared/reportitems.md +++ b/lending/docs/models/shared/reportitems.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `item_ref` | [Optional[shared.ItemRef]](../../models/shared/itemref.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: | The type of loan transaction. | | \ No newline at end of file +| `loan_ref` | [Optional[shared.LoanRef]](../../models/shared/loanref.md) | :heavy_minus_sign: | N/A | | +| `loan_transaction_type` | [Optional[shared.LoanTransactionType]](../../models/shared/loantransactiontype.md) | :heavy_minus_sign: | The type of loan transaction. | | \ No newline at end of file diff --git a/lending/docs/models/shared/reportline.md b/lending/docs/models/shared/reportline.md old mode 100755 new mode 100644 index 2adc33882..9063243d6 --- 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[[shared.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/reportlineinput.md b/lending/docs/models/shared/reportlineinput.md new file mode 100644 index 000000000..035f5cccd --- /dev/null +++ b/lending/docs/models/shared/reportlineinput.md @@ -0,0 +1,11 @@ +# ReportLineInput + + +## Fields + +| 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[[shared.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/salesorderreference.md b/lending/docs/models/shared/salesorderreference.md new file mode 100644 index 000000000..dcccc67a6 --- /dev/null +++ b/lending/docs/models/shared/salesorderreference.md @@ -0,0 +1,9 @@ +# SalesOrderReference + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `data_type` | [Optional[shared.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/schemadatatype.md b/lending/docs/models/shared/schemadatatype.md new file mode 100644 index 000000000..6f6f50a0c --- /dev/null +++ b/lending/docs/models/shared/schemadatatype.md @@ -0,0 +1,52 @@ +# SchemaDataType + +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 | +| `ITEM_RECEIPTS` | itemReceipts | +| `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/security.md b/lending/docs/models/shared/security.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/servicecharge.md b/lending/docs/models/shared/servicecharge.md old mode 100755 new mode 100644 index 0b098f367..edacda00b --- a/lending/docs/models/shared/servicecharge.md +++ b/lending/docs/models/shared/servicecharge.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | Service charges for this order. | A service charge | -| `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 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 +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `description` | *Optional[str]* | :heavy_minus_sign: | Service charges for this order. | A service charge | +| `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[[shared.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[shared.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/servicechargetype.md b/lending/docs/models/shared/servicechargetype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/sourceref.md b/lending/docs/models/shared/sourceref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/connectionsourcetype.md b/lending/docs/models/shared/sourcetype.md old mode 100755 new mode 100644 similarity index 92% rename from lending/docs/models/shared/connectionsourcetype.md rename to lending/docs/models/shared/sourcetype.md index 85e691690..e32b27ce4 --- a/lending/docs/models/shared/connectionsourcetype.md +++ b/lending/docs/models/shared/sourcetype.md @@ -1,4 +1,4 @@ -# ConnectionSourceType +# SourceType The type of platform of the connection. diff --git a/lending/docs/models/shared/accountingaccounttransactionstatus.md b/lending/docs/models/shared/status.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/models/shared/accountingaccounttransactionstatus.md rename to lending/docs/models/shared/status.md index 2d87f8c9e..8ac4cbbef --- a/lending/docs/models/shared/accountingaccounttransactionstatus.md +++ b/lending/docs/models/shared/status.md @@ -1,4 +1,4 @@ -# AccountingAccountTransactionStatus +# Status The status of the account transaction. diff --git a/lending/docs/models/shared/supplementaldata.md b/lending/docs/models/shared/supplementaldata.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/supplierref.md b/lending/docs/models/shared/supplierref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/supplierstatus.md b/lending/docs/models/shared/supplierstatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/taxcomponentallocation.md b/lending/docs/models/shared/taxcomponentallocation.md old mode 100755 new mode 100644 index 436af3294..d3ede7af5 --- a/lending/docs/models/shared/taxcomponentallocation.md +++ b/lending/docs/models/shared/taxcomponentallocation.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `rate` | *Optional[Decimal]* | :heavy_minus_sign: | Tax amount on order line sale as available from source commerce platform. | -| `tax_component_ref` | [Optional[TaxComponentRef]](../../models/shared/taxcomponentref.md) | :heavy_minus_sign: | Taxes rates reference object depending on the rates being available on source commerce package. | \ No newline at end of file +| `tax_component_ref` | [Optional[shared.TaxComponentRef]](../../models/shared/taxcomponentref.md) | :heavy_minus_sign: | Taxes rates reference object depending on the rates being available on source commerce package. | \ No newline at end of file diff --git a/lending/docs/models/shared/taxcomponentref.md b/lending/docs/models/shared/taxcomponentref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/taxrateref.md b/lending/docs/models/shared/taxrateref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/billcreditnotelineitemtaxratereference.md b/lending/docs/models/shared/taxratereference.md old mode 100755 new mode 100644 similarity index 97% rename from lending/docs/models/shared/billcreditnotelineitemtaxratereference.md rename to lending/docs/models/shared/taxratereference.md index d400c0ec8..c915cee4c --- a/lending/docs/models/shared/billcreditnotelineitemtaxratereference.md +++ b/lending/docs/models/shared/taxratereference.md @@ -1,4 +1,4 @@ -# BillCreditNoteLineItemTaxRateReference +# TaxRateReference 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/docs/models/shared/tracking.md b/lending/docs/models/shared/tracking.md old mode 100755 new mode 100644 index bd0549de8..4298234d4 --- a/lending/docs/models/shared/tracking.md +++ b/lending/docs/models/shared/tracking.md @@ -5,5 +5,5 @@ | 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 +| `invoice_to` | [Optional[shared.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[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactioncategory.md b/lending/docs/models/shared/transactioncategory.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactioncategoryref.md b/lending/docs/models/shared/transactioncategoryref.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactioncategorystatus.md b/lending/docs/models/shared/transactioncategorystatus.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactioncode.md b/lending/docs/models/shared/transactioncode.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactionsourceref.md b/lending/docs/models/shared/transactionsourceref.md old mode 100755 new mode 100644 index 5336242fc..954f41e14 --- a/lending/docs/models/shared/transactionsourceref.md +++ b/lending/docs/models/shared/transactionsourceref.md @@ -3,7 +3,7 @@ ## Fields -| 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: | The type of source the transaction arose. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | The unique identitifer of the record being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `type` | [shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transactiontype.md b/lending/docs/models/shared/transactiontype.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/transferaccount.md b/lending/docs/models/shared/transferaccount.md old mode 100755 new mode 100644 index 39a94a454..239cee664 --- a/lending/docs/models/shared/transferaccount.md +++ b/lending/docs/models/shared/transferaccount.md @@ -7,6 +7,6 @@ Account details of the account sending or receiving the transfer. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | | +| `account_ref` | [Optional[shared.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. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount transferred between accounts. | | | `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/weblinktype.md b/lending/docs/models/shared/type.md old mode 100755 new mode 100644 similarity index 92% rename from lending/docs/models/shared/weblinktype.md rename to lending/docs/models/shared/type.md index b64167deb..595fc09c0 --- a/lending/docs/models/shared/weblinktype.md +++ b/lending/docs/models/shared/type.md @@ -1,4 +1,4 @@ -# WebLinkType +# Type The type of the weblink. diff --git a/lending/docs/models/shared/validation.md b/lending/docs/models/shared/validation.md old mode 100755 new mode 100644 index 294281b51..4cfc544dc --- a/lending/docs/models/shared/validation.md +++ b/lending/docs/models/shared/validation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made when push ## Fields -| 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `errors` | List[[shared.ValidationItem](../../models/shared/validationitem.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[shared.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 old mode 100755 new mode 100644 diff --git a/lending/docs/models/shared/validdatatypelinks.md b/lending/docs/models/shared/validdatatypelinks.md new file mode 100644 index 000000000..61f7858d8 --- /dev/null +++ b/lending/docs/models/shared/validdatatypelinks.md @@ -0,0 +1,50 @@ +# ValidDataTypeLinks + +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. + +For example, `validDatatypeLinks` might indicate the following references: + +- Which tax rates are valid to use on the line item of a bill. +- Which items can be used when creating an invoice. + +You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. + +## `validDatatypeLinks` example + +The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error. + +```json validDatatypeLinks for an account +{ + "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", + "nominalCode": "090", + "name": "Business Bank Account", + #... + "validDatatypeLinks": [ + { + "property": "Id", + "links": [ + "Payment.AccountRef.Id", + "BillPayment.AccountRef.Id", + "DirectIncome.LineItems.AccountRef.Id", + "DirectCost.LineItems.AccountRef.Id" + ] + } + ] + } +``` + + + +## Support for `validDatatypeLinks` + +Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. + +If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `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/weblink.md b/lending/docs/models/shared/weblink.md old mode 100755 new mode 100644 index a61aba7f3..2a5dfd3c5 --- a/lending/docs/models/shared/weblink.md +++ b/lending/docs/models/shared/weblink.md @@ -5,7 +5,7 @@ Weblink associated with the company. ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `type` | [Optional[WebLinkType]](../../models/shared/weblinktype.md) | :heavy_minus_sign: | The type of the weblink. | -| `url` | *Optional[str]* | :heavy_minus_sign: | The full URL for the weblink. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `type` | [Optional[shared.Type]](../../models/shared/type.md) | :heavy_minus_sign: | The type of the weblink. | +| `url` | *Optional[str]* | :heavy_minus_sign: | The full URL for the weblink. | \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillwithholdingtax.md b/lending/docs/models/shared/withholdingtax.md old mode 100755 new mode 100644 similarity index 94% rename from lending/docs/models/shared/accountingbillwithholdingtax.md rename to lending/docs/models/shared/withholdingtax.md index c12239ded..277b9561e --- a/lending/docs/models/shared/accountingbillwithholdingtax.md +++ b/lending/docs/models/shared/withholdingtax.md @@ -1,4 +1,4 @@ -# AccountingBillWithholdingTax +# WithholdingTax ## Fields diff --git a/lending/docs/models/utils/retryconfig.md b/lending/docs/models/utils/retryconfig.md old mode 100755 new mode 100644 diff --git a/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md b/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md old mode 100755 new mode 100644 index 4f66e0321..0890e04a8 --- a/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md +++ b/lending/docs/models/webhooks/accountcategoriesupdatedresponse.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index 690170c94..4408f824d --- a/lending/docs/models/webhooks/clientratelimitreachedresponse.md +++ b/lending/docs/models/webhooks/clientratelimitreachedresponse.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | 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 old mode 100755 new mode 100644 index 9fdae0007..14a24dc94 --- a/lending/docs/models/webhooks/clientratelimitresetresponse.md +++ b/lending/docs/models/webhooks/clientratelimitresetresponse.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `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 +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/lending/docs/sdks/bankingaccountbalances/README.md b/lending/docs/sdks/accountbalances/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/bankingaccountbalances/README.md rename to lending/docs/sdks/accountbalances/README.md index 340dfd8de..5cbaab723 --- a/lending/docs/sdks/bankingaccountbalances/README.md +++ b/lending/docs/sdks/accountbalances/README.md @@ -1,4 +1,4 @@ -# BankingAccountBalances +# AccountBalances (*banking.account_balances*) ### Available Operations @@ -52,4 +52,9 @@ if res.banking_account_balances is not None: ### Response **[operations.ListBankingAccountBalancesResponse](../../models/operations/listbankingaccountbalancesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountingbankdataaccounts/README.md b/lending/docs/sdks/accounts/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/accountingbankdataaccounts/README.md rename to lending/docs/sdks/accounts/README.md index 808bdb076..d43632fdc --- a/lending/docs/sdks/accountingbankdataaccounts/README.md +++ b/lending/docs/sdks/accounts/README.md @@ -1,4 +1,4 @@ -# AccountingBankDataAccounts +# Accounts (*accounting_bank_data.accounts*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBankAccountRequest( - account_id='Northeast Hatchback Kia', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -53,7 +53,12 @@ if res.accounting_bank_account is not None: ### Response **[operations.GetAccountingBankAccountResponse](../../models/operations/getaccountingbankaccountresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.accounting_bank_accounts is not None: ### Response **[operations.ListAccountingBankAccountsResponse](../../models/operations/listaccountingbankaccountsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountspayable/README.md b/lending/docs/sdks/accountspayable/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/accountsreceivable/README.md b/lending/docs/sdks/accountsreceivable/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/transactionsaccounttransactions/README.md b/lending/docs/sdks/accounttransactions/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/transactionsaccounttransactions/README.md rename to lending/docs/sdks/accounttransactions/README.md index 814520547..99094ffd0 --- a/lending/docs/sdks/transactionsaccounttransactions/README.md +++ b/lending/docs/sdks/accounttransactions/README.md @@ -1,4 +1,4 @@ -# TransactionsAccountTransactions +# AccountTransactions (*transactions.account_transactions*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingAccountTransactionRequest( - account_transaction_id='Northeast Hatchback Kia', + account_transaction_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -53,7 +53,12 @@ if res.accounting_account_transaction is not None: ### Response **[operations.GetAccountingAccountTransactionResponse](../../models/operations/getaccountingaccounttransactionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.accounting_account_transactions is not None: ### Response **[operations.ListAccountingAccountTransactionsResponse](../../models/operations/listaccountingaccounttransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/financialstatementsbalancesheet/README.md b/lending/docs/sdks/balancesheet/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/financialstatementsbalancesheet/README.md rename to lending/docs/sdks/balancesheet/README.md index a0a3a7bec..65a2bc47c --- a/lending/docs/sdks/financialstatementsbalancesheet/README.md +++ b/lending/docs/sdks/balancesheet/README.md @@ -1,4 +1,4 @@ -# FinancialStatementsBalanceSheet +# BalanceSheet (*financial_statements.balance_sheet*) ### Available Operations @@ -47,7 +47,12 @@ if res.accounting_balance_sheet is not None: ### Response **[operations.GetAccountingBalanceSheetResponse](../../models/operations/getaccountingbalancesheetresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_categorized_accounts @@ -90,4 +95,9 @@ if res.enhanced_financial_report is not None: ### Response **[operations.GetCategorizedBalanceSheetStatementResponse](../../models/operations/getcategorizedbalancesheetstatementresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/bankaccounts/README.md b/lending/docs/sdks/bankaccounts/README.md new file mode 100644 index 000000000..0b57a476f --- /dev/null +++ b/lending/docs/sdks/bankaccounts/README.md @@ -0,0 +1,130 @@ +# BankAccounts +(*loan_writeback.bank_accounts*) + +### 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/lending-api#/schemas/BankAccount) for a given company's connection. + +[Bank accounts](https://docs.codat.io/lending-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/lending-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( + 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={ + 'key': { + 'key': 'string', + }, + }, + ), + ), + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', +) + +res = s.loan_writeback.bank_accounts.create(req) + +if res.accounting_create_bank_account_response is not None: + # handle response + pass +``` + +### 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)** +### Errors + +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | + +## 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/lending-api#/schemas/BankAccount) for a given company and integration. + +[Bank accounts](https://docs.codat.io/lending-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 + pass +``` + +### 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)** +### Errors + +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/banking/README.md b/lending/docs/sdks/banking/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/loanwritebackbanktransactions/README.md b/lending/docs/sdks/banktransactions/README.md old mode 100755 new mode 100644 similarity index 88% rename from lending/docs/sdks/loanwritebackbanktransactions/README.md rename to lending/docs/sdks/banktransactions/README.md index c2ed98c0d..e266b2ac9 --- a/lending/docs/sdks/loanwritebackbanktransactions/README.md +++ b/lending/docs/sdks/banktransactions/README.md @@ -1,4 +1,4 @@ -# LoanWritebackBankTransactions +# BankTransactions (*loan_writeback.bank_transactions*) ### Available Operations @@ -41,7 +41,7 @@ req = operations.CreateBankTransactionsRequest( ), ], ), - account_id='Extended South', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -64,7 +64,12 @@ if res.accounting_create_bank_transactions_response is not None: ### Response **[operations.CreateBankTransactionsResponse](../../models/operations/createbanktransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_model @@ -92,7 +97,7 @@ s = codatlending.CodatLending( ) req = operations.GetCreateBankTransactionsModelRequest( - account_id='Northwest', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -115,4 +120,9 @@ if res.push_option is not None: ### Response **[operations.GetCreateBankTransactionsModelResponse](../../models/operations/getcreatebanktransactionsmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountspayablebillcreditnotes/README.md b/lending/docs/sdks/billcreditnotes/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/accountspayablebillcreditnotes/README.md rename to lending/docs/sdks/billcreditnotes/README.md index 2ee4634f9..939a04b94 --- a/lending/docs/sdks/accountspayablebillcreditnotes/README.md +++ b/lending/docs/sdks/billcreditnotes/README.md @@ -1,4 +1,4 @@ -# AccountsPayableBillCreditNotes +# BillCreditNotes (*accounts_payable.bill_credit_notes*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillCreditNoteRequest( - bill_credit_note_id='Northeast Hatchback Kia', + bill_credit_note_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -52,7 +52,12 @@ if res.accounting_bill_credit_note is not None: ### Response **[operations.GetAccountingBillCreditNoteResponse](../../models/operations/getaccountingbillcreditnoteresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_bill_credit_notes is not None: ### Response **[operations.ListAccountingBillCreditNotesResponse](../../models/operations/listaccountingbillcreditnotesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountspayablebillpayments/README.md b/lending/docs/sdks/billpayments/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/accountspayablebillpayments/README.md rename to lending/docs/sdks/billpayments/README.md index 43ed4c8bb..2cbd17be4 --- a/lending/docs/sdks/accountspayablebillpayments/README.md +++ b/lending/docs/sdks/billpayments/README.md @@ -1,4 +1,4 @@ -# AccountsPayableBillPayments +# BillPayments (*accounts_payable.bill_payments*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillPaymentRequest( - bill_payment_id='Northeast Hatchback Kia', + bill_payment_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -52,7 +52,12 @@ if res.accounting_bill_payment is not None: ### Response **[operations.GetAccountingBillPaymentResponse](../../models/operations/getaccountingbillpaymentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_bill_payments is not None: ### Response **[operations.ListAccountingBillPaymentsResponse](../../models/operations/listaccountingbillpaymentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountspayablebills/README.md b/lending/docs/sdks/bills/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountspayablebills/README.md rename to lending/docs/sdks/bills/README.md index 926c1555c..5a232d156 --- a/lending/docs/sdks/accountspayablebills/README.md +++ b/lending/docs/sdks/bills/README.md @@ -1,4 +1,4 @@ -# AccountsPayableBills +# Bills (*accounts_payable.bills*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.DownloadAccountingBillAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', - bill_id='Dakota Avon specifically', + bill_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -55,7 +55,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingBillAttachmentResponse](../../models/operations/downloadaccountingbillattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -81,7 +86,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingBillRequest( - bill_id='Northeast Hatchback Kia', + bill_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -103,7 +108,12 @@ if res.accounting_bill is not None: ### Response **[operations.GetAccountingBillResponse](../../models/operations/getaccountingbillresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -128,7 +138,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingBillAttachmentRequest( attachment_id='8a210b68-6988-11ed-a1eb-0242ac120002', - bill_id='array East along', + bill_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -151,7 +161,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingBillAttachmentResponse](../../models/operations/getaccountingbillattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -199,7 +214,12 @@ if res.accounting_bills is not None: ### Response **[operations.ListAccountingBillsResponse](../../models/operations/listaccountingbillsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -223,7 +243,7 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBillAttachmentsRequest( - bill_id='intuitive Frozen ouch', + bill_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -246,4 +266,9 @@ if res.attachments is not None: ### Response **[operations.ListAccountingBillAttachmentsResponse](../../models/operations/listaccountingbillattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/financialstatementscashflow/README.md b/lending/docs/sdks/cashflow/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/financialstatementscashflow/README.md rename to lending/docs/sdks/cashflow/README.md index c3405248e..3d633b60e --- a/lending/docs/sdks/financialstatementscashflow/README.md +++ b/lending/docs/sdks/cashflow/README.md @@ -1,4 +1,4 @@ -# FinancialStatementsCashFlow +# CashFlow (*financial_statements.cash_flow*) ### Available Operations @@ -46,4 +46,9 @@ if res.accounting_cash_flow_statement is not None: ### Response **[operations.GetAccountingCashFlowStatementResponse](../../models/operations/getaccountingcashflowstatementresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/bankingcategorizedstatement/README.md b/lending/docs/sdks/categorizedstatement/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/bankingcategorizedstatement/README.md rename to lending/docs/sdks/categorizedstatement/README.md index da87524d3..45c0cb5b4 --- a/lending/docs/sdks/bankingcategorizedstatement/README.md +++ b/lending/docs/sdks/categorizedstatement/README.md @@ -1,4 +1,4 @@ -# BankingCategorizedStatement +# CategorizedStatement (*banking.categorized_statement*) ### Available Operations @@ -49,4 +49,9 @@ if res.enhanced_cash_flow_transactions is not None: ### Response **[operations.GetCategorizedBankStatementResponse](../../models/operations/getcategorizedbankstatementresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/codatlending/README.md b/lending/docs/sdks/codatlending/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/accountingbankdata/README.md b/lending/docs/sdks/codatlendingaccountingbankdata/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountingbankdata/README.md rename to lending/docs/sdks/codatlendingaccountingbankdata/README.md index 672af50c6..a158e8fe7 --- a/lending/docs/sdks/accountingbankdata/README.md +++ b/lending/docs/sdks/codatlendingaccountingbankdata/README.md @@ -1,4 +1,4 @@ -# AccountingBankData +# CodatLendingAccountingBankData (*accounting_bank_data*) ## Overview @@ -33,7 +33,7 @@ s = codatlending.CodatLending( ) req = operations.ListAccountingBankAccountTransactionsRequest( - account_id='Anchorage Product', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', order_by='-modifiedDate', @@ -59,4 +59,9 @@ if res.accounting_bank_transactions is not None: ### Response **[operations.ListAccountingBankAccountTransactionsResponse](../../models/operations/listaccountingbankaccounttransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/bankingaccounts/README.md b/lending/docs/sdks/codatlendingaccounts/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/bankingaccounts/README.md rename to lending/docs/sdks/codatlendingaccounts/README.md index 9fb5a1161..36b8ebef6 --- a/lending/docs/sdks/bankingaccounts/README.md +++ b/lending/docs/sdks/codatlendingaccounts/README.md @@ -1,4 +1,4 @@ -# BankingAccounts +# CodatLendingAccounts (*banking.accounts*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetBankingAccountRequest( - account_id='Northeast Hatchback Kia', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -53,7 +53,12 @@ if res.banking_account is not None: ### Response **[operations.GetBankingAccountResponse](../../models/operations/getbankingaccountresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.banking_accounts is not None: ### Response **[operations.ListBankingAccountsResponse](../../models/operations/listbankingaccountsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/bankingtransactions/README.md b/lending/docs/sdks/codatlendingbankingtransactions/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/bankingtransactions/README.md rename to lending/docs/sdks/codatlendingbankingtransactions/README.md index 0e2f61c9a..0c205085b --- a/lending/docs/sdks/bankingtransactions/README.md +++ b/lending/docs/sdks/codatlendingbankingtransactions/README.md @@ -1,4 +1,4 @@ -# BankingTransactions +# CodatLendingBankingTransactions (*banking.transactions*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetBankingTransactionRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_id='Northeast Hatchback Kia', + transaction_id='string', ) res = s.banking.transactions.get(req) @@ -53,7 +53,12 @@ if res.banking_transaction is not None: ### Response **[operations.GetBankingTransactionResponse](../../models/operations/getbankingtransactionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.banking_transactions is not None: ### Response **[operations.ListBankingTransactionsResponse](../../models/operations/listbankingtransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salescustomers/README.md b/lending/docs/sdks/codatlendingcustomers/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/salescustomers/README.md rename to lending/docs/sdks/codatlendingcustomers/README.md index 72d2fe0e3..b9d481807 --- a/lending/docs/sdks/salescustomers/README.md +++ b/lending/docs/sdks/codatlendingcustomers/README.md @@ -1,4 +1,4 @@ -# SalesCustomers +# CodatLendingCustomers (*sales.customers*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceCustomerRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='Northeast Hatchback Kia', + customer_id='string', ) res = s.sales.customers.get(req) @@ -53,7 +53,12 @@ if res.commerce_customer is not None: ### Response **[operations.GetCommerceCustomerResponse](../../models/operations/getcommercecustomerresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_customers is not None: ### Response **[operations.ListCommerceCustomersResponse](../../models/operations/listcommercecustomersresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/transactionsdirectcosts/README.md b/lending/docs/sdks/codatlendingdirectcosts/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/transactionsdirectcosts/README.md rename to lending/docs/sdks/codatlendingdirectcosts/README.md index a6a03267c..c73bfbb19 --- a/lending/docs/sdks/transactionsdirectcosts/README.md +++ b/lending/docs/sdks/codatlendingdirectcosts/README.md @@ -1,4 +1,4 @@ -# TransactionsDirectCosts +# CodatLendingDirectCosts (*transactions.direct_costs*) ### Available Operations @@ -34,7 +34,7 @@ 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='Dakota Avon specifically', + direct_cost_id='string', ) res = s.transactions.direct_costs.download_attachment(req) @@ -55,7 +55,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingDirectCostAttachmentResponse](../../models/operations/downloadaccountingdirectcostattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -83,7 +88,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingDirectCostRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='Northeast Hatchback Kia', + direct_cost_id='string', ) res = s.transactions.direct_costs.get(req) @@ -104,7 +109,12 @@ if res.accounting_direct_cost is not None: ### Response **[operations.GetAccountingDirectCostResponse](../../models/operations/getaccountingdirectcostresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -131,7 +141,7 @@ 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='array East along', + direct_cost_id='string', ) res = s.transactions.direct_costs.get_attachment(req) @@ -152,7 +162,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingDirectCostAttachmentResponse](../../models/operations/getaccountingdirectcostattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -201,7 +216,12 @@ if res.accounting_direct_costs is not None: ### Response **[operations.ListAccountingDirectCostsResponse](../../models/operations/listaccountingdirectcostsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -227,7 +247,7 @@ s = codatlending.CodatLending( req = operations.ListAccountingDirectCostAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_cost_id='intuitive Frozen ouch', + direct_cost_id='string', ) res = s.transactions.direct_costs.list_attachments(req) @@ -248,4 +268,9 @@ if res.attachments is not None: ### Response **[operations.ListAccountingDirectCostAttachmentsResponse](../../models/operations/listaccountingdirectcostattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/financialstatementsaccounts/README.md b/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/financialstatementsaccounts/README.md rename to lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md index 8e761579e..28631c9f9 --- a/lending/docs/sdks/financialstatementsaccounts/README.md +++ b/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md @@ -1,4 +1,4 @@ -# FinancialStatementsAccounts +# CodatLendingFinancialStatementsAccounts (*financial_statements.accounts*) ### Available Operations @@ -30,7 +30,7 @@ s = codatlending.CodatLending( ) req = operations.GetAccountingAccountRequest( - account_id='Northeast Hatchback Kia', + account_id='string', company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -52,7 +52,12 @@ if res.accounting_account is not None: ### Response **[operations.GetAccountingAccountResponse](../../models/operations/getaccountingaccountresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -99,4 +104,9 @@ if res.accounting_accounts is not None: ### Response **[operations.ListAccountingAccountsResponse](../../models/operations/listaccountingaccountsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwritebackaccounts/README.md b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/loanwritebackaccounts/README.md rename to lending/docs/sdks/codatlendingloanwritebackaccounts/README.md index c9284c24e..02e0309df --- a/lending/docs/sdks/loanwritebackaccounts/README.md +++ b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md @@ -1,4 +1,4 @@ -# LoanWritebackAccounts +# CodatLendingLoanWritebackAccounts (*loan_writeback.accounts*) ### Available Operations @@ -33,31 +33,27 @@ s = codatlending.CodatLending( ) req = operations.CreateAccountRequest( - accounting_account=shared.AccountingAccount( + account_prototype=shared.AccountPrototype( currency='USD', current_balance=Decimal('0'), description='Invoices the business has issued but has not yet collected payment on.', fully_qualified_category='Asset.Current', fully_qualified_name='Cash On Hand', - id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e', - metadata=shared.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', + 'key': { + 'key': 'string', }, }, ), type=shared.AccountType.ASSET, valid_datatype_links=[ - shared.AccountingAccountValidDataTypeLinks( + shared.ValidDataTypeLinks( links=[ - 'abnormally', + 'string', ], ), ], @@ -84,7 +80,12 @@ if res.accounting_create_account_response is not None: ### Response **[operations.CreateAccountResponse](../../models/operations/createaccountresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_model @@ -134,4 +135,9 @@ if res.push_option is not None: ### Response **[operations.GetCreateChartOfAccountsModelResponse](../../models/operations/getcreatechartofaccountsmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwritebackpayments/README.md b/lending/docs/sdks/codatlendingpayments/README.md old mode 100755 new mode 100644 similarity index 71% rename from lending/docs/sdks/loanwritebackpayments/README.md rename to lending/docs/sdks/codatlendingpayments/README.md index 92d7af8e4..5bd2210dc --- a/lending/docs/sdks/loanwritebackpayments/README.md +++ b/lending/docs/sdks/codatlendingpayments/README.md @@ -1,4 +1,4 @@ -# LoanWritebackPayments +# CodatLendingPayments (*loan_writeback.payments*) ### Available Operations @@ -59,8 +59,8 @@ req = operations.CreatePaymentRequest( source_modified_date='2022-10-23T00:00:00.000Z', supplemental_data=shared.SupplementalData( content={ - "blue": { - "shred": 'abnormally', + 'key': { + 'key': 'string', }, }, ), @@ -87,7 +87,12 @@ if res.accounting_create_payment_response is not None: ### Response **[operations.CreatePaymentResponse](../../models/operations/createpaymentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_model @@ -114,7 +119,7 @@ s = codatlending.CodatLending( ), ) -req = operations.GetCreatePaymentsModelRequest( +req = operations.GetCreatePaymentModelRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -128,13 +133,18 @@ if res.push_option is not None: ### 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. | +| Parameter | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetCreatePaymentModelRequest](../../models/operations/getcreatepaymentmodelrequest.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)** +**[operations.GetCreatePaymentModelResponse](../../models/operations/getcreatepaymentmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesreports/README.md b/lending/docs/sdks/codatlendingreports/README.md old mode 100755 new mode 100644 similarity index 89% rename from lending/docs/sdks/salesreports/README.md rename to lending/docs/sdks/codatlendingreports/README.md index c3f863e87..64e0d87c2 --- a/lending/docs/sdks/salesreports/README.md +++ b/lending/docs/sdks/codatlendingreports/README.md @@ -1,4 +1,4 @@ -# SalesReports +# CodatLendingReports (*sales.reports*) ### Available Operations @@ -72,7 +72,12 @@ if res.commerce_report is not None: ### Response **[operations.GetCommerceOrdersReportResponse](../../models/operations/getcommerceordersreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_refunds @@ -141,4 +146,9 @@ if res.commerce_report is not None: ### Response **[operations.GetCommerceRefundsReportResponse](../../models/operations/getcommercerefundsreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salespayments/README.md b/lending/docs/sdks/codatlendingsalespayments/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/salespayments/README.md rename to lending/docs/sdks/codatlendingsalespayments/README.md index e42f3b12a..74905d55f --- a/lending/docs/sdks/salespayments/README.md +++ b/lending/docs/sdks/codatlendingsalespayments/README.md @@ -1,4 +1,4 @@ -# SalesPayments +# CodatLendingSalesPayments (*sales.payments*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommercePaymentRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_id='Northeast Hatchback Kia', + payment_id='string', ) res = s.sales.payments.get(req) @@ -53,7 +53,12 @@ if res.commerce_payment is not None: ### Response **[operations.GetCommercePaymentResponse](../../models/operations/getcommercepaymentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_payments is not None: ### Response **[operations.ListCommercePaymentsResponse](../../models/operations/listcommercepaymentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwritebacksuppliers/README.md b/lending/docs/sdks/codatlendingsuppliers/README.md old mode 100755 new mode 100644 similarity index 88% rename from lending/docs/sdks/loanwritebacksuppliers/README.md rename to lending/docs/sdks/codatlendingsuppliers/README.md index e819ad9b7..64731c64c --- a/lending/docs/sdks/loanwritebacksuppliers/README.md +++ b/lending/docs/sdks/codatlendingsuppliers/README.md @@ -1,4 +1,4 @@ -# LoanWritebackSuppliers +# CodatLendingSuppliers (*loan_writeback.suppliers*) ### Available Operations @@ -45,8 +45,8 @@ req = operations.CreateSupplierRequest( status=shared.SupplierStatus.ACTIVE, supplemental_data=shared.SupplementalData( content={ - "innovative": { - "blue": 'shred', + 'key': { + 'key': 'string', }, }, ), @@ -73,7 +73,12 @@ if res.accounting_create_supplier_response is not None: ### Response **[operations.CreateSupplierResponse](../../models/operations/createsupplierresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_update_model @@ -123,4 +128,9 @@ if res.push_option is not None: ### Response **[operations.GetCreateUpdateSuppliersModelResponse](../../models/operations/getcreateupdatesuppliersmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salestransactions/README.md b/lending/docs/sdks/codatlendingtransactions/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/salestransactions/README.md rename to lending/docs/sdks/codatlendingtransactions/README.md index ae06f9120..eb35c0e04 --- a/lending/docs/sdks/salestransactions/README.md +++ b/lending/docs/sdks/codatlendingtransactions/README.md @@ -1,4 +1,4 @@ -# SalesTransactions +# CodatLendingTransactions (*sales.transactions*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceTransactionRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_id='Northeast Hatchback Kia', + transaction_id='string', ) res = s.sales.transactions.get(req) @@ -53,7 +53,12 @@ if res.commerce_transaction is not None: ### Response **[operations.GetCommerceTransactionResponse](../../models/operations/getcommercetransactionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_transactions is not None: ### Response **[operations.ListCommerceTransactionsResponse](../../models/operations/listcommercetransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/transactionstransfers/README.md b/lending/docs/sdks/codatlendingtransfers/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/transactionstransfers/README.md rename to lending/docs/sdks/codatlendingtransfers/README.md index cca5b8d5e..b54c13b5c --- a/lending/docs/sdks/transactionstransfers/README.md +++ b/lending/docs/sdks/codatlendingtransfers/README.md @@ -1,4 +1,4 @@ -# TransactionsTransfers +# CodatLendingTransfers (*transactions.transfers*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingTransferRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transfer_id='Northeast Hatchback Kia', + transfer_id='string', ) res = s.transactions.transfers.get(req) @@ -53,7 +53,12 @@ if res.accounting_transfer is not None: ### Response **[operations.GetAccountingTransferResponse](../../models/operations/getaccountingtransferresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.accounting_transfers is not None: ### Response **[operations.ListAccountingTransfersResponse](../../models/operations/listaccountingtransfersresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/companies/README.md b/lending/docs/sdks/companies/README.md old mode 100755 new mode 100644 index 6f6e266f7..124eb4a62 --- a/lending/docs/sdks/companies/README.md +++ b/lending/docs/sdks/companies/README.md @@ -56,7 +56,12 @@ if res.company is not None: ### Response **[operations.CreateCompanyResponse](../../models/operations/createcompanyresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 400,401,402,403,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## delete @@ -97,7 +102,12 @@ if res.status_code == 200: ### Response **[operations.DeleteCompanyResponse](../../models/operations/deletecompanyresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -137,7 +147,12 @@ if res.company is not None: ### Response **[operations.GetCompanyResponse](../../models/operations/getcompanyresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -179,7 +194,12 @@ if res.companies is not None: ### Response **[operations.ListCompaniesResponse](../../models/operations/listcompaniesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## update @@ -223,4 +243,9 @@ if res.company is not None: ### Response **[operations.UpdateCompanyResponse](../../models/operations/updatecompanyresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/companyinfo/README.md b/lending/docs/sdks/companyinfo/README.md old mode 100755 new mode 100644 index fb19f15d1..b2fda43ed --- a/lending/docs/sdks/companyinfo/README.md +++ b/lending/docs/sdks/companyinfo/README.md @@ -48,13 +48,20 @@ if res.accounting_company_info is not None: ### Response **[operations.GetAccountingProfileResponse](../../models/operations/getaccountingprofileresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_profile -Retrieve information about the company, as seen in the commerce platform. +Retrieve information about the company, as seen in the commerce +platform. -This may include information like addresses, tax registration details and social media or website information. +This may include information like addresses, tax registration details and +social media or website information." ### Example Usage @@ -91,4 +98,9 @@ if res.commerce_company_info is not None: ### Response **[operations.GetCommerceProfileResponse](../../models/operations/getcommerceprofileresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/connections/README.md b/lending/docs/sdks/connections/README.md old mode 100755 new mode 100644 index 5b498e3cd..25d73b6da --- a/lending/docs/sdks/connections/README.md +++ b/lending/docs/sdks/connections/README.md @@ -56,7 +56,12 @@ if res.connection is not None: ### Response **[operations.CreateConnectionResponse](../../models/operations/createconnectionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## delete @@ -98,7 +103,12 @@ if res.status_code == 200: ### Response **[operations.DeleteConnectionResponse](../../models/operations/deleteconnectionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -139,7 +149,12 @@ if res.connection is not None: ### Response **[operations.GetConnectionResponse](../../models/operations/getconnectionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -182,7 +197,12 @@ if res.connections is not None: ### Response **[operations.ListConnectionsResponse](../../models/operations/listconnectionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## unlink @@ -224,4 +244,9 @@ if res.connection is not None: ### Response **[operations.UnlinkConnectionResponse](../../models/operations/unlinkconnectionresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwritebackcreateoperations/README.md b/lending/docs/sdks/createoperations/README.md old mode 100755 new mode 100644 similarity index 84% rename from lending/docs/sdks/loanwritebackcreateoperations/README.md rename to lending/docs/sdks/createoperations/README.md index 826603a56..19999e8a1 --- a/lending/docs/sdks/loanwritebackcreateoperations/README.md +++ b/lending/docs/sdks/createoperations/README.md @@ -1,4 +1,4 @@ -# LoanWritebackCreateOperations +# CreateOperations (*loan_writeback.create_operations*) ### Available Operations @@ -45,7 +45,12 @@ if res.push_operation is not None: ### Response **[operations.GetCreateOperationResponse](../../models/operations/getcreateoperationresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -88,4 +93,9 @@ if res.push_operations is not None: ### Response **[operations.ListCreateOperationsResponse](../../models/operations/listcreateoperationsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountsreceivablecreditnotes/README.md b/lending/docs/sdks/creditnotes/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/accountsreceivablecreditnotes/README.md rename to lending/docs/sdks/creditnotes/README.md index d14747767..f4ad875dc --- a/lending/docs/sdks/accountsreceivablecreditnotes/README.md +++ b/lending/docs/sdks/creditnotes/README.md @@ -1,4 +1,4 @@ -# AccountsReceivableCreditNotes +# CreditNotes (*accounts_receivable.credit_notes*) ### Available Operations @@ -31,7 +31,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingCreditNoteRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - credit_note_id='Northeast Hatchback Kia', + credit_note_id='string', ) res = s.accounts_receivable.credit_notes.get(req) @@ -52,7 +52,12 @@ if res.accounting_credit_note is not None: ### Response **[operations.GetAccountingCreditNoteResponse](../../models/operations/getaccountingcreditnoteresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_credit_notes is not None: ### Response **[operations.ListAccountingCreditNotesResponse](../../models/operations/listaccountingcreditnotesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountsreceivablecustomers/README.md b/lending/docs/sdks/customers/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountsreceivablecustomers/README.md rename to lending/docs/sdks/customers/README.md index af39e7bab..cce1b50b4 --- a/lending/docs/sdks/accountsreceivablecustomers/README.md +++ b/lending/docs/sdks/customers/README.md @@ -1,4 +1,4 @@ -# AccountsReceivableCustomers +# Customers (*accounts_receivable.customers*) ### Available Operations @@ -34,7 +34,7 @@ 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='Dakota Avon specifically', + customer_id='string', ) res = s.accounts_receivable.customers.download_attachment(req) @@ -55,7 +55,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingCustomerAttachmentResponse](../../models/operations/downloadaccountingcustomerattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -82,7 +87,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingCustomerRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - customer_id='Northeast Hatchback Kia', + customer_id='string', ) res = s.accounts_receivable.customers.get(req) @@ -103,7 +108,12 @@ if res.accounting_customer is not None: ### Response **[operations.GetAccountingCustomerResponse](../../models/operations/getaccountingcustomerresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -130,7 +140,7 @@ 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='array East along', + customer_id='string', ) res = s.accounts_receivable.customers.get_attachment(req) @@ -151,7 +161,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingCustomerAttachmentResponse](../../models/operations/getaccountingcustomerattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -199,7 +214,12 @@ if res.accounting_customers is not None: ### Response **[operations.ListAccountingCustomersResponse](../../models/operations/listaccountingcustomersresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -225,7 +245,7 @@ s = codatlending.CodatLending( req = operations.ListAccountingCustomerAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - customer_id='intuitive Frozen ouch', + customer_id='string', ) res = s.accounts_receivable.customers.list_attachments(req) @@ -246,4 +266,9 @@ if res.attachments is not None: ### Response **[operations.ListAccountingCustomerAttachmentsResponse](../../models/operations/listaccountingcustomerattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/dataintegrity/README.md b/lending/docs/sdks/dataintegrity/README.md old mode 100755 new mode 100644 index 4b8b4cb90..f166d65e3 --- a/lending/docs/sdks/dataintegrity/README.md +++ b/lending/docs/sdks/dataintegrity/README.md @@ -55,7 +55,12 @@ if res.data_integrity_details is not None: ### Response **[operations.ListDataIntegrityDetailsResponse](../../models/operations/listdataintegritydetailsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## status @@ -103,7 +108,12 @@ if res.data_integrity_statuses is not None: ### Response **[operations.GetDataIntegrityStatusResponse](../../models/operations/getdataintegritystatusresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## summaries @@ -148,4 +158,9 @@ if res.data_integrity_summaries is not None: ### Response **[operations.GetDataIntegritySummariesResponse](../../models/operations/getdataintegritysummariesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwritebackdirectcosts/README.md b/lending/docs/sdks/directcosts/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/loanwritebackdirectcosts/README.md rename to lending/docs/sdks/directcosts/README.md index 7e0a6c912..bf1c811cb --- a/lending/docs/sdks/loanwritebackdirectcosts/README.md +++ b/lending/docs/sdks/directcosts/README.md @@ -1,4 +1,4 @@ -# LoanWritebackDirectCosts +# DirectCosts (*loan_writeback.direct_costs*) ### Available Operations @@ -33,8 +33,10 @@ s = codatlending.CodatLending( ) req = operations.CreateDirectCostRequest( - accounting_direct_cost=shared.AccountingDirectCost( - contact_ref=shared.ContactRef( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', + direct_cost_prototype=shared.DirectCostPrototype( + contact_ref=shared.DirectCostPrototypeContactRef( data_type=shared.DataType.INVOICES, id='', ), @@ -43,7 +45,7 @@ req = operations.CreateDirectCostRequest( line_items=[ shared.DirectCostLineItem( account_ref=shared.AccountRef(), - item_ref=shared.ItemRef( + item_ref=shared.PropertieItemRef( id='', ), quantity=Decimal('6384.24'), @@ -66,35 +68,30 @@ req = operations.CreateDirectCostRequest( unit_amount=Decimal('2884.08'), ), ], - metadata=shared.Metadata(), - modified_date='2022-10-23T00:00:00.000Z', payment_allocations=[ shared.AccountingPaymentAllocation( - allocation=shared.AccountingPaymentAllocationAllocation( + allocation=shared.Allocation( allocated_on_date='2022-10-23T00:00:00.000Z', - currency='GBP', + currency='EUR', ), payment=shared.PaymentAllocationPayment( account_ref=shared.AccountRef(), - currency='EUR', + currency='GBP', paid_on_date='2022-10-23T00:00:00.000Z', ), ), ], - source_modified_date='2022-10-23T00:00:00.000Z', - sub_total=Decimal('9510.62'), + sub_total=Decimal('7964.74'), supplemental_data=shared.SupplementalData( content={ - "abnormally": { - "deposit": 'evolve', + 'key': { + 'key': 'string', }, }, ), - tax_amount=Decimal('7150.4'), - total_amount=Decimal('7926.2'), + tax_amount=Decimal('3768.44'), + total_amount=Decimal('9510.62'), ), - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) res = s.loan_writeback.direct_costs.create(req) @@ -115,7 +112,12 @@ if res.accounting_create_direct_cost_response is not None: ### Response **[operations.CreateDirectCostResponse](../../models/operations/createdirectcostresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_model @@ -165,4 +167,9 @@ if res.push_option is not None: ### Response **[operations.GetCreateDirectCostsModelResponse](../../models/operations/getcreatedirectcostsmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountsreceivabledirectincomes/README.md b/lending/docs/sdks/directincomes/README.md old mode 100755 new mode 100644 similarity index 88% rename from lending/docs/sdks/accountsreceivabledirectincomes/README.md rename to lending/docs/sdks/directincomes/README.md index 11c3b5003..d691cb79c --- a/lending/docs/sdks/accountsreceivabledirectincomes/README.md +++ b/lending/docs/sdks/directincomes/README.md @@ -1,4 +1,4 @@ -# AccountsReceivableDirectIncomes +# DirectIncomes (*accounts_receivable.direct_incomes*) ### Available Operations @@ -34,7 +34,7 @@ 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='Dakota Avon specifically', + direct_income_id='string', ) res = s.accounts_receivable.direct_incomes.download_attachment(req) @@ -55,7 +55,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingDirectIncomeAttachmentResponse](../../models/operations/downloadaccountingdirectincomeattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -83,7 +88,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingDirectIncomeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='Northeast Hatchback Kia', + direct_income_id='string', ) res = s.accounts_receivable.direct_incomes.get(req) @@ -104,7 +109,12 @@ if res.accounting_direct_income is not None: ### Response **[operations.GetAccountingDirectIncomeResponse](../../models/operations/getaccountingdirectincomeresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -131,7 +141,7 @@ 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='array East along', + direct_income_id='string', ) res = s.accounts_receivable.direct_incomes.get_attachment(req) @@ -152,7 +162,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingDirectIncomeAttachmentResponse](../../models/operations/getaccountingdirectincomeattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -201,7 +216,12 @@ if res.accounting_direct_incomes is not None: ### Response **[operations.ListAccountingDirectIncomesResponse](../../models/operations/listaccountingdirectincomesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -227,7 +247,7 @@ s = codatlending.CodatLending( req = operations.ListAccountingDirectIncomeAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - direct_income_id='intuitive Frozen ouch', + direct_income_id='string', ) res = s.accounts_receivable.direct_incomes.list_attachments(req) @@ -248,4 +268,9 @@ if res.attachments is not None: ### Response **[operations.ListAccountingDirectIncomeAttachmentsResponse](../../models/operations/listaccountingdirectincomeattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesdisputes/README.md b/lending/docs/sdks/disputes/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/salesdisputes/README.md rename to lending/docs/sdks/disputes/README.md index 51f01e54b..2e7f0c4c3 --- a/lending/docs/sdks/salesdisputes/README.md +++ b/lending/docs/sdks/disputes/README.md @@ -1,4 +1,4 @@ -# SalesDisputes +# Disputes (*sales.disputes*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceDisputeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - dispute_id='Northeast Hatchback Kia', + dispute_id='string', ) res = s.sales.disputes.get(req) @@ -53,7 +53,12 @@ if res.commerce_dispute is not None: ### Response **[operations.GetCommerceDisputeResponse](../../models/operations/getcommercedisputeresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_disputes is not None: ### Response **[operations.ListCommerceDisputesResponse](../../models/operations/listcommercedisputesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/excelreports/README.md b/lending/docs/sdks/excelreports/README.md old mode 100755 new mode 100644 index f6fa46bc3..df05da245 --- a/lending/docs/sdks/excelreports/README.md +++ b/lending/docs/sdks/excelreports/README.md @@ -54,7 +54,12 @@ if res.body is not None: ### Response **[operations.DownloadExcelReportResponse](../../models/operations/downloadexcelreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## generate @@ -111,7 +116,12 @@ if res.excel_status is not None: ### Response **[operations.GenerateExcelReportResponse](../../models/operations/generateexcelreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_status @@ -156,4 +166,9 @@ if res.excel_status is not None: ### Response **[operations.GetExcelReportGenerationStatusResponse](../../models/operations/getexcelreportgenerationstatusresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/fileupload/README.md b/lending/docs/sdks/fileupload/README.md old mode 100755 new mode 100644 index c75590918..6fa85d00e --- a/lending/docs/sdks/fileupload/README.md +++ b/lending/docs/sdks/fileupload/README.md @@ -50,7 +50,12 @@ if res.data is not None: ### Response **[operations.DownloadFilesResponse](../../models/operations/downloadfilesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_uploaded @@ -90,7 +95,12 @@ if res.files is not None: ### Response **[operations.ListFilesResponse](../../models/operations/listfilesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## upload @@ -116,8 +126,8 @@ s = codatlending.CodatLending( req = operations.UploadFilesRequest( request_body=operations.UploadFilesRequestBody( - content='F?SRSKG@^n'.encode(), - request_body='ullam', + content='0x87cbca97eC'.encode(), + file_name='ullam.wav', ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', @@ -141,4 +151,9 @@ if res.status_code == 200: ### Response **[operations.UploadFilesResponse](../../models/operations/uploadfilesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/financialstatements/README.md b/lending/docs/sdks/financialstatements/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/accountsreceivableinvoices/README.md b/lending/docs/sdks/invoices/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountsreceivableinvoices/README.md rename to lending/docs/sdks/invoices/README.md index c0236ecc6..50b4d3c00 --- a/lending/docs/sdks/accountsreceivableinvoices/README.md +++ b/lending/docs/sdks/invoices/README.md @@ -1,4 +1,4 @@ -# AccountsReceivableInvoices +# Invoices (*accounts_receivable.invoices*) ### Available Operations @@ -36,7 +36,7 @@ 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='Dakota Avon specifically', + invoice_id='string', ) res = s.accounts_receivable.invoices.download_attachment(req) @@ -57,7 +57,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingInvoiceAttachmentResponse](../../models/operations/downloadaccountinginvoiceattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## download_pdf @@ -77,7 +82,7 @@ s = codatlending.CodatLending( req = operations.DownloadAccountingInvoicePdfRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - invoice_id='Associate', + invoice_id='string', ) res = s.accounts_receivable.invoices.download_pdf(req) @@ -98,7 +103,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingInvoicePdfResponse](../../models/operations/downloadaccountinginvoicepdfresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -124,7 +134,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingInvoiceRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - invoice_id='Northeast Hatchback Kia', + invoice_id='string', ) res = s.accounts_receivable.invoices.get(req) @@ -145,7 +155,12 @@ if res.accounting_invoice is not None: ### Response **[operations.GetAccountingInvoiceResponse](../../models/operations/getaccountinginvoiceresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -172,7 +187,7 @@ 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='array East along', + invoice_id='string', ) res = s.accounts_receivable.invoices.get_attachment(req) @@ -193,7 +208,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingInvoiceAttachmentResponse](../../models/operations/getaccountinginvoiceattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -247,7 +267,12 @@ if res.accounting_invoices is not None: ### Response **[operations.ListAccountingInvoicesResponse](../../models/operations/listaccountinginvoicesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -273,7 +298,7 @@ s = codatlending.CodatLending( req = operations.ListAccountingInvoiceAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - invoice_id='intuitive Frozen ouch', + invoice_id='string', ) res = s.accounts_receivable.invoices.list_attachments(req) @@ -294,7 +319,12 @@ if res.attachments is not None: ### Response **[operations.ListAccountingInvoiceAttachmentsResponse](../../models/operations/listaccountinginvoiceattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_reconciled @@ -336,4 +366,9 @@ if res.enhanced_invoices_report is not None: ### Response **[operations.ListReconciledInvoicesResponse](../../models/operations/listreconciledinvoicesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/transactionsjournalentries/README.md b/lending/docs/sdks/journalentries/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/transactionsjournalentries/README.md rename to lending/docs/sdks/journalentries/README.md index 195f8fe76..e06467562 --- a/lending/docs/sdks/transactionsjournalentries/README.md +++ b/lending/docs/sdks/journalentries/README.md @@ -1,4 +1,4 @@ -# TransactionsJournalEntries +# JournalEntries (*transactions.journal_entries*) ### Available Operations @@ -31,7 +31,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingJournalEntryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - journal_entry_id='Northeast Hatchback Kia', + journal_entry_id='string', ) res = s.transactions.journal_entries.get(req) @@ -52,7 +52,12 @@ if res.accounting_journal_entry is not None: ### Response **[operations.GetAccountingJournalEntryResponse](../../models/operations/getaccountingjournalentryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_journal_entries is not None: ### Response **[operations.ListAccountingJournalEntriesResponse](../../models/operations/listaccountingjournalentriesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/transactionsjournals/README.md b/lending/docs/sdks/journals/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/transactionsjournals/README.md rename to lending/docs/sdks/journals/README.md index aecea4524..1dd6826cf --- a/lending/docs/sdks/transactionsjournals/README.md +++ b/lending/docs/sdks/journals/README.md @@ -1,4 +1,4 @@ -# TransactionsJournals +# Journals (*transactions.journals*) ### Available Operations @@ -31,7 +31,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingJournalRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - journal_id='Northeast Hatchback Kia', + journal_id='string', ) res = s.transactions.journals.get(req) @@ -52,7 +52,12 @@ if res.accounting_journal is not None: ### Response **[operations.GetAccountingJournalResponse](../../models/operations/getaccountingjournalresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_journals is not None: ### Response **[operations.ListAccountingJournalsResponse](../../models/operations/listaccountingjournalsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/liabilities/README.md b/lending/docs/sdks/liabilities/README.md old mode 100755 new mode 100644 index 4e03697f8..e94ac6d2e --- a/lending/docs/sdks/liabilities/README.md +++ b/lending/docs/sdks/liabilities/README.md @@ -35,7 +35,7 @@ s = codatlending.CodatLending( req = operations.GenerateLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GenerateLoanSummarySourceType.ACCOUNTING, + source_type=operations.SourceType.ACCOUNTING, ) res = s.liabilities.generate_loan_summary(req) @@ -56,7 +56,12 @@ if res.status_code == 200: ### Response **[operations.GenerateLoanSummaryResponse](../../models/operations/generateloansummaryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## generate_loan_transactions @@ -81,7 +86,7 @@ s = codatlending.CodatLending( req = operations.GenerateLoanTransactionsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GenerateLoanTransactionsSourceType.ACCOUNTING, + source_type=operations.QueryParamSourceType.ACCOUNTING, ) res = s.liabilities.generate_loan_transactions(req) @@ -102,7 +107,12 @@ if res.status_code == 200: ### Response **[operations.GenerateLoanTransactionsResponse](../../models/operations/generateloantransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_loan_summary @@ -127,7 +137,7 @@ s = codatlending.CodatLending( req = operations.GetLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GetLoanSummarySourceType.BANKING, + source_type=operations.GetLoanSummaryQueryParamSourceType.BANKING, ) res = s.liabilities.get_loan_summary(req) @@ -148,7 +158,12 @@ if res.loan_summary is not None: ### Response **[operations.GetLoanSummaryResponse](../../models/operations/getloansummaryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_loan_transactions @@ -173,7 +188,7 @@ s = codatlending.CodatLending( req = operations.ListLoanTransactionsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.ListLoanTransactionsSourceType.COMMERCE, + source_type=operations.ListLoanTransactionsQueryParamSourceType.COMMERCE, ) res = s.liabilities.list_loan_transactions(req) @@ -194,4 +209,9 @@ if res.loan_transactions is not None: ### Response **[operations.ListLoanTransactionsResponse](../../models/operations/listloantransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/loanwriteback/README.md b/lending/docs/sdks/loanwriteback/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/saleslocations/README.md b/lending/docs/sdks/locations/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/saleslocations/README.md rename to lending/docs/sdks/locations/README.md index 042c34a11..beb94e801 --- a/lending/docs/sdks/saleslocations/README.md +++ b/lending/docs/sdks/locations/README.md @@ -1,4 +1,4 @@ -# SalesLocations +# Locations (*sales.locations*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceLocationRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - location_id='Northeast Hatchback Kia', + location_id='string', ) res = s.sales.locations.get(req) @@ -53,7 +53,12 @@ if res.commerce_location is not None: ### Response **[operations.GetCommerceLocationResponse](../../models/operations/getcommercelocationresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -99,4 +104,9 @@ if res.commerce_locations is not None: ### Response **[operations.ListCommerceLocationsResponse](../../models/operations/listcommercelocationsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/managedata/README.md b/lending/docs/sdks/managedata/README.md old mode 100755 new mode 100644 index 9976e3005..fb84b1313 --- a/lending/docs/sdks/managedata/README.md +++ b/lending/docs/sdks/managedata/README.md @@ -27,7 +27,7 @@ req = operations.GetDataStatusRequest( res = s.manage_data.get_status(req) -if res.data_status_response is not None: +if res.data_statuses is not None: # handle response pass ``` @@ -43,4 +43,9 @@ if res.data_status_response is not None: ### Response **[operations.GetDataStatusResponse](../../models/operations/getdatastatusresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesmetrics/README.md b/lending/docs/sdks/metrics/README.md old mode 100755 new mode 100644 similarity index 90% rename from lending/docs/sdks/salesmetrics/README.md rename to lending/docs/sdks/metrics/README.md index ab4f9ece1..37b9b21a7 --- a/lending/docs/sdks/salesmetrics/README.md +++ b/lending/docs/sdks/metrics/README.md @@ -1,4 +1,4 @@ -# SalesMetrics +# Metrics (*sales.metrics*) ### Available Operations @@ -78,7 +78,12 @@ if res.commerce_report is not None: ### Response **[operations.GetCommerceCustomerRetentionMetricsResponse](../../models/operations/getcommercecustomerretentionmetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_lifetime_value @@ -145,7 +150,12 @@ if res.commerce_report is not None: ### Response **[operations.GetCommerceLifetimeValueMetricsResponse](../../models/operations/getcommercelifetimevaluemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_revenue @@ -213,4 +223,9 @@ if res.commerce_report is not None: ### Response **[operations.GetCommerceRevenueMetricsResponse](../../models/operations/getcommercerevenuemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesorders/README.md b/lending/docs/sdks/orders/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/salesorders/README.md rename to lending/docs/sdks/orders/README.md index 8177d53e7..0faaa08f6 --- a/lending/docs/sdks/salesorders/README.md +++ b/lending/docs/sdks/orders/README.md @@ -1,4 +1,4 @@ -# SalesOrders +# Orders (*sales.orders*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceOrderRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - order_id='Northeast Hatchback Kia', + order_id='string', ) res = s.sales.orders.get(req) @@ -53,7 +53,12 @@ if res.commerce_order is not None: ### Response **[operations.GetCommerceOrderResponse](../../models/operations/getcommerceorderresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_orders is not None: ### Response **[operations.ListCommerceOrdersResponse](../../models/operations/listcommerceordersresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salespaymentmethods/README.md b/lending/docs/sdks/paymentmethods/README.md old mode 100755 new mode 100644 similarity index 86% rename from lending/docs/sdks/salespaymentmethods/README.md rename to lending/docs/sdks/paymentmethods/README.md index bae352a07..974190b14 --- a/lending/docs/sdks/salespaymentmethods/README.md +++ b/lending/docs/sdks/paymentmethods/README.md @@ -1,4 +1,4 @@ -# SalesPaymentMethods +# PaymentMethods (*sales.payment_methods*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommercePaymentMethodRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - payment_method_id='Northeast Hatchback Kia', + payment_method_id='string', ) res = s.sales.payment_methods.get(req) @@ -53,7 +53,12 @@ if res.commerce_payment_method is not None: ### Response **[operations.GetCommercePaymentMethodResponse](../../models/operations/getcommercepaymentmethodresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_payment_methods is not None: ### Response **[operations.ListCommercePaymentMethodsResponse](../../models/operations/listcommercepaymentmethodsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountsreceivablepayments/README.md b/lending/docs/sdks/payments/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/accountsreceivablepayments/README.md rename to lending/docs/sdks/payments/README.md index d8f95d112..8e93ae1bc --- a/lending/docs/sdks/accountsreceivablepayments/README.md +++ b/lending/docs/sdks/payments/README.md @@ -1,4 +1,4 @@ -# AccountsReceivablePayments +# Payments (*accounts_receivable.payments*) ### Available Operations @@ -31,7 +31,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingPaymentRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - payment_id='Northeast Hatchback Kia', + payment_id='string', ) res = s.accounts_receivable.payments.get(req) @@ -52,7 +52,12 @@ if res.accounting_payment is not None: ### Response **[operations.GetAccountingPaymentResponse](../../models/operations/getaccountingpaymentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -100,4 +105,9 @@ if res.accounting_payments is not None: ### Response **[operations.ListAccountingPaymentsResponse](../../models/operations/listaccountingpaymentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesproductcategories/README.md b/lending/docs/sdks/productcategories/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/salesproductcategories/README.md rename to lending/docs/sdks/productcategories/README.md index 0f05247a9..ab158f579 --- a/lending/docs/sdks/salesproductcategories/README.md +++ b/lending/docs/sdks/productcategories/README.md @@ -1,4 +1,4 @@ -# SalesProductCategories +# ProductCategories (*sales.product_categories*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceProductCategoryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - product_id='Northeast Hatchback Kia', + product_id='string', ) res = s.sales.product_categories.get(req) @@ -53,7 +53,12 @@ if res.commerce_product_category is not None: ### Response **[operations.GetCommerceProductCategoryResponse](../../models/operations/getcommerceproductcategoryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_product_categories is not None: ### Response **[operations.ListCommerceProductCategoriesResponse](../../models/operations/listcommerceproductcategoriesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/salesproducts/README.md b/lending/docs/sdks/products/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/salesproducts/README.md rename to lending/docs/sdks/products/README.md index e43f19fc7..3baf74ba8 --- a/lending/docs/sdks/salesproducts/README.md +++ b/lending/docs/sdks/products/README.md @@ -1,4 +1,4 @@ -# SalesProducts +# Products (*sales.products*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetCommerceProductRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - product_id='Northeast Hatchback Kia', + product_id='string', ) res = s.sales.products.get(req) @@ -53,7 +53,12 @@ if res.commerce_product is not None: ### Response **[operations.GetCommerceProductResponse](../../models/operations/getcommerceproductresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.commerce_products is not None: ### Response **[operations.ListCommerceProductsResponse](../../models/operations/listcommerceproductsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/financialstatementsprofitandloss/README.md b/lending/docs/sdks/profitandloss/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/financialstatementsprofitandloss/README.md rename to lending/docs/sdks/profitandloss/README.md index f444f88eb..340699b6f --- a/lending/docs/sdks/financialstatementsprofitandloss/README.md +++ b/lending/docs/sdks/profitandloss/README.md @@ -1,4 +1,4 @@ -# FinancialStatementsProfitAndLoss +# ProfitAndLoss (*financial_statements.profit_and_loss*) ### Available Operations @@ -47,7 +47,12 @@ if res.accounting_profit_and_loss_report is not None: ### Response **[operations.GetAccountingProfitAndLossResponse](../../models/operations/getaccountingprofitandlossresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_categorized_accounts @@ -90,4 +95,9 @@ if res.enhanced_financial_report is not None: ### Response **[operations.GetCategorizedProfitAndLossStatementResponse](../../models/operations/getcategorizedprofitandlossstatementresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/managedatapulloperations/README.md b/lending/docs/sdks/pulloperations/README.md old mode 100755 new mode 100644 similarity index 84% rename from lending/docs/sdks/managedatapulloperations/README.md rename to lending/docs/sdks/pulloperations/README.md index 4224b47c2..b4b1a0e49 --- a/lending/docs/sdks/managedatapulloperations/README.md +++ b/lending/docs/sdks/pulloperations/README.md @@ -1,4 +1,4 @@ -# ManageDataPullOperations +# PullOperations (*manage_data.pull_operations*) ### Available Operations @@ -45,7 +45,12 @@ if res.pull_operation is not None: ### Response **[operations.GetPullOperationResponse](../../models/operations/getpulloperationresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -88,4 +93,9 @@ if res.pull_operations is not None: ### Response **[operations.ListPullOperationsResponse](../../models/operations/listpulloperationsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/managedatarefresh/README.md b/lending/docs/sdks/refresh/README.md old mode 100755 new mode 100644 similarity index 85% rename from lending/docs/sdks/managedatarefresh/README.md rename to lending/docs/sdks/refresh/README.md index c18f9bbba..95c0c0ff1 --- a/lending/docs/sdks/managedatarefresh/README.md +++ b/lending/docs/sdks/refresh/README.md @@ -1,4 +1,4 @@ -# ManageDataRefresh +# Refresh (*manage_data.refresh*) ### Available Operations @@ -48,7 +48,12 @@ if res.status_code == 200: ### Response **[operations.RefreshAllDataTypesResponse](../../models/operations/refreshalldatatypesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## data_type @@ -70,7 +75,7 @@ s = codatlending.CodatLending( req = operations.RefreshDataTypeRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - data_type=shared.DataType.INVOICES, + data_type=shared.SchemaDataType.INVOICES, ) res = s.manage_data.refresh.data_type(req) @@ -91,4 +96,9 @@ if res.pull_operation is not None: ### Response **[operations.RefreshDataTypeResponse](../../models/operations/refreshdatatyperesponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/accountsreceivablereports/README.md b/lending/docs/sdks/reports/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountsreceivablereports/README.md rename to lending/docs/sdks/reports/README.md index 809250873..005428571 --- a/lending/docs/sdks/accountsreceivablereports/README.md +++ b/lending/docs/sdks/reports/README.md @@ -1,4 +1,4 @@ -# AccountsReceivableReports +# Reports (*accounts_receivable.reports*) ### Available Operations @@ -50,7 +50,12 @@ if res.accounting_aged_creditor_report is not None: ### Response **[operations.GetAccountingAgedCreditorsReportResponse](../../models/operations/getaccountingagedcreditorsreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_aged_debtors @@ -94,7 +99,12 @@ if res.accounting_aged_debtor_report is not None: ### Response **[operations.GetAccountingAgedDebtorsReportResponse](../../models/operations/getaccountingageddebtorsreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## is_aged_creditors_available @@ -118,7 +128,7 @@ req = operations.IsAgedCreditorsReportAvailableRequest( res = s.accounts_receivable.reports.is_aged_creditors_available(req) -if res.is_aged_creditors_report_available_200_application_json_boolean is not None: +if res.boolean is not None: # handle response pass ``` @@ -134,7 +144,12 @@ if res.is_aged_creditors_report_available_200_application_json_boolean is not No ### Response **[operations.IsAgedCreditorsReportAvailableResponse](../../models/operations/isagedcreditorsreportavailableresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## is_aged_debtors_available @@ -158,7 +173,7 @@ req = operations.IsAgedDebtorsReportAvailableRequest( res = s.accounts_receivable.reports.is_aged_debtors_available(req) -if res.is_aged_debtors_report_available_200_application_json_boolean is not None: +if res.boolean is not None: # handle response pass ``` @@ -174,4 +189,9 @@ if res.is_aged_debtors_report_available_200_application_json_boolean is not None ### Response **[operations.IsAgedDebtorsReportAvailableResponse](../../models/operations/isageddebtorsreportavailableresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/sales/README.md b/lending/docs/sdks/sales/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/accountspayablesuppliers/README.md b/lending/docs/sdks/suppliers/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/accountspayablesuppliers/README.md rename to lending/docs/sdks/suppliers/README.md index 34f666307..d00d0107e --- a/lending/docs/sdks/accountspayablesuppliers/README.md +++ b/lending/docs/sdks/suppliers/README.md @@ -1,4 +1,4 @@ -# AccountsPayableSuppliers +# Suppliers (*accounts_payable.suppliers*) ### Available Operations @@ -34,7 +34,7 @@ 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='Dakota Avon specifically', + supplier_id='string', ) res = s.accounts_payable.suppliers.download_attachment(req) @@ -55,7 +55,12 @@ if res.data is not None: ### Response **[operations.DownloadAccountingSupplierAttachmentResponse](../../models/operations/downloadaccountingsupplierattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get @@ -82,7 +87,7 @@ s = codatlending.CodatLending( req = operations.GetAccountingSupplierRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - supplier_id='Northeast Hatchback Kia', + supplier_id='string', ) res = s.accounts_payable.suppliers.get(req) @@ -103,7 +108,12 @@ if res.accounting_supplier is not None: ### Response **[operations.GetAccountingSupplierResponse](../../models/operations/getaccountingsupplierresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_attachment @@ -130,7 +140,7 @@ 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='array East along', + supplier_id='string', ) res = s.accounts_payable.suppliers.get_attachment(req) @@ -151,7 +161,12 @@ if res.accounting_attachment is not None: ### Response **[operations.GetAccountingSupplierAttachmentResponse](../../models/operations/getaccountingsupplierattachmentresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -199,7 +214,12 @@ if res.accounting_suppliers is not None: ### Response **[operations.ListAccountingSuppliersResponse](../../models/operations/listaccountingsuppliersresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_attachments @@ -225,7 +245,7 @@ s = codatlending.CodatLending( req = operations.ListAccountingSupplierAttachmentsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - supplier_id='intuitive Frozen ouch', + supplier_id='string', ) res = s.accounts_payable.suppliers.list_attachments(req) @@ -246,4 +266,9 @@ if res.attachments is not None: ### Response **[operations.ListAccountingSupplierAttachmentsResponse](../../models/operations/listaccountingsupplierattachmentsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/bankingtransactioncategories/README.md b/lending/docs/sdks/transactioncategories/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/bankingtransactioncategories/README.md rename to lending/docs/sdks/transactioncategories/README.md index 5e005c19c..283df7519 --- a/lending/docs/sdks/bankingtransactioncategories/README.md +++ b/lending/docs/sdks/transactioncategories/README.md @@ -1,4 +1,4 @@ -# BankingTransactionCategories +# TransactionCategories (*banking.transaction_categories*) ### Available Operations @@ -32,7 +32,7 @@ s = codatlending.CodatLending( req = operations.GetBankingTransactionCategoryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - transaction_category_id='Northeast Hatchback Kia', + transaction_category_id='string', ) res = s.banking.transaction_categories.get(req) @@ -53,7 +53,12 @@ if res.banking_transaction_category is not None: ### Response **[operations.GetBankingTransactionCategoryResponse](../../models/operations/getbankingtransactioncategoryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list @@ -102,4 +107,9 @@ if res.banking_transaction_categories is not None: ### Response **[operations.ListBankingTransactionCategoriesResponse](../../models/operations/listbankingtransactioncategoriesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ----------------------------------- | ----------------------------------- | ----------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/docs/sdks/transactions/README.md b/lending/docs/sdks/transactions/README.md old mode 100755 new mode 100644 diff --git a/lending/docs/sdks/loanwritebacktransfers/README.md b/lending/docs/sdks/transfers/README.md old mode 100755 new mode 100644 similarity index 87% rename from lending/docs/sdks/loanwritebacktransfers/README.md rename to lending/docs/sdks/transfers/README.md index df8424963..c5fec7234 --- a/lending/docs/sdks/loanwritebacktransfers/README.md +++ b/lending/docs/sdks/transfers/README.md @@ -1,4 +1,4 @@ -# LoanWritebackTransfers +# Transfers (*loan_writeback.transfers*) ### Available Operations @@ -34,7 +34,7 @@ s = codatlending.CodatLending( req = operations.CreateTransferRequest( accounting_transfer=shared.AccountingTransfer( - contact_ref=shared.AccountingTransferContactRef( + contact_ref=shared.ContactRef( data_type=shared.DataType.INVOICES, id='', ), @@ -53,14 +53,14 @@ req = operations.CreateTransferRequest( source_modified_date='2022-10-23T00:00:00.000Z', supplemental_data=shared.SupplementalData( content={ - "innovative": { - "blue": 'shred', + 'key': { + 'key': 'string', }, }, ), to=shared.TransferAccount( account_ref=shared.AccountRef(), - currency='USD', + currency='GBP', ), tracking_category_refs=[ shared.TrackingCategoryRef( @@ -90,7 +90,12 @@ if res.accounting_create_transfer_response is not None: ### Response **[operations.CreateTransferResponse](../../models/operations/createtransferresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_create_model @@ -140,4 +145,9 @@ if res.push_option is not None: ### Response **[operations.GetCreateTransfersModelResponse](../../models/operations/getcreatetransfersmodelresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/lending/files.gen b/lending/files.gen index 4ad6b397f..c24ae07c4 100755 --- a/lending/files.gen +++ b/lending/files.gen @@ -1,106 +1,109 @@ src/codatlending/sdkconfiguration.py -src/codatlending/accounting_bank_data_accounts.py -src/codatlending/accounting_bank_data.py src/codatlending/companies.py -src/codatlending/company_info.py src/codatlending/connections.py -src/codatlending/data_integrity.py -src/codatlending/excel_reports.py -src/codatlending/file_upload.py -src/codatlending/liabilities.py -src/codatlending/accounts_payable_bill_credit_notes.py -src/codatlending/accounts_payable_bill_payments.py -src/codatlending/accounts_payable_bills.py -src/codatlending/accounts_payable_suppliers.py +src/codatlending/account_transactions.py +src/codatlending/codatlending_direct_costs.py +src/codatlending/codatlending_transfers.py +src/codatlending/journal_entries.py +src/codatlending/journals.py +src/codatlending/transactions.py +src/codatlending/accounts.py +src/codatlending/codatlending_accounting_bank_data.py +src/codatlending/account_balances.py +src/codatlending/codatlending_accounts.py +src/codatlending/transaction_categories.py +src/codatlending/codatlending_banking_transactions.py +src/codatlending/categorized_statement.py +src/codatlending/banking.py +src/codatlending/bills.py +src/codatlending/suppliers.py +src/codatlending/bill_credit_notes.py +src/codatlending/bill_payments.py src/codatlending/accounts_payable.py -src/codatlending/accounts_receivable_credit_notes.py -src/codatlending/accounts_receivable_customers.py -src/codatlending/accounts_receivable_direct_incomes.py -src/codatlending/accounts_receivable_invoices.py -src/codatlending/accounts_receivable_payments.py -src/codatlending/accounts_receivable_reports.py +src/codatlending/codatlending_customers.py +src/codatlending/disputes.py +src/codatlending/locations.py +src/codatlending/orders.py +src/codatlending/payment_methods.py +src/codatlending/codatlending_sales_payments.py +src/codatlending/product_categories.py +src/codatlending/products.py +src/codatlending/codatlending_transactions.py +src/codatlending/metrics.py +src/codatlending/codatlending_reports.py +src/codatlending/sales.py +src/codatlending/company_info.py +src/codatlending/customers.py +src/codatlending/direct_incomes.py +src/codatlending/invoices.py +src/codatlending/credit_notes.py +src/codatlending/payments.py +src/codatlending/reports.py src/codatlending/accounts_receivable.py -src/codatlending/banking_account_balances.py -src/codatlending/banking_accounts.py -src/codatlending/banking_categorized_statement.py -src/codatlending/banking_transaction_categories.py -src/codatlending/banking_transactions.py -src/codatlending/banking.py -src/codatlending/financial_statements_accounts.py -src/codatlending/financial_statements_balance_sheet.py -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_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/file_upload.py +src/codatlending/bank_accounts.py +src/codatlending/bank_transactions.py +src/codatlending/codatlending_loan_writeback_accounts.py +src/codatlending/direct_costs.py +src/codatlending/codatlending_payments.py +src/codatlending/codatlending_suppliers.py +src/codatlending/transfers.py +src/codatlending/create_operations.py src/codatlending/loan_writeback.py -src/codatlending/manage_data_pull_operations.py -src/codatlending/manage_data_refresh.py +src/codatlending/codatlending_financial_statements_accounts.py +src/codatlending/balance_sheet.py +src/codatlending/cash_flow.py +src/codatlending/profit_and_loss.py +src/codatlending/financial_statements.py +src/codatlending/refresh.py +src/codatlending/pull_operations.py src/codatlending/manage_data.py -src/codatlending/sales_customers.py -src/codatlending/sales_disputes.py -src/codatlending/sales_locations.py -src/codatlending/sales_metrics.py -src/codatlending/sales_orders.py -src/codatlending/sales_payment_methods.py -src/codatlending/sales_payments.py -src/codatlending/sales_product_categories.py -src/codatlending/sales_products.py -src/codatlending/sales_reports.py -src/codatlending/sales_transactions.py -src/codatlending/sales.py -src/codatlending/transactions_account_transactions.py -src/codatlending/transactions_direct_costs.py -src/codatlending/transactions_journal_entries.py -src/codatlending/transactions_journals.py -src/codatlending/transactions_transfers.py -src/codatlending/transactions.py +src/codatlending/liabilities.py +src/codatlending/data_integrity.py +src/codatlending/excel_reports.py src/codatlending/sdk.py pylintrc setup.py src/codatlending/__init__.py -src/codatlending/models/__init__.py -src/codatlending/models/errors/sdkerror.py src/codatlending/utils/__init__.py src/codatlending/utils/retries.py src/codatlending/utils/utils.py -src/codatlending/models/operations/get_accounting_bank_account.py -src/codatlending/models/operations/list_accounting_bank_accounts.py -src/codatlending/models/operations/list_accounting_bank_account_transactions.py +src/codatlending/models/errors/sdkerror.py +tests/helpers.py src/codatlending/models/operations/create_company.py src/codatlending/models/operations/delete_company.py src/codatlending/models/operations/get_company.py src/codatlending/models/operations/list_companies.py src/codatlending/models/operations/update_company.py -src/codatlending/models/operations/get_accounting_profile.py -src/codatlending/models/operations/get_commerce_profile.py src/codatlending/models/operations/create_connection.py src/codatlending/models/operations/delete_connection.py src/codatlending/models/operations/get_connection.py src/codatlending/models/operations/list_connections.py src/codatlending/models/operations/unlink_connection.py -src/codatlending/models/operations/list_data_integrity_details.py -src/codatlending/models/operations/get_data_integrity_status.py -src/codatlending/models/operations/get_data_integrity_summaries.py -src/codatlending/models/operations/download_excel_report.py -src/codatlending/models/operations/generate_excel_report.py -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 -src/codatlending/models/operations/list_accounting_bill_credit_notes.py -src/codatlending/models/operations/get_accounting_bill_payment.py -src/codatlending/models/operations/list_accounting_bill_payments.py +src/codatlending/models/operations/get_accounting_account_transaction.py +src/codatlending/models/operations/list_accounting_account_transactions.py +src/codatlending/models/operations/download_accounting_direct_cost_attachment.py +src/codatlending/models/operations/get_accounting_direct_cost.py +src/codatlending/models/operations/get_accounting_direct_cost_attachment.py +src/codatlending/models/operations/list_accounting_direct_costs.py +src/codatlending/models/operations/list_accounting_direct_cost_attachments.py +src/codatlending/models/operations/get_accounting_transfer.py +src/codatlending/models/operations/list_accounting_transfers.py +src/codatlending/models/operations/get_accounting_journal_entry.py +src/codatlending/models/operations/list_accounting_journal_entries.py +src/codatlending/models/operations/get_accounting_journal.py +src/codatlending/models/operations/list_accounting_journals.py +src/codatlending/models/operations/list_accounting_bank_account_transactions.py +src/codatlending/models/operations/get_accounting_bank_account.py +src/codatlending/models/operations/list_accounting_bank_accounts.py +src/codatlending/models/operations/list_banking_account_balances.py +src/codatlending/models/operations/get_banking_account.py +src/codatlending/models/operations/list_banking_accounts.py +src/codatlending/models/operations/get_banking_transaction_category.py +src/codatlending/models/operations/list_banking_transaction_categories.py +src/codatlending/models/operations/get_banking_transaction.py +src/codatlending/models/operations/list_banking_transactions.py +src/codatlending/models/operations/get_categorized_bank_statement.py src/codatlending/models/operations/download_accounting_bill_attachment.py src/codatlending/models/operations/get_accounting_bill.py src/codatlending/models/operations/get_accounting_bill_attachment.py @@ -111,8 +114,35 @@ src/codatlending/models/operations/get_accounting_supplier.py src/codatlending/models/operations/get_accounting_supplier_attachment.py src/codatlending/models/operations/list_accounting_suppliers.py src/codatlending/models/operations/list_accounting_supplier_attachments.py -src/codatlending/models/operations/get_accounting_credit_note.py -src/codatlending/models/operations/list_accounting_credit_notes.py +src/codatlending/models/operations/get_accounting_bill_credit_note.py +src/codatlending/models/operations/list_accounting_bill_credit_notes.py +src/codatlending/models/operations/get_accounting_bill_payment.py +src/codatlending/models/operations/list_accounting_bill_payments.py +src/codatlending/models/operations/get_commerce_customer.py +src/codatlending/models/operations/list_commerce_customers.py +src/codatlending/models/operations/get_commerce_dispute.py +src/codatlending/models/operations/list_commerce_disputes.py +src/codatlending/models/operations/get_commerce_location.py +src/codatlending/models/operations/list_commerce_locations.py +src/codatlending/models/operations/get_commerce_order.py +src/codatlending/models/operations/list_commerce_orders.py +src/codatlending/models/operations/get_commerce_payment_method.py +src/codatlending/models/operations/list_commerce_payment_methods.py +src/codatlending/models/operations/get_commerce_payment.py +src/codatlending/models/operations/list_commerce_payments.py +src/codatlending/models/operations/get_commerce_product_category.py +src/codatlending/models/operations/list_commerce_product_categories.py +src/codatlending/models/operations/get_commerce_product.py +src/codatlending/models/operations/list_commerce_products.py +src/codatlending/models/operations/get_commerce_transaction.py +src/codatlending/models/operations/list_commerce_transactions.py +src/codatlending/models/operations/get_commerce_customer_retention_metrics.py +src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py +src/codatlending/models/operations/get_commerce_revenue_metrics.py +src/codatlending/models/operations/get_commerce_orders_report.py +src/codatlending/models/operations/get_commerce_refunds_report.py +src/codatlending/models/operations/get_accounting_profile.py +src/codatlending/models/operations/get_commerce_profile.py src/codatlending/models/operations/download_accounting_customer_attachment.py src/codatlending/models/operations/get_accounting_customer.py src/codatlending/models/operations/get_accounting_customer_attachment.py @@ -130,208 +160,101 @@ src/codatlending/models/operations/get_accounting_invoice_attachment.py src/codatlending/models/operations/list_accounting_invoices.py src/codatlending/models/operations/list_accounting_invoice_attachments.py src/codatlending/models/operations/list_reconciled_invoices.py +src/codatlending/models/operations/get_accounting_credit_note.py +src/codatlending/models/operations/list_accounting_credit_notes.py src/codatlending/models/operations/get_accounting_payment.py src/codatlending/models/operations/list_accounting_payments.py src/codatlending/models/operations/get_accounting_aged_creditors_report.py src/codatlending/models/operations/get_accounting_aged_debtors_report.py src/codatlending/models/operations/is_aged_creditors_report_available.py src/codatlending/models/operations/is_aged_debtors_report_available.py -src/codatlending/models/operations/list_banking_account_balances.py -src/codatlending/models/operations/get_banking_account.py -src/codatlending/models/operations/list_banking_accounts.py -src/codatlending/models/operations/get_categorized_bank_statement.py -src/codatlending/models/operations/get_banking_transaction_category.py -src/codatlending/models/operations/list_banking_transaction_categories.py -src/codatlending/models/operations/get_banking_transaction.py -src/codatlending/models/operations/list_banking_transactions.py -src/codatlending/models/operations/get_accounting_account.py -src/codatlending/models/operations/list_accounting_accounts.py -src/codatlending/models/operations/get_accounting_balance_sheet.py -src/codatlending/models/operations/get_categorized_balance_sheet_statement.py -src/codatlending/models/operations/get_accounting_cash_flow_statement.py -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/download_files.py +src/codatlending/models/operations/list_files.py +src/codatlending/models/operations/upload_files.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_account.py +src/codatlending/models/operations/get_create_chartofaccounts_model.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/get_create_payment_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 src/codatlending/models/operations/get_create_transfers_model.py -src/codatlending/models/operations/get_pull_operation.py -src/codatlending/models/operations/list_pull_operations.py +src/codatlending/models/operations/get_create_operation.py +src/codatlending/models/operations/list_create_operations.py +src/codatlending/models/operations/get_accounting_account.py +src/codatlending/models/operations/list_accounting_accounts.py +src/codatlending/models/operations/get_accounting_balance_sheet.py +src/codatlending/models/operations/get_categorized_balance_sheet_statement.py +src/codatlending/models/operations/get_accounting_cash_flow_statement.py +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/get_data_status.py src/codatlending/models/operations/refresh_all_data_types.py src/codatlending/models/operations/refresh_data_type.py -src/codatlending/models/operations/get_data_status.py -src/codatlending/models/operations/get_commerce_customer.py -src/codatlending/models/operations/list_commerce_customers.py -src/codatlending/models/operations/get_commerce_dispute.py -src/codatlending/models/operations/list_commerce_disputes.py -src/codatlending/models/operations/get_commerce_location.py -src/codatlending/models/operations/list_commerce_locations.py -src/codatlending/models/operations/get_commerce_customer_retention_metrics.py -src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py -src/codatlending/models/operations/get_commerce_revenue_metrics.py -src/codatlending/models/operations/get_commerce_order.py -src/codatlending/models/operations/list_commerce_orders.py -src/codatlending/models/operations/get_commerce_payment_method.py -src/codatlending/models/operations/list_commerce_payment_methods.py -src/codatlending/models/operations/get_commerce_payment.py -src/codatlending/models/operations/list_commerce_payments.py -src/codatlending/models/operations/get_commerce_product_category.py -src/codatlending/models/operations/list_commerce_product_categories.py -src/codatlending/models/operations/get_commerce_product.py -src/codatlending/models/operations/list_commerce_products.py -src/codatlending/models/operations/get_commerce_orders_report.py -src/codatlending/models/operations/get_commerce_refunds_report.py -src/codatlending/models/operations/get_commerce_transaction.py -src/codatlending/models/operations/list_commerce_transactions.py -src/codatlending/models/operations/get_accounting_account_transaction.py -src/codatlending/models/operations/list_accounting_account_transactions.py -src/codatlending/models/operations/download_accounting_direct_cost_attachment.py -src/codatlending/models/operations/get_accounting_direct_cost.py -src/codatlending/models/operations/get_accounting_direct_cost_attachment.py -src/codatlending/models/operations/list_accounting_direct_costs.py -src/codatlending/models/operations/list_accounting_direct_cost_attachments.py -src/codatlending/models/operations/get_accounting_journal_entry.py -src/codatlending/models/operations/list_accounting_journal_entries.py -src/codatlending/models/operations/get_accounting_journal.py -src/codatlending/models/operations/list_accounting_journals.py -src/codatlending/models/operations/get_accounting_transfer.py -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 -src/codatlending/models/shared/links.py -src/codatlending/models/shared/halref.py -src/codatlending/models/shared/accountingbanktransactions.py -src/codatlending/models/shared/accountingbanktransaction.py -src/codatlending/models/shared/banktransactiontype.py +src/codatlending/models/operations/get_pull_operation.py +src/codatlending/models/operations/list_pull_operations.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/list_data_integrity_details.py +src/codatlending/models/operations/get_data_integrity_status.py +src/codatlending/models/operations/get_data_integrity_summaries.py +src/codatlending/models/operations/download_excel_report.py +src/codatlending/models/operations/generate_excel_report.py +src/codatlending/models/operations/get_excel_report_generation_status.py src/codatlending/models/shared/company.py src/codatlending/models/shared/connection.py src/codatlending/models/shared/dataconnectionstatus.py src/codatlending/models/shared/dataconnectionerror.py src/codatlending/models/shared/companyrequestbody.py src/codatlending/models/shared/companies.py -src/codatlending/models/shared/accountingcompanyinfo.py -src/codatlending/models/shared/weblink.py -src/codatlending/models/shared/phonenumber.py -src/codatlending/models/shared/phonenumbertype.py -src/codatlending/models/shared/accountingaddress.py -src/codatlending/models/shared/accountingaddresstype.py -src/codatlending/models/shared/commercecompanyinfo.py -src/codatlending/models/shared/commerceaddress.py -src/codatlending/models/shared/commerceaddresstype.py -src/codatlending/models/shared/accountbalance.py +src/codatlending/models/shared/links.py +src/codatlending/models/shared/halref.py src/codatlending/models/shared/connections.py -src/codatlending/models/shared/dataintegritydetails.py -src/codatlending/models/shared/dataintegritydetail.py -src/codatlending/models/shared/dataintegritymatch.py -src/codatlending/models/shared/dataintegritydatatype.py -src/codatlending/models/shared/dataintegritystatuses.py -src/codatlending/models/shared/dataintegritystatus.py -src/codatlending/models/shared/dataintegritystatusinfo.py -src/codatlending/models/shared/integritystatus.py -src/codatlending/models/shared/dataintegritydates.py -src/codatlending/models/shared/dataintegrityconnectionid.py -src/codatlending/models/shared/dataintegrityamounts.py -src/codatlending/models/shared/dataintegritysummaries.py -src/codatlending/models/shared/dataintegritysummary.py -src/codatlending/models/shared/dataintegritybycount.py -src/codatlending/models/shared/dataintegritybyamount.py -src/codatlending/models/shared/excelreporttypes.py -src/codatlending/models/shared/excelstatus.py -src/codatlending/models/shared/file.py -src/codatlending/models/shared/loansummary.py -src/codatlending/models/shared/loansummaryreportitem.py -src/codatlending/models/shared/loansummaryrecordref.py -src/codatlending/models/shared/loansummaryrecordreftype.py -src/codatlending/models/shared/loansummaryintegrationtype.py -src/codatlending/models/shared/loansummaryreportinfo.py -src/codatlending/models/shared/loantransactions.py -src/codatlending/models/shared/reportitems.py -src/codatlending/models/shared/loanref.py -src/codatlending/models/shared/definitionsitemref.py -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/billcreditnotestatus.py +src/codatlending/models/shared/accountingaccounttransaction.py +src/codatlending/models/shared/metadata.py +src/codatlending/models/shared/accounttransactionline.py +src/codatlending/models/shared/recordref.py +src/codatlending/models/shared/bankaccountref.py +src/codatlending/models/shared/accountingaccounttransactions.py +src/codatlending/models/shared/accountingdirectcost.py +src/codatlending/models/shared/supplementaldata.py src/codatlending/models/shared/accountingpaymentallocation.py src/codatlending/models/shared/paymentallocationpayment.py src/codatlending/models/shared/accountref.py -src/codatlending/models/shared/billcreditnotelineitem.py +src/codatlending/models/shared/directcostlineitem.py src/codatlending/models/shared/trackingcategoryref.py -src/codatlending/models/shared/accountspayabletracking.py -src/codatlending/models/shared/projectref.py -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 -src/codatlending/models/shared/accountingbillpayments.py -src/codatlending/models/shared/accountingbill.py -src/codatlending/models/shared/billstatus.py -src/codatlending/models/shared/billlineitem.py +src/codatlending/models/shared/tracking.py src/codatlending/models/shared/taxrateref.py -src/codatlending/models/shared/itemref.py +src/codatlending/models/shared/propertie_itemref.py +src/codatlending/models/shared/datatype.py src/codatlending/models/shared/accountingattachment.py -src/codatlending/models/shared/accountingbills.py +src/codatlending/models/shared/accountingdirectcosts.py src/codatlending/models/shared/attachments.py -src/codatlending/models/shared/accountingsupplier.py -src/codatlending/models/shared/supplierstatus.py -src/codatlending/models/shared/accountingsuppliers.py -src/codatlending/models/shared/accountingcreditnote.py -src/codatlending/models/shared/creditnotestatus.py -src/codatlending/models/shared/creditnotelineitem.py -src/codatlending/models/shared/accountsreceivabletracking.py -src/codatlending/models/shared/billedtotype1.py -src/codatlending/models/shared/accountingcreditnotes.py -src/codatlending/models/shared/accountingcustomer.py -src/codatlending/models/shared/customerstatus.py -src/codatlending/models/shared/contact.py -src/codatlending/models/shared/accountingcustomers.py -src/codatlending/models/shared/accountingdirectincome.py -src/codatlending/models/shared/directincomelineitem.py +src/codatlending/models/shared/accountingtransfer.py +src/codatlending/models/shared/transferaccount.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 -src/codatlending/models/shared/invoicelineitem.py -src/codatlending/models/shared/accountinginvoices.py -src/codatlending/models/shared/enhancedinvoicesreport.py -src/codatlending/models/shared/enhancedinvoicereportitem.py -src/codatlending/models/shared/payment.py -src/codatlending/models/shared/bankingtransactionref.py -src/codatlending/models/shared/lendingcustomerref.py -src/codatlending/models/shared/reportinfo.py -src/codatlending/models/shared/accountingpayment.py -src/codatlending/models/shared/paymentline.py -src/codatlending/models/shared/paymentlinelink.py -src/codatlending/models/shared/paymentlinktype.py -src/codatlending/models/shared/accountingpayments.py -src/codatlending/models/shared/accountingagedcreditorreport.py -src/codatlending/models/shared/agedcreditor.py -src/codatlending/models/shared/agedcurrencyoutstanding.py -src/codatlending/models/shared/agedoutstandingamount.py -src/codatlending/models/shared/agedoutstandingamountdetail.py -src/codatlending/models/shared/accountingageddebtorreport.py -src/codatlending/models/shared/ageddebtor.py +src/codatlending/models/shared/accountingtransfers.py +src/codatlending/models/shared/accountingjournalentry.py +src/codatlending/models/shared/journalref.py +src/codatlending/models/shared/journalline.py +src/codatlending/models/shared/accountingjournalentries.py +src/codatlending/models/shared/accountingjournal.py +src/codatlending/models/shared/journalstatus.py +src/codatlending/models/shared/accountingjournals.py +src/codatlending/models/shared/accountingbanktransactions.py +src/codatlending/models/shared/accountingbanktransaction.py +src/codatlending/models/shared/banktransactiontype.py +src/codatlending/models/shared/accountingbankaccount.py +src/codatlending/models/shared/accountingbankaccounttype.py +src/codatlending/models/shared/accountingbankaccounts.py src/codatlending/models/shared/bankingaccountbalances.py src/codatlending/models/shared/bankingaccountbalance.py src/codatlending/models/shared/accountbalanceamounts.py @@ -340,13 +263,6 @@ src/codatlending/models/shared/accountinstitution.py src/codatlending/models/shared/accountidentifiers.py src/codatlending/models/shared/accountidentifiertype.py src/codatlending/models/shared/bankingaccounts.py -src/codatlending/models/shared/enhancedcashflowtransactions.py -src/codatlending/models/shared/enhancedcashflowitem.py -src/codatlending/models/shared/enhancedcashflowtransaction.py -src/codatlending/models/shared/transactioncategory.py -src/codatlending/models/shared/sourceref.py -src/codatlending/models/shared/datasource.py -src/codatlending/models/shared/accounts.py src/codatlending/models/shared/bankingtransactioncategory.py src/codatlending/models/shared/transactioncategorystatus.py src/codatlending/models/shared/bankingtransactioncategories.py @@ -354,55 +270,42 @@ src/codatlending/models/shared/bankingtransaction.py src/codatlending/models/shared/transactioncategoryref.py src/codatlending/models/shared/transactioncode.py src/codatlending/models/shared/bankingtransactions.py -src/codatlending/models/shared/accountingaccount.py -src/codatlending/models/shared/accounttype.py -src/codatlending/models/shared/accountstatus.py -src/codatlending/models/shared/accountingaccounts.py -src/codatlending/models/shared/accountingbalancesheet.py -src/codatlending/models/shared/balancesheet.py -src/codatlending/models/shared/reportline.py -src/codatlending/models/shared/enhancedfinancialreport.py -src/codatlending/models/shared/enhancedreportaccountcategory.py -src/codatlending/models/shared/accountcategorylevel.py -src/codatlending/models/shared/enhancedreportinfo.py -src/codatlending/models/shared/accountingcashflowstatement.py -src/codatlending/models/shared/cashflowstatement.py -src/codatlending/models/shared/reportinput.py -src/codatlending/models/shared/reportbasis.py -src/codatlending/models/shared/accountingprofitandlossreport.py -src/codatlending/models/shared/profitandlossreport.py -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/pushoperationchange.py -src/codatlending/models/shared/pushchangetype.py -src/codatlending/models/shared/pushoperationref.py -src/codatlending/models/shared/pushoption.py -src/codatlending/models/shared/pushvalidationinfo.py -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/accountingcreatebanktransactionsresponse.py -src/codatlending/models/shared/accountingcreatebanktransactions.py -src/codatlending/models/shared/createbankaccounttransaction.py -src/codatlending/models/shared/pushoperation.py -src/codatlending/models/shared/pushoperations.py -src/codatlending/models/shared/accountingcreatedirectcostresponse.py -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 -src/codatlending/models/shared/transferaccount.py -src/codatlending/models/shared/pulloperation.py -src/codatlending/models/shared/pulloperations.py -src/codatlending/models/shared/datastatus.py +src/codatlending/models/shared/enhancedcashflowtransactions.py +src/codatlending/models/shared/enhancedcashflowitem.py +src/codatlending/models/shared/enhancedcashflowtransaction.py +src/codatlending/models/shared/transactioncategory.py +src/codatlending/models/shared/sourceref.py +src/codatlending/models/shared/reportinfo.py +src/codatlending/models/shared/datasource.py +src/codatlending/models/shared/accounts.py +src/codatlending/models/shared/accountingbill.py +src/codatlending/models/shared/supplierref.py +src/codatlending/models/shared/billstatus.py +src/codatlending/models/shared/billlineitem.py +src/codatlending/models/shared/accountspayabletracking.py +src/codatlending/models/shared/projectref.py +src/codatlending/models/shared/billedtotype.py +src/codatlending/models/shared/accountingcustomerref.py +src/codatlending/models/shared/accountingbills.py +src/codatlending/models/shared/accountingsupplier.py +src/codatlending/models/shared/supplierstatus.py +src/codatlending/models/shared/accountingaddress.py +src/codatlending/models/shared/accountingaddresstype.py +src/codatlending/models/shared/accountingsuppliers.py +src/codatlending/models/shared/accountingbillcreditnote.py +src/codatlending/models/shared/items.py +src/codatlending/models/shared/billcreditnotestatus.py +src/codatlending/models/shared/billcreditnotelineitem.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 +src/codatlending/models/shared/accountingbillpayments.py src/codatlending/models/shared/commercecustomer.py +src/codatlending/models/shared/commerceaddress.py +src/codatlending/models/shared/commerceaddresstype.py src/codatlending/models/shared/commercecustomers.py src/codatlending/models/shared/commercedispute.py src/codatlending/models/shared/disputestatus.py @@ -411,13 +314,6 @@ src/codatlending/models/shared/transactionsourcetype.py src/codatlending/models/shared/commercedisputes.py src/codatlending/models/shared/commercelocation.py src/codatlending/models/shared/commercelocations.py -src/codatlending/models/shared/commercereport.py -src/codatlending/models/shared/commercereportcomponent.py -src/codatlending/models/shared/reportcomponentmeasure.py -src/codatlending/models/shared/commercereportmeasure.py -src/codatlending/models/shared/commercereporterror.py -src/codatlending/models/shared/commercereportdimension.py -src/codatlending/models/shared/periodunit.py src/codatlending/models/shared/commerceorder.py src/codatlending/models/shared/servicecharge.py src/codatlending/models/shared/servicechargetype.py @@ -450,103 +346,214 @@ src/codatlending/models/shared/commerceproducts.py src/codatlending/models/shared/commercetransaction.py src/codatlending/models/shared/transactiontype.py src/codatlending/models/shared/commercetransactions.py -src/codatlending/models/shared/accountingaccounttransaction.py -src/codatlending/models/shared/accounttransactionline.py -src/codatlending/models/shared/bankaccountref.py -src/codatlending/models/shared/accountingaccounttransactions.py -src/codatlending/models/shared/accountingdirectcosts.py -src/codatlending/models/shared/accountingjournalentry.py -src/codatlending/models/shared/journalref.py -src/codatlending/models/shared/journalline.py -src/codatlending/models/shared/accountingjournalentries.py -src/codatlending/models/shared/accountingjournal.py -src/codatlending/models/shared/journalstatus.py -src/codatlending/models/shared/accountingjournals.py -src/codatlending/models/shared/accountingtransfers.py -src/codatlending/models/shared/security.py -src/codatlending/models/shared/accountcategoriesupdatedwebhook.py -src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py -src/codatlending/models/shared/clientratelimitreachedwebhook.py -src/codatlending/models/shared/clientratelimitreachedwebhookdata.py -src/codatlending/models/shared/clientratelimitresetwebhook.py -src/codatlending/models/shared/clientratelimitresetwebhookdata.py -src/codatlending/models/shared/__init__.py -src/codatlending/models/webhooks/account_categories_updated.py -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 -USAGE.md -docs/models/operations/getaccountingbankaccountrequest.md -docs/models/operations/getaccountingbankaccountresponse.md -docs/models/operations/listaccountingbankaccountsrequest.md -docs/models/operations/listaccountingbankaccountsresponse.md -docs/models/operations/listaccountingbankaccounttransactionsrequest.md -docs/models/operations/listaccountingbankaccounttransactionsresponse.md -docs/models/operations/createcompanyresponse.md -docs/models/operations/deletecompanyrequest.md -docs/models/operations/deletecompanyresponse.md -docs/models/operations/getcompanyrequest.md -docs/models/operations/getcompanyresponse.md -docs/models/operations/listcompaniesrequest.md -docs/models/operations/listcompaniesresponse.md -docs/models/operations/updatecompanyrequest.md -docs/models/operations/updatecompanyresponse.md -docs/models/operations/getaccountingprofilerequest.md -docs/models/operations/getaccountingprofileresponse.md -docs/models/operations/getcommerceprofilerequest.md -docs/models/operations/getcommerceprofileresponse.md -docs/models/operations/createconnectionrequestbody.md -docs/models/operations/createconnectionrequest.md -docs/models/operations/createconnectionresponse.md -docs/models/operations/deleteconnectionrequest.md -docs/models/operations/deleteconnectionresponse.md -docs/models/operations/getconnectionrequest.md -docs/models/operations/getconnectionresponse.md -docs/models/operations/listconnectionsrequest.md -docs/models/operations/listconnectionsresponse.md -docs/models/operations/unlinkconnectionupdateconnection.md -docs/models/operations/unlinkconnectionrequest.md -docs/models/operations/unlinkconnectionresponse.md -docs/models/operations/listdataintegritydetailsrequest.md -docs/models/operations/listdataintegritydetailsresponse.md -docs/models/operations/getdataintegritystatusrequest.md -docs/models/operations/getdataintegritystatusresponse.md -docs/models/operations/getdataintegritysummariesrequest.md -docs/models/operations/getdataintegritysummariesresponse.md -docs/models/operations/downloadexcelreportrequest.md -docs/models/operations/downloadexcelreportresponse.md -docs/models/operations/generateexcelreportrequest.md -docs/models/operations/generateexcelreportresponse.md -docs/models/operations/getexcelreportgenerationstatusrequest.md -docs/models/operations/getexcelreportgenerationstatusresponse.md -docs/models/operations/downloadfilesrequest.md -docs/models/operations/downloadfilesresponse.md -docs/models/operations/listfilesrequest.md -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 -docs/models/operations/listloantransactionsrequest.md -docs/models/operations/listloantransactionsresponse.md -docs/models/operations/getaccountingbillcreditnoterequest.md -docs/models/operations/getaccountingbillcreditnoteresponse.md -docs/models/operations/listaccountingbillcreditnotesrequest.md -docs/models/operations/listaccountingbillcreditnotesresponse.md -docs/models/operations/getaccountingbillpaymentrequest.md -docs/models/operations/getaccountingbillpaymentresponse.md -docs/models/operations/listaccountingbillpaymentsrequest.md -docs/models/operations/listaccountingbillpaymentsresponse.md +src/codatlending/models/shared/commercereport.py +src/codatlending/models/shared/commercereportcomponent.py +src/codatlending/models/shared/reportcomponentmeasure.py +src/codatlending/models/shared/commercereportmeasure.py +src/codatlending/models/shared/commercereporterror.py +src/codatlending/models/shared/commercereportdimension.py +src/codatlending/models/shared/periodunit.py +src/codatlending/models/shared/accountingcompanyinfo.py +src/codatlending/models/shared/weblink.py +src/codatlending/models/shared/phonenumber.py +src/codatlending/models/shared/phonenumbertype.py +src/codatlending/models/shared/commercecompanyinfo.py +src/codatlending/models/shared/accountbalance.py +src/codatlending/models/shared/accountingcustomer.py +src/codatlending/models/shared/customerstatus.py +src/codatlending/models/shared/contact.py +src/codatlending/models/shared/accountingcustomers.py +src/codatlending/models/shared/accountingdirectincome.py +src/codatlending/models/shared/directincomelineitem.py +src/codatlending/models/shared/accountingdirectincomes.py +src/codatlending/models/shared/accountinginvoice.py +src/codatlending/models/shared/invoicestatus.py +src/codatlending/models/shared/invoicelineitem.py +src/codatlending/models/shared/accountsreceivabletracking.py +src/codatlending/models/shared/billedtotype1.py +src/codatlending/models/shared/accountinginvoices.py +src/codatlending/models/shared/enhancedinvoicesreport.py +src/codatlending/models/shared/enhancedinvoicereportitem.py +src/codatlending/models/shared/payment.py +src/codatlending/models/shared/bankingtransactionref.py +src/codatlending/models/shared/lendingcustomerref.py +src/codatlending/models/shared/accountingcreditnote.py +src/codatlending/models/shared/creditnotestatus.py +src/codatlending/models/shared/creditnotelineitem.py +src/codatlending/models/shared/accountingcreditnotes.py +src/codatlending/models/shared/accountingpayment.py +src/codatlending/models/shared/paymentline.py +src/codatlending/models/shared/paymentlinelink.py +src/codatlending/models/shared/paymentlinktype.py +src/codatlending/models/shared/accountingpayments.py +src/codatlending/models/shared/accountingagedcreditorreport.py +src/codatlending/models/shared/agedcreditor.py +src/codatlending/models/shared/agedcurrencyoutstanding.py +src/codatlending/models/shared/agedoutstandingamount.py +src/codatlending/models/shared/agedoutstandingamountdetail.py +src/codatlending/models/shared/accountingageddebtorreport.py +src/codatlending/models/shared/ageddebtor.py +src/codatlending/models/shared/file.py +src/codatlending/models/shared/accountingcreatebankaccountresponse.py +src/codatlending/models/shared/validation.py +src/codatlending/models/shared/validationitem.py +src/codatlending/models/shared/pushoperationstatus.py +src/codatlending/models/shared/pushoperationchange.py +src/codatlending/models/shared/pushchangetype.py +src/codatlending/models/shared/pushoperationref.py +src/codatlending/models/shared/pushoption.py +src/codatlending/models/shared/pushvalidationinfo.py +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/accountingcreatebanktransactionsresponse.py +src/codatlending/models/shared/accountingcreatebanktransactions.py +src/codatlending/models/shared/createbankaccounttransaction.py +src/codatlending/models/shared/accountingcreateaccountresponse.py +src/codatlending/models/shared/accountingaccount.py +src/codatlending/models/shared/accounttype.py +src/codatlending/models/shared/accountstatus.py +src/codatlending/models/shared/accountprototype.py +src/codatlending/models/shared/accountingcreatedirectcostresponse.py +src/codatlending/models/shared/directcostprototype.py +src/codatlending/models/shared/accountingcreatepaymentresponse.py +src/codatlending/models/shared/accountingcreatesupplierresponse.py +src/codatlending/models/shared/accountingcreatetransferresponse.py +src/codatlending/models/shared/pushoperation.py +src/codatlending/models/shared/pushoperations.py +src/codatlending/models/shared/accountingaccounts.py +src/codatlending/models/shared/accountingbalancesheet.py +src/codatlending/models/shared/balancesheet.py +src/codatlending/models/shared/reportline_input.py +src/codatlending/models/shared/reportline.py +src/codatlending/models/shared/enhancedfinancialreport.py +src/codatlending/models/shared/enhancedreportaccountcategory.py +src/codatlending/models/shared/accountcategorylevel.py +src/codatlending/models/shared/enhancedreportinfo.py +src/codatlending/models/shared/accountingcashflowstatement.py +src/codatlending/models/shared/cashflowstatement.py +src/codatlending/models/shared/reportinput.py +src/codatlending/models/shared/reportbasis.py +src/codatlending/models/shared/accountingprofitandlossreport.py +src/codatlending/models/shared/profitandlossreport.py +src/codatlending/models/shared/datastatus.py +src/codatlending/models/shared/pulloperation.py +src/codatlending/models/shared/schema_datatype.py +src/codatlending/models/shared/pulloperations.py +src/codatlending/models/shared/loansummary.py +src/codatlending/models/shared/loansummaryreportitem.py +src/codatlending/models/shared/loansummaryrecordref.py +src/codatlending/models/shared/loansummaryrecordreftype.py +src/codatlending/models/shared/loansummaryintegrationtype.py +src/codatlending/models/shared/loansummaryreportinfo.py +src/codatlending/models/shared/loantransactions.py +src/codatlending/models/shared/reportitems.py +src/codatlending/models/shared/loanref.py +src/codatlending/models/shared/itemref.py +src/codatlending/models/shared/loantransactionsreportinfo.py +src/codatlending/models/shared/dataintegritydetails.py +src/codatlending/models/shared/dataintegritydetail.py +src/codatlending/models/shared/dataintegritymatch.py +src/codatlending/models/shared/dataintegritydatatype.py +src/codatlending/models/shared/dataintegritystatuses.py +src/codatlending/models/shared/dataintegritystatus.py +src/codatlending/models/shared/dataintegritystatusinfo.py +src/codatlending/models/shared/integritystatus.py +src/codatlending/models/shared/dataintegritydates.py +src/codatlending/models/shared/dataintegrityconnectionid.py +src/codatlending/models/shared/dataintegrityamounts.py +src/codatlending/models/shared/dataintegritysummaries.py +src/codatlending/models/shared/dataintegritysummary.py +src/codatlending/models/shared/dataintegritybycount.py +src/codatlending/models/shared/dataintegritybyamount.py +src/codatlending/models/shared/excelreporttypes.py +src/codatlending/models/shared/excelstatus.py +src/codatlending/models/shared/security.py +src/codatlending/models/shared/accountcategoriesupdatedwebhook.py +src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py +src/codatlending/models/shared/clientratelimitreachedwebhook.py +src/codatlending/models/shared/clientratelimitreachedwebhookdata.py +src/codatlending/models/shared/clientratelimitresetwebhook.py +src/codatlending/models/shared/clientratelimitresetwebhookdata.py +src/codatlending/models/errors/errormessage.py +src/codatlending/models/webhooks/account_categories_updated.py +src/codatlending/models/webhooks/client_rate_limit_reached.py +src/codatlending/models/webhooks/client_rate_limit_reset.py +src/codatlending/models/__init__.py +src/codatlending/models/errors/__init__.py +src/codatlending/models/operations/__init__.py +src/codatlending/models/shared/__init__.py +src/codatlending/models/webhooks/__init__.py +docs/models/operations/createcompanyresponse.md +docs/models/operations/deletecompanyrequest.md +docs/models/operations/deletecompanyresponse.md +docs/models/operations/getcompanyrequest.md +docs/models/operations/getcompanyresponse.md +docs/models/operations/listcompaniesrequest.md +docs/models/operations/listcompaniesresponse.md +docs/models/operations/updatecompanyrequest.md +docs/models/operations/updatecompanyresponse.md +docs/models/operations/createconnectionrequestbody.md +docs/models/operations/createconnectionrequest.md +docs/models/operations/createconnectionresponse.md +docs/models/operations/deleteconnectionrequest.md +docs/models/operations/deleteconnectionresponse.md +docs/models/operations/getconnectionrequest.md +docs/models/operations/getconnectionresponse.md +docs/models/operations/listconnectionsrequest.md +docs/models/operations/listconnectionsresponse.md +docs/models/operations/unlinkconnectionupdateconnection.md +docs/models/operations/unlinkconnectionrequest.md +docs/models/operations/unlinkconnectionresponse.md +docs/models/operations/getaccountingaccounttransactionrequest.md +docs/models/operations/getaccountingaccounttransactionresponse.md +docs/models/operations/listaccountingaccounttransactionsrequest.md +docs/models/operations/listaccountingaccounttransactionsresponse.md +docs/models/operations/downloadaccountingdirectcostattachmentrequest.md +docs/models/operations/downloadaccountingdirectcostattachmentresponse.md +docs/models/operations/getaccountingdirectcostrequest.md +docs/models/operations/getaccountingdirectcostresponse.md +docs/models/operations/getaccountingdirectcostattachmentrequest.md +docs/models/operations/getaccountingdirectcostattachmentresponse.md +docs/models/operations/listaccountingdirectcostsrequest.md +docs/models/operations/listaccountingdirectcostsresponse.md +docs/models/operations/listaccountingdirectcostattachmentsrequest.md +docs/models/operations/listaccountingdirectcostattachmentsresponse.md +docs/models/operations/getaccountingtransferrequest.md +docs/models/operations/getaccountingtransferresponse.md +docs/models/operations/listaccountingtransfersrequest.md +docs/models/operations/listaccountingtransfersresponse.md +docs/models/operations/getaccountingjournalentryrequest.md +docs/models/operations/getaccountingjournalentryresponse.md +docs/models/operations/listaccountingjournalentriesrequest.md +docs/models/operations/listaccountingjournalentriesresponse.md +docs/models/operations/getaccountingjournalrequest.md +docs/models/operations/getaccountingjournalresponse.md +docs/models/operations/listaccountingjournalsrequest.md +docs/models/operations/listaccountingjournalsresponse.md +docs/models/operations/listaccountingbankaccounttransactionsrequest.md +docs/models/operations/listaccountingbankaccounttransactionsresponse.md +docs/models/operations/getaccountingbankaccountrequest.md +docs/models/operations/getaccountingbankaccountresponse.md +docs/models/operations/listaccountingbankaccountsrequest.md +docs/models/operations/listaccountingbankaccountsresponse.md +docs/models/operations/listbankingaccountbalancesrequest.md +docs/models/operations/listbankingaccountbalancesresponse.md +docs/models/operations/getbankingaccountrequest.md +docs/models/operations/getbankingaccountresponse.md +docs/models/operations/listbankingaccountsrequest.md +docs/models/operations/listbankingaccountsresponse.md +docs/models/operations/getbankingtransactioncategoryrequest.md +docs/models/operations/getbankingtransactioncategoryresponse.md +docs/models/operations/listbankingtransactioncategoriesrequest.md +docs/models/operations/listbankingtransactioncategoriesresponse.md +docs/models/operations/getbankingtransactionrequest.md +docs/models/operations/getbankingtransactionresponse.md +docs/models/operations/listbankingtransactionsrequest.md +docs/models/operations/listbankingtransactionsresponse.md +docs/models/operations/getcategorizedbankstatementrequest.md +docs/models/operations/getcategorizedbankstatementresponse.md docs/models/operations/downloadaccountingbillattachmentrequest.md docs/models/operations/downloadaccountingbillattachmentresponse.md docs/models/operations/getaccountingbillrequest.md @@ -567,124 +574,14 @@ docs/models/operations/listaccountingsuppliersrequest.md docs/models/operations/listaccountingsuppliersresponse.md docs/models/operations/listaccountingsupplierattachmentsrequest.md docs/models/operations/listaccountingsupplierattachmentsresponse.md -docs/models/operations/getaccountingcreditnoterequest.md -docs/models/operations/getaccountingcreditnoteresponse.md -docs/models/operations/listaccountingcreditnotesrequest.md -docs/models/operations/listaccountingcreditnotesresponse.md -docs/models/operations/downloadaccountingcustomerattachmentrequest.md -docs/models/operations/downloadaccountingcustomerattachmentresponse.md -docs/models/operations/getaccountingcustomerrequest.md -docs/models/operations/getaccountingcustomerresponse.md -docs/models/operations/getaccountingcustomerattachmentrequest.md -docs/models/operations/getaccountingcustomerattachmentresponse.md -docs/models/operations/listaccountingcustomersrequest.md -docs/models/operations/listaccountingcustomersresponse.md -docs/models/operations/listaccountingcustomerattachmentsrequest.md -docs/models/operations/listaccountingcustomerattachmentsresponse.md -docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md -docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md -docs/models/operations/getaccountingdirectincomerequest.md -docs/models/operations/getaccountingdirectincomeresponse.md -docs/models/operations/getaccountingdirectincomeattachmentrequest.md -docs/models/operations/getaccountingdirectincomeattachmentresponse.md -docs/models/operations/listaccountingdirectincomesrequest.md -docs/models/operations/listaccountingdirectincomesresponse.md -docs/models/operations/listaccountingdirectincomeattachmentsrequest.md -docs/models/operations/listaccountingdirectincomeattachmentsresponse.md -docs/models/operations/downloadaccountinginvoiceattachmentrequest.md -docs/models/operations/downloadaccountinginvoiceattachmentresponse.md -docs/models/operations/downloadaccountinginvoicepdfrequest.md -docs/models/operations/downloadaccountinginvoicepdfresponse.md -docs/models/operations/getaccountinginvoicerequest.md -docs/models/operations/getaccountinginvoiceresponse.md -docs/models/operations/getaccountinginvoiceattachmentrequest.md -docs/models/operations/getaccountinginvoiceattachmentresponse.md -docs/models/operations/listaccountinginvoicesrequest.md -docs/models/operations/listaccountinginvoicesresponse.md -docs/models/operations/listaccountinginvoiceattachmentsrequest.md -docs/models/operations/listaccountinginvoiceattachmentsresponse.md -docs/models/operations/listreconciledinvoicesrequest.md -docs/models/operations/listreconciledinvoicesresponse.md -docs/models/operations/getaccountingpaymentrequest.md -docs/models/operations/getaccountingpaymentresponse.md -docs/models/operations/listaccountingpaymentsrequest.md -docs/models/operations/listaccountingpaymentsresponse.md -docs/models/operations/getaccountingagedcreditorsreportrequest.md -docs/models/operations/getaccountingagedcreditorsreportresponse.md -docs/models/operations/getaccountingageddebtorsreportrequest.md -docs/models/operations/getaccountingageddebtorsreportresponse.md -docs/models/operations/isagedcreditorsreportavailablerequest.md -docs/models/operations/isagedcreditorsreportavailableresponse.md -docs/models/operations/isageddebtorsreportavailablerequest.md -docs/models/operations/isageddebtorsreportavailableresponse.md -docs/models/operations/listbankingaccountbalancesrequest.md -docs/models/operations/listbankingaccountbalancesresponse.md -docs/models/operations/getbankingaccountrequest.md -docs/models/operations/getbankingaccountresponse.md -docs/models/operations/listbankingaccountsrequest.md -docs/models/operations/listbankingaccountsresponse.md -docs/models/operations/getcategorizedbankstatementrequest.md -docs/models/operations/getcategorizedbankstatementresponse.md -docs/models/operations/getbankingtransactioncategoryrequest.md -docs/models/operations/getbankingtransactioncategoryresponse.md -docs/models/operations/listbankingtransactioncategoriesrequest.md -docs/models/operations/listbankingtransactioncategoriesresponse.md -docs/models/operations/getbankingtransactionrequest.md -docs/models/operations/getbankingtransactionresponse.md -docs/models/operations/listbankingtransactionsrequest.md -docs/models/operations/listbankingtransactionsresponse.md -docs/models/operations/getaccountingaccountrequest.md -docs/models/operations/getaccountingaccountresponse.md -docs/models/operations/listaccountingaccountsrequest.md -docs/models/operations/listaccountingaccountsresponse.md -docs/models/operations/getaccountingbalancesheetrequest.md -docs/models/operations/getaccountingbalancesheetresponse.md -docs/models/operations/getcategorizedbalancesheetstatementrequest.md -docs/models/operations/getcategorizedbalancesheetstatementresponse.md -docs/models/operations/getaccountingcashflowstatementrequest.md -docs/models/operations/getaccountingcashflowstatementresponse.md -docs/models/operations/getaccountingprofitandlossrequest.md -docs/models/operations/getaccountingprofitandlossresponse.md -docs/models/operations/getcategorizedprofitandlossstatementrequest.md -docs/models/operations/getcategorizedprofitandlossstatementresponse.md -docs/models/operations/createaccountrequest.md -docs/models/operations/createaccountresponse.md -docs/models/operations/getcreatechartofaccountsmodelrequest.md -docs/models/operations/getcreatechartofaccountsmodelresponse.md -docs/models/operations/createbanktransactionsrequest.md -docs/models/operations/createbanktransactionsresponse.md -docs/models/operations/getcreatebanktransactionsmodelrequest.md -docs/models/operations/getcreatebanktransactionsmodelresponse.md -docs/models/operations/getcreateoperationrequest.md -docs/models/operations/getcreateoperationresponse.md -docs/models/operations/listcreateoperationsrequest.md -docs/models/operations/listcreateoperationsresponse.md -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 -docs/models/operations/getcreateupdatesuppliersmodelresponse.md -docs/models/operations/createtransferrequest.md -docs/models/operations/createtransferresponse.md -docs/models/operations/getcreatetransfersmodelrequest.md -docs/models/operations/getcreatetransfersmodelresponse.md -docs/models/operations/getpulloperationrequest.md -docs/models/operations/getpulloperationresponse.md -docs/models/operations/listpulloperationsrequest.md -docs/models/operations/listpulloperationsresponse.md -docs/models/operations/refreshalldatatypesrequest.md -docs/models/operations/refreshalldatatypesresponse.md -docs/models/operations/refreshdatatyperequest.md -docs/models/operations/refreshdatatyperesponse.md -docs/models/operations/getdatastatusrequest.md -docs/models/operations/getdatastatusresponse.md +docs/models/operations/getaccountingbillcreditnoterequest.md +docs/models/operations/getaccountingbillcreditnoteresponse.md +docs/models/operations/listaccountingbillcreditnotesrequest.md +docs/models/operations/listaccountingbillcreditnotesresponse.md +docs/models/operations/getaccountingbillpaymentrequest.md +docs/models/operations/getaccountingbillpaymentresponse.md +docs/models/operations/listaccountingbillpaymentsrequest.md +docs/models/operations/listaccountingbillpaymentsresponse.md docs/models/operations/getcommercecustomerrequest.md docs/models/operations/getcommercecustomerresponse.md docs/models/operations/listcommercecustomersrequest.md @@ -697,12 +594,6 @@ docs/models/operations/getcommercelocationrequest.md docs/models/operations/getcommercelocationresponse.md docs/models/operations/listcommercelocationsrequest.md docs/models/operations/listcommercelocationsresponse.md -docs/models/operations/getcommercecustomerretentionmetricsrequest.md -docs/models/operations/getcommercecustomerretentionmetricsresponse.md -docs/models/operations/getcommercelifetimevaluemetricsrequest.md -docs/models/operations/getcommercelifetimevaluemetricsresponse.md -docs/models/operations/getcommercerevenuemetricsrequest.md -docs/models/operations/getcommercerevenuemetricsresponse.md docs/models/operations/getcommerceorderrequest.md docs/models/operations/getcommerceorderresponse.md docs/models/operations/listcommerceordersrequest.md @@ -723,177 +614,212 @@ docs/models/operations/getcommerceproductrequest.md docs/models/operations/getcommerceproductresponse.md docs/models/operations/listcommerceproductsrequest.md docs/models/operations/listcommerceproductsresponse.md -docs/models/operations/getcommerceordersreportrequest.md -docs/models/operations/getcommerceordersreportresponse.md -docs/models/operations/getcommercerefundsreportrequest.md -docs/models/operations/getcommercerefundsreportresponse.md docs/models/operations/getcommercetransactionrequest.md docs/models/operations/getcommercetransactionresponse.md docs/models/operations/listcommercetransactionsrequest.md docs/models/operations/listcommercetransactionsresponse.md -docs/models/operations/getaccountingaccounttransactionrequest.md -docs/models/operations/getaccountingaccounttransactionresponse.md -docs/models/operations/listaccountingaccounttransactionsrequest.md -docs/models/operations/listaccountingaccounttransactionsresponse.md -docs/models/operations/downloadaccountingdirectcostattachmentrequest.md -docs/models/operations/downloadaccountingdirectcostattachmentresponse.md -docs/models/operations/getaccountingdirectcostrequest.md -docs/models/operations/getaccountingdirectcostresponse.md -docs/models/operations/getaccountingdirectcostattachmentrequest.md -docs/models/operations/getaccountingdirectcostattachmentresponse.md -docs/models/operations/listaccountingdirectcostsrequest.md -docs/models/operations/listaccountingdirectcostsresponse.md -docs/models/operations/listaccountingdirectcostattachmentsrequest.md -docs/models/operations/listaccountingdirectcostattachmentsresponse.md -docs/models/operations/getaccountingjournalentryrequest.md -docs/models/operations/getaccountingjournalentryresponse.md -docs/models/operations/listaccountingjournalentriesrequest.md -docs/models/operations/listaccountingjournalentriesresponse.md -docs/models/operations/getaccountingjournalrequest.md -docs/models/operations/getaccountingjournalresponse.md -docs/models/operations/listaccountingjournalsrequest.md -docs/models/operations/listaccountingjournalsresponse.md -docs/models/operations/getaccountingtransferrequest.md -docs/models/operations/getaccountingtransferresponse.md -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 -docs/models/shared/links.md -docs/models/shared/halref.md -docs/models/shared/accountingbanktransactions.md -docs/models/shared/accountingbanktransaction.md -docs/models/shared/banktransactiontype.md +docs/models/operations/getcommercecustomerretentionmetricsrequest.md +docs/models/operations/getcommercecustomerretentionmetricsresponse.md +docs/models/operations/getcommercelifetimevaluemetricsrequest.md +docs/models/operations/getcommercelifetimevaluemetricsresponse.md +docs/models/operations/getcommercerevenuemetricsrequest.md +docs/models/operations/getcommercerevenuemetricsresponse.md +docs/models/operations/getcommerceordersreportrequest.md +docs/models/operations/getcommerceordersreportresponse.md +docs/models/operations/getcommercerefundsreportrequest.md +docs/models/operations/getcommercerefundsreportresponse.md +docs/models/operations/getaccountingprofilerequest.md +docs/models/operations/getaccountingprofileresponse.md +docs/models/operations/getcommerceprofilerequest.md +docs/models/operations/getcommerceprofileresponse.md +docs/models/operations/downloadaccountingcustomerattachmentrequest.md +docs/models/operations/downloadaccountingcustomerattachmentresponse.md +docs/models/operations/getaccountingcustomerrequest.md +docs/models/operations/getaccountingcustomerresponse.md +docs/models/operations/getaccountingcustomerattachmentrequest.md +docs/models/operations/getaccountingcustomerattachmentresponse.md +docs/models/operations/listaccountingcustomersrequest.md +docs/models/operations/listaccountingcustomersresponse.md +docs/models/operations/listaccountingcustomerattachmentsrequest.md +docs/models/operations/listaccountingcustomerattachmentsresponse.md +docs/models/operations/downloadaccountingdirectincomeattachmentrequest.md +docs/models/operations/downloadaccountingdirectincomeattachmentresponse.md +docs/models/operations/getaccountingdirectincomerequest.md +docs/models/operations/getaccountingdirectincomeresponse.md +docs/models/operations/getaccountingdirectincomeattachmentrequest.md +docs/models/operations/getaccountingdirectincomeattachmentresponse.md +docs/models/operations/listaccountingdirectincomesrequest.md +docs/models/operations/listaccountingdirectincomesresponse.md +docs/models/operations/listaccountingdirectincomeattachmentsrequest.md +docs/models/operations/listaccountingdirectincomeattachmentsresponse.md +docs/models/operations/downloadaccountinginvoiceattachmentrequest.md +docs/models/operations/downloadaccountinginvoiceattachmentresponse.md +docs/models/operations/downloadaccountinginvoicepdfrequest.md +docs/models/operations/downloadaccountinginvoicepdfresponse.md +docs/models/operations/getaccountinginvoicerequest.md +docs/models/operations/getaccountinginvoiceresponse.md +docs/models/operations/getaccountinginvoiceattachmentrequest.md +docs/models/operations/getaccountinginvoiceattachmentresponse.md +docs/models/operations/listaccountinginvoicesrequest.md +docs/models/operations/listaccountinginvoicesresponse.md +docs/models/operations/listaccountinginvoiceattachmentsrequest.md +docs/models/operations/listaccountinginvoiceattachmentsresponse.md +docs/models/operations/listreconciledinvoicesrequest.md +docs/models/operations/listreconciledinvoicesresponse.md +docs/models/operations/getaccountingcreditnoterequest.md +docs/models/operations/getaccountingcreditnoteresponse.md +docs/models/operations/listaccountingcreditnotesrequest.md +docs/models/operations/listaccountingcreditnotesresponse.md +docs/models/operations/getaccountingpaymentrequest.md +docs/models/operations/getaccountingpaymentresponse.md +docs/models/operations/listaccountingpaymentsrequest.md +docs/models/operations/listaccountingpaymentsresponse.md +docs/models/operations/getaccountingagedcreditorsreportrequest.md +docs/models/operations/getaccountingagedcreditorsreportresponse.md +docs/models/operations/getaccountingageddebtorsreportrequest.md +docs/models/operations/getaccountingageddebtorsreportresponse.md +docs/models/operations/isagedcreditorsreportavailablerequest.md +docs/models/operations/isagedcreditorsreportavailableresponse.md +docs/models/operations/isageddebtorsreportavailablerequest.md +docs/models/operations/isageddebtorsreportavailableresponse.md +docs/models/operations/downloadfilesrequest.md +docs/models/operations/downloadfilesresponse.md +docs/models/operations/listfilesrequest.md +docs/models/operations/listfilesresponse.md +docs/models/operations/uploadfilesrequestbody.md +docs/models/operations/uploadfilesrequest.md +docs/models/operations/uploadfilesresponse.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 +docs/models/operations/getcreatebanktransactionsmodelresponse.md +docs/models/operations/createaccountrequest.md +docs/models/operations/createaccountresponse.md +docs/models/operations/getcreatechartofaccountsmodelrequest.md +docs/models/operations/getcreatechartofaccountsmodelresponse.md +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/getcreatepaymentmodelrequest.md +docs/models/operations/getcreatepaymentmodelresponse.md +docs/models/operations/createsupplierrequest.md +docs/models/operations/createsupplierresponse.md +docs/models/operations/getcreateupdatesuppliersmodelrequest.md +docs/models/operations/getcreateupdatesuppliersmodelresponse.md +docs/models/operations/createtransferrequest.md +docs/models/operations/createtransferresponse.md +docs/models/operations/getcreatetransfersmodelrequest.md +docs/models/operations/getcreatetransfersmodelresponse.md +docs/models/operations/getcreateoperationrequest.md +docs/models/operations/getcreateoperationresponse.md +docs/models/operations/listcreateoperationsrequest.md +docs/models/operations/listcreateoperationsresponse.md +docs/models/operations/getaccountingaccountrequest.md +docs/models/operations/getaccountingaccountresponse.md +docs/models/operations/listaccountingaccountsrequest.md +docs/models/operations/listaccountingaccountsresponse.md +docs/models/operations/getaccountingbalancesheetrequest.md +docs/models/operations/getaccountingbalancesheetresponse.md +docs/models/operations/getcategorizedbalancesheetstatementrequest.md +docs/models/operations/getcategorizedbalancesheetstatementresponse.md +docs/models/operations/getaccountingcashflowstatementrequest.md +docs/models/operations/getaccountingcashflowstatementresponse.md +docs/models/operations/getaccountingprofitandlossrequest.md +docs/models/operations/getaccountingprofitandlossresponse.md +docs/models/operations/getcategorizedprofitandlossstatementrequest.md +docs/models/operations/getcategorizedprofitandlossstatementresponse.md +docs/models/operations/getdatastatusrequest.md +docs/models/operations/getdatastatusresponse.md +docs/models/operations/refreshalldatatypesrequest.md +docs/models/operations/refreshalldatatypesresponse.md +docs/models/operations/refreshdatatyperequest.md +docs/models/operations/refreshdatatyperesponse.md +docs/models/operations/getpulloperationrequest.md +docs/models/operations/getpulloperationresponse.md +docs/models/operations/listpulloperationsrequest.md +docs/models/operations/listpulloperationsresponse.md +docs/models/operations/sourcetype.md +docs/models/operations/generateloansummaryrequest.md +docs/models/operations/generateloansummaryresponse.md +docs/models/operations/queryparamsourcetype.md +docs/models/operations/generateloantransactionsrequest.md +docs/models/operations/generateloantransactionsresponse.md +docs/models/operations/getloansummaryqueryparamsourcetype.md +docs/models/operations/getloansummaryrequest.md +docs/models/operations/getloansummaryresponse.md +docs/models/operations/listloantransactionsqueryparamsourcetype.md +docs/models/operations/listloantransactionsrequest.md +docs/models/operations/listloantransactionsresponse.md +docs/models/operations/listdataintegritydetailsrequest.md +docs/models/operations/listdataintegritydetailsresponse.md +docs/models/operations/getdataintegritystatusrequest.md +docs/models/operations/getdataintegritystatusresponse.md +docs/models/operations/getdataintegritysummariesrequest.md +docs/models/operations/getdataintegritysummariesresponse.md +docs/models/operations/downloadexcelreportrequest.md +docs/models/operations/downloadexcelreportresponse.md +docs/models/operations/generateexcelreportrequest.md +docs/models/operations/generateexcelreportresponse.md +docs/models/operations/getexcelreportgenerationstatusrequest.md +docs/models/operations/getexcelreportgenerationstatusresponse.md docs/models/shared/company.md -docs/models/shared/connectionsourcetype.md +docs/models/shared/sourcetype.md docs/models/shared/connection.md docs/models/shared/dataconnectionstatus.md docs/models/shared/dataconnectionerror.md docs/models/shared/companyrequestbody.md docs/models/shared/companies.md -docs/models/shared/accountingcompanyinfo.md -docs/models/shared/weblinktype.md -docs/models/shared/weblink.md -docs/models/shared/phonenumber.md -docs/models/shared/phonenumbertype.md -docs/models/shared/accountingaddress.md -docs/models/shared/accountingaddresstype.md -docs/models/shared/commercecompanyinfo.md -docs/models/shared/commerceaddress.md -docs/models/shared/commerceaddresstype.md -docs/models/shared/accountbalance.md +docs/models/shared/links.md +docs/models/shared/halref.md docs/models/shared/connections.md -docs/models/shared/dataintegritydetails.md -docs/models/shared/dataintegritydetail.md -docs/models/shared/dataintegritymatch.md -docs/models/shared/dataintegritydatatype.md -docs/models/shared/dataintegritystatuses.md -docs/models/shared/dataintegritystatus.md -docs/models/shared/dataintegritystatusinfo.md -docs/models/shared/integritystatus.md -docs/models/shared/dataintegritydates.md -docs/models/shared/dataintegrityconnectionid.md -docs/models/shared/dataintegrityamounts.md -docs/models/shared/dataintegritysummaries.md -docs/models/shared/dataintegritysummary.md -docs/models/shared/dataintegritybycount.md -docs/models/shared/dataintegritybyamount.md -docs/models/shared/excelreporttypes.md -docs/models/shared/excelstatus.md -docs/models/shared/file.md -docs/models/shared/loansummary.md -docs/models/shared/loansummaryreportitem.md -docs/models/shared/loansummaryrecordref.md -docs/models/shared/loansummaryrecordreftype.md -docs/models/shared/loansummaryintegrationtype.md -docs/models/shared/loansummaryreportinfo.md -docs/models/shared/loantransactions.md -docs/models/shared/reportitemsloantransactiontype.md -docs/models/shared/reportitems.md -docs/models/shared/loanref.md -docs/models/shared/definitionsitemref.md -docs/models/shared/loantransactionsreportinfo.md -docs/models/shared/accountingbillcreditnote.md -docs/models/shared/items.md -docs/models/shared/supplierref.md -docs/models/shared/billcreditnotestatus.md -docs/models/shared/accountingpaymentallocationallocation.md +docs/models/shared/status.md +docs/models/shared/accountingaccounttransaction.md +docs/models/shared/metadata.md +docs/models/shared/accounttransactionline.md +docs/models/shared/recordref.md +docs/models/shared/bankaccountref.md +docs/models/shared/accountingaccounttransactions.md +docs/models/shared/accountingdirectcostcontactref.md +docs/models/shared/accountingdirectcost.md +docs/models/shared/supplementaldata.md +docs/models/shared/allocation.md docs/models/shared/accountingpaymentallocation.md docs/models/shared/paymentallocationpayment.md docs/models/shared/accountref.md -docs/models/shared/billcreditnotelineitemitemreference.md -docs/models/shared/billcreditnotelineitemtaxratereference.md -docs/models/shared/billcreditnotelineitem.md +docs/models/shared/directcostlineitem.md docs/models/shared/trackingcategoryref.md -docs/models/shared/accountspayabletracking.md -docs/models/shared/projectref.md -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 -docs/models/shared/accountingbillpayments.md -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/tracking.md docs/models/shared/taxrateref.md -docs/models/shared/itemref.md +docs/models/shared/propertieitemref.md +docs/models/shared/datatype.md docs/models/shared/accountingattachment.md -docs/models/shared/accountingbills.md +docs/models/shared/accountingdirectcosts.md docs/models/shared/attachments.md -docs/models/shared/accountingsupplier.md -docs/models/shared/supplierstatus.md -docs/models/shared/accountingsuppliers.md -docs/models/shared/accountingcreditnote.md -docs/models/shared/creditnotestatus.md -docs/models/shared/creditnotelineitem.md -docs/models/shared/accountsreceivabletrackingrecordreference.md -docs/models/shared/accountsreceivabletracking.md -docs/models/shared/billedtotype1.md -docs/models/shared/accountingcreditnotes.md -docs/models/shared/accountingcustomer.md -docs/models/shared/customerstatus.md -docs/models/shared/contact.md -docs/models/shared/accountingcustomers.md -docs/models/shared/accountingdirectincome.md -docs/models/shared/directincomelineitem.md +docs/models/shared/accountingtransfer.md +docs/models/shared/transferaccount.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 -docs/models/shared/invoicestatus.md -docs/models/shared/invoicelineitem.md -docs/models/shared/accountinginvoices.md -docs/models/shared/enhancedinvoicesreport.md -docs/models/shared/enhancedinvoicereportitem.md -docs/models/shared/payment.md -docs/models/shared/bankingtransactionref.md -docs/models/shared/lendingcustomerref.md -docs/models/shared/reportinfo.md -docs/models/shared/accountingpayment.md -docs/models/shared/paymentline.md -docs/models/shared/paymentlinelink.md -docs/models/shared/paymentlinktype.md -docs/models/shared/accountingpayments.md -docs/models/shared/accountingagedcreditorreport.md -docs/models/shared/agedcreditor.md -docs/models/shared/agedcurrencyoutstanding.md -docs/models/shared/agedoutstandingamount.md -docs/models/shared/agedoutstandingamountdetail.md -docs/models/shared/accountingageddebtorreport.md -docs/models/shared/ageddebtor.md +docs/models/shared/accountingtransfers.md +docs/models/shared/accountingjournalentry.md +docs/models/shared/journalref.md +docs/models/shared/journallinetracking.md +docs/models/shared/journalline.md +docs/models/shared/accountingjournalentries.md +docs/models/shared/accountingjournal.md +docs/models/shared/journalstatus.md +docs/models/shared/accountingjournals.md +docs/models/shared/accountingbanktransactions.md +docs/models/shared/accountingbanktransaction.md +docs/models/shared/banktransactiontype.md +docs/models/shared/accountingbankaccount.md +docs/models/shared/accountingbankaccounttype.md +docs/models/shared/accountingbankaccounts.md docs/models/shared/bankingaccountbalances.md docs/models/shared/bankingaccountbalance.md docs/models/shared/accountbalanceamounts.md @@ -902,13 +828,6 @@ docs/models/shared/accountinstitution.md docs/models/shared/accountidentifiers.md docs/models/shared/accountidentifiertype.md docs/models/shared/bankingaccounts.md -docs/models/shared/enhancedcashflowtransactions.md -docs/models/shared/enhancedcashflowitem.md -docs/models/shared/enhancedcashflowtransaction.md -docs/models/shared/transactioncategory.md -docs/models/shared/sourceref.md -docs/models/shared/datasource.md -docs/models/shared/accounts.md docs/models/shared/bankingtransactioncategory.md docs/models/shared/transactioncategorystatus.md docs/models/shared/bankingtransactioncategories.md @@ -916,60 +835,48 @@ docs/models/shared/bankingtransaction.md docs/models/shared/transactioncategoryref.md docs/models/shared/transactioncode.md docs/models/shared/bankingtransactions.md -docs/models/shared/accountingaccountvaliddatatypelinks.md -docs/models/shared/accountingaccount.md -docs/models/shared/accounttype.md -docs/models/shared/accountstatus.md -docs/models/shared/accountingaccounts.md -docs/models/shared/accountingbalancesheet.md -docs/models/shared/balancesheet.md -docs/models/shared/reportline.md -docs/models/shared/enhancedfinancialreportreportitem.md -docs/models/shared/enhancedfinancialreport.md -docs/models/shared/enhancedreportaccountcategory.md -docs/models/shared/accountcategorylevel.md -docs/models/shared/enhancedreportinfo.md -docs/models/shared/accountingcashflowstatement.md -docs/models/shared/cashflowstatement.md -docs/models/shared/reportinput.md -docs/models/shared/reportbasis.md -docs/models/shared/accountingprofitandlossreport.md -docs/models/shared/profitandlossreport.md -docs/models/shared/accountingcreateaccountresponse.md -docs/models/shared/validation.md -docs/models/shared/validationitem.md -docs/models/shared/pushoperationstatus.md -docs/models/shared/pushoperationchange.md -docs/models/shared/pushchangetype.md -docs/models/shared/pushoperationref.md -docs/models/shared/pushoption.md -docs/models/shared/pushvalidationinfo.md -docs/models/shared/pushfieldvalidation.md -docs/models/shared/pushoptiontype.md -docs/models/shared/pushoptionproperty.md -docs/models/shared/pushoptionchoice.md -docs/models/shared/accountingcreatebanktransactionsresponse.md -docs/models/shared/accountingcreatebanktransactions.md -docs/models/shared/createbankaccounttransaction.md -docs/models/shared/pushoperation.md -docs/models/shared/pushoperations.md -docs/models/shared/accountingcreatedirectcostresponse.md -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 -docs/models/shared/accountingtransfer.md -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/enhancedcashflowtransactions.md +docs/models/shared/enhancedcashflowitem.md +docs/models/shared/enhancedcashflowtransaction.md +docs/models/shared/transactioncategory.md +docs/models/shared/sourceref.md +docs/models/shared/reportinfo.md +docs/models/shared/datasource.md +docs/models/shared/accounts.md +docs/models/shared/purchaseorderreference.md +docs/models/shared/withholdingtax.md +docs/models/shared/accountingbill.md +docs/models/shared/supplierref.md +docs/models/shared/billstatus.md +docs/models/shared/billlineitemdatatype.md +docs/models/shared/recordlinereference.md +docs/models/shared/billlineitem.md +docs/models/shared/accountspayabletracking.md +docs/models/shared/projectref.md +docs/models/shared/billedtotype.md +docs/models/shared/accountingcustomerref.md +docs/models/shared/accountingbills.md +docs/models/shared/accountingsupplier.md +docs/models/shared/supplierstatus.md +docs/models/shared/accountingaddress.md +docs/models/shared/accountingaddresstype.md +docs/models/shared/accountingsuppliers.md +docs/models/shared/accountingbillcreditnote.md +docs/models/shared/items.md +docs/models/shared/billcreditnotestatus.md +docs/models/shared/itemreference.md +docs/models/shared/taxratereference.md +docs/models/shared/billcreditnotelineitem.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 +docs/models/shared/accountingbillpayments.md docs/models/shared/commercecustomer.md +docs/models/shared/commerceaddress.md +docs/models/shared/commerceaddresstype.md docs/models/shared/commercecustomers.md docs/models/shared/commercedispute.md docs/models/shared/disputestatus.md @@ -978,14 +885,6 @@ docs/models/shared/transactionsourcetype.md docs/models/shared/commercedisputes.md docs/models/shared/commercelocation.md docs/models/shared/commercelocations.md -docs/models/shared/commercereport.md -docs/models/shared/commercereportcomponent.md -docs/models/shared/reportcomponentmeasure.md -docs/models/shared/commercereportmeasure.md -docs/models/shared/commercereporterror.md -docs/models/shared/commercereportdimensionitems.md -docs/models/shared/commercereportdimension.md -docs/models/shared/periodunit.md docs/models/shared/commerceorder.md docs/models/shared/servicecharge.md docs/models/shared/servicechargetype.md @@ -1019,21 +918,140 @@ docs/models/shared/commerceproducts.md docs/models/shared/commercetransaction.md docs/models/shared/transactiontype.md docs/models/shared/commercetransactions.md -docs/models/shared/accountingaccounttransactionstatus.md -docs/models/shared/accountingaccounttransaction.md -docs/models/shared/accounttransactionline.md -docs/models/shared/bankaccountref.md -docs/models/shared/accountingaccounttransactions.md -docs/models/shared/accountingdirectcosts.md -docs/models/shared/accountingjournalentry.md -docs/models/shared/journalref.md -docs/models/shared/journallinetracking.md -docs/models/shared/journalline.md -docs/models/shared/accountingjournalentries.md -docs/models/shared/accountingjournal.md -docs/models/shared/journalstatus.md -docs/models/shared/accountingjournals.md -docs/models/shared/accountingtransfers.md +docs/models/shared/commercereport.md +docs/models/shared/commercereportcomponent.md +docs/models/shared/reportcomponentmeasure.md +docs/models/shared/commercereportmeasure.md +docs/models/shared/commercereporterror.md +docs/models/shared/commercereportdimensionitems.md +docs/models/shared/commercereportdimension.md +docs/models/shared/periodunit.md +docs/models/shared/accountingcompanyinfo.md +docs/models/shared/type.md +docs/models/shared/weblink.md +docs/models/shared/phonenumber.md +docs/models/shared/phonenumbertype.md +docs/models/shared/commercecompanyinfo.md +docs/models/shared/accountbalance.md +docs/models/shared/accountingcustomer.md +docs/models/shared/customerstatus.md +docs/models/shared/contact.md +docs/models/shared/accountingcustomers.md +docs/models/shared/accountingdirectincome.md +docs/models/shared/directincomelineitem.md +docs/models/shared/accountingdirectincomes.md +docs/models/shared/salesorderreference.md +docs/models/shared/accountinginvoice.md +docs/models/shared/invoicestatus.md +docs/models/shared/invoicelineitem.md +docs/models/shared/recordreference.md +docs/models/shared/accountsreceivabletracking.md +docs/models/shared/billedtotype1.md +docs/models/shared/accountinginvoices.md +docs/models/shared/enhancedinvoicesreport.md +docs/models/shared/enhancedinvoicereportitem.md +docs/models/shared/payment.md +docs/models/shared/bankingtransactionref.md +docs/models/shared/lendingcustomerref.md +docs/models/shared/accountingcreditnote.md +docs/models/shared/creditnotestatus.md +docs/models/shared/creditnotelineitem.md +docs/models/shared/accountingcreditnotes.md +docs/models/shared/accountingpayment.md +docs/models/shared/paymentline.md +docs/models/shared/paymentlinelink.md +docs/models/shared/paymentlinktype.md +docs/models/shared/accountingpayments.md +docs/models/shared/accountingagedcreditorreport.md +docs/models/shared/agedcreditor.md +docs/models/shared/agedcurrencyoutstanding.md +docs/models/shared/agedoutstandingamount.md +docs/models/shared/agedoutstandingamountdetail.md +docs/models/shared/accountingageddebtorreport.md +docs/models/shared/ageddebtor.md +docs/models/shared/file.md +docs/models/shared/accountingcreatebankaccountresponse.md +docs/models/shared/validation.md +docs/models/shared/validationitem.md +docs/models/shared/pushoperationstatus.md +docs/models/shared/pushoperationchange.md +docs/models/shared/pushchangetype.md +docs/models/shared/pushoperationref.md +docs/models/shared/pushoption.md +docs/models/shared/pushvalidationinfo.md +docs/models/shared/pushfieldvalidation.md +docs/models/shared/pushoptiontype.md +docs/models/shared/pushoptionproperty.md +docs/models/shared/pushoptionchoice.md +docs/models/shared/accountingcreatebanktransactionsresponse.md +docs/models/shared/accountingcreatebanktransactions.md +docs/models/shared/createbankaccounttransaction.md +docs/models/shared/accountingcreateaccountresponse.md +docs/models/shared/accountingaccountvaliddatatypelinks.md +docs/models/shared/accountingaccount.md +docs/models/shared/accounttype.md +docs/models/shared/accountstatus.md +docs/models/shared/validdatatypelinks.md +docs/models/shared/accountprototype.md +docs/models/shared/accountingcreatedirectcostresponse.md +docs/models/shared/directcostprototypecontactref.md +docs/models/shared/directcostprototype.md +docs/models/shared/accountingcreatepaymentresponse.md +docs/models/shared/accountingcreatesupplierresponse.md +docs/models/shared/accountingcreatetransferresponse.md +docs/models/shared/pushoperation.md +docs/models/shared/pushoperations.md +docs/models/shared/accountingaccounts.md +docs/models/shared/accountingbalancesheet.md +docs/models/shared/balancesheet.md +docs/models/shared/reportlineinput.md +docs/models/shared/reportline.md +docs/models/shared/reportitem.md +docs/models/shared/enhancedfinancialreport.md +docs/models/shared/enhancedreportaccountcategory.md +docs/models/shared/accountcategorylevel.md +docs/models/shared/enhancedreportinfo.md +docs/models/shared/accountingcashflowstatement.md +docs/models/shared/cashflowstatement.md +docs/models/shared/reportinput.md +docs/models/shared/reportbasis.md +docs/models/shared/accountingprofitandlossreport.md +docs/models/shared/profitandlossreport.md +docs/models/shared/datatypes.md +docs/models/shared/datastatus.md +docs/models/shared/pulloperationstatus.md +docs/models/shared/pulloperation.md +docs/models/shared/schemadatatype.md +docs/models/shared/pulloperations.md +docs/models/shared/loansummary.md +docs/models/shared/loansummaryreportitem.md +docs/models/shared/loansummaryrecordref.md +docs/models/shared/loansummaryrecordreftype.md +docs/models/shared/loansummaryintegrationtype.md +docs/models/shared/loansummaryreportinfo.md +docs/models/shared/loantransactions.md +docs/models/shared/loantransactiontype.md +docs/models/shared/reportitems.md +docs/models/shared/loanref.md +docs/models/shared/itemref.md +docs/models/shared/loantransactionsreportinfo.md +docs/models/shared/dataintegritydetails.md +docs/models/shared/dataintegritydetail.md +docs/models/shared/dataintegritymatch.md +docs/models/shared/dataintegritydatatype.md +docs/models/shared/dataintegritystatuses.md +docs/models/shared/dataintegritystatus.md +docs/models/shared/dataintegritystatusinfo.md +docs/models/shared/integritystatus.md +docs/models/shared/dataintegritydates.md +docs/models/shared/dataintegrityconnectionid.md +docs/models/shared/dataintegrityamounts.md +docs/models/shared/dataintegritysummaries.md +docs/models/shared/dataintegritysummary.md +docs/models/shared/dataintegritybycount.md +docs/models/shared/dataintegritybyamount.md +docs/models/shared/excelreporttypes.md +docs/models/shared/excelstatus.md docs/models/shared/security.md docs/models/shared/accountcategoriesupdatedwebhook.md docs/models/shared/accountcategoriesupdatedwebhookdata.md @@ -1041,70 +1059,73 @@ docs/models/shared/clientratelimitreachedwebhook.md docs/models/shared/clientratelimitreachedwebhookdata.md docs/models/shared/clientratelimitresetwebhook.md docs/models/shared/clientratelimitresetwebhookdata.md +docs/models/errors/errormessage.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/transactions/README.md +docs/sdks/accounttransactions/README.md +docs/sdks/codatlendingdirectcosts/README.md +docs/sdks/codatlendingtransfers/README.md +docs/sdks/journalentries/README.md +docs/sdks/journals/README.md +docs/sdks/codatlendingaccountingbankdata/README.md +docs/sdks/accounts/README.md +docs/sdks/banking/README.md +docs/sdks/accountbalances/README.md +docs/sdks/codatlendingaccounts/README.md +docs/sdks/transactioncategories/README.md +docs/sdks/codatlendingbankingtransactions/README.md +docs/sdks/categorizedstatement/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/bills/README.md +docs/sdks/suppliers/README.md +docs/sdks/billcreditnotes/README.md +docs/sdks/billpayments/README.md +docs/sdks/sales/README.md +docs/sdks/codatlendingcustomers/README.md +docs/sdks/disputes/README.md +docs/sdks/locations/README.md +docs/sdks/orders/README.md +docs/sdks/paymentmethods/README.md +docs/sdks/codatlendingsalespayments/README.md +docs/sdks/productcategories/README.md +docs/sdks/products/README.md +docs/sdks/codatlendingtransactions/README.md +docs/sdks/metrics/README.md +docs/sdks/codatlendingreports/README.md +docs/sdks/companyinfo/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/customers/README.md +docs/sdks/directincomes/README.md +docs/sdks/invoices/README.md +docs/sdks/creditnotes/README.md +docs/sdks/payments/README.md +docs/sdks/reports/README.md +docs/sdks/fileupload/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/bankaccounts/README.md +docs/sdks/banktransactions/README.md +docs/sdks/codatlendingloanwritebackaccounts/README.md +docs/sdks/directcosts/README.md +docs/sdks/codatlendingpayments/README.md +docs/sdks/codatlendingsuppliers/README.md +docs/sdks/transfers/README.md +docs/sdks/createoperations/README.md +docs/sdks/financialstatements/README.md +docs/sdks/codatlendingfinancialstatementsaccounts/README.md +docs/sdks/balancesheet/README.md +docs/sdks/cashflow/README.md +docs/sdks/profitandloss/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 +docs/sdks/refresh/README.md +docs/sdks/pulloperations/README.md +docs/sdks/liabilities/README.md +docs/sdks/dataintegrity/README.md +docs/sdks/excelreports/README.md +USAGE.md .gitattributes \ No newline at end of file diff --git a/lending/gen.yaml b/lending/gen.yaml index 01b7dc9e0..9c8473520 100644 --- a/lending/gen.yaml +++ b/lending/gen.yaml @@ -1,28 +1,46 @@ configVersion: 1.0.0 management: - docChecksum: 49794ddbb09eb6f879edbfdbcf289538 + docChecksum: 12e40076647cc13ceba5ae79e163f014 docVersion: 3.0.0 - speakeasyVersion: 1.100.2 - generationVersion: 2.159.2 + speakeasyVersion: 1.125.1 + generationVersion: 2.210.3 generation: + comments: {} sdkClassName: CodatLending - singleTagPerOp: false + repoURL: https://github.com/codatio/client-sdk-python.git + usageSnippets: + optionalPropertyRendering: withExample telemetryEnabled: true features: python: - core: 3.0.2 + core: 4.1.5 deprecations: 2.81.1 - downloadStreams: 0.0.1 - examples: 2.81.2 - globalSecurity: 2.82.0 - globalServerURLs: 2.82.0 + downloadStreams: 0.0.2 + examples: 2.81.3 + globalSecurity: 2.83.0 + globalServerURLs: 2.82.1 groups: 2.81.2 + inputOutputModels: 2.82.0 nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 5.0.0 + version: 6.0.0 author: Codat + clientServerStatusCodesAsErrors: true description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. flattenGlobalSecurity: false + imports: + option: openapi + paths: + callbacks: models/callbacks + errors: models/errors + operations: models/operations + shared: models/shared + webhooks: models/webhooks + inputModelSuffix: input + installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=lending maxMethodParams: 0 + outputModelSuffix: output packageName: codat-lending + published: true + repoSubDirectory: lending diff --git a/lending/pylintrc b/lending/pylintrc old mode 100755 new mode 100644 diff --git a/lending/setup.py b/lending/setup.py old mode 100755 new mode 100644 index e4f1c6754..535ffd880 --- a/lending/setup.py +++ b/lending/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="codat-lending", - version="5.0.0", + version="6.0.0", author="Codat", description="Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.", long_description=long_description, @@ -30,7 +30,7 @@ "six>=1.16.0", "typing-inspect>=0.9.0", "typing_extensions>=4.7.1", - "urllib3>=2.0.4", + "urllib3>=1.26.18", ], extras_require={ "dev":["pylint==2.16.2"] diff --git a/lending/src/codatlending/__init__.py b/lending/src/codatlending/__init__.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/banking_account_balances.py b/lending/src/codatlending/account_balances.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/banking_account_balances.py rename to lending/src/codatlending/account_balances.py index 5f17bee2a..09487b1e4 --- a/lending/src/codatlending/banking_account_balances.py +++ b/lending/src/codatlending/account_balances.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class BankingAccountBalances: +class AccountBalances: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/AccountBalance) for a given company's connection. @@ -28,7 +29,10 @@ def list(self, request: operations.ListBankingAccountBalancesRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -47,7 +51,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListBankingAccountBalancesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -56,12 +60,15 @@ def do_request(): res.banking_account_balances = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions_account_transactions.py b/lending/src/codatlending/account_transactions.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/transactions_account_transactions.py rename to lending/src/codatlending/account_transactions.py index 359b19e8d..1583712d0 --- a/lending/src/codatlending/transactions_account_transactions.py +++ b/lending/src/codatlending/account_transactions.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class TransactionsAccountTransactions: +class AccountTransactions: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingAccountTransactionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingAccountTransactionResponse: r"""Get account transaction The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingAccountTransactionRequest, retrie headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingAccountTransactionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_account_transaction = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/AccountTransaction) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingAccountTransactionsRequest, ret headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingAccountTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_account_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 [400, 401, 404, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounting_bank_data_accounts.py b/lending/src/codatlending/accounts.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/accounting_bank_data_accounts.py rename to lending/src/codatlending/accounts.py index 7652ea9a2..080b60db2 --- a/lending/src/codatlending/accounting_bank_data_accounts.py +++ b/lending/src/codatlending/accounts.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountingBankDataAccounts: +class Accounts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingBankAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBankAccountResponse: r"""Get bank account The *Get bank account* endpoint returns a single account for a given accountId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingBankAccountRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBankAccountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_bank_account = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/BankAccount) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingBankAccountsRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBankAccountsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_bank_accounts = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_payable.py b/lending/src/codatlending/accounts_payable.py old mode 100755 new mode 100644 index 4adb8b76f..2ca983559 --- a/lending/src/codatlending/accounts_payable.py +++ b/lending/src/codatlending/accounts_payable.py @@ -1,16 +1,16 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .accounts_payable_bill_credit_notes import AccountsPayableBillCreditNotes -from .accounts_payable_bill_payments import AccountsPayableBillPayments -from .accounts_payable_bills import AccountsPayableBills -from .accounts_payable_suppliers import AccountsPayableSuppliers +from .bill_credit_notes import BillCreditNotes +from .bill_payments import BillPayments +from .bills import Bills from .sdkconfiguration import SDKConfiguration +from .suppliers import Suppliers class AccountsPayable: - bill_credit_notes: AccountsPayableBillCreditNotes - bill_payments: AccountsPayableBillPayments - bills: AccountsPayableBills - suppliers: AccountsPayableSuppliers + bills: Bills + suppliers: Suppliers + bill_credit_notes: BillCreditNotes + bill_payments: BillPayments sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -18,9 +18,9 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.bill_credit_notes = AccountsPayableBillCreditNotes(self.sdk_configuration) - self.bill_payments = AccountsPayableBillPayments(self.sdk_configuration) - self.bills = AccountsPayableBills(self.sdk_configuration) - self.suppliers = AccountsPayableSuppliers(self.sdk_configuration) + self.bills = Bills(self.sdk_configuration) + self.suppliers = Suppliers(self.sdk_configuration) + self.bill_credit_notes = BillCreditNotes(self.sdk_configuration) + self.bill_payments = BillPayments(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/accounts_receivable.py b/lending/src/codatlending/accounts_receivable.py old mode 100755 new mode 100644 index 40a0a7811..128e38cb6 --- a/lending/src/codatlending/accounts_receivable.py +++ b/lending/src/codatlending/accounts_receivable.py @@ -1,20 +1,20 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .accounts_receivable_credit_notes import AccountsReceivableCreditNotes -from .accounts_receivable_customers import AccountsReceivableCustomers -from .accounts_receivable_direct_incomes import AccountsReceivableDirectIncomes -from .accounts_receivable_invoices import AccountsReceivableInvoices -from .accounts_receivable_payments import AccountsReceivablePayments -from .accounts_receivable_reports import AccountsReceivableReports +from .credit_notes import CreditNotes +from .customers import Customers +from .direct_incomes import DirectIncomes +from .invoices import Invoices +from .payments import Payments +from .reports import Reports from .sdkconfiguration import SDKConfiguration class AccountsReceivable: - credit_notes: AccountsReceivableCreditNotes - customers: AccountsReceivableCustomers - direct_incomes: AccountsReceivableDirectIncomes - invoices: AccountsReceivableInvoices - payments: AccountsReceivablePayments - reports: AccountsReceivableReports + customers: Customers + direct_incomes: DirectIncomes + invoices: Invoices + credit_notes: CreditNotes + payments: Payments + reports: Reports sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -22,11 +22,11 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.credit_notes = AccountsReceivableCreditNotes(self.sdk_configuration) - self.customers = AccountsReceivableCustomers(self.sdk_configuration) - self.direct_incomes = AccountsReceivableDirectIncomes(self.sdk_configuration) - self.invoices = AccountsReceivableInvoices(self.sdk_configuration) - self.payments = AccountsReceivablePayments(self.sdk_configuration) - self.reports = AccountsReceivableReports(self.sdk_configuration) + self.customers = Customers(self.sdk_configuration) + self.direct_incomes = DirectIncomes(self.sdk_configuration) + self.invoices = Invoices(self.sdk_configuration) + self.credit_notes = CreditNotes(self.sdk_configuration) + self.payments = Payments(self.sdk_configuration) + self.reports = Reports(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/financial_statements_balance_sheet.py b/lending/src/codatlending/balance_sheet.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/financial_statements_balance_sheet.py rename to lending/src/codatlending/balance_sheet.py index 5cc682aad..91b6ab3fe --- a/lending/src/codatlending/financial_statements_balance_sheet.py +++ b/lending/src/codatlending/balance_sheet.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class FinancialStatementsBalanceSheet: +class BalanceSheet: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingBalanceSheetRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBalanceSheetResponse: r"""Get balance sheet Gets the latest balance sheet for a company. @@ -24,7 +25,10 @@ def get(self, request: operations.GetAccountingBalanceSheetRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -43,7 +47,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBalanceSheetResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -52,16 +56,20 @@ def do_request(): res.accounting_balance_sheet = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_categorized_accounts(self, request: operations.GetCategorizedBalanceSheetStatementRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCategorizedBalanceSheetStatementResponse: r"""Get categorized balance sheet statement The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. @@ -76,7 +84,10 @@ def get_categorized_accounts(self, request: operations.GetCategorizedBalanceShee headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -95,7 +106,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCategorizedBalanceSheetStatementResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -104,12 +115,15 @@ def do_request(): res.enhanced_financial_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/bank_accounts.py b/lending/src/codatlending/bank_accounts.py new file mode 100644 index 000000000..47d1ecb4f --- /dev/null +++ b/lending/src/codatlending/bank_accounts.py @@ -0,0 +1,146 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkconfiguration import SDKConfiguration +from codatlending import utils +from codatlending.models import errors, operations, shared +from typing import Optional + +class BankAccounts: + 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/lending-api#/schemas/BankAccount) for a given company's connection. + + [Bank accounts](https://docs.codat.io/lending-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/lending-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. + """ + 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) + headers = {} + req_content_type, data, form = utils.serialize_request_body(request, "accounting_bank_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.CreateBankAccountRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) + + 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, data=data, files=form, 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.CreateBankAccountResponse(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 + 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, 402, 403, 404, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + + 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/lending-api#/schemas/BankAccount) for a given company and integration. + + [Bank accounts](https://docs.codat.io/lending-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. + """ + 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) + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) + + 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('GET', url, 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.GetCreateUpdateBankAccountsModelResponse(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.PushOption]) + res.push_option = 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, 402, 403, 404, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + + return res + + \ No newline at end of file diff --git a/lending/src/codatlending/loan_writeback_bank_transactions.py b/lending/src/codatlending/bank_transactions.py old mode 100755 new mode 100644 similarity index 80% rename from lending/src/codatlending/loan_writeback_bank_transactions.py rename to lending/src/codatlending/bank_transactions.py index 446aefa84..b3866cb91 --- a/lending/src/codatlending/loan_writeback_bank_transactions.py +++ b/lending/src/codatlending/bank_transactions.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackBankTransactions: +class BankTransactions: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/BankTransactions) for a given company's connection. @@ -35,7 +36,10 @@ def create(self, request: operations.CreateBankTransactionsRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateBankTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,16 +67,20 @@ def do_request(): res.accounting_create_bank_transactions_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 [401, 404, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/BankTransactions) for a given company and integration. @@ -92,7 +100,10 @@ def get_create_model(self, request: operations.GetCreateBankTransactionsModelReq headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,7 +122,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateBankTransactionsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/banking.py b/lending/src/codatlending/banking.py old mode 100755 new mode 100644 index 96d1b7e6e..61d5087e2 --- a/lending/src/codatlending/banking.py +++ b/lending/src/codatlending/banking.py @@ -1,18 +1,18 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .banking_account_balances import BankingAccountBalances -from .banking_accounts import BankingAccounts -from .banking_categorized_statement import BankingCategorizedStatement -from .banking_transaction_categories import BankingTransactionCategories -from .banking_transactions import BankingTransactions +from .account_balances import AccountBalances +from .categorized_statement import CategorizedStatement +from .codatlending_accounts import CodatLendingAccounts +from .codatlending_banking_transactions import CodatLendingBankingTransactions from .sdkconfiguration import SDKConfiguration +from .transaction_categories import TransactionCategories class Banking: - account_balances: BankingAccountBalances - accounts: BankingAccounts - categorized_statement: BankingCategorizedStatement - transaction_categories: BankingTransactionCategories - transactions: BankingTransactions + account_balances: AccountBalances + accounts: CodatLendingAccounts + transaction_categories: TransactionCategories + transactions: CodatLendingBankingTransactions + categorized_statement: CategorizedStatement sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -20,10 +20,10 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.account_balances = BankingAccountBalances(self.sdk_configuration) - self.accounts = BankingAccounts(self.sdk_configuration) - self.categorized_statement = BankingCategorizedStatement(self.sdk_configuration) - self.transaction_categories = BankingTransactionCategories(self.sdk_configuration) - self.transactions = BankingTransactions(self.sdk_configuration) + self.account_balances = AccountBalances(self.sdk_configuration) + self.accounts = CodatLendingAccounts(self.sdk_configuration) + self.transaction_categories = TransactionCategories(self.sdk_configuration) + self.transactions = CodatLendingBankingTransactions(self.sdk_configuration) + self.categorized_statement = CategorizedStatement(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/accounts_payable_bill_credit_notes.py b/lending/src/codatlending/bill_credit_notes.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/accounts_payable_bill_credit_notes.py rename to lending/src/codatlending/bill_credit_notes.py index b50d0f391..4b74c1347 --- a/lending/src/codatlending/accounts_payable_bill_credit_notes.py +++ b/lending/src/codatlending/bill_credit_notes.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountsPayableBillCreditNotes: +class BillCreditNotes: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingBillCreditNoteRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBillCreditNoteResponse: r"""Get bill credit note The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingBillCreditNoteRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBillCreditNoteResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_bill_credit_note = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/BillCreditNote) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingBillCreditNotesRequest, retries headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBillCreditNotesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_bill_credit_notes = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_payable_bill_payments.py b/lending/src/codatlending/bill_payments.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/accounts_payable_bill_payments.py rename to lending/src/codatlending/bill_payments.py index e7012e225..72e719647 --- a/lending/src/codatlending/accounts_payable_bill_payments.py +++ b/lending/src/codatlending/bill_payments.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountsPayableBillPayments: +class BillPayments: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingBillPaymentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBillPaymentResponse: r"""Get bill payment The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingBillPaymentRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBillPaymentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_bill_payment = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/BillPayment) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingBillPaymentsRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBillPaymentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_bill_payments = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_payable_bills.py b/lending/src/codatlending/bills.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/accounts_payable_bills.py rename to lending/src/codatlending/bills.py index 4743d3413..cda4fdddc --- a/lending/src/codatlending/accounts_payable_bills.py +++ b/lending/src/codatlending/bills.py @@ -10,13 +10,14 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class AccountsPayableBills: +class Bills: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingBillAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingBillAttachmentResponse: r"""Download bill attachment The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. @@ -35,7 +36,10 @@ def download_attachment(self, request: operations.DownloadAccountingBillAttachme headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingBillAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,16 +66,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingBillRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBillResponse: r"""Get bill The *Get bill* endpoint returns a single bill for a given billId. @@ -89,7 +97,10 @@ def get(self, request: operations.GetAccountingBillRequest, retries: Optional[ut headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -108,7 +119,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBillResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -117,16 +128,20 @@ def do_request(): res.accounting_bill = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingBillAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingBillAttachmentResponse: r"""Get bill attachment The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. @@ -142,7 +157,10 @@ def get_attachment(self, request: operations.GetAccountingBillAttachmentRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -161,7 +179,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingBillAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -170,16 +188,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Bill) for a given company's connection. @@ -196,7 +218,10 @@ def list(self, request: operations.ListAccountingBillsRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -215,7 +240,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBillsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -224,16 +249,20 @@ def do_request(): res.accounting_bills = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingBillAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingBillAttachmentsResponse: r"""List bill attachments The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. @@ -249,7 +278,10 @@ def list_attachments(self, request: operations.ListAccountingBillAttachmentsRequ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -268,7 +300,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBillAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -277,12 +309,15 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/financial_statements_cash_flow.py b/lending/src/codatlending/cash_flow.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/financial_statements_cash_flow.py rename to lending/src/codatlending/cash_flow.py index 2cf769b09..2baa0c7a3 --- a/lending/src/codatlending/financial_statements_cash_flow.py +++ b/lending/src/codatlending/cash_flow.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class FinancialStatementsCashFlow: +class CashFlow: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingCashFlowStatementRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingCashFlowStatementResponse: r"""Get cash flow statement Gets the latest cash flow statement for a company. @@ -24,7 +25,10 @@ def get(self, request: operations.GetAccountingCashFlowStatementRequest, retries headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -43,7 +47,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingCashFlowStatementResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -52,12 +56,15 @@ def do_request(): res.accounting_cash_flow_statement = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/banking_categorized_statement.py b/lending/src/codatlending/categorized_statement.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/banking_categorized_statement.py rename to lending/src/codatlending/categorized_statement.py index 5561f40c3..f6d6aa2fc --- a/lending/src/codatlending/banking_categorized_statement.py +++ b/lending/src/codatlending/categorized_statement.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class BankingCategorizedStatement: +class CategorizedStatement: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCategorizedBankStatementRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCategorizedBankStatementResponse: r"""Get categorized bank statement > **Categorization engine** @@ -28,7 +29,10 @@ def get(self, request: operations.GetCategorizedBankStatementRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -47,7 +51,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCategorizedBankStatementResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -56,12 +60,15 @@ def do_request(): res.enhanced_cash_flow_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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounting_bank_data.py b/lending/src/codatlending/codatlending_accounting_bank_data.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/accounting_bank_data.py rename to lending/src/codatlending/codatlending_accounting_bank_data.py index 205ca592e..c5689b274 --- a/lending/src/codatlending/accounting_bank_data.py +++ b/lending/src/codatlending/codatlending_accounting_bank_data.py @@ -1,14 +1,14 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .accounting_bank_data_accounts import AccountingBankDataAccounts +from .accounts import Accounts from .sdkconfiguration import SDKConfiguration from codatlending import utils from codatlending.models import errors, operations, shared from typing import Optional -class AccountingBankData: +class CodatLendingAccountingBankData: r"""Access bank transactions from an accounting platform.""" - accounts: AccountingBankDataAccounts + accounts: Accounts sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -16,9 +16,10 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.accounts = AccountingBankDataAccounts(self.sdk_configuration) + self.accounts = Accounts(self.sdk_configuration) + 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/lending-api#/schemas/BankTransactions) for a given company's connection. @@ -37,7 +38,10 @@ def list_transactions(self, request: operations.ListAccountingBankAccountTransac headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -56,7 +60,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingBankAccountTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -65,12 +69,15 @@ def do_request(): res.accounting_bank_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 [400, 401, 404, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/banking_accounts.py b/lending/src/codatlending/codatlending_accounts.py old mode 100755 new mode 100644 similarity index 74% rename from lending/src/codatlending/banking_accounts.py rename to lending/src/codatlending/codatlending_accounts.py index 20eaf8131..6c4b9d217 --- a/lending/src/codatlending/banking_accounts.py +++ b/lending/src/codatlending/codatlending_accounts.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class BankingAccounts: +class CodatLendingAccounts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetBankingAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetBankingAccountResponse: r"""Get account The *Get account* endpoint returns a single account for a given accountId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetBankingAccountRequest, retries: Optional[ut headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetBankingAccountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,10 +61,20 @@ def do_request(): res.banking_account = 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, 402, 403, 404, 409, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Account) for a given company's connection. @@ -77,7 +91,10 @@ def list(self, request: operations.ListBankingAccountsRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -96,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListBankingAccountsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -105,12 +122,15 @@ def do_request(): res.banking_accounts = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/banking_transactions.py b/lending/src/codatlending/codatlending_banking_transactions.py old mode 100755 new mode 100644 similarity index 75% rename from lending/src/codatlending/banking_transactions.py rename to lending/src/codatlending/codatlending_banking_transactions.py index a89548f1b..65a70d1a4 --- a/lending/src/codatlending/banking_transactions.py +++ b/lending/src/codatlending/codatlending_banking_transactions.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class BankingTransactions: +class CodatLendingBankingTransactions: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetBankingTransactionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetBankingTransactionResponse: r"""Get bank transaction The *Get transaction* endpoint returns a single transaction for a given transactionId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetBankingTransactionRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetBankingTransactionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,10 +61,20 @@ def do_request(): res.banking_transaction = 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, 402, 403, 404, 409, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Transaction) for a given company's connection. @@ -77,7 +91,10 @@ def list(self, request: operations.ListBankingTransactionsRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -96,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListBankingTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -105,12 +122,15 @@ def do_request(): res.banking_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 [400, 401, 404, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_customers.py b/lending/src/codatlending/codatlending_customers.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_customers.py rename to lending/src/codatlending/codatlending_customers.py index f67585a8e..ece83eca9 --- a/lending/src/codatlending/sales_customers.py +++ b/lending/src/codatlending/codatlending_customers.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesCustomers: +class CodatLendingCustomers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceCustomerRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceCustomerResponse: r"""Get customer The *Get customer* endpoint returns a single customer for a given customerId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceCustomerRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceCustomerResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_customer = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Customer) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceCustomersRequest, retries: Option headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceCustomersResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_customers = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions_direct_costs.py b/lending/src/codatlending/codatlending_direct_costs.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/transactions_direct_costs.py rename to lending/src/codatlending/codatlending_direct_costs.py index baae15cae..676a3f41d --- a/lending/src/codatlending/transactions_direct_costs.py +++ b/lending/src/codatlending/codatlending_direct_costs.py @@ -10,13 +10,14 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class TransactionsDirectCosts: +class CodatLendingDirectCosts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingDirectCostAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingDirectCostAttachmentResponse: r"""Download direct cost attachment The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. @@ -35,7 +36,10 @@ def download_attachment(self, request: operations.DownloadAccountingDirectCostAt headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingDirectCostAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,16 +66,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingDirectCostRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingDirectCostResponse: r"""Get direct cost The *Get direct cost* endpoint returns a single direct cost for a given directCostId. @@ -89,7 +97,10 @@ def get(self, request: operations.GetAccountingDirectCostRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -108,7 +119,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingDirectCostResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -117,16 +128,20 @@ def do_request(): res.accounting_direct_cost = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingDirectCostAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingDirectCostAttachmentResponse: r"""Get direct cost attachment The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. @@ -142,7 +157,10 @@ def get_attachment(self, request: operations.GetAccountingDirectCostAttachmentRe headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -161,7 +179,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingDirectCostAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -170,16 +188,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/DirectCost) for a given company's connection. @@ -196,7 +218,10 @@ def list(self, request: operations.ListAccountingDirectCostsRequest, retries: Op headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -215,7 +240,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingDirectCostsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -224,16 +249,20 @@ def do_request(): res.accounting_direct_costs = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingDirectCostAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingDirectCostAttachmentsResponse: r"""List direct cost attachments The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. @@ -249,7 +278,10 @@ def list_attachments(self, request: operations.ListAccountingDirectCostAttachmen headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -268,7 +300,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingDirectCostAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -277,12 +309,15 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/financial_statements_accounts.py b/lending/src/codatlending/codatlending_financial_statements_accounts.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/financial_statements_accounts.py rename to lending/src/codatlending/codatlending_financial_statements_accounts.py index 6a4fe2177..3c805fd99 --- a/lending/src/codatlending/financial_statements_accounts.py +++ b/lending/src/codatlending/codatlending_financial_statements_accounts.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class FinancialStatementsAccounts: +class CodatLendingFinancialStatementsAccounts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingAccountRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingAccountResponse: r"""Get account The *Get account* endpoint returns a single account for a given accountId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingAccountRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingAccountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_account = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Account) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingAccountsRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingAccountsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_accounts = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback_accounts.py b/lending/src/codatlending/codatlending_loan_writeback_accounts.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/loan_writeback_accounts.py rename to lending/src/codatlending/codatlending_loan_writeback_accounts.py index 041803fd0..ae5cff765 --- a/lending/src/codatlending/loan_writeback_accounts.py +++ b/lending/src/codatlending/codatlending_loan_writeback_accounts.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackAccounts: +class CodatLendingLoanWritebackAccounts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/Account) for a given company's connection. @@ -28,14 +29,17 @@ 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", True, True, 'json') + req_content_type, data, form = utils.serialize_request_body(request, "account_prototype", 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.CreateAccountRequest, request) headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateAccountResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,16 +67,20 @@ def do_request(): res.accounting_create_account_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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Account) for a given company and integration. @@ -92,7 +100,10 @@ def get_create_model(self, request: operations.GetCreateChartOfAccountsModelRequ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,7 +122,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateChartOfAccountsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback_payments.py b/lending/src/codatlending/codatlending_payments.py old mode 100755 new mode 100644 similarity index 74% rename from lending/src/codatlending/loan_writeback_payments.py rename to lending/src/codatlending/codatlending_payments.py index f052ef4ab..89956b61a --- a/lending/src/codatlending/loan_writeback_payments.py +++ b/lending/src/codatlending/codatlending_payments.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackPayments: +class CodatLendingPayments: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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. @@ -35,7 +36,10 @@ def create(self, request: operations.CreatePaymentRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreatePaymentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,17 +67,21 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res - def get_create_model(self, request: operations.GetCreatePaymentsModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreatePaymentsModelResponse: + + def get_create_model(self, request: operations.GetCreatePaymentModelRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreatePaymentModelResponse: 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. @@ -87,12 +95,15 @@ def get_create_model(self, request: operations.GetCreatePaymentsModelRequest, re """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetCreatePaymentsModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/payments', request) + url = utils.generate_url(operations.GetCreatePaymentModelRequest, base_url, '/companies/{companyId}/connections/{connectionId}/options/payments', request) headers = {} headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,8 +122,8 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - - res = operations.GetCreatePaymentsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + + res = operations.GetCreatePaymentModelResponse(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'): @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_reports.py b/lending/src/codatlending/codatlending_reports.py old mode 100755 new mode 100644 similarity index 82% rename from lending/src/codatlending/sales_reports.py rename to lending/src/codatlending/codatlending_reports.py index bd23cfd33..e39aac48f --- a/lending/src/codatlending/sales_reports.py +++ b/lending/src/codatlending/codatlending_reports.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesReports: +class CodatLendingReports: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get_orders(self, request: operations.GetCommerceOrdersReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceOrdersReportResponse: r"""Get orders report The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time. @@ -46,7 +47,10 @@ def get_orders(self, request: operations.GetCommerceOrdersReportRequest, retries headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -65,7 +69,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceOrdersReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -74,16 +78,20 @@ def do_request(): res.commerce_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_refunds(self, request: operations.GetCommerceRefundsReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceRefundsReportResponse: r"""Get refunds report The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time. @@ -119,7 +127,10 @@ def get_refunds(self, request: operations.GetCommerceRefundsReportRequest, retri headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -138,7 +149,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceRefundsReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -147,12 +158,15 @@ def do_request(): res.commerce_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_payments.py b/lending/src/codatlending/codatlending_sales_payments.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/sales_payments.py rename to lending/src/codatlending/codatlending_sales_payments.py index ee6dcf452..c3cba739f --- a/lending/src/codatlending/sales_payments.py +++ b/lending/src/codatlending/codatlending_sales_payments.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesPayments: +class CodatLendingSalesPayments: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommercePaymentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommercePaymentResponse: r"""Get payment The *Get payment* endpoint returns a single payment for a given paymentId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommercePaymentRequest, retries: Optional[u headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommercePaymentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_payment = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Payment) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommercePaymentsRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommercePaymentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_payments = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback_suppliers.py b/lending/src/codatlending/codatlending_suppliers.py old mode 100755 new mode 100644 similarity index 80% rename from lending/src/codatlending/loan_writeback_suppliers.py rename to lending/src/codatlending/codatlending_suppliers.py index 1dc8558de..b3005d667 --- a/lending/src/codatlending/loan_writeback_suppliers.py +++ b/lending/src/codatlending/codatlending_suppliers.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackSuppliers: +class CodatLendingSuppliers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/Supplier) for a given company's connection. @@ -35,7 +36,10 @@ def create(self, request: operations.CreateSupplierRequest, retries: Optional[ut headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateSupplierResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,16 +67,20 @@ def do_request(): res.accounting_create_supplier_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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Supplier) for a given company and integration. @@ -92,7 +100,10 @@ def get_create_update_model(self, request: operations.GetCreateUpdateSuppliersMo headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,7 +122,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateUpdateSuppliersModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_transactions.py b/lending/src/codatlending/codatlending_transactions.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_transactions.py rename to lending/src/codatlending/codatlending_transactions.py index 5dd5dd80f..06fe34c8c --- a/lending/src/codatlending/sales_transactions.py +++ b/lending/src/codatlending/codatlending_transactions.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesTransactions: +class CodatLendingTransactions: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceTransactionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceTransactionResponse: r"""Get transaction The *Get transaction* endpoint returns a single transaction for a given transactionId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceTransactionRequest, retries: Option headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceTransactionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_transaction = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Transaction) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceTransactionsRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_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 [400, 401, 404, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions_transfers.py b/lending/src/codatlending/codatlending_transfers.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/transactions_transfers.py rename to lending/src/codatlending/codatlending_transfers.py index db768a006..518959cd5 --- a/lending/src/codatlending/transactions_transfers.py +++ b/lending/src/codatlending/codatlending_transfers.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class TransactionsTransfers: +class CodatLendingTransfers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingTransferRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingTransferResponse: r"""Get transfer The *Get transfer* endpoint returns a single transfer for a given transferId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingTransferRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingTransferResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_transfer = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Transfer) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingTransfersRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingTransfersResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_transfers = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/companies.py b/lending/src/codatlending/companies.py old mode 100755 new mode 100644 index 8180d18da..00ac0fd48 --- a/lending/src/codatlending/companies.py +++ b/lending/src/codatlending/companies.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.RetryConfig] = None) -> operations.CreateCompanyResponse: r"""Create company Creates a new company that can be used to assign connections to. @@ -29,7 +30,10 @@ def create(self, request: shared.CompanyRequestBody, retries: Optional[utils.Ret headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateCompanyResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.company = 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, 429]: + elif http_res.status_code in [400, 401, 402, 403, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def delete(self, request: operations.DeleteCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DeleteCompanyResponse: r"""Delete a company Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned. @@ -78,7 +86,10 @@ def delete(self, request: operations.DeleteCompanyRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -97,21 +108,25 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DeleteCompanyResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 204: pass - elif http_res.status_code in [401, 404, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCompanyResponse: r"""Get company Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. @@ -123,7 +138,10 @@ def get(self, request: operations.GetCompanyRequest, retries: Optional[utils.Ret headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -142,7 +160,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCompanyResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -151,16 +169,20 @@ def do_request(): res.company = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list(self, request: operations.ListCompaniesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCompaniesResponse: r"""List companies Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/lending-api#/schemas/Connection) related to the company. @@ -173,7 +195,10 @@ def list(self, request: operations.ListCompaniesRequest, retries: Optional[utils headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -192,7 +217,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCompaniesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -201,16 +226,20 @@ def do_request(): res.companies = 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, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def update(self, request: operations.UpdateCompanyRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateCompanyResponse: r"""Update company Updates both the name and description of the company. @@ -225,7 +254,10 @@ def update(self, request: operations.UpdateCompanyRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -244,7 +276,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.UpdateCompanyResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -253,12 +285,15 @@ def do_request(): res.company = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/company_info.py b/lending/src/codatlending/company_info.py old mode 100755 new mode 100644 index 956d40054..846abde9f --- a/lending/src/codatlending/company_info.py +++ b/lending/src/codatlending/company_info.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get_accounting_profile(self, request: operations.GetAccountingProfileRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingProfileResponse: r"""Get company accounting profile Gets the latest basic info for a company. @@ -24,7 +25,10 @@ def get_accounting_profile(self, request: operations.GetAccountingProfileRequest headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -43,7 +47,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingProfileResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -52,21 +56,27 @@ def do_request(): res.accounting_company_info = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_profile(self, request: operations.GetCommerceProfileRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceProfileResponse: r"""Get company commerce profile - Retrieve information about the company, as seen in the commerce platform. + Retrieve information about the company, as seen in the commerce + platform. - This may include information like addresses, tax registration details and social media or website information. + This may include information like addresses, tax registration details and + social media or website information.\" """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -75,7 +85,10 @@ def get_commerce_profile(self, request: operations.GetCommerceProfileRequest, re headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -94,7 +107,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceProfileResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -103,12 +116,15 @@ def do_request(): res.commerce_company_info = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/connections.py b/lending/src/codatlending/connections.py old mode 100755 new mode 100644 index 6b62bf07b..3426429e7 --- a/lending/src/codatlending/connections.py +++ b/lending/src/codatlending/connections.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def create(self, request: operations.CreateConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.CreateConnectionResponse: r"""Create connection Creates a connection for the company by providing a valid `platformKey`. @@ -29,7 +30,10 @@ def create(self, request: operations.CreateConnectionRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.connection = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def delete(self, request: operations.DeleteConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DeleteConnectionResponse: r"""Delete connection Revoke and remove a connection from a company. @@ -79,7 +87,10 @@ def delete(self, request: operations.DeleteConnectionRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -98,21 +109,25 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DeleteConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: pass - elif http_res.status_code in [401, 404, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetConnectionResponse: r"""Get connection Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. @@ -124,7 +139,10 @@ def get(self, request: operations.GetConnectionRequest, retries: Optional[utils. headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -143,7 +161,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -152,16 +170,20 @@ def do_request(): res.connection = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list(self, request: operations.ListConnectionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListConnectionsResponse: r"""List connections List the connections for a company. @@ -174,7 +196,10 @@ def list(self, request: operations.ListConnectionsRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -193,7 +218,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListConnectionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -202,16 +227,20 @@ def do_request(): res.connections = 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UnlinkConnectionResponse: r"""Unlink connection This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. @@ -226,7 +255,10 @@ def unlink(self, request: operations.UnlinkConnectionRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -245,7 +277,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.UnlinkConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -254,12 +286,15 @@ def do_request(): res.connection = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback_create_operations.py b/lending/src/codatlending/create_operations.py old mode 100755 new mode 100644 similarity index 74% rename from lending/src/codatlending/loan_writeback_create_operations.py rename to lending/src/codatlending/create_operations.py index ad1a143b7..970d28fbf --- a/lending/src/codatlending/loan_writeback_create_operations.py +++ b/lending/src/codatlending/create_operations.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackCreateOperations: +class CreateOperations: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCreateOperationRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCreateOperationResponse: r"""Get create operation Retrieve create operation. @@ -23,7 +24,10 @@ def get(self, request: operations.GetCreateOperationRequest, retries: Optional[u headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -42,7 +46,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateOperationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -51,16 +55,20 @@ def do_request(): res.push_operation = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list(self, request: operations.ListCreateOperationsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListCreateOperationsResponse: r"""List create operations List create operations. @@ -73,7 +81,10 @@ def list(self, request: operations.ListCreateOperationsRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -92,7 +103,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCreateOperationsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -101,12 +112,15 @@ def do_request(): res.push_operations = 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_receivable_credit_notes.py b/lending/src/codatlending/credit_notes.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/accounts_receivable_credit_notes.py rename to lending/src/codatlending/credit_notes.py index b46577c92..ca0c97e78 --- a/lending/src/codatlending/accounts_receivable_credit_notes.py +++ b/lending/src/codatlending/credit_notes.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountsReceivableCreditNotes: +class CreditNotes: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingCreditNoteRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingCreditNoteResponse: r"""Get credit note The *Get credit note* endpoint returns a single credit note for a given creditNoteId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingCreditNoteRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingCreditNoteResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_credit_note = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/CreditNote) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingCreditNotesRequest, retries: Op headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingCreditNotesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_credit_notes = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_receivable_customers.py b/lending/src/codatlending/customers.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/accounts_receivable_customers.py rename to lending/src/codatlending/customers.py index 7eb909e7e..14dbf4b2b --- a/lending/src/codatlending/accounts_receivable_customers.py +++ b/lending/src/codatlending/customers.py @@ -10,13 +10,14 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class AccountsReceivableCustomers: +class Customers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingCustomerAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingCustomerAttachmentResponse: r"""Download customer attachment The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. @@ -35,7 +36,10 @@ def download_attachment(self, request: operations.DownloadAccountingCustomerAtta headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingCustomerAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,16 +66,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingCustomerRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingCustomerResponse: r"""Get customer The *Get customer* endpoint returns a single customer for a given customerId. @@ -89,7 +97,10 @@ def get(self, request: operations.GetAccountingCustomerRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -108,7 +119,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingCustomerResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -117,16 +128,20 @@ def do_request(): res.accounting_customer = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingCustomerAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingCustomerAttachmentResponse: r"""Get customer attachment The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. @@ -142,7 +157,10 @@ def get_attachment(self, request: operations.GetAccountingCustomerAttachmentRequ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -161,7 +179,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingCustomerAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -170,16 +188,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Customer) for a given company's connection. @@ -196,7 +218,10 @@ def list(self, request: operations.ListAccountingCustomersRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -215,7 +240,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingCustomersResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -224,16 +249,20 @@ def do_request(): res.accounting_customers = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingCustomerAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingCustomerAttachmentsResponse: r"""List customer attachments The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. @@ -249,7 +278,10 @@ def list_attachments(self, request: operations.ListAccountingCustomerAttachments headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -268,7 +300,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingCustomerAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -277,12 +309,15 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/data_integrity.py b/lending/src/codatlending/data_integrity.py old mode 100755 new mode 100644 index 56e80ba86..ffb8aa99d --- a/lending/src/codatlending/data_integrity.py +++ b/lending/src/codatlending/data_integrity.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def details(self, request: operations.ListDataIntegrityDetailsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListDataIntegrityDetailsResponse: r"""List data integrity details The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results. @@ -27,7 +28,10 @@ def details(self, request: operations.ListDataIntegrityDetailsRequest, retries: headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -46,7 +50,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListDataIntegrityDetailsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -55,16 +59,20 @@ def do_request(): res.data_integrity_details = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegrityStatusResponse: r"""Get data integrity status The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. @@ -83,7 +91,10 @@ def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetDataIntegrityStatusResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,16 +122,20 @@ def do_request(): res.data_integrity_statuses = 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, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def summaries(self, request: operations.GetDataIntegritySummariesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegritySummariesResponse: r"""Get data integrity summaries The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). @@ -137,7 +152,10 @@ def summaries(self, request: operations.GetDataIntegritySummariesRequest, retrie headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -156,7 +174,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetDataIntegritySummariesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -165,12 +183,15 @@ def do_request(): res.data_integrity_summaries = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback_direct_costs.py b/lending/src/codatlending/direct_costs.py old mode 100755 new mode 100644 similarity index 79% rename from lending/src/codatlending/loan_writeback_direct_costs.py rename to lending/src/codatlending/direct_costs.py index 81bf0faae..0388b4d02 --- a/lending/src/codatlending/loan_writeback_direct_costs.py +++ b/lending/src/codatlending/direct_costs.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackDirectCosts: +class DirectCosts: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/DirectCost) for a given company's connection. @@ -28,14 +29,17 @@ 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", True, True, 'json') + req_content_type, data, form = utils.serialize_request_body(request, "direct_cost_prototype", 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.CreateDirectCostRequest, request) headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateDirectCostResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,16 +67,20 @@ def do_request(): res.accounting_create_direct_cost_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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/DirectCost) for a given company and integration. @@ -92,7 +100,10 @@ def get_create_model(self, request: operations.GetCreateDirectCostsModelRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,7 +122,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateDirectCostsModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_receivable_direct_incomes.py b/lending/src/codatlending/direct_incomes.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/accounts_receivable_direct_incomes.py rename to lending/src/codatlending/direct_incomes.py index f54c7ffe0..2c89d61a3 --- a/lending/src/codatlending/accounts_receivable_direct_incomes.py +++ b/lending/src/codatlending/direct_incomes.py @@ -10,13 +10,14 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class AccountsReceivableDirectIncomes: +class DirectIncomes: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingDirectIncomeAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingDirectIncomeAttachmentResponse: r"""Download direct income attachment The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. @@ -35,7 +36,10 @@ def download_attachment(self, request: operations.DownloadAccountingDirectIncome headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingDirectIncomeAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,16 +66,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingDirectIncomeRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingDirectIncomeResponse: r"""Get direct income The *Get direct income* endpoint returns a single direct income for a given directIncomeId. @@ -89,7 +97,10 @@ def get(self, request: operations.GetAccountingDirectIncomeRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -108,7 +119,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingDirectIncomeResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -117,16 +128,20 @@ def do_request(): res.accounting_direct_income = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingDirectIncomeAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingDirectIncomeAttachmentResponse: r"""Get direct income attachment The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. @@ -143,7 +158,10 @@ def get_attachment(self, request: operations.GetAccountingDirectIncomeAttachment headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -162,7 +180,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingDirectIncomeAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -171,16 +189,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/DirectIncome) for a given company's connection. @@ -197,7 +219,10 @@ def list(self, request: operations.ListAccountingDirectIncomesRequest, retries: headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -216,7 +241,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingDirectIncomesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -225,16 +250,20 @@ def do_request(): res.accounting_direct_incomes = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingDirectIncomeAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingDirectIncomeAttachmentsResponse: r"""List direct income attachments The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. @@ -250,7 +279,10 @@ def list_attachments(self, request: operations.ListAccountingDirectIncomeAttachm headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -269,7 +301,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingDirectIncomeAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -278,12 +310,15 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_disputes.py b/lending/src/codatlending/disputes.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_disputes.py rename to lending/src/codatlending/disputes.py index b89f0b8ea..acff76b0e --- a/lending/src/codatlending/sales_disputes.py +++ b/lending/src/codatlending/disputes.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesDisputes: +class Disputes: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceDisputeRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceDisputeResponse: r"""Get dispute The *Get dispute* endpoint returns a single dispute for a given disputeId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceDisputeRequest, retries: Optional[u headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceDisputeResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_dispute = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Dispute) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceDisputesRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceDisputesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_disputes = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/excel_reports.py b/lending/src/codatlending/excel_reports.py old mode 100755 new mode 100644 index 10b07e09e..3410c6721 --- a/lending/src/codatlending/excel_reports.py +++ b/lending/src/codatlending/excel_reports.py @@ -18,6 +18,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download(self, request: operations.DownloadExcelReportRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAcceptEnum] = None) -> operations.DownloadExcelReportResponse: r"""Download Excel report The *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company. @@ -37,7 +38,10 @@ def download(self, request: operations.DownloadExcelReportRequest, retries: Opti headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -56,7 +60,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadExcelReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -64,16 +68,20 @@ def do_request(): res.body = http_res.content 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def generate(self, request: operations.GenerateExcelReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateExcelReportResponse: r"""Generate Excel report The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. @@ -99,7 +107,10 @@ def generate(self, request: operations.GenerateExcelReportRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -118,7 +129,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GenerateExcelReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -127,16 +138,20 @@ def do_request(): res.excel_status = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_status(self, request: operations.GetExcelReportGenerationStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetExcelReportGenerationStatusResponse: r"""Get Excel report status The *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests. @@ -153,7 +168,10 @@ def get_status(self, request: operations.GetExcelReportGenerationStatusRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -172,7 +190,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetExcelReportGenerationStatusResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -181,12 +199,15 @@ def do_request(): res.excel_status = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/file_upload.py b/lending/src/codatlending/file_upload.py old mode 100755 new mode 100644 index 2f93a6075..5825ef7ae --- a/lending/src/codatlending/file_upload.py +++ b/lending/src/codatlending/file_upload.py @@ -18,6 +18,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download(self, request: operations.DownloadFilesRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAcceptEnum] = None) -> operations.DownloadFilesResponse: r"""Download all files for a company The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. @@ -33,7 +34,10 @@ def download(self, request: operations.DownloadFilesRequest, retries: Optional[u headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -52,7 +56,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadFilesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -60,16 +64,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_uploaded(self, request: operations.ListFilesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListFilesResponse: r"""List all files uploaded by a company The *List files* endpoint returns a list of all files uploaded to Codat by the SMB. @@ -81,7 +89,10 @@ def list_uploaded(self, request: operations.ListFilesRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -100,7 +111,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListFilesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -109,16 +120,20 @@ def do_request(): res.files = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def upload(self, request: operations.UploadFilesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UploadFilesResponse: r"""Upload files for a company The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. @@ -139,7 +154,10 @@ def upload(self, request: operations.UploadFilesRequest, retries: Optional[utils headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -158,17 +176,20 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.UploadFilesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: pass - elif http_res.status_code in [400, 401, 404, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/financial_statements.py b/lending/src/codatlending/financial_statements.py old mode 100755 new mode 100644 index 9edd353db..84da54909 --- a/lending/src/codatlending/financial_statements.py +++ b/lending/src/codatlending/financial_statements.py @@ -1,16 +1,16 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .financial_statements_accounts import FinancialStatementsAccounts -from .financial_statements_balance_sheet import FinancialStatementsBalanceSheet -from .financial_statements_cash_flow import FinancialStatementsCashFlow -from .financial_statements_profit_and_loss import FinancialStatementsProfitAndLoss +from .balance_sheet import BalanceSheet +from .cash_flow import CashFlow +from .codatlending_financial_statements_accounts import CodatLendingFinancialStatementsAccounts +from .profit_and_loss import ProfitAndLoss from .sdkconfiguration import SDKConfiguration class FinancialStatements: - accounts: FinancialStatementsAccounts - balance_sheet: FinancialStatementsBalanceSheet - cash_flow: FinancialStatementsCashFlow - profit_and_loss: FinancialStatementsProfitAndLoss + accounts: CodatLendingFinancialStatementsAccounts + balance_sheet: BalanceSheet + cash_flow: CashFlow + profit_and_loss: ProfitAndLoss sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -18,9 +18,9 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.accounts = FinancialStatementsAccounts(self.sdk_configuration) - self.balance_sheet = FinancialStatementsBalanceSheet(self.sdk_configuration) - self.cash_flow = FinancialStatementsCashFlow(self.sdk_configuration) - self.profit_and_loss = FinancialStatementsProfitAndLoss(self.sdk_configuration) + self.accounts = CodatLendingFinancialStatementsAccounts(self.sdk_configuration) + self.balance_sheet = BalanceSheet(self.sdk_configuration) + self.cash_flow = CashFlow(self.sdk_configuration) + self.profit_and_loss = ProfitAndLoss(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/accounts_receivable_invoices.py b/lending/src/codatlending/invoices.py old mode 100755 new mode 100644 similarity index 74% rename from lending/src/codatlending/accounts_receivable_invoices.py rename to lending/src/codatlending/invoices.py index 4dce5466a..4925ca3dd --- a/lending/src/codatlending/accounts_receivable_invoices.py +++ b/lending/src/codatlending/invoices.py @@ -10,13 +10,18 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class AccountsReceivableInvoices: +class DownloadPdfAcceptEnum(str, Enum): + APPLICATION_JSON = "application/json" + APPLICATION_PDF = "application/pdf" + +class Invoices: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingInvoiceAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingInvoiceAttachmentResponse: r"""Download invoice attachment The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. @@ -35,7 +40,10 @@ def download_attachment(self, request: operations.DownloadAccountingInvoiceAttac headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +62,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingInvoiceAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,17 +70,21 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res - def download_pdf(self, request: operations.DownloadAccountingInvoicePdfRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DownloadAccountingInvoicePdfResponse: + + def download_pdf(self, request: operations.DownloadAccountingInvoicePdfRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadPdfAcceptEnum] = None) -> operations.DownloadAccountingInvoicePdfResponse: r"""Get invoice as PDF Download invoice as a pdf. """ @@ -80,10 +92,16 @@ 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' + if accept_header_override is not None: + headers['Accept'] = accept_header_override.value + else: + headers['Accept'] = 'application/json;q=1, application/pdf;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,18 +120,28 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingInvoicePdfResponse(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/octet-stream'): + if utils.match_content_type(content_type, 'application/pdf'): 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, 402, 403, 404, 409, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingInvoiceRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingInvoiceResponse: r"""Get invoice The *Get invoice* endpoint returns a single invoice for a given invoiceId. @@ -131,7 +159,10 @@ def get(self, request: operations.GetAccountingInvoiceRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -150,7 +181,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingInvoiceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -159,16 +190,20 @@ def do_request(): res.accounting_invoice = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingInvoiceAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingInvoiceAttachmentResponse: r"""Get invoice attachment The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. @@ -184,7 +219,10 @@ def get_attachment(self, request: operations.GetAccountingInvoiceAttachmentReque headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -203,7 +241,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingInvoiceAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -212,16 +250,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Invoice) for a given company's connection. @@ -245,7 +287,10 @@ def list(self, request: operations.ListAccountingInvoicesRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -264,7 +309,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingInvoicesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -273,16 +318,20 @@ def do_request(): res.accounting_invoices = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingInvoiceAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingInvoiceAttachmentsResponse: r"""List invoice attachments The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. @@ -298,7 +347,10 @@ def list_attachments(self, request: operations.ListAccountingInvoiceAttachmentsR headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -317,7 +369,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingInvoiceAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -326,16 +378,20 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_reconciled(self, request: operations.ListReconciledInvoicesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListReconciledInvoicesResponse: r"""List reconciled invoices Gets a list of invoices linked to the corresponding banking transaction @@ -348,7 +404,10 @@ def list_reconciled(self, request: operations.ListReconciledInvoicesRequest, ret headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -367,7 +426,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListReconciledInvoicesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -376,12 +435,15 @@ def do_request(): res.enhanced_invoices_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions_journal_entries.py b/lending/src/codatlending/journal_entries.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/transactions_journal_entries.py rename to lending/src/codatlending/journal_entries.py index d73abd811..956c01333 --- a/lending/src/codatlending/transactions_journal_entries.py +++ b/lending/src/codatlending/journal_entries.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class TransactionsJournalEntries: +class JournalEntries: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingJournalEntryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingJournalEntryResponse: r"""Get journal entry The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingJournalEntryRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingJournalEntryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_journal_entry = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/JournalEntry) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingJournalEntriesRequest, retries: headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingJournalEntriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_journal_entries = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions_journals.py b/lending/src/codatlending/journals.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/transactions_journals.py rename to lending/src/codatlending/journals.py index f06e1fa89..dbc745873 --- a/lending/src/codatlending/transactions_journals.py +++ b/lending/src/codatlending/journals.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class TransactionsJournals: +class Journals: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingJournalRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingJournalResponse: r"""Get journal The *Get journal* endpoint returns a single journal for a given journalId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingJournalRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingJournalResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_journal = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Journal) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingJournalsRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingJournalsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_journals = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/liabilities.py b/lending/src/codatlending/liabilities.py old mode 100755 new mode 100644 index 101965eae..eb0b618b2 --- a/lending/src/codatlending/liabilities.py +++ b/lending/src/codatlending/liabilities.py @@ -13,6 +13,7 @@ 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. @@ -29,7 +30,10 @@ def generate_loan_summary(self, request: operations.GenerateLoanSummaryRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,21 +52,25 @@ def do_request(): '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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', 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. @@ -79,7 +87,10 @@ def generate_loan_transactions(self, request: operations.GenerateLoanTransaction headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -98,21 +109,25 @@ def do_request(): '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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', 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 from a company's accounting, banking, and commerce integrations. @@ -129,7 +144,10 @@ def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -148,7 +166,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetLoanSummaryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -157,16 +175,20 @@ 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListLoanTransactionsResponse: r"""List loan transactions The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. @@ -183,7 +205,10 @@ def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -202,7 +227,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListLoanTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -211,12 +236,15 @@ 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, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/loan_writeback.py b/lending/src/codatlending/loan_writeback.py old mode 100755 new mode 100644 index 201ce599a..7286a20f0 --- a/lending/src/codatlending/loan_writeback.py +++ b/lending/src/codatlending/loan_writeback.py @@ -1,22 +1,24 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .loan_writeback_accounts import LoanWritebackAccounts -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 .bank_accounts import BankAccounts +from .bank_transactions import BankTransactions +from .codatlending_loan_writeback_accounts import CodatLendingLoanWritebackAccounts +from .codatlending_payments import CodatLendingPayments +from .codatlending_suppliers import CodatLendingSuppliers +from .create_operations import CreateOperations +from .direct_costs import DirectCosts from .sdkconfiguration import SDKConfiguration +from .transfers import Transfers class LoanWriteback: - accounts: LoanWritebackAccounts - bank_transactions: LoanWritebackBankTransactions - create_operations: LoanWritebackCreateOperations - direct_costs: LoanWritebackDirectCosts - payments: LoanWritebackPayments - suppliers: LoanWritebackSuppliers - transfers: LoanWritebackTransfers + bank_accounts: BankAccounts + bank_transactions: BankTransactions + accounts: CodatLendingLoanWritebackAccounts + direct_costs: DirectCosts + payments: CodatLendingPayments + suppliers: CodatLendingSuppliers + transfers: Transfers + create_operations: CreateOperations sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -24,12 +26,13 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.accounts = LoanWritebackAccounts(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) + self.bank_accounts = BankAccounts(self.sdk_configuration) + self.bank_transactions = BankTransactions(self.sdk_configuration) + self.accounts = CodatLendingLoanWritebackAccounts(self.sdk_configuration) + self.direct_costs = DirectCosts(self.sdk_configuration) + self.payments = CodatLendingPayments(self.sdk_configuration) + self.suppliers = CodatLendingSuppliers(self.sdk_configuration) + self.transfers = Transfers(self.sdk_configuration) + self.create_operations = CreateOperations(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/sales_locations.py b/lending/src/codatlending/locations.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_locations.py rename to lending/src/codatlending/locations.py index 6ed4760e4..b1eb615e5 --- a/lending/src/codatlending/sales_locations.py +++ b/lending/src/codatlending/locations.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesLocations: +class Locations: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceLocationRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceLocationResponse: r"""Get location The *Get location* endpoint returns a single location for a given locationId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceLocationRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceLocationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_location = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Location) for a given company's connection. @@ -82,7 +90,10 @@ def list(self, request: operations.ListCommerceLocationsRequest, retries: Option headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -101,7 +112,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceLocationsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -110,12 +121,15 @@ def do_request(): res.commerce_locations = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/manage_data.py b/lending/src/codatlending/manage_data.py old mode 100755 new mode 100644 index 2e0298984..9a1061b1a --- a/lending/src/codatlending/manage_data.py +++ b/lending/src/codatlending/manage_data.py @@ -1,15 +1,15 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .manage_data_pull_operations import ManageDataPullOperations -from .manage_data_refresh import ManageDataRefresh +from .pull_operations import PullOperations +from .refresh import Refresh from .sdkconfiguration import SDKConfiguration from codatlending import utils from codatlending.models import errors, operations, shared from typing import Dict, Optional class ManageData: - pull_operations: ManageDataPullOperations - refresh: ManageDataRefresh + refresh: Refresh + pull_operations: PullOperations sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -17,10 +17,11 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.pull_operations = ManageDataPullOperations(self.sdk_configuration) - self.refresh = ManageDataRefresh(self.sdk_configuration) + self.refresh = Refresh(self.sdk_configuration) + self.pull_operations = PullOperations(self.sdk_configuration) + def get_status(self, request: operations.GetDataStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataStatusResponse: r"""Get data status Get the state of each data type for a company @@ -32,7 +33,10 @@ def get_status(self, request: operations.GetDataStatusRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -51,21 +55,24 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetDataStatusResponse(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[Dict[str, shared.DataStatus]]) - res.data_status_response = out + res.data_statuses = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_metrics.py b/lending/src/codatlending/metrics.py old mode 100755 new mode 100644 similarity index 83% rename from lending/src/codatlending/sales_metrics.py rename to lending/src/codatlending/metrics.py index a55dcb64d..2d782cd40 --- a/lending/src/codatlending/sales_metrics.py +++ b/lending/src/codatlending/metrics.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesMetrics: +class Metrics: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get_customer_retention(self, request: operations.GetCommerceCustomerRetentionMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceCustomerRetentionMetricsResponse: r"""Get customer retention metrics The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time. @@ -52,7 +53,10 @@ def get_customer_retention(self, request: operations.GetCommerceCustomerRetentio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -71,7 +75,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceCustomerRetentionMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -80,16 +84,20 @@ def do_request(): res.commerce_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_lifetime_value(self, request: operations.GetCommerceLifetimeValueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceLifetimeValueMetricsResponse: r"""Get lifetime value metrics The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. @@ -123,7 +131,10 @@ def get_lifetime_value(self, request: operations.GetCommerceLifetimeValueMetrics headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -142,7 +153,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceLifetimeValueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -151,16 +162,20 @@ def do_request(): res.commerce_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_revenue(self, request: operations.GetCommerceRevenueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceRevenueMetricsResponse: r"""Get commerce revenue metrics The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time. @@ -195,7 +210,10 @@ def get_revenue(self, request: operations.GetCommerceRevenueMetricsRequest, retr headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -214,7 +232,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceRevenueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -223,12 +241,15 @@ def do_request(): res.commerce_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/models/__init__.py b/lending/src/codatlending/models/__init__.py old mode 100755 new mode 100644 index 36628d6cc..722bb9982 --- a/lending/src/codatlending/models/__init__.py +++ b/lending/src/codatlending/models/__init__.py @@ -1,3 +1,4 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -# __init__.py + +# package diff --git a/lending/src/codatlending/models/errors/__init__.py b/lending/src/codatlending/models/errors/__init__.py old mode 100755 new mode 100644 index cfd848441..bf15fd116 --- a/lending/src/codatlending/models/errors/__init__.py +++ b/lending/src/codatlending/models/errors/__init__.py @@ -1,4 +1,6 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .sdkerror import SDKError -__all__ = ["SDKError"] +from .errormessage import * +from .sdkerror import * + +__all__ = ["ErrorMessage","SDKError"] diff --git a/lending/src/codatlending/models/shared/errormessage.py b/lending/src/codatlending/models/errors/errormessage.py old mode 100755 new mode 100644 similarity index 92% rename from lending/src/codatlending/models/shared/errormessage.py rename to lending/src/codatlending/models/errors/errormessage.py index 49a7bd5f4..a3b6a1384 --- a/lending/src/codatlending/models/shared/errormessage.py +++ b/lending/src/codatlending/models/errors/errormessage.py @@ -8,8 +8,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass -class ErrorMessage: +class ErrorMessage(Exception): + r"""The request made is not valid.""" 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 }}) @@ -24,3 +26,5 @@ class ErrorMessage: r"""The HTTP status code returned by the error.""" + def __str__(self) -> str: + return utils.marshal_json(self) diff --git a/lending/src/codatlending/models/errors/sdkerror.py b/lending/src/codatlending/models/errors/sdkerror.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/operations/__init__.py b/lending/src/codatlending/models/operations/__init__.py old mode 100755 new mode 100644 index b619cd9ba..5eae63865 --- a/lending/src/codatlending/models/operations/__init__.py +++ b/lending/src/codatlending/models/operations/__init__.py @@ -1,6 +1,7 @@ """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 * @@ -77,8 +78,9 @@ 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_payment_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 * @@ -138,4 +140,4 @@ from .update_company import * from .upload_files import * -__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"] +__all__ = ["CreateAccountRequest","CreateAccountResponse","CreateBankAccountRequest","CreateBankAccountResponse","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","GenerateLoanTransactionsRequest","GenerateLoanTransactionsResponse","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","GetCreatePaymentModelRequest","GetCreatePaymentModelResponse","GetCreateTransfersModelRequest","GetCreateTransfersModelResponse","GetCreateUpdateBankAccountsModelRequest","GetCreateUpdateBankAccountsModelResponse","GetCreateUpdateSuppliersModelRequest","GetCreateUpdateSuppliersModelResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetDataStatusRequest","GetDataStatusResponse","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetLoanSummaryQueryParamSourceType","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","ListLoanTransactionsQueryParamSourceType","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListPullOperationsRequest","ListPullOperationsResponse","ListReconciledInvoicesRequest","ListReconciledInvoicesResponse","QueryParamSourceType","RefreshAllDataTypesRequest","RefreshAllDataTypesResponse","RefreshDataTypeRequest","RefreshDataTypeResponse","SourceType","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 old mode 100755 new mode 100644 index 64089c16d..de1d3db3d --- a/lending/src/codatlending/models/operations/create_account.py +++ b/lending/src/codatlending/models/operations/create_account.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingaccount as shared_accountingaccount -from ..shared import accountingcreateaccountresponse as shared_accountingcreateaccountresponse -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreateaccountresponse as shared_accountingcreateaccountresponse +from ...models.shared import accountprototype as shared_accountprototype from typing import Optional @@ -15,7 +14,7 @@ class CreateAccountRequest: 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' }}) + account_prototype: Optional[shared_accountprototype.AccountPrototype] = 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 }}) @@ -28,13 +27,11 @@ class CreateAccountRequest: class CreateAccountResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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_account.py b/lending/src/codatlending/models/operations/create_bank_account.py new file mode 100644 index 000000000..28349ab7f --- /dev/null +++ b/lending/src/codatlending/models/operations/create_bank_account.py @@ -0,0 +1,37 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ...models.shared import accountingbankaccount as shared_accountingbankaccount +from ...models.shared import accountingcreatebankaccountresponse as shared_accountingcreatebankaccountresponse +from typing import Optional + + +@dataclasses.dataclass +class CreateBankAccountRequest: + 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_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=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: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + accounting_create_bank_account_response: Optional[shared_accountingcreatebankaccountresponse.AccountingCreateBankAccountResponse] = dataclasses.field(default=None) + r"""Success""" + + diff --git a/lending/src/codatlending/models/operations/create_bank_transactions.py b/lending/src/codatlending/models/operations/create_bank_transactions.py old mode 100755 new mode 100644 index 4e741656b..15e532d87 --- a/lending/src/codatlending/models/operations/create_bank_transactions.py +++ b/lending/src/codatlending/models/operations/create_bank_transactions.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreatebanktransactions as shared_accountingcreatebanktransactions -from ..shared import accountingcreatebanktransactionsresponse as shared_accountingcreatebanktransactionsresponse -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreatebanktransactions as shared_accountingcreatebanktransactions +from ...models.shared import accountingcreatebanktransactionsresponse as shared_accountingcreatebanktransactionsresponse from typing import Optional @@ -30,13 +29,11 @@ class CreateBankTransactionsRequest: class CreateBankTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 3225796a8..6d6514892 --- a/lending/src/codatlending/models/operations/create_company.py +++ b/lending/src/codatlending/models/operations/create_company.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import company as shared_company -from ..shared import errormessage as shared_errormessage +from ...models.shared import company as shared_company from typing import Optional @@ -12,13 +11,11 @@ class CreateCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 77cc81b5f..b892bf575 --- a/lending/src/codatlending/models/operations/create_connection.py +++ b/lending/src/codatlending/models/operations/create_connection.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import connection as shared_connection -from ..shared import errormessage as shared_errormessage +from ...models.shared import connection as shared_connection from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -32,13 +31,11 @@ class CreateConnectionRequest: class CreateConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7f0c56f42..4e25e0ed5 --- a/lending/src/codatlending/models/operations/create_direct_cost.py +++ b/lending/src/codatlending/models/operations/create_direct_cost.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreatedirectcostresponse as shared_accountingcreatedirectcostresponse -from ..shared import accountingdirectcost as shared_accountingdirectcost -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreatedirectcostresponse as shared_accountingcreatedirectcostresponse +from ...models.shared import directcostprototype as shared_directcostprototype from typing import Optional @@ -15,9 +14,9 @@ class CreateDirectCostRequest: 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=True, metadata={'query_param': { 'field_name': 'allowSyncOnPushComplete', 'style': 'form', 'explode': True }}) r"""Allow a sync upon push completion.""" + direct_cost_prototype: Optional[shared_directcostprototype.DirectCostPrototype] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) 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.""" @@ -28,13 +27,11 @@ class CreateDirectCostRequest: class CreateDirectCostResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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_payment.py b/lending/src/codatlending/models/operations/create_payment.py old mode 100755 new mode 100644 index 8d603e6f8..46f3ba828 --- a/lending/src/codatlending/models/operations/create_payment.py +++ b/lending/src/codatlending/models/operations/create_payment.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreatepaymentresponse as shared_accountingcreatepaymentresponse -from ..shared import accountingpayment as shared_accountingpayment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreatepaymentresponse as shared_accountingcreatepaymentresponse +from ...models.shared import accountingpayment as shared_accountingpayment from typing import Optional @@ -28,13 +27,11 @@ class CreatePaymentRequest: class CreatePaymentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index be8b86e2f..06a3980b0 --- a/lending/src/codatlending/models/operations/create_supplier.py +++ b/lending/src/codatlending/models/operations/create_supplier.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreatesupplierresponse as shared_accountingcreatesupplierresponse -from ..shared import accountingsupplier as shared_accountingsupplier -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreatesupplierresponse as shared_accountingcreatesupplierresponse +from ...models.shared import accountingsupplier as shared_accountingsupplier from typing import Optional @@ -28,13 +27,11 @@ class CreateSupplierRequest: class CreateSupplierResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 521d71fd9..ec0c3ca0a --- a/lending/src/codatlending/models/operations/create_transfer.py +++ b/lending/src/codatlending/models/operations/create_transfer.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreatetransferresponse as shared_accountingcreatetransferresponse -from ..shared import accountingtransfer as shared_accountingtransfer -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreatetransferresponse as shared_accountingcreatetransferresponse +from ...models.shared import accountingtransfer as shared_accountingtransfer from typing import Optional @@ -28,13 +27,11 @@ class CreateTransferRequest: class CreateTransferResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 0c7da43c5..cee215d50 --- a/lending/src/codatlending/models/operations/delete_company.py +++ b/lending/src/codatlending/models/operations/delete_company.py @@ -3,8 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from typing import Optional @dataclasses.dataclass @@ -19,11 +17,9 @@ class DeleteCompanyRequest: class DeleteCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 568a81d83..f6c98ce2b --- a/lending/src/codatlending/models/operations/delete_connection.py +++ b/lending/src/codatlending/models/operations/delete_connection.py @@ -3,8 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from typing import Optional @dataclasses.dataclass @@ -21,11 +19,9 @@ class DeleteConnectionRequest: class DeleteConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 68cf80a71..571b5a7c2 --- a/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_bill_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingBillAttachmentRequest: class DownloadAccountingBillAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index 98fa9dc3a..aac20db29 --- a/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_customer_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingCustomerAttachmentRequest: class DownloadAccountingCustomerAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index 348d24c3c..cdd039a86 --- a/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_direct_cost_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingDirectCostAttachmentRequest: class DownloadAccountingDirectCostAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index 583bbafde..258e0e073 --- a/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_direct_income_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingDirectIncomeAttachmentRequest: class DownloadAccountingDirectIncomeAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index 925e84be2..38d39fa1b --- a/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_invoice_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingInvoiceAttachmentRequest: class DownloadAccountingInvoiceAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index d76adad24..7eb8f2103 --- a/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py +++ b/lending/src/codatlending/models/operations/download_accounting_invoice_pdf.py @@ -20,11 +20,11 @@ class DownloadAccountingInvoicePdfRequest: class DownloadAccountingInvoicePdfResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index cd6109829..38ec859a1 --- a/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py +++ b/lending/src/codatlending/models/operations/download_accounting_supplier_attachment.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -25,13 +24,11 @@ class DownloadAccountingSupplierAttachmentRequest: class DownloadAccountingSupplierAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index afb3833b3..30a6efc9f --- a/lending/src/codatlending/models/operations/download_excel_report.py +++ b/lending/src/codatlending/models/operations/download_excel_report.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import excelreporttypes as shared_excelreporttypes +from ...models.shared import excelreporttypes as shared_excelreporttypes from typing import Optional @@ -22,12 +21,10 @@ class DownloadExcelReportRequest: class DownloadExcelReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 16a0c9c21..96c257947 --- a/lending/src/codatlending/models/operations/download_files.py +++ b/lending/src/codatlending/models/operations/download_files.py @@ -3,7 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @@ -21,13 +20,11 @@ class DownloadFilesRequest: class DownloadFilesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() 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 old mode 100755 new mode 100644 index 0f8d44f1d..3bc85c63b --- a/lending/src/codatlending/models/operations/generate_excel_report.py +++ b/lending/src/codatlending/models/operations/generate_excel_report.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import excelreporttypes as shared_excelreporttypes -from ..shared import excelstatus as shared_excelstatus +from ...models.shared import excelreporttypes as shared_excelreporttypes +from ...models.shared import excelstatus as shared_excelstatus from typing import Optional @@ -23,13 +22,11 @@ class GenerateExcelReportRequest: class GenerateExcelReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index a8372fcd6..016b45b51 --- a/lending/src/codatlending/models/operations/generate_loan_summary.py +++ b/lending/src/codatlending/models/operations/generate_loan_summary.py @@ -3,11 +3,9 @@ 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): +class SourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -18,7 +16,7 @@ class GenerateLoanSummarySourceType(str, Enum): 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 }}) + source_type: SourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -28,11 +26,9 @@ class GenerateLoanSummaryRequest: class GenerateLoanSummaryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 291e38f4b..fb18b9540 --- a/lending/src/codatlending/models/operations/generate_loan_transactions.py +++ b/lending/src/codatlending/models/operations/generate_loan_transactions.py @@ -3,11 +3,9 @@ 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): +class QueryParamSourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -18,7 +16,7 @@ class GenerateLoanTransactionsSourceType(str, Enum): 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 }}) + source_type: QueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -28,11 +26,9 @@ class GenerateLoanTransactionsRequest: class GenerateLoanTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index f543647c4..91591c147 --- a/lending/src/codatlending/models/operations/get_accounting_account.py +++ b/lending/src/codatlending/models/operations/get_accounting_account.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingaccount as shared_accountingaccount -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingaccount as shared_accountingaccount from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingAccountRequest: class GetAccountingAccountResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 083929e79..b878e7490 --- a/lending/src/codatlending/models/operations/get_accounting_account_transaction.py +++ b/lending/src/codatlending/models/operations/get_accounting_account_transaction.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingaccounttransaction as shared_accountingaccounttransaction -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingaccounttransaction as shared_accountingaccounttransaction from typing import Optional @@ -24,13 +23,11 @@ class GetAccountingAccountTransactionRequest: class GetAccountingAccountTransactionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index b395be7f6..e0561723d --- a/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py +++ b/lending/src/codatlending/models/operations/get_accounting_aged_creditors_report.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingagedcreditorreport as shared_accountingagedcreditorreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingagedcreditorreport as shared_accountingagedcreditorreport from datetime import date from typing import Optional @@ -27,13 +26,11 @@ class GetAccountingAgedCreditorsReportRequest: class GetAccountingAgedCreditorsReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 826826aa8..1c00c8f79 --- a/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py +++ b/lending/src/codatlending/models/operations/get_accounting_aged_debtors_report.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingageddebtorreport as shared_accountingageddebtorreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingageddebtorreport as shared_accountingageddebtorreport from datetime import date from typing import Optional @@ -27,13 +26,11 @@ class GetAccountingAgedDebtorsReportRequest: class GetAccountingAgedDebtorsReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 4b09d589a..b0c19fba8 --- a/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py +++ b/lending/src/codatlending/models/operations/get_accounting_balance_sheet.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbalancesheet as shared_accountingbalancesheet -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbalancesheet as shared_accountingbalancesheet from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingBalanceSheetRequest: class GetAccountingBalanceSheetResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 04785a72d..e8230d62a --- a/lending/src/codatlending/models/operations/get_accounting_bank_account.py +++ b/lending/src/codatlending/models/operations/get_accounting_bank_account.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbankaccount as shared_accountingbankaccount -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbankaccount as shared_accountingbankaccount from typing import Optional @@ -24,13 +23,11 @@ class GetAccountingBankAccountRequest: class GetAccountingBankAccountResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 047c77f20..34ebff07b --- a/lending/src/codatlending/models/operations/get_accounting_bill.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbill as shared_accountingbill -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbill as shared_accountingbill from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingBillRequest: class GetAccountingBillResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 928795c71..873ab50fe --- a/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingBillAttachmentRequest: class GetAccountingBillAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index aa98f09ef..eedf7e69f --- a/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_credit_note.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbillcreditnote as shared_accountingbillcreditnote -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbillcreditnote as shared_accountingbillcreditnote from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingBillCreditNoteRequest: class GetAccountingBillCreditNoteResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 1fb055c91..0e9eea822 --- a/lending/src/codatlending/models/operations/get_accounting_bill_payment.py +++ b/lending/src/codatlending/models/operations/get_accounting_bill_payment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbillpayment as shared_accountingbillpayment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbillpayment as shared_accountingbillpayment from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingBillPaymentRequest: class GetAccountingBillPaymentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 6d480a608..ff2eee750 --- a/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py +++ b/lending/src/codatlending/models/operations/get_accounting_cash_flow_statement.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcashflowstatement as shared_accountingcashflowstatement -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcashflowstatement as shared_accountingcashflowstatement from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingCashFlowStatementRequest: class GetAccountingCashFlowStatementResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 0657fc50c..41a0f38b6 --- a/lending/src/codatlending/models/operations/get_accounting_credit_note.py +++ b/lending/src/codatlending/models/operations/get_accounting_credit_note.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreditnote as shared_accountingcreditnote -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreditnote as shared_accountingcreditnote from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingCreditNoteRequest: class GetAccountingCreditNoteResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 915e65b3b..7f9164726 --- a/lending/src/codatlending/models/operations/get_accounting_customer.py +++ b/lending/src/codatlending/models/operations/get_accounting_customer.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcustomer as shared_accountingcustomer -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcustomer as shared_accountingcustomer from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingCustomerRequest: class GetAccountingCustomerResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 857e60c29..d57b8eb7c --- a/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_customer_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingCustomerAttachmentRequest: class GetAccountingCustomerAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 97aa7eb4c..da2ae35b6 --- a/lending/src/codatlending/models/operations/get_accounting_direct_cost.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_cost.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingdirectcost as shared_accountingdirectcost -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingdirectcost as shared_accountingdirectcost from typing import Optional @@ -24,13 +23,11 @@ class GetAccountingDirectCostRequest: class GetAccountingDirectCostResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7b685813b..a6a459bf9 --- a/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_cost_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingDirectCostAttachmentRequest: class GetAccountingDirectCostAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 0ba595ac5..01baf8888 --- a/lending/src/codatlending/models/operations/get_accounting_direct_income.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_income.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingdirectincome as shared_accountingdirectincome -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingdirectincome as shared_accountingdirectincome from typing import Optional @@ -24,13 +23,11 @@ class GetAccountingDirectIncomeRequest: class GetAccountingDirectIncomeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 27ac170c8..f57880818 --- a/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_direct_income_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -28,13 +27,11 @@ class GetAccountingDirectIncomeAttachmentRequest: class GetAccountingDirectIncomeAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 28605067a..478e30d6b --- a/lending/src/codatlending/models/operations/get_accounting_invoice.py +++ b/lending/src/codatlending/models/operations/get_accounting_invoice.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountinginvoice as shared_accountinginvoice -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountinginvoice as shared_accountinginvoice from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingInvoiceRequest: class GetAccountingInvoiceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8e6d197a1..496639ac5 --- a/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_invoice_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingInvoiceAttachmentRequest: class GetAccountingInvoiceAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index fa97b7a4f..cb917634f --- a/lending/src/codatlending/models/operations/get_accounting_journal.py +++ b/lending/src/codatlending/models/operations/get_accounting_journal.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingjournal as shared_accountingjournal -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingjournal as shared_accountingjournal from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingJournalRequest: class GetAccountingJournalResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 546be20ff..155d9e409 --- a/lending/src/codatlending/models/operations/get_accounting_journal_entry.py +++ b/lending/src/codatlending/models/operations/get_accounting_journal_entry.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingjournalentry as shared_accountingjournalentry -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingjournalentry as shared_accountingjournalentry from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingJournalEntryRequest: class GetAccountingJournalEntryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9ea5c7586..fa62fc3d9 --- a/lending/src/codatlending/models/operations/get_accounting_payment.py +++ b/lending/src/codatlending/models/operations/get_accounting_payment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingpayment as shared_accountingpayment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingpayment as shared_accountingpayment from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingPaymentRequest: class GetAccountingPaymentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index aee5f6065..1a1e69570 --- a/lending/src/codatlending/models/operations/get_accounting_profile.py +++ b/lending/src/codatlending/models/operations/get_accounting_profile.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcompanyinfo as shared_accountingcompanyinfo -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcompanyinfo as shared_accountingcompanyinfo from typing import Optional @@ -20,13 +19,11 @@ class GetAccountingProfileRequest: class GetAccountingProfileResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 6ead1f6a3..a042466e7 --- a/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py +++ b/lending/src/codatlending/models/operations/get_accounting_profit_and_loss.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingprofitandlossreport as shared_accountingprofitandlossreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingprofitandlossreport as shared_accountingprofitandlossreport from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingProfitAndLossRequest: class GetAccountingProfitAndLossResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index b53fa285b..c831056b2 --- a/lending/src/codatlending/models/operations/get_accounting_supplier.py +++ b/lending/src/codatlending/models/operations/get_accounting_supplier.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingsupplier as shared_accountingsupplier -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingsupplier as shared_accountingsupplier from typing import Optional @@ -22,13 +21,11 @@ class GetAccountingSupplierRequest: class GetAccountingSupplierResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 5afd6acc1..0cac0b887 --- a/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py +++ b/lending/src/codatlending/models/operations/get_accounting_supplier_attachment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingattachment as shared_accountingattachment -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingattachment as shared_accountingattachment from typing import Optional @@ -26,13 +25,11 @@ class GetAccountingSupplierAttachmentRequest: class GetAccountingSupplierAttachmentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 2827543fd..70682d040 --- a/lending/src/codatlending/models/operations/get_accounting_transfer.py +++ b/lending/src/codatlending/models/operations/get_accounting_transfer.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingtransfer as shared_accountingtransfer -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingtransfer as shared_accountingtransfer from typing import Optional @@ -24,13 +23,11 @@ class GetAccountingTransferRequest: class GetAccountingTransferResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 57f2231ae..71ce30fc4 --- a/lending/src/codatlending/models/operations/get_banking_account.py +++ b/lending/src/codatlending/models/operations/get_banking_account.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingaccount as shared_bankingaccount +from ...models.shared import bankingaccount as shared_bankingaccount from typing import Optional @@ -23,11 +23,11 @@ class GetBankingAccountRequest: class GetBankingAccountResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 775875a2d..2ab8a72a6 --- a/lending/src/codatlending/models/operations/get_banking_transaction.py +++ b/lending/src/codatlending/models/operations/get_banking_transaction.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingtransaction as shared_bankingtransaction +from ...models.shared import bankingtransaction as shared_bankingtransaction from typing import Optional @@ -23,11 +23,11 @@ class GetBankingTransactionRequest: class GetBankingTransactionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index a95ffca9b..f11fc35b9 --- a/lending/src/codatlending/models/operations/get_banking_transaction_category.py +++ b/lending/src/codatlending/models/operations/get_banking_transaction_category.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingtransactioncategory as shared_bankingtransactioncategory +from ...models.shared import bankingtransactioncategory as shared_bankingtransactioncategory from typing import Optional @@ -23,11 +23,11 @@ class GetBankingTransactionCategoryRequest: class GetBankingTransactionCategoryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index e5e03feca..1db91930b --- a/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py +++ b/lending/src/codatlending/models/operations/get_categorized_balance_sheet_statement.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedfinancialreport as shared_enhancedfinancialreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedfinancialreport as shared_enhancedfinancialreport from typing import Optional @@ -24,13 +23,11 @@ class GetCategorizedBalanceSheetStatementRequest: class GetCategorizedBalanceSheetStatementResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 3126f15d1..1bdea9e06 --- a/lending/src/codatlending/models/operations/get_categorized_bank_statement.py +++ b/lending/src/codatlending/models/operations/get_categorized_bank_statement.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedcashflowtransactions as shared_enhancedcashflowtransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedcashflowtransactions as shared_enhancedcashflowtransactions from typing import Optional @@ -26,13 +25,11 @@ class GetCategorizedBankStatementRequest: class GetCategorizedBankStatementResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 592dc3955..507a3696b --- 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 @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedfinancialreport as shared_enhancedfinancialreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedfinancialreport as shared_enhancedfinancialreport from typing import Optional @@ -24,13 +23,11 @@ class GetCategorizedProfitAndLossStatementRequest: class GetCategorizedProfitAndLossStatementResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 5f3d50556..db2f4b211 --- a/lending/src/codatlending/models/operations/get_commerce_customer.py +++ b/lending/src/codatlending/models/operations/get_commerce_customer.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercecustomer as shared_commercecustomer -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercecustomer as shared_commercecustomer from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceCustomerRequest: class GetCommerceCustomerResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 46b15217f..2aa33c47b --- a/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_customer_retention_metrics.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercereport as shared_commercereport -from ..shared import errormessage as shared_errormessage -from ..shared import periodunit as shared_periodunit +from ...models.shared import commercereport as shared_commercereport +from ...models.shared import periodunit as shared_periodunit from typing import Optional @@ -33,13 +32,11 @@ class GetCommerceCustomerRetentionMetricsRequest: class GetCommerceCustomerRetentionMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9e2446a72..90c9ed883 --- a/lending/src/codatlending/models/operations/get_commerce_dispute.py +++ b/lending/src/codatlending/models/operations/get_commerce_dispute.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercedispute as shared_commercedispute -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercedispute as shared_commercedispute from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceDisputeRequest: class GetCommerceDisputeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index eaa26c364..2328746d9 --- a/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_lifetime_value_metrics.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercereport as shared_commercereport -from ..shared import errormessage as shared_errormessage -from ..shared import periodunit as shared_periodunit +from ...models.shared import commercereport as shared_commercereport +from ...models.shared import periodunit as shared_periodunit from typing import Optional @@ -33,13 +32,11 @@ class GetCommerceLifetimeValueMetricsRequest: class GetCommerceLifetimeValueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 15d4a0a8e..3eef89ac1 --- a/lending/src/codatlending/models/operations/get_commerce_location.py +++ b/lending/src/codatlending/models/operations/get_commerce_location.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercelocation as shared_commercelocation -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercelocation as shared_commercelocation from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceLocationRequest: class GetCommerceLocationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 993262aee..a847dd3ff --- a/lending/src/codatlending/models/operations/get_commerce_order.py +++ b/lending/src/codatlending/models/operations/get_commerce_order.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceorder as shared_commerceorder -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceorder as shared_commerceorder from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceOrderRequest: class GetCommerceOrderResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7551adffb..42094f59d --- a/lending/src/codatlending/models/operations/get_commerce_orders_report.py +++ b/lending/src/codatlending/models/operations/get_commerce_orders_report.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercereport as shared_commercereport -from ..shared import errormessage as shared_errormessage -from ..shared import periodunit as shared_periodunit +from ...models.shared import commercereport as shared_commercereport +from ...models.shared import periodunit as shared_periodunit from typing import Optional @@ -33,13 +32,11 @@ class GetCommerceOrdersReportRequest: class GetCommerceOrdersReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index a8f17ec7c..8d4c87af1 --- a/lending/src/codatlending/models/operations/get_commerce_payment.py +++ b/lending/src/codatlending/models/operations/get_commerce_payment.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercepayment as shared_commercepayment -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercepayment as shared_commercepayment from typing import Optional @@ -24,13 +23,11 @@ class GetCommercePaymentRequest: class GetCommercePaymentResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index e828c47a7..d38b80ef7 --- a/lending/src/codatlending/models/operations/get_commerce_payment_method.py +++ b/lending/src/codatlending/models/operations/get_commerce_payment_method.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercepaymentmethod as shared_commercepaymentmethod -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercepaymentmethod as shared_commercepaymentmethod from typing import Optional @@ -24,13 +23,11 @@ class GetCommercePaymentMethodRequest: class GetCommercePaymentMethodResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 81309281e..394188309 --- a/lending/src/codatlending/models/operations/get_commerce_product.py +++ b/lending/src/codatlending/models/operations/get_commerce_product.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceproduct as shared_commerceproduct -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceproduct as shared_commerceproduct from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceProductRequest: class GetCommerceProductResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 6895344b1..1fff08d1b --- a/lending/src/codatlending/models/operations/get_commerce_product_category.py +++ b/lending/src/codatlending/models/operations/get_commerce_product_category.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceproductcategory as shared_commerceproductcategory -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceproductcategory as shared_commerceproductcategory from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceProductCategoryRequest: class GetCommerceProductCategoryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index a7e4368c5..1b97f34bd --- a/lending/src/codatlending/models/operations/get_commerce_profile.py +++ b/lending/src/codatlending/models/operations/get_commerce_profile.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercecompanyinfo as shared_commercecompanyinfo -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercecompanyinfo as shared_commercecompanyinfo from typing import Optional @@ -22,13 +21,11 @@ class GetCommerceProfileRequest: class GetCommerceProfileResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 77880e62e..08a59beef --- a/lending/src/codatlending/models/operations/get_commerce_refunds_report.py +++ b/lending/src/codatlending/models/operations/get_commerce_refunds_report.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercereport as shared_commercereport -from ..shared import errormessage as shared_errormessage -from ..shared import periodunit as shared_periodunit +from ...models.shared import commercereport as shared_commercereport +from ...models.shared import periodunit as shared_periodunit from typing import Optional @@ -33,13 +32,11 @@ class GetCommerceRefundsReportRequest: class GetCommerceRefundsReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index cd7d312e0..9007c883a --- a/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py +++ b/lending/src/codatlending/models/operations/get_commerce_revenue_metrics.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercereport as shared_commercereport -from ..shared import errormessage as shared_errormessage -from ..shared import periodunit as shared_periodunit +from ...models.shared import commercereport as shared_commercereport +from ...models.shared import periodunit as shared_periodunit from typing import Optional @@ -33,13 +32,11 @@ class GetCommerceRevenueMetricsRequest: class GetCommerceRevenueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index eda45f6fb..3b7f5cca3 --- a/lending/src/codatlending/models/operations/get_commerce_transaction.py +++ b/lending/src/codatlending/models/operations/get_commerce_transaction.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercetransaction as shared_commercetransaction -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercetransaction as shared_commercetransaction from typing import Optional @@ -24,13 +23,11 @@ class GetCommerceTransactionRequest: class GetCommerceTransactionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9660394e9..2938755e5 --- a/lending/src/codatlending/models/operations/get_company.py +++ b/lending/src/codatlending/models/operations/get_company.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import company as shared_company -from ..shared import errormessage as shared_errormessage +from ...models.shared import company as shared_company from typing import Optional @@ -20,13 +19,11 @@ class GetCompanyRequest: class GetCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index c21ca84ed..80642dd26 --- a/lending/src/codatlending/models/operations/get_connection.py +++ b/lending/src/codatlending/models/operations/get_connection.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import connection as shared_connection -from ..shared import errormessage as shared_errormessage +from ...models.shared import connection as shared_connection from typing import Optional @@ -22,13 +21,11 @@ class GetConnectionRequest: class GetConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 5568e2eaf..90149ec65 --- a/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py +++ b/lending/src/codatlending/models/operations/get_create_bank_transactions_model.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @@ -24,13 +23,11 @@ class GetCreateBankTransactionsModelRequest: class GetCreateBankTransactionsModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7961bde4f..029cfcc20 --- a/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py +++ b/lending/src/codatlending/models/operations/get_create_chartofaccounts_model.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @@ -22,13 +21,11 @@ class GetCreateChartOfAccountsModelRequest: class GetCreateChartOfAccountsModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9e98e73e5..2651ccb6f --- a/lending/src/codatlending/models/operations/get_create_directcosts_model.py +++ b/lending/src/codatlending/models/operations/get_create_directcosts_model.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @@ -22,13 +21,11 @@ class GetCreateDirectCostsModelRequest: class GetCreateDirectCostsModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8f6d546bd..f3b99e5b2 --- a/lending/src/codatlending/models/operations/get_create_operation.py +++ b/lending/src/codatlending/models/operations/get_create_operation.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoperation as shared_pushoperation +from ...models.shared import pushoperation as shared_pushoperation from typing import Optional @@ -22,13 +21,11 @@ class GetCreateOperationRequest: class GetCreateOperationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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_payments_model.py b/lending/src/codatlending/models/operations/get_create_payment_model.py old mode 100755 new mode 100644 similarity index 70% rename from lending/src/codatlending/models/operations/get_create_payments_model.py rename to lending/src/codatlending/models/operations/get_create_payment_model.py index 65b82c32c..43a303054 --- a/lending/src/codatlending/models/operations/get_create_payments_model.py +++ b/lending/src/codatlending/models/operations/get_create_payment_model.py @@ -3,13 +3,12 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @dataclasses.dataclass -class GetCreatePaymentsModelRequest: +class GetCreatePaymentModelRequest: 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 }}) @@ -19,16 +18,14 @@ class GetCreatePaymentsModelRequest: @dataclasses.dataclass -class GetCreatePaymentsModelResponse: +class GetCreatePaymentModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 084497a55..6f5df0b67 --- a/lending/src/codatlending/models/operations/get_create_transfers_model.py +++ b/lending/src/codatlending/models/operations/get_create_transfers_model.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @@ -22,13 +21,11 @@ class GetCreateTransfersModelRequest: class GetCreateTransfersModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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_bankaccounts_model.py b/lending/src/codatlending/models/operations/get_create_update_bankaccounts_model.py new file mode 100644 index 000000000..203ba868b --- /dev/null +++ b/lending/src/codatlending/models/operations/get_create_update_bankaccounts_model.py @@ -0,0 +1,31 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from ...models.shared import pushoption as shared_pushoption +from typing import Optional + + +@dataclasses.dataclass +class GetCreateUpdateBankAccountsModelRequest: + 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: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) + r"""OK""" + + 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 old mode 100755 new mode 100644 index 5254ced72..3d47acc67 --- a/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py +++ b/lending/src/codatlending/models/operations/get_create_update_suppliers_model.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoption as shared_pushoption +from ...models.shared import pushoption as shared_pushoption from typing import Optional @@ -22,13 +21,11 @@ class GetCreateUpdateSuppliersModelRequest: class GetCreateUpdateSuppliersModelResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 24727acd7..3af46dbdc --- a/lending/src/codatlending/models/operations/get_data_integrity_status.py +++ b/lending/src/codatlending/models/operations/get_data_integrity_status.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import dataintegritystatuses as shared_dataintegritystatuses -from ..shared import errormessage as shared_errormessage +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import dataintegritystatuses as shared_dataintegritystatuses from typing import Optional @@ -23,13 +22,11 @@ class GetDataIntegrityStatusRequest: class GetDataIntegrityStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 4fe2ea5e3..c33265919 --- a/lending/src/codatlending/models/operations/get_data_integrity_summaries.py +++ b/lending/src/codatlending/models/operations/get_data_integrity_summaries.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import dataintegritysummaries as shared_dataintegritysummaries -from ..shared import errormessage as shared_errormessage +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import dataintegritysummaries as shared_dataintegritysummaries from typing import Optional @@ -25,13 +24,11 @@ class GetDataIntegritySummariesRequest: class GetDataIntegritySummariesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index f6135ac0d..47c2dde92 --- a/lending/src/codatlending/models/operations/get_data_status.py +++ b/lending/src/codatlending/models/operations/get_data_status.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import datastatus as shared_datastatus -from ..shared import errormessage as shared_errormessage +from ...models.shared import datastatus as shared_datastatus from typing import Dict, Optional @@ -20,13 +19,11 @@ class GetDataStatusRequest: class GetDataStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - data_status_response: Optional[Dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) + data_statuses: 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 old mode 100755 new mode 100644 index 4387fd00c..c96189388 --- a/lending/src/codatlending/models/operations/get_excel_report_generation_status.py +++ b/lending/src/codatlending/models/operations/get_excel_report_generation_status.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import excelreporttypes as shared_excelreporttypes -from ..shared import excelstatus as shared_excelstatus +from ...models.shared import excelreporttypes as shared_excelreporttypes +from ...models.shared import excelstatus as shared_excelstatus from typing import Optional @@ -23,13 +22,11 @@ class GetExcelReportGenerationStatusRequest: class GetExcelReportGenerationStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index abb8b1962..153f5499a --- a/lending/src/codatlending/models/operations/get_loan_summary.py +++ b/lending/src/codatlending/models/operations/get_loan_summary.py @@ -3,12 +3,11 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import loansummary as shared_loansummary +from ...models.shared import loansummary as shared_loansummary from enum import Enum from typing import Optional -class GetLoanSummarySourceType(str, Enum): +class GetLoanSummaryQueryParamSourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -19,7 +18,7 @@ class GetLoanSummarySourceType(str, Enum): 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 }}) + source_type: GetLoanSummaryQueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -29,13 +28,11 @@ class GetLoanSummaryRequest: class GetLoanSummaryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 09ba964b9..0afe77aaf --- a/lending/src/codatlending/models/operations/get_pull_operation.py +++ b/lending/src/codatlending/models/operations/get_pull_operation.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pulloperation as shared_pulloperation +from ...models.shared import pulloperation as shared_pulloperation from typing import Optional @@ -22,13 +21,11 @@ class GetPullOperationRequest: class GetPullOperationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 2e8ea73f1..831f86fc3 --- a/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py +++ b/lending/src/codatlending/models/operations/is_aged_creditors_report_available.py @@ -18,11 +18,11 @@ class IsAgedCreditorsReportAvailableRequest: class IsAgedCreditorsReportAvailableResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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) + 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 old mode 100755 new mode 100644 index de5da8ea7..4bb270273 --- a/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py +++ b/lending/src/codatlending/models/operations/is_aged_debtors_report_available.py @@ -18,11 +18,11 @@ class IsAgedDebtorsReportAvailableRequest: class IsAgedDebtorsReportAvailableResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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) + 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 old mode 100755 new mode 100644 index 2b81651ad..af49544f6 --- a/lending/src/codatlending/models/operations/list_accounting_account_transactions.py +++ b/lending/src/codatlending/models/operations/list_accounting_account_transactions.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingaccounttransactions as shared_accountingaccounttransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingaccounttransactions as shared_accountingaccounttransactions from typing import Optional @@ -30,13 +29,11 @@ class ListAccountingAccountTransactionsRequest: class ListAccountingAccountTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index fa1a96656..54ff21735 --- a/lending/src/codatlending/models/operations/list_accounting_accounts.py +++ b/lending/src/codatlending/models/operations/list_accounting_accounts.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingaccounts as shared_accountingaccounts -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingaccounts as shared_accountingaccounts from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingAccountsRequest: class ListAccountingAccountsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 2ebad0ecb..f34bbb100 --- a/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py +++ b/lending/src/codatlending/models/operations/list_accounting_bank_account_transactions.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbanktransactions as shared_accountingbanktransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbanktransactions as shared_accountingbanktransactions from typing import Optional @@ -32,13 +31,11 @@ class ListAccountingBankAccountTransactionsRequest: class ListAccountingBankAccountTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index dd9640bd3..0a5bc7833 --- a/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py +++ b/lending/src/codatlending/models/operations/list_accounting_bank_accounts.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbankaccounts as shared_accountingbankaccounts -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbankaccounts as shared_accountingbankaccounts from typing import Optional @@ -30,13 +29,11 @@ class ListAccountingBankAccountsRequest: class ListAccountingBankAccountsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 396869d02..143e913f2 --- a/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingBillAttachmentsRequest: class ListAccountingBillAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index e8652dcc7..d21dc3f9e --- a/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_credit_notes.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbillcreditnotes as shared_accountingbillcreditnotes -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbillcreditnotes as shared_accountingbillcreditnotes from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingBillCreditNotesRequest: class ListAccountingBillCreditNotesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index d1cf2ac2b..c80a1bfcf --- a/lending/src/codatlending/models/operations/list_accounting_bill_payments.py +++ b/lending/src/codatlending/models/operations/list_accounting_bill_payments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbillpayments as shared_accountingbillpayments -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbillpayments as shared_accountingbillpayments from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingBillPaymentsRequest: class ListAccountingBillPaymentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 96b63e120..88c12aca1 --- a/lending/src/codatlending/models/operations/list_accounting_bills.py +++ b/lending/src/codatlending/models/operations/list_accounting_bills.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingbills as shared_accountingbills -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingbills as shared_accountingbills from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingBillsRequest: class ListAccountingBillsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 3740d70dc..8c2d46f5c --- a/lending/src/codatlending/models/operations/list_accounting_credit_notes.py +++ b/lending/src/codatlending/models/operations/list_accounting_credit_notes.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcreditnotes as shared_accountingcreditnotes -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcreditnotes as shared_accountingcreditnotes from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingCreditNotesRequest: class ListAccountingCreditNotesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8754a82de..19584b777 --- a/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_customer_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingCustomerAttachmentsRequest: class ListAccountingCustomerAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 727445b24..9b2b91d95 --- a/lending/src/codatlending/models/operations/list_accounting_customers.py +++ b/lending/src/codatlending/models/operations/list_accounting_customers.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingcustomers as shared_accountingcustomers -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingcustomers as shared_accountingcustomers from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingCustomersRequest: class ListAccountingCustomersResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 6cdd41f47..307a8af54 --- a/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_cost_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingDirectCostAttachmentsRequest: class ListAccountingDirectCostAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 16a6ad9da..8f7395a5c --- a/lending/src/codatlending/models/operations/list_accounting_direct_costs.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_costs.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingdirectcosts as shared_accountingdirectcosts -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingdirectcosts as shared_accountingdirectcosts from typing import Optional @@ -30,13 +29,11 @@ class ListAccountingDirectCostsRequest: class ListAccountingDirectCostsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 3078e09ca..144d12056 --- a/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_income_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingDirectIncomeAttachmentsRequest: class ListAccountingDirectIncomeAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index f34ca1d0a..2548ac208 --- a/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py +++ b/lending/src/codatlending/models/operations/list_accounting_direct_incomes.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingdirectincomes as shared_accountingdirectincomes -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingdirectincomes as shared_accountingdirectincomes from typing import Optional @@ -30,13 +29,11 @@ class ListAccountingDirectIncomesRequest: class ListAccountingDirectIncomesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7d04e8f0f..b02eb3900 --- a/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_invoice_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingInvoiceAttachmentsRequest: class ListAccountingInvoiceAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9e1ef461d..cfebbb875 --- a/lending/src/codatlending/models/operations/list_accounting_invoices.py +++ b/lending/src/codatlending/models/operations/list_accounting_invoices.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountinginvoices as shared_accountinginvoices -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountinginvoices as shared_accountinginvoices from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingInvoicesRequest: class ListAccountingInvoicesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8a33aad52..3a04d276f --- a/lending/src/codatlending/models/operations/list_accounting_journal_entries.py +++ b/lending/src/codatlending/models/operations/list_accounting_journal_entries.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingjournalentries as shared_accountingjournalentries -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingjournalentries as shared_accountingjournalentries from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingJournalEntriesRequest: class ListAccountingJournalEntriesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index e76248752..7c5e4047c --- a/lending/src/codatlending/models/operations/list_accounting_journals.py +++ b/lending/src/codatlending/models/operations/list_accounting_journals.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingjournals as shared_accountingjournals -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingjournals as shared_accountingjournals from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingJournalsRequest: class ListAccountingJournalsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index a47496021..41ea19446 --- a/lending/src/codatlending/models/operations/list_accounting_payments.py +++ b/lending/src/codatlending/models/operations/list_accounting_payments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingpayments as shared_accountingpayments -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingpayments as shared_accountingpayments from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingPaymentsRequest: class ListAccountingPaymentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 45b424015..30c2de5b8 --- a/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py +++ b/lending/src/codatlending/models/operations/list_accounting_supplier_attachments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import attachments as shared_attachments -from ..shared import errormessage as shared_errormessage +from ...models.shared import attachments as shared_attachments from typing import Optional @@ -24,13 +23,11 @@ class ListAccountingSupplierAttachmentsRequest: class ListAccountingSupplierAttachmentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index f624e67f1..bfd62132a --- a/lending/src/codatlending/models/operations/list_accounting_suppliers.py +++ b/lending/src/codatlending/models/operations/list_accounting_suppliers.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingsuppliers as shared_accountingsuppliers -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingsuppliers as shared_accountingsuppliers from typing import Optional @@ -28,13 +27,11 @@ class ListAccountingSuppliersRequest: class ListAccountingSuppliersResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8bc461b3f..b905c4b83 --- a/lending/src/codatlending/models/operations/list_accounting_transfers.py +++ b/lending/src/codatlending/models/operations/list_accounting_transfers.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import accountingtransfers as shared_accountingtransfers -from ..shared import errormessage as shared_errormessage +from ...models.shared import accountingtransfers as shared_accountingtransfers from typing import Optional @@ -30,13 +29,11 @@ class ListAccountingTransfersRequest: class ListAccountingTransfersResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 84e59d387..3df3a8340 --- a/lending/src/codatlending/models/operations/list_banking_account_balances.py +++ b/lending/src/codatlending/models/operations/list_banking_account_balances.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingaccountbalances as shared_bankingaccountbalances -from ..shared import errormessage as shared_errormessage +from ...models.shared import bankingaccountbalances as shared_bankingaccountbalances from typing import Optional @@ -30,13 +29,11 @@ class ListBankingAccountBalancesRequest: class ListBankingAccountBalancesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7915f1043..90a47074e --- a/lending/src/codatlending/models/operations/list_banking_accounts.py +++ b/lending/src/codatlending/models/operations/list_banking_accounts.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingaccounts as shared_bankingaccounts -from ..shared import errormessage as shared_errormessage +from ...models.shared import bankingaccounts as shared_bankingaccounts from typing import Optional @@ -30,13 +29,11 @@ class ListBankingAccountsRequest: class ListBankingAccountsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 487928436..3e21c3c47 --- a/lending/src/codatlending/models/operations/list_banking_transaction_categories.py +++ b/lending/src/codatlending/models/operations/list_banking_transaction_categories.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingtransactioncategories as shared_bankingtransactioncategories -from ..shared import errormessage as shared_errormessage +from ...models.shared import bankingtransactioncategories as shared_bankingtransactioncategories from typing import Optional @@ -30,13 +29,11 @@ class ListBankingTransactionCategoriesRequest: class ListBankingTransactionCategoriesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 741782e98..2567eeed5 --- a/lending/src/codatlending/models/operations/list_banking_transactions.py +++ b/lending/src/codatlending/models/operations/list_banking_transactions.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import bankingtransactions as shared_bankingtransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import bankingtransactions as shared_bankingtransactions from typing import Optional @@ -30,13 +29,11 @@ class ListBankingTransactionsRequest: class ListBankingTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 37b669f04..95857417f --- a/lending/src/codatlending/models/operations/list_commerce_customers.py +++ b/lending/src/codatlending/models/operations/list_commerce_customers.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercecustomers as shared_commercecustomers -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercecustomers as shared_commercecustomers from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceCustomersRequest: class ListCommerceCustomersResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 0df381cc5..60053f52e --- a/lending/src/codatlending/models/operations/list_commerce_disputes.py +++ b/lending/src/codatlending/models/operations/list_commerce_disputes.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercedisputes as shared_commercedisputes -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercedisputes as shared_commercedisputes from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceDisputesRequest: class ListCommerceDisputesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 1afe3f90e..395748220 --- a/lending/src/codatlending/models/operations/list_commerce_locations.py +++ b/lending/src/codatlending/models/operations/list_commerce_locations.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercelocations as shared_commercelocations -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercelocations as shared_commercelocations from typing import Optional @@ -22,13 +21,11 @@ class ListCommerceLocationsRequest: class ListCommerceLocationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8bf158f4e..9e968328b --- a/lending/src/codatlending/models/operations/list_commerce_orders.py +++ b/lending/src/codatlending/models/operations/list_commerce_orders.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceorders as shared_commerceorders -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceorders as shared_commerceorders from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceOrdersRequest: class ListCommerceOrdersResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index cbd25a49c..d7fa0029a --- a/lending/src/codatlending/models/operations/list_commerce_payment_methods.py +++ b/lending/src/codatlending/models/operations/list_commerce_payment_methods.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercepaymentmethods as shared_commercepaymentmethods -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercepaymentmethods as shared_commercepaymentmethods from typing import Optional @@ -30,13 +29,11 @@ class ListCommercePaymentMethodsRequest: class ListCommercePaymentMethodsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index b8761efb2..125916b2b --- a/lending/src/codatlending/models/operations/list_commerce_payments.py +++ b/lending/src/codatlending/models/operations/list_commerce_payments.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercepayments as shared_commercepayments -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercepayments as shared_commercepayments from typing import Optional @@ -30,13 +29,11 @@ class ListCommercePaymentsRequest: class ListCommercePaymentsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 80bd4f722..ca848e04e --- a/lending/src/codatlending/models/operations/list_commerce_product_categories.py +++ b/lending/src/codatlending/models/operations/list_commerce_product_categories.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceproductcategories as shared_commerceproductcategories -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceproductcategories as shared_commerceproductcategories from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceProductCategoriesRequest: class ListCommerceProductCategoriesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 68e5d0c7d..2d0f691de --- a/lending/src/codatlending/models/operations/list_commerce_products.py +++ b/lending/src/codatlending/models/operations/list_commerce_products.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commerceproducts as shared_commerceproducts -from ..shared import errormessage as shared_errormessage +from ...models.shared import commerceproducts as shared_commerceproducts from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceProductsRequest: class ListCommerceProductsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 1fe8bf4bf..6b2463e46 --- a/lending/src/codatlending/models/operations/list_commerce_transactions.py +++ b/lending/src/codatlending/models/operations/list_commerce_transactions.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import commercetransactions as shared_commercetransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import commercetransactions as shared_commercetransactions from typing import Optional @@ -30,13 +29,11 @@ class ListCommerceTransactionsRequest: class ListCommerceTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 601c3326c..72bcc118a --- a/lending/src/codatlending/models/operations/list_companies.py +++ b/lending/src/codatlending/models/operations/list_companies.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import companies as shared_companies -from ..shared import errormessage as shared_errormessage +from ...models.shared import companies as shared_companies from typing import Optional @@ -26,13 +25,11 @@ class ListCompaniesRequest: class ListCompaniesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 8c85c3ad3..24f4c54f5 --- a/lending/src/codatlending/models/operations/list_connections.py +++ b/lending/src/codatlending/models/operations/list_connections.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import connections as shared_connections -from ..shared import errormessage as shared_errormessage +from ...models.shared import connections as shared_connections from typing import Optional @@ -28,13 +27,11 @@ class ListConnectionsRequest: class ListConnectionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9aa9632cc..8aa0e0eb8 --- a/lending/src/codatlending/models/operations/list_create_operations.py +++ b/lending/src/codatlending/models/operations/list_create_operations.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pushoperations as shared_pushoperations +from ...models.shared import pushoperations as shared_pushoperations from typing import Optional @@ -28,13 +27,11 @@ class ListCreateOperationsRequest: class ListCreateOperationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index ff41cdbc6..d4bd927df --- a/lending/src/codatlending/models/operations/list_data_integrity_details.py +++ b/lending/src/codatlending/models/operations/list_data_integrity_details.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import dataintegritydetails as shared_dataintegritydetails -from ..shared import errormessage as shared_errormessage +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import dataintegritydetails as shared_dataintegritydetails from typing import Optional @@ -31,13 +30,11 @@ class ListDataIntegrityDetailsRequest: class ListDataIntegrityDetailsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 80adbc08f..f8199ca56 --- a/lending/src/codatlending/models/operations/list_files.py +++ b/lending/src/codatlending/models/operations/list_files.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import file as shared_file +from ...models.shared import file as shared_file from typing import List, Optional @@ -20,13 +19,11 @@ class ListFilesRequest: class ListFilesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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) 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 old mode 100755 new mode 100644 index 7e1c74ffb..3a7465c91 --- a/lending/src/codatlending/models/operations/list_loan_transactions.py +++ b/lending/src/codatlending/models/operations/list_loan_transactions.py @@ -3,12 +3,11 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import loantransactions as shared_loantransactions +from ...models.shared import loantransactions as shared_loantransactions from enum import Enum from typing import Optional -class ListLoanTransactionsSourceType(str, Enum): +class ListLoanTransactionsQueryParamSourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -19,7 +18,7 @@ class ListLoanTransactionsSourceType(str, Enum): 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 }}) + source_type: ListLoanTransactionsQueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -29,13 +28,11 @@ class ListLoanTransactionsRequest: class ListLoanTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 609e02e50..348e80bd8 --- a/lending/src/codatlending/models/operations/list_pull_operations.py +++ b/lending/src/codatlending/models/operations/list_pull_operations.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from ..shared import pulloperations as shared_pulloperations +from ...models.shared import pulloperations as shared_pulloperations from typing import Optional @@ -28,13 +27,11 @@ class ListPullOperationsRequest: class ListPullOperationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index c6648382f..4ce5b879d --- a/lending/src/codatlending/models/operations/list_reconciled_invoices.py +++ b/lending/src/codatlending/models/operations/list_reconciled_invoices.py @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedinvoicesreport as shared_enhancedinvoicesreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedinvoicesreport as shared_enhancedinvoicesreport from typing import Optional @@ -26,13 +25,11 @@ class ListReconciledInvoicesRequest: class ListReconciledInvoicesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 526ab213e..a67673841 --- a/lending/src/codatlending/models/operations/refresh_all_data_types.py +++ b/lending/src/codatlending/models/operations/refresh_all_data_types.py @@ -3,8 +3,6 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage -from typing import Optional @dataclasses.dataclass @@ -19,11 +17,9 @@ class RefreshAllDataTypesRequest: class RefreshAllDataTypesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index ad5ef640d..ea9a0a6be --- a/lending/src/codatlending/models/operations/refresh_data_type.py +++ b/lending/src/codatlending/models/operations/refresh_data_type.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import datatype as shared_datatype -from ..shared import errormessage as shared_errormessage -from ..shared import pulloperation as shared_pulloperation +from ...models.shared import pulloperation as shared_pulloperation +from ...models.shared import schema_datatype as shared_schema_datatype from typing import Optional @@ -13,7 +12,7 @@ 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 }}) + data_type: shared_schema_datatype.SchemaDataType = 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 }}) r"""Optionally, provide a data connection id to only queue pull operations on that connection.""" @@ -25,13 +24,11 @@ class RefreshDataTypeRequest: class RefreshDataTypeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7c5f18780..3567b02bc --- a/lending/src/codatlending/models/operations/unlink_connection.py +++ b/lending/src/codatlending/models/operations/unlink_connection.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import connection as shared_connection -from ..shared import dataconnectionstatus as shared_dataconnectionstatus -from ..shared import errormessage as shared_errormessage +from ...models.shared import connection as shared_connection +from ...models.shared import dataconnectionstatus as shared_dataconnectionstatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -35,13 +34,11 @@ class UnlinkConnectionRequest: class UnlinkConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 6f159a98a..3df4f661f --- a/lending/src/codatlending/models/operations/update_company.py +++ b/lending/src/codatlending/models/operations/update_company.py @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import company as shared_company -from ..shared import companyrequestbody as shared_companyrequestbody -from ..shared import errormessage as shared_errormessage +from ...models.shared import company as shared_company +from ...models.shared import companyrequestbody as shared_companyrequestbody from typing import Optional @@ -22,13 +21,11 @@ class UpdateCompanyRequest: class UpdateCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9276fa0e7..db30e5329 --- a/lending/src/codatlending/models/operations/upload_files.py +++ b/lending/src/codatlending/models/operations/upload_files.py @@ -3,14 +3,13 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from typing import Optional @dataclasses.dataclass class UploadFilesRequestBody: content: bytes = dataclasses.field(metadata={'multipart_form': { 'content': True }}) - request_body: str = dataclasses.field(metadata={'multipart_form': { 'field_name': 'requestBody' }}) + file_name: str = dataclasses.field(metadata={'multipart_form': { 'field_name': 'fileName' }}) @@ -30,11 +29,9 @@ class UploadFilesRequest: class UploadFilesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 9c069526b..aa400acd7 --- a/lending/src/codatlending/models/shared/__init__.py +++ b/lending/src/codatlending/models/shared/__init__.py @@ -31,6 +31,7 @@ from .accountingcashflowstatement import * from .accountingcompanyinfo import * from .accountingcreateaccountresponse import * +from .accountingcreatebankaccountresponse import * from .accountingcreatebanktransactions import * from .accountingcreatebanktransactionsresponse import * from .accountingcreatedirectcostresponse import * @@ -61,6 +62,7 @@ from .accountingtransfer import * from .accountingtransfers import * from .accountinstitution import * +from .accountprototype import * from .accountref import * from .accounts import * from .accountspayabletracking import * @@ -158,8 +160,8 @@ from .datasource import * from .datastatus import * from .datatype import * -from .definitionsitemref import * from .directcostlineitem import * +from .directcostprototype import * from .directincomelineitem import * from .disputestatus import * from .enhancedcashflowitem import * @@ -170,7 +172,6 @@ from .enhancedinvoicesreport import * from .enhancedreportaccountcategory import * from .enhancedreportinfo import * -from .errormessage import * from .excelreporttypes import * from .excelstatus import * from .file import * @@ -219,6 +220,7 @@ from .productvariantstatus import * from .profitandlossreport import * from .projectref import * +from .propertie_itemref import * from .pulloperation import * from .pulloperations import * from .pushchangetype import * @@ -240,6 +242,8 @@ from .reportinput import * from .reportitems import * from .reportline import * +from .reportline_input import * +from .schema_datatype import * from .security import * from .servicecharge import * from .servicechargetype import * @@ -264,4 +268,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","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"] +__all__ = ["AccountBalance","AccountBalanceAmounts","AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategoryLevel","AccountIdentifierType","AccountIdentifiers","AccountInstitution","AccountPrototype","AccountRef","AccountStatus","AccountTransactionLine","AccountType","AccountingAccount","AccountingAccountTransaction","AccountingAccountTransactions","AccountingAccountValidDataTypeLinks","AccountingAccounts","AccountingAddress","AccountingAddressType","AccountingAgedCreditorReport","AccountingAgedDebtorReport","AccountingAttachment","AccountingBalanceSheet","AccountingBankAccount","AccountingBankAccountType","AccountingBankAccounts","AccountingBankTransaction","AccountingBankTransactions","AccountingBill","AccountingBillCreditNote","AccountingBillCreditNotes","AccountingBillPayment","AccountingBillPayments","AccountingBills","AccountingCashFlowStatement","AccountingCompanyInfo","AccountingCreateAccountResponse","AccountingCreateBankAccountResponse","AccountingCreateBankTransactions","AccountingCreateBankTransactionsResponse","AccountingCreateDirectCostResponse","AccountingCreatePaymentResponse","AccountingCreateSupplierResponse","AccountingCreateTransferResponse","AccountingCreditNote","AccountingCreditNotes","AccountingCustomer","AccountingCustomerRef","AccountingCustomers","AccountingDirectCost","AccountingDirectCostContactRef","AccountingDirectCosts","AccountingDirectIncome","AccountingDirectIncomes","AccountingInvoice","AccountingInvoices","AccountingJournal","AccountingJournalEntries","AccountingJournalEntry","AccountingJournals","AccountingPayment","AccountingPaymentAllocation","AccountingPayments","AccountingProfitAndLossReport","AccountingSupplier","AccountingSuppliers","AccountingTransfer","AccountingTransfers","Accounts","AccountsPayableTracking","AccountsReceivableTracking","AgedCreditor","AgedCurrencyOutstanding","AgedDebtor","AgedOutstandingAmount","AgedOutstandingAmountDetail","Allocation","Attachments","BalanceSheet","BankAccountRef","BankTransactionType","BankingAccount","BankingAccountBalance","BankingAccountBalances","BankingAccounts","BankingTransaction","BankingTransactionCategories","BankingTransactionCategory","BankingTransactionRef","BankingTransactions","BillCreditNoteLineItem","BillCreditNoteStatus","BillLineItem","BillLineItemDataType","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","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","DataTypes","DirectCostLineItem","DirectCostPrototype","DirectCostPrototypeContactRef","DirectIncomeLineItem","DisputeStatus","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedFinancialReport","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedReportAccountCategory","EnhancedReportInfo","ExcelReportTypes","ExcelStatus","File","HalRef","IntegrityStatus","InvoiceLineItem","InvoiceStatus","ItemRef","ItemReference","Items","JournalLine","JournalLineTracking","JournalRef","JournalStatus","LendingCustomerRef","Links","LoanRef","LoanSummary","LoanSummaryIntegrationType","LoanSummaryRecordRef","LoanSummaryRecordRefType","LoanSummaryReportInfo","LoanSummaryReportItem","LoanTransactionType","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","PropertieItemRef","PullOperation","PullOperationStatus","PullOperations","PurchaseOrderReference","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","RecordLineReference","RecordRef","RecordReference","ReportBasis","ReportComponentMeasure","ReportInfo","ReportInput","ReportItem","ReportItems","ReportLine","ReportLineInput","SalesOrderReference","SchemaDataType","Security","ServiceCharge","ServiceChargeType","SourceRef","SourceType","Status","SupplementalData","SupplierRef","SupplierStatus","TaxComponentAllocation","TaxComponentRef","TaxRateRef","TaxRateReference","Tracking","TrackingCategoryRef","TransactionCategory","TransactionCategoryRef","TransactionCategoryStatus","TransactionCode","TransactionSourceRef","TransactionSourceType","TransactionType","TransferAccount","Type","ValidDataTypeLinks","Validation","ValidationItem","WebLink","WithholdingTax"] diff --git a/lending/src/codatlending/models/shared/accountbalance.py b/lending/src/codatlending/models/shared/accountbalance.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountbalanceamounts.py b/lending/src/codatlending/models/shared/accountbalanceamounts.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py old mode 100755 new mode 100644 index 76a65434d..8715afa42 --- a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py +++ b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhook.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountcategoriesupdatedwebhookdata as shared_accountcategoriesupdatedwebhookdata +from .accountcategoriesupdatedwebhookdata import AccountCategoriesUpdatedWebhookData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -20,7 +20,7 @@ class AccountCategoriesUpdatedWebhook: r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[shared_accountcategoriesupdatedwebhookdata.AccountCategoriesUpdatedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[AccountCategoriesUpdatedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) 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 for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py b/lending/src/codatlending/models/shared/accountcategoriesupdatedwebhookdata.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountcategorylevel.py b/lending/src/codatlending/models/shared/accountcategorylevel.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountidentifiers.py b/lending/src/codatlending/models/shared/accountidentifiers.py old mode 100755 new mode 100644 index 7b88e39fc..9c8ef5c83 --- a/lending/src/codatlending/models/shared/accountidentifiers.py +++ b/lending/src/codatlending/models/shared/accountidentifiers.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountidentifiertype as shared_accountidentifiertype +from .accountidentifiertype import AccountIdentifierType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -12,7 +12,7 @@ @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') }}) + type: 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') }}) r"""The local (usually national) routing number for the account. diff --git a/lending/src/codatlending/models/shared/accountidentifiertype.py b/lending/src/codatlending/models/shared/accountidentifiertype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountingaccount.py b/lending/src/codatlending/models/shared/accountingaccount.py old mode 100755 new mode 100644 index aeb81b4d7..2dd91c4d6 --- a/lending/src/codatlending/models/shared/accountingaccount.py +++ b/lending/src/codatlending/models/shared/accountingaccount.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -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 .accountstatus import AccountStatus +from .accounttype import AccountType +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -73,27 +73,27 @@ class AccountingAccount: ## 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. + 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. + * 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. + 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. + 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: + 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. + - 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. """ currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) @@ -124,21 +124,21 @@ class AccountingAccount: r"""Identifier for the account, unique for the company.""" is_bank_account: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBankAccount'), 'exclude': lambda f: f is None }}) 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 }}) + metadata: Optional[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') }}) r"""Name of the account.""" 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 }}) + status: Optional[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 }}) + supplemental_data: Optional[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 }}) + type: Optional[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') }}) 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 old mode 100755 new mode 100644 index d04035a1a..31c7dbbda --- a/lending/src/codatlending/models/shared/accountingaccounts.py +++ b/lending/src/codatlending/models/shared/accountingaccounts.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaccount as shared_accountingaccount -from ..shared import links as shared_links +from .accountingaccount import AccountingAccount +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 7cfa1e907..ccb19cf15 --- a/lending/src/codatlending/models/shared/accountingaccounttransaction.py +++ b/lending/src/codatlending/models/shared/accountingaccounttransaction.py @@ -2,16 +2,16 @@ from __future__ import annotations import dataclasses -from ..shared import accounttransactionline as shared_accounttransactionline -from ..shared import bankaccountref as shared_bankaccountref -from ..shared import metadata as shared_metadata +from .accounttransactionline import AccountTransactionLine +from .bankaccountref import BankAccountRef +from .metadata import Metadata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum from typing import List, Optional -class AccountingAccountTransactionStatus(str, Enum): +class Status(str, Enum): r"""The status of the account transaction.""" UNKNOWN = 'Unknown' UNRECONCILED = 'Unreconciled' @@ -40,7 +40,7 @@ class AccountingAccountTransaction: 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 }}) + bank_account_ref: Optional[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.""" 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_. @@ -101,14 +101,14 @@ 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') }}) + lines: Optional[List[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 }}) + metadata: Optional[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') }}) 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 }}) + status: Optional[Status] = 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.""" diff --git a/lending/src/codatlending/models/shared/accountingaccounttransactions.py b/lending/src/codatlending/models/shared/accountingaccounttransactions.py old mode 100755 new mode 100644 index 5565b9746..86a91dabf --- a/lending/src/codatlending/models/shared/accountingaccounttransactions.py +++ b/lending/src/codatlending/models/shared/accountingaccounttransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaccounttransaction as shared_accountingaccounttransaction -from ..shared import links as shared_links +from .accountingaccounttransaction import AccountingAccountTransaction +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 654f404d3..2c0afcfb1 --- a/lending/src/codatlending/models/shared/accountingaddress.py +++ b/lending/src/codatlending/models/shared/accountingaddress.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaddresstype as shared_accountingaddresstype +from .accountingaddresstype import AccountingAddressType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,7 +11,7 @@ @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') }}) + type: 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') }}) r"""City of the customer address.""" diff --git a/lending/src/codatlending/models/shared/accountingaddresstype.py b/lending/src/codatlending/models/shared/accountingaddresstype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountingagedcreditorreport.py b/lending/src/codatlending/models/shared/accountingagedcreditorreport.py old mode 100755 new mode 100644 index 5d454ef26..0efc822f7 --- a/lending/src/codatlending/models/shared/accountingagedcreditorreport.py +++ b/lending/src/codatlending/models/shared/accountingagedcreditorreport.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import agedcreditor as shared_agedcreditor +from .agedcreditor import AgedCreditor from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -44,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[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 old mode 100755 new mode 100644 index 0c46b8db6..561c9f8c7 --- a/lending/src/codatlending/models/shared/accountingageddebtorreport.py +++ b/lending/src/codatlending/models/shared/accountingageddebtorreport.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import ageddebtor as shared_ageddebtor +from .ageddebtor import AgedDebtor from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -44,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[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountingbalancesheet.py b/lending/src/codatlending/models/shared/accountingbalancesheet.py old mode 100755 new mode 100644 index c55ef6163..61dde9293 --- a/lending/src/codatlending/models/shared/accountingbalancesheet.py +++ b/lending/src/codatlending/models/shared/accountingbalancesheet.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import balancesheet as shared_balancesheet +from .balancesheet import BalanceSheet from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -39,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[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 old mode 100755 new mode 100644 index 60b3b104a..bd3559090 --- a/lending/src/codatlending/models/shared/accountingbankaccount.py +++ b/lending/src/codatlending/models/shared/accountingbankaccount.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbankaccounttype as shared_accountingbankaccounttype -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingbankaccounttype import AccountingBankAccountType +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -42,7 +42,7 @@ class AccountingBankAccount: FreeAgent integrations For Credit accounts, only the last four digits are required. For other types, the field is optional. """ - account_type: Optional[shared_accountingbankaccounttype.AccountingBankAccountType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountType'), 'exclude': lambda f: f is None }}) + account_type: Optional[AccountingBankAccountType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountType'), 'exclude': lambda f: f is None }}) r"""The type of transactions and balances on the account. For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For Debit accounts, positive balances are assets, and positive transactions **increase** assets. @@ -66,7 +66,7 @@ class AccountingBankAccount: 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') }}) 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 }}) + metadata: Optional[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') }}) r"""Code used to identify each nominal account for a business.""" @@ -82,7 +82,7 @@ class AccountingBankAccount: 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 }}) + supplemental_data: Optional[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 old mode 100755 new mode 100644 index 1268bf00f..d7ef97963 --- a/lending/src/codatlending/models/shared/accountingbankaccounts.py +++ b/lending/src/codatlending/models/shared/accountingbankaccounts.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbankaccount as shared_accountingbankaccount -from ..shared import links as shared_links +from .accountingbankaccount import AccountingBankAccount +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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/accountingbankaccounttype.py b/lending/src/codatlending/models/shared/accountingbankaccounttype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountingbanktransaction.py b/lending/src/codatlending/models/shared/accountingbanktransaction.py old mode 100755 new mode 100644 index 0d5b63dd8..22785b010 --- a/lending/src/codatlending/models/shared/accountingbanktransaction.py +++ b/lending/src/codatlending/models/shared/accountingbanktransaction.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import banktransactiontype as shared_banktransactiontype +from .banktransactiontype import BankTransactionType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -64,7 +64,7 @@ class AccountingBankTransaction: 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 }}) + transaction_type: Optional[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.""" diff --git a/lending/src/codatlending/models/shared/accountingbanktransactions.py b/lending/src/codatlending/models/shared/accountingbanktransactions.py old mode 100755 new mode 100644 index 092d8fcb2..d4fe3dd52 --- a/lending/src/codatlending/models/shared/accountingbanktransactions.py +++ b/lending/src/codatlending/models/shared/accountingbanktransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbanktransaction as shared_accountingbanktransaction -from ..shared import links as shared_links +from .accountingbanktransaction import AccountingBankTransaction +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 1c6506d1a..aa931d5d9 --- a/lending/src/codatlending/models/shared/accountingbill.py +++ b/lending/src/codatlending/models/shared/accountingbill.py @@ -2,12 +2,12 @@ from __future__ import annotations import dataclasses -from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation -from ..shared import billlineitem as shared_billlineitem -from ..shared import billstatus as shared_billstatus -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata -from ..shared import supplierref as shared_supplierref +from .accountingpaymentallocation import AccountingPaymentAllocation +from .billlineitem import BillLineItem +from .billstatus import BillStatus +from .metadata import Metadata +from .supplementaldata import SupplementalData +from .supplierref import SupplierRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -16,7 +16,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AccountingBillPurchaseOrderReference: +class PurchaseOrderReference: 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') }}) @@ -27,7 +27,7 @@ class AccountingBillPurchaseOrderReference: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AccountingBillWithholdingTax: +class WithholdingTax: 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') }}) @@ -60,7 +60,7 @@ class AccountingBill: 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') }}) + status: BillStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Current state of the bill.""" sub_total: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subTotal'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Total amount of the bill, excluding any taxes.""" @@ -109,25 +109,25 @@ 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') }}) + line_items: Optional[List[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 }}) + metadata: Optional[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') }}) 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') }}) + payment_allocations: Optional[List[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') }}) + purchase_order_refs: Optional[List[PurchaseOrderReference]] = 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 }}) + supplemental_data: Optional[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. """ - 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 }}) + supplier_ref: Optional[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') }}) + withholding_tax: Optional[List[WithholdingTax]] = 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 old mode 100755 new mode 100644 index bb955f737..10c2d4166 --- a/lending/src/codatlending/models/shared/accountingbillcreditnote.py +++ b/lending/src/codatlending/models/shared/accountingbillcreditnote.py @@ -2,13 +2,13 @@ from __future__ import annotations import dataclasses -from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation -from ..shared import billcreditnotelineitem as shared_billcreditnotelineitem -from ..shared import billcreditnotestatus as shared_billcreditnotestatus -from ..shared import items as shared_items -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata -from ..shared import supplierref as shared_supplierref +from .accountingpaymentallocation import AccountingPaymentAllocation +from .billcreditnotelineitem import BillCreditNoteLineItem +from .billcreditnotestatus import BillCreditNoteStatus +from .items import Items +from .metadata import Metadata +from .supplementaldata import SupplementalData +from .supplierref import SupplierRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -37,7 +37,7 @@ class AccountingBillCreditNote: """ discount_percentage: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountPercentage'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Percentage rate of any discount applied to the bill credit note.""" - status: shared_billcreditnotestatus.BillCreditNoteStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: BillCreditNoteStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""Current state of the bill 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"""Total amount of the bill credit note, including discounts but excluding tax.""" @@ -129,24 +129,24 @@ 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') }}) + line_items: Optional[List[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 }}) + metadata: Optional[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') }}) 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') }}) + payment_allocations: Optional[List[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.""" 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 }}) + supplemental_data: Optional[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. """ - 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 }}) + supplier_ref: Optional[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') }}) + withholding_tax: Optional[List[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 old mode 100755 new mode 100644 index 24f200e76..9a28624de --- a/lending/src/codatlending/models/shared/accountingbillcreditnotes.py +++ b/lending/src/codatlending/models/shared/accountingbillcreditnotes.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbillcreditnote as shared_accountingbillcreditnote -from ..shared import links as shared_links +from .accountingbillcreditnote import AccountingBillCreditNote +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 24bb4c10c..679836132 --- a/lending/src/codatlending/models/shared/accountingbillpayment.py +++ b/lending/src/codatlending/models/shared/accountingbillpayment.py @@ -2,12 +2,12 @@ from __future__ import annotations import dataclasses -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 .accountref import AccountRef +from .billpaymentline import BillPaymentLine +from .metadata import Metadata +from .paymentmethodref import PaymentMethodRef +from .supplementaldata import SupplementalData +from .supplierref import SupplierRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -169,7 +169,7 @@ class AccountingBillPayment: - The currency of the item. """ date_: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date') }}) - 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 }}) + account_ref: Optional[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 }}) @@ -201,22 +201,22 @@ 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') }}) + lines: Optional[List[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 }}) + metadata: Optional[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') }}) r"""Additional information associated with the payment.""" - 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 }}) + payment_method_ref: Optional[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 }}) + supplemental_data: Optional[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. """ - 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 }}) + supplier_ref: Optional[SupplierRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplierRef'), '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, 'exclude': lambda f: f is None }}) r"""Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account.""" diff --git a/lending/src/codatlending/models/shared/accountingbillpayments.py b/lending/src/codatlending/models/shared/accountingbillpayments.py old mode 100755 new mode 100644 index 9ec803977..01b6d9082 --- a/lending/src/codatlending/models/shared/accountingbillpayments.py +++ b/lending/src/codatlending/models/shared/accountingbillpayments.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbillpayment as shared_accountingbillpayment -from ..shared import links as shared_links +from .accountingbillpayment import AccountingBillPayment +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 47a6afeee..94baa1d82 --- a/lending/src/codatlending/models/shared/accountingbills.py +++ b/lending/src/codatlending/models/shared/accountingbills.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingbill as shared_accountingbill -from ..shared import links as shared_links +from .accountingbill import AccountingBill +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 7143bc812..44c1a063d --- a/lending/src/codatlending/models/shared/accountingcashflowstatement.py +++ b/lending/src/codatlending/models/shared/accountingcashflowstatement.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import cashflowstatement as shared_cashflowstatement -from ..shared import reportbasis as shared_reportbasis -from ..shared import reportinput as shared_reportinput +from .cashflowstatement import CashFlowStatement +from .reportbasis import ReportBasis +from .reportinput import ReportInput from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -36,11 +36,11 @@ class AccountingCashFlowStatement: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - report_basis: shared_reportbasis.ReportBasis = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportBasis') }}) + report_basis: ReportBasis = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportBasis') }}) 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') }}) + report_input: 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[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 old mode 100755 new mode 100644 index 2ffb9d43e..dba394a6c --- a/lending/src/codatlending/models/shared/accountingcompanyinfo.py +++ b/lending/src/codatlending/models/shared/accountingcompanyinfo.py @@ -2,10 +2,10 @@ from __future__ import annotations 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 .accountingaddress import AccountingAddress +from .phonenumber import PhoneNumber +from .supplementaldata import SupplementalData +from .weblink import WebLink from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -14,17 +14,17 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AccountingCompanyInfo: - r"""> View the coverage for company info in the Data coverage explorer. + r"""> View the coverage for company profile in the Data coverage explorer. Company info provides standard details about a linked company such as their address, phone number, and company registration. > **Company information or companies?** > - > 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. + > Company profile 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') }}) 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') }}) + addresses: Optional[List[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') }}) r"""Currency set in the accounting platform of the linked company. Used by the currency rate.""" @@ -95,7 +95,7 @@ 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') }}) + phone_numbers: Optional[List[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') }}) r"""Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.""" @@ -104,14 +104,14 @@ class AccountingCompanyInfo: 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[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[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') }}) + web_links: Optional[List[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 old mode 100755 new mode 100644 index 3c4162fab..ee2f1dcb4 --- a/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreateaccountresponse.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaccount as shared_accountingaccount -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 .accountingaccount import AccountingAccount +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ 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. """ - status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: 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') }}) + changes: Optional[List[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,37 +69,37 @@ 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') }}) + data: Optional[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. ## 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. + 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. + * 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. + 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. + 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: + 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. + - 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_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 }}) + data_type: Optional[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.""" @@ -110,7 +110,7 @@ class AccountingCreateAccountResponse: 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 }}) + validation: Optional[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 new file mode 100644 index 000000000..27bcc22e7 --- /dev/null +++ b/lending/src/codatlending/models/shared/accountingcreatebankaccountresponse.py @@ -0,0 +1,104 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .accountingbankaccount import AccountingBankAccount +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import 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 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: 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[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[AccountingBankAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data') }}) + 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/lending-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[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[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 old mode 100755 new mode 100644 index 7ee671f5d..8a44997e8 --- a/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py +++ b/lending/src/codatlending/models/shared/accountingcreatebanktransactions.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import createbankaccounttransaction as shared_createbankaccounttransaction +from .createbankaccounttransaction import CreateBankAccountTransaction from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -13,6 +13,6 @@ 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 }}) 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 }}) + transactions: Optional[List[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 old mode 100755 new mode 100644 index 63fec7a6f..6906ae2ef --- a/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatebanktransactionsresponse.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcreatebanktransactions as shared_accountingcreatebanktransactions -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 .accountingcreatebanktransactions import AccountingCreateBankTransactions +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ class AccountingCreateBankTransactionsResponse: > 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') }}) + status: 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') }}) + changes: Optional[List[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,8 +69,8 @@ class AccountingCreateBankTransactionsResponse: > 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_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 }}) + data: Optional[AccountingCreateBankTransactions] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) + data_type: Optional[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.""" @@ -81,7 +81,7 @@ class AccountingCreateBankTransactionsResponse: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index 380abf1fc..2f236b919 --- a/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatedirectcostresponse.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingdirectcost as shared_accountingdirectcost -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 .accountingdirectcost import AccountingDirectCost +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ 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. """ - status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: 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') }}) + changes: Optional[List[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') }}) + data: Optional[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. @@ -86,7 +86,7 @@ class AccountingCreateDirectCostResponse: 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 }}) + data_type: Optional[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.""" @@ -97,7 +97,7 @@ class AccountingCreateDirectCostResponse: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index 14eebb7a3..9757da5c7 --- a/lending/src/codatlending/models/shared/accountingcreatepaymentresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatepaymentresponse.py @@ -2,11 +2,11 @@ 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 .accountingpayment import AccountingPayment +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ class AccountingCreatePaymentResponse: > 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') }}) + status: 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') }}) + changes: Optional[List[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,9 +69,9 @@ class AccountingCreatePaymentResponse: > 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') }}) + data: Optional[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. @@ -80,7 +80,7 @@ class AccountingCreatePaymentResponse: 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 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. @@ -106,9 +106,9 @@ class AccountingCreatePaymentResponse: - 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`. + - 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. @@ -139,12 +139,12 @@ class AccountingCreatePaymentResponse: - 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 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. @@ -154,14 +154,14 @@ class AccountingCreatePaymentResponse: - 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. + - 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: + 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. @@ -170,14 +170,14 @@ class AccountingCreatePaymentResponse: - 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. + - 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. + 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: + 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. @@ -186,570 +186,570 @@ class AccountingCreatePaymentResponse: - 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. + - 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: + There are two types of currency rate that are included in the payments data type: - Payment currency rate: + Payment currency rate: - Base currency of the accounts receivable account. - Foreign currency of the payment. - Payment line link currency rate: + 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 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, - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 }}) + data_type: Optional[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.""" @@ -760,7 +760,7 @@ class AccountingCreatePaymentResponse: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index 28f041a56..065f388b2 --- a/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatesupplierresponse.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingsupplier as shared_accountingsupplier -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 .accountingsupplier import AccountingSupplier +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ 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. """ - status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: 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') }}) + changes: Optional[List[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,14 +69,14 @@ 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') }}) + data: Optional[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/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 }}) + data_type: Optional[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.""" @@ -87,7 +87,7 @@ class AccountingCreateSupplierResponse: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index c9e2c5b17..8bfe8a5fd --- a/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py +++ b/lending/src/codatlending/models/shared/accountingcreatetransferresponse.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingtransfer as shared_accountingtransfer -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 .accountingtransfer import AccountingTransfer +from .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -42,11 +42,11 @@ 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. """ - status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: 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') }}) + changes: Optional[List[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,12 +69,12 @@ 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') }}) + data: Optional[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/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 }}) + data_type: Optional[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.""" @@ -85,7 +85,7 @@ class AccountingCreateTransferResponse: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index 5769e0455..130df8c15 --- a/lending/src/codatlending/models/shared/accountingcreditnote.py +++ b/lending/src/codatlending/models/shared/accountingcreditnote.py @@ -2,13 +2,13 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcustomerref as shared_accountingcustomerref -from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation -from ..shared import creditnotelineitem as shared_creditnotelineitem -from ..shared import creditnotestatus as shared_creditnotestatus -from ..shared import items as shared_items -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingcustomerref import AccountingCustomerRef +from .accountingpaymentallocation import AccountingPaymentAllocation +from .creditnotelineitem import CreditNoteLineItem +from .creditnotestatus import CreditNoteStatus +from .items import Items +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -35,7 +35,7 @@ class AccountingCreditNote: r"""Percentage rate (from 0 to 100) of discounts applied to the credit note.""" 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') }}) + status: 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.""" @@ -108,7 +108,7 @@ class AccountingCreditNote: | **EUR** | €20 | 1.134 | $22.68 | | **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 }}) + customer_ref: Optional[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 credit note, unique to the company in the accounting platform.""" issue_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate'), 'exclude': lambda f: f is None }}) @@ -132,19 +132,19 @@ 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') }}) - 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 }}) + line_items: Optional[List[CreditNoteLineItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) + metadata: Optional[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') }}) 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') }}) + payment_allocations: Optional[List[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 }}) + supplemental_data: Optional[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. """ - withholding_tax: Optional[List[shared_items.Items]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('withholdingTax') }}) + withholding_tax: Optional[List[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 old mode 100755 new mode 100644 index 85ce7a111..8be32b0ee --- a/lending/src/codatlending/models/shared/accountingcreditnotes.py +++ b/lending/src/codatlending/models/shared/accountingcreditnotes.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcreditnote as shared_accountingcreditnote -from ..shared import links as shared_links +from .accountingcreditnote import AccountingCreditNote +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 9d789b8a8..2fad0db7e --- a/lending/src/codatlending/models/shared/accountingcustomer.py +++ b/lending/src/codatlending/models/shared/accountingcustomer.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaddress as shared_accountingaddress -from ..shared import contact as shared_contact -from ..shared import customerstatus as shared_customerstatus -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingaddress import AccountingAddress +from .contact import Contact +from .customerstatus import CustomerStatus +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -23,13 +23,13 @@ class AccountingCustomer: 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') }}) + status: 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') }}) + addresses: Optional[List[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') }}) 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') }}) + contacts: Optional[List[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') }}) r"""Name of the customer as recorded in the accounting system, typically the company name.""" @@ -46,14 +46,14 @@ class AccountingCustomer: 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 }}) + metadata: Optional[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') }}) 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') }}) 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 }}) + supplemental_data: Optional[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/accountingcustomerref.py b/lending/src/codatlending/models/shared/accountingcustomerref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountingcustomers.py b/lending/src/codatlending/models/shared/accountingcustomers.py old mode 100755 new mode 100644 index 8ce50d73b..0a05e7c21 --- a/lending/src/codatlending/models/shared/accountingcustomers.py +++ b/lending/src/codatlending/models/shared/accountingcustomers.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcustomer as shared_accountingcustomer -from ..shared import links as shared_links +from .accountingcustomer import AccountingCustomer +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index c9a03d28f..3d7921f4c --- a/lending/src/codatlending/models/shared/accountingdirectcost.py +++ b/lending/src/codatlending/models/shared/accountingdirectcost.py @@ -2,17 +2,29 @@ from __future__ import annotations import dataclasses -from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation -from ..shared import contactref as shared_contactref -from ..shared import directcostlineitem as shared_directcostlineitem -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingpaymentallocation import AccountingPaymentAllocation +from .datatype import DataType +from .directcostlineitem import DirectCostLineItem +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from typing import List, Optional +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AccountingDirectCostContactRef: + r"""A customer or supplier associated with the direct cost.""" + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""Unique identifier for a customer or supplier.""" + data_type: Optional[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 AccountingDirectCost: @@ -62,9 +74,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[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[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.""" @@ -72,8 +84,8 @@ class AccountingDirectCost: r"""The total amount of tax on the direct costs.""" total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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.""" + contact_ref: Optional[AccountingDirectCostContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) + r"""A customer or supplier associated with the direct cost.""" 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. @@ -103,14 +115,14 @@ class AccountingDirectCost: """ 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 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 }}) + metadata: Optional[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') }}) 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') }}) 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 }}) + supplemental_data: Optional[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/accountingdirectcosts.py b/lending/src/codatlending/models/shared/accountingdirectcosts.py old mode 100755 new mode 100644 index 7dea1cea8..d5156f5bf --- a/lending/src/codatlending/models/shared/accountingdirectcosts.py +++ b/lending/src/codatlending/models/shared/accountingdirectcosts.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingdirectcost as shared_accountingdirectcost -from ..shared import links as shared_links +from .accountingdirectcost import AccountingDirectCost +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index e835fbedb..cb62bb415 --- a/lending/src/codatlending/models/shared/accountingdirectincome.py +++ b/lending/src/codatlending/models/shared/accountingdirectincome.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountingpaymentallocation as shared_accountingpaymentallocation -from ..shared import contactref as shared_contactref -from ..shared import directincomelineitem as shared_directincomelineitem -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingpaymentallocation import AccountingPaymentAllocation +from .contactref import ContactRef +from .directincomelineitem import DirectIncomeLineItem +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -62,17 +62,17 @@ 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[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[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 }}) r"""The total amount of tax on the direct incomes.""" total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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.""" + contact_ref: Optional[ContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) + r"""A customer or supplier associated with the direct cost.""" 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. @@ -102,14 +102,14 @@ class AccountingDirectIncome: """ 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 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 }}) + metadata: Optional[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') }}) 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 }}) + supplemental_data: Optional[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/accountingdirectincomes.py b/lending/src/codatlending/models/shared/accountingdirectincomes.py old mode 100755 new mode 100644 index d3db5a660..9f6310bc0 --- a/lending/src/codatlending/models/shared/accountingdirectincomes.py +++ b/lending/src/codatlending/models/shared/accountingdirectincomes.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingdirectincome as shared_accountingdirectincome -from ..shared import links as shared_links +from .accountingdirectincome import AccountingDirectIncome +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 44fe11575..400db8597 --- a/lending/src/codatlending/models/shared/accountinginvoice.py +++ b/lending/src/codatlending/models/shared/accountinginvoice.py @@ -2,14 +2,14 @@ from __future__ import annotations 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 -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata +from .accountingcustomerref import AccountingCustomerRef +from .accountingpaymentallocation import AccountingPaymentAllocation +from .datatype import DataType +from .invoicelineitem import InvoiceLineItem +from .invoicestatus import InvoiceStatus +from .items import Items +from .metadata import Metadata +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -18,8 +18,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AccountingInvoiceSalesOrderReference: - 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 }}) +class SalesOrderReference: + data_type: Optional[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`.""" @@ -83,7 +83,7 @@ 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. """ - status: shared_invoicestatus.InvoiceStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: InvoiceStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) r"""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. @@ -136,7 +136,7 @@ class AccountingInvoice: | **EUR** | €20 | 1.134 | $22.68 | | **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 }}) + customer_ref: Optional[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 }}) 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 }}) @@ -164,9 +164,9 @@ class AccountingInvoice: 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') }}) 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') }}) + line_items: Optional[List[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 }}) + metadata: Optional[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') }}) 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.""" @@ -191,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') }}) + payment_allocations: Optional[List[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') }}) + sales_order_refs: Optional[List[SalesOrderReference]] = 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 }}) 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 }}) + supplemental_data: Optional[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 }}) 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') }}) + withholding_tax: Optional[List[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 old mode 100755 new mode 100644 index 40dd19dea..b3a049fa6 --- a/lending/src/codatlending/models/shared/accountinginvoices.py +++ b/lending/src/codatlending/models/shared/accountinginvoices.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountinginvoice as shared_accountinginvoice -from ..shared import links as shared_links +from .accountinginvoice import AccountingInvoice +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index ee6bf633a..5e2a86975 --- a/lending/src/codatlending/models/shared/accountingjournal.py +++ b/lending/src/codatlending/models/shared/accountingjournal.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import journalstatus as shared_journalstatus -from ..shared import metadata as shared_metadata +from .journalstatus import JournalStatus +from .metadata import Metadata from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -62,7 +62,7 @@ class AccountingJournal: r"""Journal ID.""" 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 }}) + metadata: Optional[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') }}) r"""Journal name. @@ -73,7 +73,7 @@ class AccountingJournal: 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 }}) + status: Optional[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') }}) r"""The type of the journal.""" diff --git a/lending/src/codatlending/models/shared/accountingjournalentries.py b/lending/src/codatlending/models/shared/accountingjournalentries.py old mode 100755 new mode 100644 index 5248df3b2..e68444d71 --- a/lending/src/codatlending/models/shared/accountingjournalentries.py +++ b/lending/src/codatlending/models/shared/accountingjournalentries.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingjournalentry as shared_accountingjournalentry -from ..shared import links as shared_links +from .accountingjournalentry import AccountingJournalEntry +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 8dd374649..9edd528ab --- a/lending/src/codatlending/models/shared/accountingjournalentry.py +++ b/lending/src/codatlending/models/shared/accountingjournalentry.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import journalline as shared_journalline -from ..shared import journalref as shared_journalref -from ..shared import metadata as shared_metadata -from ..shared import recordref as shared_recordref -from ..shared import supplementaldata as shared_supplementaldata +from .journalline import JournalLine +from .journalref import JournalRef +from .metadata import Metadata +from .recordref import RecordRef +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -63,11 +63,11 @@ class AccountingJournalEntry: 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') }}) + journal_lines: Optional[List[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 }}) + journal_ref: Optional[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).""" - 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 }}) + metadata: Optional[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 }}) posted_on: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('postedOn'), '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: @@ -90,13 +90,13 @@ 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. """ - 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 }}) + record_ref: Optional[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. 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. """ 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 }}) + supplemental_data: Optional[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/accountingjournals.py b/lending/src/codatlending/models/shared/accountingjournals.py old mode 100755 new mode 100644 index 3ed082f37..dd8314eed --- a/lending/src/codatlending/models/shared/accountingjournals.py +++ b/lending/src/codatlending/models/shared/accountingjournals.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingjournal as shared_accountingjournal -from ..shared import links as shared_links +from .accountingjournal import AccountingJournal +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 5d90f9f55..0b85cc189 --- a/lending/src/codatlending/models/shared/accountingpayment.py +++ b/lending/src/codatlending/models/shared/accountingpayment.py @@ -2,12 +2,12 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcustomerref as shared_accountingcustomerref -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 .accountingcustomerref import AccountingCustomerRef +from .accountref import AccountRef +from .metadata import Metadata +from .paymentline import PaymentLine +from .paymentmethodref import PaymentMethodRef +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -18,7 +18,7 @@ @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/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. @@ -27,7 +27,7 @@ class AccountingPayment: 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 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. @@ -53,9 +53,9 @@ class AccountingPayment: - 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`. + - 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. @@ -86,12 +86,12 @@ class AccountingPayment: - 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 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. @@ -101,14 +101,14 @@ class AccountingPayment: - 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. + - 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: + 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. @@ -117,14 +117,14 @@ class AccountingPayment: - 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. + - 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. + 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: + 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. @@ -133,568 +133,568 @@ class AccountingPayment: - 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. + - 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: + There are two types of currency rate that are included in the payments data type: - Payment currency rate: + Payment currency rate: - Base currency of the accounts receivable account. - Foreign currency of the payment. - Payment line link currency rate: + 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 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, - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 - } - ] - } - ] - } - ``` + ```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 + } + ] + } + ] + } + ``` """ date_: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date') }}) 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: @@ -717,7 +717,7 @@ class AccountingPayment: > 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. """ - 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 }}) + account_ref: Optional[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 }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -755,21 +755,21 @@ class AccountingPayment: | **EUR** | €20 | 1.134 | $22.68 | | **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 }}) + customer_ref: Optional[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') }}) + lines: Optional[List[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 }}) + metadata: Optional[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') }}) r"""Any additional information associated with the payment.""" - 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 }}) + payment_method_ref: Optional[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 }}) + supplemental_data: Optional[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/accountingpaymentallocation.py b/lending/src/codatlending/models/shared/accountingpaymentallocation.py old mode 100755 new mode 100644 index fd80e0b63..08dacd53f --- a/lending/src/codatlending/models/shared/accountingpaymentallocation.py +++ b/lending/src/codatlending/models/shared/accountingpaymentallocation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import paymentallocationpayment as shared_paymentallocationpayment +from .paymentallocationpayment import PaymentAllocationPayment from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AccountingPaymentAllocationAllocation: +class Allocation: 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: @@ -78,7 +78,7 @@ 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') }}) - payment: shared_paymentallocationpayment.PaymentAllocationPayment = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payment') }}) + allocation: Allocation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('allocation') }}) + payment: PaymentAllocationPayment = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payment') }}) diff --git a/lending/src/codatlending/models/shared/accountingpayments.py b/lending/src/codatlending/models/shared/accountingpayments.py old mode 100755 new mode 100644 index 5a3898d46..651bfc1d0 --- a/lending/src/codatlending/models/shared/accountingpayments.py +++ b/lending/src/codatlending/models/shared/accountingpayments.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingpayment as shared_accountingpayment -from ..shared import links as shared_links +from .accountingpayment import AccountingPayment +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index b909e9b95..4d874068e --- a/lending/src/codatlending/models/shared/accountingprofitandlossreport.py +++ b/lending/src/codatlending/models/shared/accountingprofitandlossreport.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import profitandlossreport as shared_profitandlossreport -from ..shared import reportbasis as shared_reportbasis +from .profitandlossreport import ProfitAndLossReport +from .reportbasis import ReportBasis from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -37,9 +37,9 @@ class AccountingProfitAndLossReport: """ currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) 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') }}) + report_basis: 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[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 old mode 100755 new mode 100644 index d8503a456..4e6755503 --- a/lending/src/codatlending/models/shared/accountingsupplier.py +++ b/lending/src/codatlending/models/shared/accountingsupplier.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaddress as shared_accountingaddress -from ..shared import metadata as shared_metadata -from ..shared import supplementaldata as shared_supplementaldata -from ..shared import supplierstatus as shared_supplierstatus +from .accountingaddress import AccountingAddress +from .metadata import Metadata +from .supplementaldata import SupplementalData +from .supplierstatus import SupplierStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -20,9 +20,9 @@ class AccountingSupplier: 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') }}) + status: 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') }}) + addresses: Optional[List[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') }}) r"""Name of the main contact for the supplier.""" @@ -32,14 +32,14 @@ class AccountingSupplier: 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 }}) + metadata: Optional[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') }}) 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') }}) 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 }}) + supplemental_data: Optional[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/accountingsuppliers.py b/lending/src/codatlending/models/shared/accountingsuppliers.py old mode 100755 new mode 100644 index 604f18bc4..8f8ce15c5 --- a/lending/src/codatlending/models/shared/accountingsuppliers.py +++ b/lending/src/codatlending/models/shared/accountingsuppliers.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingsupplier as shared_accountingsupplier -from ..shared import links as shared_links +from .accountingsupplier import AccountingSupplier +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 6cc022b73..887e3e368 --- a/lending/src/codatlending/models/shared/accountingtransfer.py +++ b/lending/src/codatlending/models/shared/accountingtransfer.py @@ -2,29 +2,17 @@ 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 -from ..shared import trackingcategoryref as shared_trackingcategoryref -from ..shared import transferaccount as shared_transferaccount +from .contactref import ContactRef +from .metadata import Metadata +from .recordref import RecordRef +from .supplementaldata import SupplementalData +from .trackingcategoryref import TrackingCategoryRef +from .transferaccount import TransferAccount from codatlending import utils from dataclasses_json import Undefined, dataclass_json 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') }}) - 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: @@ -32,8 +20,8 @@ class AccountingTransfer: 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.""" + contact_ref: Optional[ContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) + r"""A customer or supplier associated with the direct cost.""" 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: @@ -55,25 +43,25 @@ 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') }}) + deposited_record_refs: Optional[List[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') }}) 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 }}) + from_: Optional[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 }}) + metadata: Optional[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 }}) 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 }}) + supplemental_data: Optional[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. """ - 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 }}) + to: Optional[TransferAccount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('to'), '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') }}) + tracking_category_refs: Optional[List[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 old mode 100755 new mode 100644 index 8da550544..31b22bbed --- a/lending/src/codatlending/models/shared/accountingtransfers.py +++ b/lending/src/codatlending/models/shared/accountingtransfers.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountingtransfer as shared_accountingtransfer -from ..shared import links as shared_links +from .accountingtransfer import AccountingTransfer +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accountprototype.py b/lending/src/codatlending/models/shared/accountprototype.py new file mode 100644 index 000000000..05bca214d --- /dev/null +++ b/lending/src/codatlending/models/shared/accountprototype.py @@ -0,0 +1,111 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .accountstatus import AccountStatus +from .accounttype import AccountType +from .supplementaldata import SupplementalData +from codatlending import utils +from dataclasses_json import Undefined, dataclass_json +from decimal import Decimal +from typing import List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ValidDataTypeLinks: + 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. + + For example, `validDatatypeLinks` might indicate the following references: + + - Which tax rates are valid to use on the line item of a bill. + - Which items can be used when creating an invoice. + + You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. + + ## `validDatatypeLinks` example + + The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error. + + ```json validDatatypeLinks for an account + { + \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\", + \"nominalCode\": \"090\", + \"name\": \"Business Bank Account\", + #... + \"validDatatypeLinks\": [ + { + \"property\": \"Id\", + \"links\": [ + \"Payment.AccountRef.Id\", + \"BillPayment.AccountRef.Id\", + \"DirectIncome.LineItems.AccountRef.Id\", + \"DirectCost.LineItems.AccountRef.Id\" + ] + } + ] + } + ``` + + + + ## Support for `validDatatypeLinks` + + Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. + + 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') }}) + 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') }}) + r"""The property from the account that can be linked.""" + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AccountPrototype: + 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. + """ + 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') }}) + r"""Description for the account.""" + 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') }}) + r"""Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` + """ + is_bank_account: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBankAccount'), 'exclude': lambda f: f is None }}) + r"""Confirms whether the account is a bank account or not.""" + 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') }}) + 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.""" + status: Optional[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[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[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[ValidDataTypeLinks]] = 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/accountref.py b/lending/src/codatlending/models/shared/accountref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accounts.py b/lending/src/codatlending/models/shared/accounts.py old mode 100755 new mode 100644 index 6e85b8c46..4febef475 --- a/lending/src/codatlending/models/shared/accounts.py +++ b/lending/src/codatlending/models/shared/accounts.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import sourceref as shared_sourceref +from .sourceref import SourceRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -31,7 +31,7 @@ class Accounts: r"""The balance of the bank account.""" platform_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformName'), 'exclude': lambda f: f is None }}) r"""Name of the banking data source, e.g. \\"Plaid\\".""" - source_ref: Optional[shared_sourceref.SourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceRef'), 'exclude': lambda f: f is None }}) + source_ref: Optional[SourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceRef'), 'exclude': lambda f: f is None }}) r"""A source reference containing the `sourceType` object \\"Banking\\".""" diff --git a/lending/src/codatlending/models/shared/accountspayabletracking.py b/lending/src/codatlending/models/shared/accountspayabletracking.py old mode 100755 new mode 100644 index 3ea36eba3..02113223d --- a/lending/src/codatlending/models/shared/accountspayabletracking.py +++ b/lending/src/codatlending/models/shared/accountspayabletracking.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcustomerref as shared_accountingcustomerref -from ..shared import billedtotype as shared_billedtotype -from ..shared import projectref as shared_projectref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountingcustomerref import AccountingCustomerRef +from .billedtotype import BilledToType +from .projectref import ProjectRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -15,12 +15,12 @@ @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') }}) - is_billed_to: shared_billedtotype.BilledToType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + category_refs: List[TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + is_billed_to: 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') }}) + is_rebilled_to: 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 }}) + customer_ref: Optional[AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) + project_ref: Optional[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 old mode 100755 new mode 100644 index 661532839..e11a595ad --- a/lending/src/codatlending/models/shared/accountsreceivabletracking.py +++ b/lending/src/codatlending/models/shared/accountsreceivabletracking.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountingcustomerref as shared_accountingcustomerref -from ..shared import billedtotype1 as shared_billedtotype1 -from ..shared import projectref as shared_projectref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountingcustomerref import AccountingCustomerRef +from .billedtotype1 import BilledToType1 +from .projectref import ProjectRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -13,7 +13,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AccountsReceivableTrackingRecordReference: +class RecordReference: r"""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. @@ -30,14 +30,14 @@ class AccountsReceivableTrackingRecordReference: @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') }}) - is_billed_to: shared_billedtotype1.BilledToType1 = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isBilledTo') }}) + category_refs: List[TrackingCategoryRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categoryRefs') }}) + is_billed_to: 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') }}) + is_rebilled_to: 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 }}) + customer_ref: Optional[AccountingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) + project_ref: Optional[ProjectRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projectRef'), 'exclude': lambda f: f is None }}) + record_ref: Optional[RecordReference] = 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. 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. diff --git a/lending/src/codatlending/models/shared/accountstatus.py b/lending/src/codatlending/models/shared/accountstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/accounttransactionline.py b/lending/src/codatlending/models/shared/accounttransactionline.py old mode 100755 new mode 100644 index bd4fdaac2..cff67a7e6 --- a/lending/src/codatlending/models/shared/accounttransactionline.py +++ b/lending/src/codatlending/models/shared/accounttransactionline.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import recordref as shared_recordref +from .recordref import RecordRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -16,7 +16,7 @@ class AccountTransactionLine: r"""Amount in the bill payment currency.""" 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 }}) + record_ref: Optional[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. 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. diff --git a/lending/src/codatlending/models/shared/accounttype.py b/lending/src/codatlending/models/shared/accounttype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/agedcreditor.py b/lending/src/codatlending/models/shared/agedcreditor.py old mode 100755 new mode 100644 index 77d78e60d..c5e3bf3a3 --- a/lending/src/codatlending/models/shared/agedcreditor.py +++ b/lending/src/codatlending/models/shared/agedcreditor.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import agedcurrencyoutstanding as shared_agedcurrencyoutstanding +from .agedcurrencyoutstanding import AgedCurrencyOutstanding from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 index 7d0e46f36..bdab1b3d2 --- a/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py +++ b/lending/src/codatlending/models/shared/agedcurrencyoutstanding.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import agedoutstandingamount as shared_agedoutstandingamount +from .agedoutstandingamount import AgedOutstandingAmount from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 index 59c2f6b02..5c6be6676 --- a/lending/src/codatlending/models/shared/ageddebtor.py +++ b/lending/src/codatlending/models/shared/ageddebtor.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import agedcurrencyoutstanding as shared_agedcurrencyoutstanding +from .agedcurrencyoutstanding import AgedCurrencyOutstanding from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 index f4f2cd6b9..a75622de3 --- a/lending/src/codatlending/models/shared/agedoutstandingamount.py +++ b/lending/src/codatlending/models/shared/agedoutstandingamount.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import agedoutstandingamountdetail as shared_agedoutstandingamountdetail +from .agedoutstandingamountdetail import AgedOutstandingAmountDetail from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ 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[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/attachments.py b/lending/src/codatlending/models/shared/attachments.py old mode 100755 new mode 100644 index dfbf97f9c..511591744 --- a/lending/src/codatlending/models/shared/attachments.py +++ b/lending/src/codatlending/models/shared/attachments.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountingattachment as shared_accountingattachment +from .accountingattachment import AccountingAttachment from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,6 +11,6 @@ @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') }}) + attachments: Optional[List[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 old mode 100755 new mode 100644 index f8e90c5db..d4e4fcbe1 --- a/lending/src/codatlending/models/shared/balancesheet.py +++ b/lending/src/codatlending/models/shared/balancesheet.py @@ -2,7 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import reportline as shared_reportline +from .reportline import ReportLine +from .reportline_input import ReportLineInput from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +15,7 @@ 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 }}) r"""Value of net assets for a company in their base currency.""" - assets: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assets'), 'exclude': lambda f: f is None }}) + assets: Optional[ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assets'), 'exclude': lambda f: f is None }}) 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,7 +37,7 @@ class BalanceSheet: > 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. """ - equity: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('equity'), 'exclude': lambda f: f is None }}) - liabilities: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('liabilities'), 'exclude': lambda f: f is None }}) + equity: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('equity'), 'exclude': lambda f: f is None }}) + liabilities: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('liabilities'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/bankaccountref.py b/lending/src/codatlending/models/shared/bankaccountref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/bankingaccount.py b/lending/src/codatlending/models/shared/bankingaccount.py old mode 100755 new mode 100644 index a206c4b49..a98cf140e --- a/lending/src/codatlending/models/shared/bankingaccount.py +++ b/lending/src/codatlending/models/shared/bankingaccount.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountbalanceamounts as shared_accountbalanceamounts -from ..shared import accountidentifiers as shared_accountidentifiers -from ..shared import accountingbankaccounttype as shared_accountingbankaccounttype -from ..shared import accountinstitution as shared_accountinstitution +from .accountbalanceamounts import AccountBalanceAmounts +from .accountidentifiers import AccountIdentifiers +from .accountingbankaccounttype import AccountingBankAccountType +from .accountinstitution import AccountInstitution from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -20,19 +20,19 @@ class BankingAccount: Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. """ - balance: shared_accountbalanceamounts.AccountBalanceAmounts = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance') }}) + balance: AccountBalanceAmounts = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance') }}) r"""Depending on the data provided by the underlying bank, not all balances are always available.""" currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }}) r"""The currency code for the account.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""The ID of the account from the provider.""" - identifiers: shared_accountidentifiers.AccountIdentifiers = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers') }}) + identifiers: AccountIdentifiers = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('identifiers') }}) r"""An object containing bank account identification information.""" - institution: shared_accountinstitution.AccountInstitution = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution') }}) + institution: AccountInstitution = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('institution') }}) r"""The bank or other financial institution providing the account.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""The name of the account according to the provider.""" - type: shared_accountingbankaccounttype.AccountingBankAccountType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) + type: AccountingBankAccountType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The type of transactions and balances on the account. For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For Debit accounts, positive balances are assets, and positive transactions **increase** assets. diff --git a/lending/src/codatlending/models/shared/bankingaccountbalance.py b/lending/src/codatlending/models/shared/bankingaccountbalance.py old mode 100755 new mode 100644 index 65a7d5c87..d73bdd68c --- a/lending/src/codatlending/models/shared/bankingaccountbalance.py +++ b/lending/src/codatlending/models/shared/bankingaccountbalance.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountbalanceamounts as shared_accountbalanceamounts +from .accountbalanceamounts import AccountBalanceAmounts from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -23,7 +23,7 @@ class BankingAccountBalance: """ account_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId') }}) r"""The unique identifier of the account.""" - balance: shared_accountbalanceamounts.AccountBalanceAmounts = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance') }}) + balance: AccountBalanceAmounts = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance') }}) r"""Depending on the data provided by the underlying bank, not all balances are always available.""" date_: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date') }}) 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/bankingaccountbalances.py b/lending/src/codatlending/models/shared/bankingaccountbalances.py old mode 100755 new mode 100644 index 4f218cf4b..05b425def --- a/lending/src/codatlending/models/shared/bankingaccountbalances.py +++ b/lending/src/codatlending/models/shared/bankingaccountbalances.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import bankingaccountbalance as shared_bankingaccountbalance -from ..shared import links as shared_links +from .bankingaccountbalance import BankingAccountBalance +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 44d652c68..c1b5844b0 --- a/lending/src/codatlending/models/shared/bankingaccounts.py +++ b/lending/src/codatlending/models/shared/bankingaccounts.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import bankingaccount as shared_bankingaccount -from ..shared import links as shared_links +from .bankingaccount import BankingAccount +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 58f9264ed..bc9784601 --- a/lending/src/codatlending/models/shared/bankingtransaction.py +++ b/lending/src/codatlending/models/shared/bankingtransaction.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import transactioncategoryref as shared_transactioncategoryref -from ..shared import transactioncode as shared_transactioncode +from .transactioncategoryref import TransactionCategoryRef +from .transactioncode import TransactionCode from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -48,7 +48,7 @@ class BankingTransaction: > 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. """ - 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 }}) + code: Optional[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') }}) r"""The description of the bank transaction.""" @@ -77,7 +77,7 @@ class BankingTransaction: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ 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_category_ref: Optional[shared_transactioncategoryref.TransactionCategoryRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionCategoryRef'), 'exclude': lambda f: f is None }}) + transaction_category_ref: Optional[TransactionCategoryRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionCategoryRef'), 'exclude': lambda f: f is None }}) r"""An object of bank transaction category reference data.""" diff --git a/lending/src/codatlending/models/shared/bankingtransactioncategories.py b/lending/src/codatlending/models/shared/bankingtransactioncategories.py old mode 100755 new mode 100644 index d86d25d2f..573624c34 --- a/lending/src/codatlending/models/shared/bankingtransactioncategories.py +++ b/lending/src/codatlending/models/shared/bankingtransactioncategories.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import bankingtransactioncategory as shared_bankingtransactioncategory -from ..shared import links as shared_links +from .bankingtransactioncategory import BankingTransactionCategory +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index b8e1dfa61..70ceebaa5 --- a/lending/src/codatlending/models/shared/bankingtransactioncategory.py +++ b/lending/src/codatlending/models/shared/bankingtransactioncategory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import transactioncategorystatus as shared_transactioncategorystatus +from .transactioncategorystatus import TransactionCategoryStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -22,7 +22,7 @@ class BankingTransactionCategory: 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 }}) + status: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/bankingtransactions.py b/lending/src/codatlending/models/shared/bankingtransactions.py old mode 100755 new mode 100644 index 782c968c7..0e32e57ac --- a/lending/src/codatlending/models/shared/bankingtransactions.py +++ b/lending/src/codatlending/models/shared/bankingtransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import bankingtransaction as shared_bankingtransaction -from ..shared import links as shared_links +from .bankingtransaction import BankingTransaction +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/billcreditnotelineitem.py b/lending/src/codatlending/models/shared/billcreditnotelineitem.py old mode 100755 new mode 100644 index 91e12c060..767055130 --- a/lending/src/codatlending/models/shared/billcreditnotelineitem.py +++ b/lending/src/codatlending/models/shared/billcreditnotelineitem.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import accountspayabletracking as shared_accountspayabletracking -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .accountspayabletracking import AccountsPayableTracking +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -13,7 +13,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class BillCreditNoteLineItemItemReference: +class ItemReference: 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.""" @@ -25,7 +25,7 @@ class BillCreditNoteLineItemItemReference: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class BillCreditNoteLineItemTaxRateReference: +class TaxRateReference: 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. Found on: @@ -54,7 +54,7 @@ class BillCreditNoteLineItem: r"""Number of units of the goods or service for which credit has been received.""" unit_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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 }}) + account_ref: Optional[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') }}) r"""Friendly name of each line item. For example, the goods or service for which credit has been received.""" @@ -62,13 +62,13 @@ class BillCreditNoteLineItem: 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 }}) 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 }}) + item_ref: Optional[ItemReference] = 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 }}) 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 }}) 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 }}) + tax_rate_ref: Optional[TaxRateReference] = 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. Found on: @@ -82,9 +82,9 @@ class BillCreditNoteLineItem: """ 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 }}) + tracking: Optional[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') }}) + tracking_category_refs: Optional[List[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/billcreditnotestatus.py b/lending/src/codatlending/models/shared/billcreditnotestatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/billedtotype.py b/lending/src/codatlending/models/shared/billedtotype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/billedtotype1.py b/lending/src/codatlending/models/shared/billedtotype1.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/billlineitem.py b/lending/src/codatlending/models/shared/billlineitem.py old mode 100755 new mode 100644 index a93d7be7c..c45d93cb2 --- a/lending/src/codatlending/models/shared/billlineitem.py +++ b/lending/src/codatlending/models/shared/billlineitem.py @@ -2,27 +2,27 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import accountspayabletracking as shared_accountspayabletracking -from ..shared import itemref as shared_itemref -from ..shared import taxrateref as shared_taxrateref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .accountspayabletracking import AccountsPayableTracking +from .propertie_itemref import PropertieItemRef +from .taxrateref import TaxRateRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum from typing import List, Optional -class BillLineItemRecordLineReferenceDataType(str, Enum): +class BillLineItemDataType(str, Enum): r"""Allowed name of the 'dataType'.""" PURCHASE_ORDERS = 'purchaseOrders' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class BillLineItemRecordLineReference: +class RecordLineReference: 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 }}) + data_type: Optional[BillLineItemDataType] = 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.""" @@ -39,7 +39,7 @@ class BillLineItem: r"""Number of units of goods or services received.""" unit_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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 }}) + account_ref: Optional[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') }}) r"""Friendly name of the goods or services received.""" @@ -52,17 +52,16 @@ class BillLineItem: 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 }}) + item_ref: Optional[PropertieItemRef] = 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.""" 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.""" + purchase_order_line_ref: Optional[RecordLineReference] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purchaseOrderLineRef'), '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 }}) 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 }}) + tax_rate_ref: Optional[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. Found on: @@ -76,9 +75,11 @@ class BillLineItem: """ 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 }}) + tracking: Optional[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') }}) + tracking_category_refs: Optional[List[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.""" + unit_of_measurement: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitOfMeasurement') }}) + r"""The measurement which defines a unit for this item (e.g. 'kilogram', 'litre').""" diff --git a/lending/src/codatlending/models/shared/billpaymentline.py b/lending/src/codatlending/models/shared/billpaymentline.py old mode 100755 new mode 100644 index c0f7b4249..ff83e5a97 --- a/lending/src/codatlending/models/shared/billpaymentline.py +++ b/lending/src/codatlending/models/shared/billpaymentline.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import billpaymentlinelink as shared_billpaymentlinelink +from .billpaymentlinelink import BillPaymentLineLink from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -35,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') }}) + links: Optional[List[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 old mode 100755 new mode 100644 index a14bd2ade..fc883a71c --- a/lending/src/codatlending/models/shared/billpaymentlinelink.py +++ b/lending/src/codatlending/models/shared/billpaymentlinelink.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import billpaymentlinelinktype as shared_billpaymentlinelinktype +from .billpaymentlinelinktype import BillPaymentLineLinkType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,7 +12,7 @@ @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') }}) + type: 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 }}) r"""Amount by which the balance of the linked entity is altered, in the currency of the linked entity. diff --git a/lending/src/codatlending/models/shared/billpaymentlinelinktype.py b/lending/src/codatlending/models/shared/billpaymentlinelinktype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/billstatus.py b/lending/src/codatlending/models/shared/billstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/cashflowstatement.py b/lending/src/codatlending/models/shared/cashflowstatement.py old mode 100755 new mode 100644 index 1bbfb6e9a..17e083840 --- a/lending/src/codatlending/models/shared/cashflowstatement.py +++ b/lending/src/codatlending/models/shared/cashflowstatement.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import reportline as shared_reportline +from .reportline_input import ReportLineInput from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,8 +11,8 @@ @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 }}) - cash_receipts: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cashReceipts'), 'exclude': lambda f: f is None }}) + cash_payments: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cashPayments'), 'exclude': lambda f: f is None }}) + cash_receipts: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cashReceipts'), 'exclude': lambda f: f is None }}) 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/clientratelimitreachedwebhook.py b/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py old mode 100755 new mode 100644 index 97d0d3c68..c1e17ad55 --- a/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py +++ b/lending/src/codatlending/models/shared/clientratelimitreachedwebhook.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import clientratelimitreachedwebhookdata as shared_clientratelimitreachedwebhookdata +from .clientratelimitreachedwebhookdata import ClientRateLimitReachedWebhookData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -18,7 +18,7 @@ class ClientRateLimitReachedWebhook: r"""Unique identifier for your client in Codat.""" client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) r"""Name of your client in Codat.""" - data: Optional[shared_clientratelimitreachedwebhookdata.ClientRateLimitReachedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[ClientRateLimitReachedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), '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 }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py b/lending/src/codatlending/models/shared/clientratelimitreachedwebhookdata.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py b/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py old mode 100755 new mode 100644 index 3bcf56590..d7a15e4d0 --- a/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py +++ b/lending/src/codatlending/models/shared/clientratelimitresetwebhook.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import clientratelimitresetwebhookdata as shared_clientratelimitresetwebhookdata +from .clientratelimitresetwebhookdata import ClientRateLimitResetWebhookData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -18,7 +18,7 @@ class ClientRateLimitResetWebhook: r"""Unique identifier for your client in Codat.""" client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) r"""Name of your client in Codat.""" - data: Optional[shared_clientratelimitresetwebhookdata.ClientRateLimitResetWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[ClientRateLimitResetWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), '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 }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py b/lending/src/codatlending/models/shared/clientratelimitresetwebhookdata.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commerceaddress.py b/lending/src/codatlending/models/shared/commerceaddress.py old mode 100755 new mode 100644 index 8f45c4b3c..1977aad99 --- a/lending/src/codatlending/models/shared/commerceaddress.py +++ b/lending/src/codatlending/models/shared/commerceaddress.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import commerceaddresstype as shared_commerceaddresstype +from .commerceaddresstype import CommerceAddressType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -23,7 +23,7 @@ class CommerceAddress: r"""The postal (or zip) code for the address""" region: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) r"""The fourth line of the address, or region""" - type: Optional[shared_commerceaddresstype.CommerceAddressType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[CommerceAddressType] = 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 address""" diff --git a/lending/src/codatlending/models/shared/commerceaddresstype.py b/lending/src/codatlending/models/shared/commerceaddresstype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercecompanyinfo.py b/lending/src/codatlending/models/shared/commercecompanyinfo.py old mode 100755 new mode 100644 index 217b9e547..be04e66be --- a/lending/src/codatlending/models/shared/commercecompanyinfo.py +++ b/lending/src/codatlending/models/shared/commercecompanyinfo.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountbalance as shared_accountbalance -from ..shared import commerceaddress as shared_commerceaddress -from ..shared import phonenumber as shared_phonenumber -from ..shared import weblink as shared_weblink +from .accountbalance import AccountBalance +from .commerceaddress import CommerceAddress +from .phonenumber import PhoneNumber +from .weblink import WebLink from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -14,14 +14,14 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class CommerceCompanyInfo: - r"""In the Codat system, company information includes standard commercial details about + r"""In the Codat system, company profile includes standard commercial details about a linked company, such as their address, phone number, and company registration. 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[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[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_. @@ -60,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[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 }}) 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[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 old mode 100755 new mode 100644 index 1b9983498..fdfee4c93 --- a/lending/src/codatlending/models/shared/commercecustomer.py +++ b/lending/src/codatlending/models/shared/commercecustomer.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import commerceaddress as shared_commerceaddress +from .commerceaddress import CommerceAddress from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -17,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[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: diff --git a/lending/src/codatlending/models/shared/commercecustomerref.py b/lending/src/codatlending/models/shared/commercecustomerref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercecustomers.py b/lending/src/codatlending/models/shared/commercecustomers.py old mode 100755 new mode 100644 index 70f695aaf..1f34f5826 --- a/lending/src/codatlending/models/shared/commercecustomers.py +++ b/lending/src/codatlending/models/shared/commercecustomers.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercecustomer as shared_commercecustomer -from ..shared import links as shared_links +from .commercecustomer import CommerceCustomer +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index f5aa1f76a..bf5970ff2 --- a/lending/src/codatlending/models/shared/commercedispute.py +++ b/lending/src/codatlending/models/shared/commercedispute.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import disputestatus as shared_disputestatus -from ..shared import transactionsourceref as shared_transactionsourceref +from .disputestatus import DisputeStatus +from .transactionsourceref import TransactionSourceRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Any, List, Optional @@ -53,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[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: @@ -80,7 +80,7 @@ class CommerceDispute: reason: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reason'), 'exclude': lambda f: f is None }}) r"""Reason for the dispute""" 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_disputestatus.DisputeStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + status: Optional[DisputeStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Current status of the dispute""" total_amount: Optional[Any] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'exclude': lambda f: f is None }}) r"""Total transaction amount that is under dispute.""" diff --git a/lending/src/codatlending/models/shared/commercedisputes.py b/lending/src/codatlending/models/shared/commercedisputes.py old mode 100755 new mode 100644 index 0a370093a..cb5521935 --- a/lending/src/codatlending/models/shared/commercedisputes.py +++ b/lending/src/codatlending/models/shared/commercedisputes.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercedispute as shared_commercedispute -from ..shared import links as shared_links +from .commercedispute import CommerceDispute +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index c303ba610..048228354 --- a/lending/src/codatlending/models/shared/commercelocation.py +++ b/lending/src/codatlending/models/shared/commercelocation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import commerceaddress as shared_commerceaddress +from .commerceaddress import CommerceAddress from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -19,7 +19,7 @@ class CommerceLocation: """ id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) r"""A unique, persistent identifier for this record""" - address: Optional[shared_commerceaddress.CommerceAddress] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('address'), 'exclude': lambda f: f is None }}) + address: Optional[CommerceAddress] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('address'), '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 }}) r"""Name of this location""" diff --git a/lending/src/codatlending/models/shared/commercelocations.py b/lending/src/codatlending/models/shared/commercelocations.py old mode 100755 new mode 100644 index bd7679d6e..3f7cdb27a --- a/lending/src/codatlending/models/shared/commercelocations.py +++ b/lending/src/codatlending/models/shared/commercelocations.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercelocation as shared_commercelocation -from ..shared import links as shared_links +from .commercelocation import CommerceLocation +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index a4aaa03ce..2a6c6e61c --- a/lending/src/codatlending/models/shared/commerceorder.py +++ b/lending/src/codatlending/models/shared/commerceorder.py @@ -2,12 +2,12 @@ from __future__ import annotations import dataclasses -from ..shared import commercecustomerref as shared_commercecustomerref -from ..shared import locationref as shared_locationref -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 .commercecustomerref import CommerceCustomerRef +from .locationref import LocationRef +from .orderlineitem import OrderLineItem +from .paymentref import PaymentRef +from .servicecharge import ServiceCharge +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -73,18 +73,18 @@ class CommerceOrder: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) - customer_ref: Optional[shared_commercecustomerref.CommerceCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) + customer_ref: Optional[CommerceCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) r"""Reference to the customer that placed the order.""" - 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 }}) + location_ref: Optional[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[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[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[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[shared_supplementaldata.SupplementalData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('supplementalData'), 'exclude': lambda f: f is None }}) + supplemental_data: Optional[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/commerceorders.py b/lending/src/codatlending/models/shared/commerceorders.py old mode 100755 new mode 100644 index 5ce3d3cf2..68ee040ce --- a/lending/src/codatlending/models/shared/commerceorders.py +++ b/lending/src/codatlending/models/shared/commerceorders.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commerceorder as shared_commerceorder -from ..shared import links as shared_links +from .commerceorder import CommerceOrder +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index e1a760d3e..00f6f74ef --- a/lending/src/codatlending/models/shared/commercepayment.py +++ b/lending/src/codatlending/models/shared/commercepayment.py @@ -2,9 +2,9 @@ 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 .paymentmethodref import PaymentMethodRef +from .paymentstatus import PaymentStatus +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -78,14 +78,14 @@ 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[shared_paymentmethodref.PaymentMethodRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paymentMethodRef'), 'exclude': lambda f: f is None }}) + payment_method_ref: Optional[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 }}) + status: Optional[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 }}) + supplemental_data: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercepaymentmethods.py b/lending/src/codatlending/models/shared/commercepaymentmethods.py old mode 100755 new mode 100644 index f6ee4f0d6..976f866cc --- a/lending/src/codatlending/models/shared/commercepaymentmethods.py +++ b/lending/src/codatlending/models/shared/commercepaymentmethods.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercepaymentmethod as shared_commercepaymentmethod -from ..shared import links as shared_links +from .commercepaymentmethod import CommercePaymentMethod +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index b949858a7..784965aa8 --- a/lending/src/codatlending/models/shared/commercepayments.py +++ b/lending/src/codatlending/models/shared/commercepayments.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercepayment as shared_commercepayment -from ..shared import links as shared_links +from .commercepayment import CommercePayment +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index e73b16ac6..c906d3564 --- a/lending/src/codatlending/models/shared/commerceproduct.py +++ b/lending/src/codatlending/models/shared/commerceproduct.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import productvariant as shared_productvariant -from ..shared import supplementaldata as shared_supplementaldata +from .productvariant import ProductVariant +from .supplementaldata import SupplementalData from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -28,11 +28,11 @@ class CommerceProduct: """ 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""" - 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 }}) + supplemental_data: Optional[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 }}) + variants: Optional[List[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 old mode 100755 new mode 100644 index 2c3e6c720..a72a9ea17 --- a/lending/src/codatlending/models/shared/commerceproductcategories.py +++ b/lending/src/codatlending/models/shared/commerceproductcategories.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commerceproductcategory as shared_commerceproductcategory -from ..shared import links as shared_links +from .commerceproductcategory import CommerceProductCategory +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index e3f25c395..70a151672 --- a/lending/src/codatlending/models/shared/commerceproductcategory.py +++ b/lending/src/codatlending/models/shared/commerceproductcategory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import commercerecordref as shared_commercerecordref +from .commercerecordref import CommerceRecordRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -15,7 +15,7 @@ class CommerceProductCategory: 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[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 old mode 100755 new mode 100644 index f400f1221..00ec040b5 --- a/lending/src/codatlending/models/shared/commerceproducts.py +++ b/lending/src/codatlending/models/shared/commerceproducts.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commerceproduct as shared_commerceproduct -from ..shared import links as shared_links +from .commerceproduct import CommerceProduct +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercereport.py b/lending/src/codatlending/models/shared/commercereport.py old mode 100755 new mode 100644 index b0f959214..4f97fdf22 --- a/lending/src/codatlending/models/shared/commercereport.py +++ b/lending/src/codatlending/models/shared/commercereport.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import commercereportcomponent as shared_commercereportcomponent -from ..shared import commercereportdimension as shared_commercereportdimension -from ..shared import commercereporterror as shared_commercereporterror -from ..shared import commercereportmeasure as shared_commercereportmeasure +from .commercereportcomponent import CommerceReportComponent +from .commercereportdimension import CommerceReportDimension +from .commercereporterror import CommerceReportError +from .commercereportmeasure import CommerceReportMeasure from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -56,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 }}) + dimensions: Optional[List[CommerceReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) + errors: Optional[List[CommerceReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) + measures: Optional[List[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[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 old mode 100755 new mode 100644 index 6020735d1..03f54994a --- a/lending/src/codatlending/models/shared/commercereportcomponent.py +++ b/lending/src/codatlending/models/shared/commercereportcomponent.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import reportcomponentmeasure as shared_reportcomponentmeasure +from .reportcomponentmeasure import ReportComponentMeasure from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -20,6 +20,6 @@ class CommerceReportComponent: 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 }}) 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 }}) + measures: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercereporterror.py b/lending/src/codatlending/models/shared/commercereporterror.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercereportmeasure.py b/lending/src/codatlending/models/shared/commercereportmeasure.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/commercetransaction.py b/lending/src/codatlending/models/shared/commercetransaction.py old mode 100755 new mode 100644 index 860b48421..1e0c36dd7 --- a/lending/src/codatlending/models/shared/commercetransaction.py +++ b/lending/src/codatlending/models/shared/commercetransaction.py @@ -2,9 +2,9 @@ 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 .supplementaldata import SupplementalData +from .transactionsourceref import TransactionSourceRef +from .transactiontype import TransactionType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -82,16 +82,16 @@ 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 }}) + supplemental_data: Optional[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 }}) + transaction_source_ref: Optional[TransactionSourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionSourceRef'), 'exclude': lambda f: f is None }}) r"""Link to the source event which triggered this transaction""" - type: Optional[shared_transactiontype.TransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[TransactionType] = 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 platform transaction: - `Unknown` - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. diff --git a/lending/src/codatlending/models/shared/commercetransactions.py b/lending/src/codatlending/models/shared/commercetransactions.py old mode 100755 new mode 100644 index ab9b64925..984263df3 --- a/lending/src/codatlending/models/shared/commercetransactions.py +++ b/lending/src/codatlending/models/shared/commercetransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import commercetransaction as shared_commercetransaction -from ..shared import links as shared_links +from .commercetransaction import CommerceTransaction +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index 279df7a12..e9678946c --- a/lending/src/codatlending/models/shared/companies.py +++ b/lending/src/codatlending/models/shared/companies.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import company as shared_company -from ..shared import links as shared_links +from .company import Company +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index ad8ef239f..73fcf570b --- a/lending/src/codatlending/models/shared/company.py +++ b/lending/src/codatlending/models/shared/company.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import connection as shared_connection +from .connection import Connection from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -46,7 +46,7 @@ class Company: """ 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 }}) 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 }}) + data_connections: Optional[List[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 }}) diff --git a/lending/src/codatlending/models/shared/companyrequestbody.py b/lending/src/codatlending/models/shared/companyrequestbody.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/connection.py b/lending/src/codatlending/models/shared/connection.py old mode 100755 new mode 100644 index 1284142d5..5d8c15068 --- a/lending/src/codatlending/models/shared/connection.py +++ b/lending/src/codatlending/models/shared/connection.py @@ -2,14 +2,14 @@ from __future__ import annotations import dataclasses -from ..shared import dataconnectionerror as shared_dataconnectionerror -from ..shared import dataconnectionstatus as shared_dataconnectionstatus +from .dataconnectionerror import DataConnectionError +from .dataconnectionstatus import DataConnectionStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, List, Optional -class ConnectionSourceType(str, Enum): +class SourceType(str, Enum): r"""The type of platform of the connection.""" ACCOUNTING = 'Accounting' BANKING = 'Banking' @@ -65,13 +65,13 @@ class Connection: 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') }}) + source_type: SourceType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) r"""The type of platform of the connection.""" - status: shared_dataconnectionstatus.DataConnectionStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: 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 }}) + data_connection_errors: Optional[List[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 old mode 100755 new mode 100644 index 063e65f0a..23b17333e --- a/lending/src/codatlending/models/shared/connections.py +++ b/lending/src/codatlending/models/shared/connections.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import connection as shared_connection -from ..shared import links as shared_links +from .connection import Connection +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 index f821a40da..d258fbdb3 --- a/lending/src/codatlending/models/shared/contact.py +++ b/lending/src/codatlending/models/shared/contact.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import accountingaddress as shared_accountingaddress -from ..shared import customerstatus as shared_customerstatus -from ..shared import phonenumber as shared_phonenumber +from .accountingaddress import AccountingAddress +from .customerstatus import CustomerStatus +from .phonenumber import PhoneNumber from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -13,9 +13,9 @@ @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') }}) + status: 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 }}) + address: Optional[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') }}) 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 }}) @@ -41,7 +41,7 @@ class Contact: """ 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') }}) + phone: Optional[List[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 old mode 100755 new mode 100644 index 74002551c..d52a112c5 --- a/lending/src/codatlending/models/shared/contactref.py +++ b/lending/src/codatlending/models/shared/contactref.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import datatype as shared_datatype +from .datatype import DataType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,10 +11,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class ContactRef: - r"""The customer or supplier for the transfer, if available.""" + r"""A customer or supplier associated with the direct cost.""" id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) 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 }}) + data_type: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/creditnotelineitem.py b/lending/src/codatlending/models/shared/creditnotelineitem.py old mode 100755 new mode 100644 index 0cc2f69ab..afb0f2a8e --- a/lending/src/codatlending/models/shared/creditnotelineitem.py +++ b/lending/src/codatlending/models/shared/creditnotelineitem.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import accountsreceivabletracking as shared_accountsreceivabletracking -from ..shared import itemref as shared_itemref -from ..shared import taxrateref as shared_taxrateref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .accountsreceivabletracking import AccountsReceivableTracking +from .propertie_itemref import PropertieItemRef +from .taxrateref import TaxRateRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -20,7 +20,7 @@ class CreditNoteLineItem: r"""Number of units of the goods or service for which credit has been issued.""" unit_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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 }}) + account_ref: Optional[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') }}) r"""Friendly name of each line item. For example, the goods or service for which credit has been issued.""" @@ -30,13 +30,13 @@ class CreditNoteLineItem: 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 }}) + item_ref: Optional[PropertieItemRef] = 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 }}) 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 }}) 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 }}) + tax_rate_ref: Optional[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. Found on: @@ -50,9 +50,9 @@ class CreditNoteLineItem: """ 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 }}) + tracking: Optional[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') }}) + tracking_category_refs: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/customerstatus.py b/lending/src/codatlending/models/shared/customerstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataconnectionerror.py b/lending/src/codatlending/models/shared/dataconnectionerror.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataconnectionstatus.py b/lending/src/codatlending/models/shared/dataconnectionstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegrityamounts.py b/lending/src/codatlending/models/shared/dataintegrityamounts.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritybyamount.py b/lending/src/codatlending/models/shared/dataintegritybyamount.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritybycount.py b/lending/src/codatlending/models/shared/dataintegritybycount.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegrityconnectionid.py b/lending/src/codatlending/models/shared/dataintegrityconnectionid.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritydatatype.py b/lending/src/codatlending/models/shared/dataintegritydatatype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritydates.py b/lending/src/codatlending/models/shared/dataintegritydates.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritydetail.py b/lending/src/codatlending/models/shared/dataintegritydetail.py old mode 100755 new mode 100644 index 94e27cd00..81f5d4da9 --- a/lending/src/codatlending/models/shared/dataintegritydetail.py +++ b/lending/src/codatlending/models/shared/dataintegritydetail.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritymatch as shared_dataintegritymatch +from .dataintegritymatch import DataIntegrityMatch from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -50,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[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 old mode 100755 new mode 100644 index 4805fea1c..a1d0b4661 --- a/lending/src/codatlending/models/shared/dataintegritydetails.py +++ b/lending/src/codatlending/models/shared/dataintegritydetails.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritydetail as shared_dataintegritydetail -from ..shared import links as shared_links +from .dataintegritydetail import DataIntegrityDetail +from .links import Links from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/dataintegritystatus.py b/lending/src/codatlending/models/shared/dataintegritystatus.py old mode 100755 new mode 100644 index 79c134119..171be3ba6 --- a/lending/src/codatlending/models/shared/dataintegritystatus.py +++ b/lending/src/codatlending/models/shared/dataintegritystatus.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegrityamounts as shared_dataintegrityamounts -from ..shared import dataintegrityconnectionid as shared_dataintegrityconnectionid -from ..shared import dataintegritydates as shared_dataintegritydates -from ..shared import dataintegritystatusinfo as shared_dataintegritystatusinfo +from .dataintegrityamounts import DataIntegrityAmounts +from .dataintegrityconnectionid import DataIntegrityConnectionID +from .dataintegritydates import DataIntegrityDates +from .dataintegritystatusinfo import DataIntegrityStatusInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -14,12 +14,12 @@ @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 }}) + amounts: Optional[DataIntegrityAmounts] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amounts'), 'exclude': lambda f: f is None }}) r"""Only returned for transactions. For accounts, there is nothing returned.""" - connection_ids: Optional[shared_dataintegrityconnectionid.DataIntegrityConnectionID] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionIds'), 'exclude': lambda f: f is None }}) - dates: Optional[shared_dataintegritydates.DataIntegrityDates] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dates'), 'exclude': lambda f: f is None }}) + connection_ids: Optional[DataIntegrityConnectionID] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionIds'), 'exclude': lambda f: f is None }}) + dates: Optional[DataIntegrityDates] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dates'), 'exclude': lambda f: f is None }}) r"""Only returned for transactions. For accounts, there is nothing returned.""" - status_info: Optional[shared_dataintegritystatusinfo.DataIntegrityStatusInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusInfo'), 'exclude': lambda f: f is None }}) + status_info: Optional[DataIntegrityStatusInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusInfo'), '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 which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.""" diff --git a/lending/src/codatlending/models/shared/dataintegritystatuses.py b/lending/src/codatlending/models/shared/dataintegritystatuses.py old mode 100755 new mode 100644 index a0e0ca7c8..1b14be192 --- a/lending/src/codatlending/models/shared/dataintegritystatuses.py +++ b/lending/src/codatlending/models/shared/dataintegritystatuses.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritystatus as shared_dataintegritystatus +from .dataintegritystatus import DataIntegrityStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,6 +11,6 @@ @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[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 old mode 100755 new mode 100644 index d59d5454d..09fa18d10 --- a/lending/src/codatlending/models/shared/dataintegritystatusinfo.py +++ b/lending/src/codatlending/models/shared/dataintegritystatusinfo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import integritystatus as shared_integritystatus +from .integritystatus import IntegrityStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,7 +11,7 @@ @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 }}) + current_status: Optional[IntegrityStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus'), 'exclude': lambda f: f is None }}) r"""The current status of the most recently run matching algorithm.""" last_matched: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastMatched'), '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/dataintegritysummaries.py b/lending/src/codatlending/models/shared/dataintegritysummaries.py old mode 100755 new mode 100644 index 4e3ad4dd3..79e3ec32f --- a/lending/src/codatlending/models/shared/dataintegritysummaries.py +++ b/lending/src/codatlending/models/shared/dataintegritysummaries.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritysummary as shared_dataintegritysummary +from .dataintegritysummary import DataIntegritySummary from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,6 +11,6 @@ @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[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 old mode 100755 new mode 100644 index 8fdfa243e..3c337667e --- a/lending/src/codatlending/models/shared/dataintegritysummary.py +++ b/lending/src/codatlending/models/shared/dataintegritysummary.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritybyamount as shared_dataintegritybyamount -from ..shared import dataintegritybycount as shared_dataintegritybycount +from .dataintegritybyamount import DataIntegrityByAmount +from .dataintegritybycount import DataIntegrityByCount from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -12,8 +12,8 @@ @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 }}) - by_count: Optional[shared_dataintegritybycount.DataIntegrityByCount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byCount'), 'exclude': lambda f: f is None }}) + by_amount: Optional[DataIntegrityByAmount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byAmount'), 'exclude': lambda f: f is None }}) + by_count: Optional[DataIntegrityByCount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byCount'), '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 which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.""" diff --git a/lending/src/codatlending/models/shared/datasource.py b/lending/src/codatlending/models/shared/datasource.py old mode 100755 new mode 100644 index c6e65b31f..ad4ef2e4f --- a/lending/src/codatlending/models/shared/datasource.py +++ b/lending/src/codatlending/models/shared/datasource.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accounts as shared_accounts +from .accounts import Accounts from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 index 0cac937f4..1f2f996ec --- a/lending/src/codatlending/models/shared/datastatus.py +++ b/lending/src/codatlending/models/shared/datastatus.py @@ -7,7 +7,7 @@ from enum import Enum from typing import Optional -class DataStatusDataTypes(str, Enum): +class DataTypes(str, Enum): r"""Available Data types""" ACCOUNT_TRANSACTIONS = 'accountTransactions' BALANCE_SHEET = 'balanceSheet' @@ -24,6 +24,7 @@ class DataStatusDataTypes(str, Enum): DIRECT_COSTS = 'directCosts' DIRECT_INCOMES = 'directIncomes' INVOICES = 'invoices' + ITEM_RECEIPTS = 'itemReceipts' ITEMS = 'items' JOURNAL_ENTRIES = 'journalEntries' JOURNALS = 'journals' @@ -59,7 +60,7 @@ 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') }}) 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') }}) + data_type: DataTypes = 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: diff --git a/lending/src/codatlending/models/shared/datatype.py b/lending/src/codatlending/models/shared/datatype.py old mode 100755 new mode 100644 index ea726125d..df149bcf0 --- a/lending/src/codatlending/models/shared/datatype.py +++ b/lending/src/codatlending/models/shared/datatype.py @@ -20,6 +20,7 @@ class DataType(str, Enum): DIRECT_COSTS = 'directCosts' DIRECT_INCOMES = 'directIncomes' INVOICES = 'invoices' + ITEM_RECEIPTS = 'itemReceipts' ITEMS = 'items' JOURNAL_ENTRIES = 'journalEntries' JOURNALS = 'journals' diff --git a/lending/src/codatlending/models/shared/definitionsitemref.py b/lending/src/codatlending/models/shared/definitionsitemref.py deleted file mode 100755 index c4b135f3e..000000000 --- a/lending/src/codatlending/models/shared/definitionsitemref.py +++ /dev/null @@ -1,20 +0,0 @@ -"""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 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 }}) - r"""The data connection id being referenced.""" - id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) - r"""The id of the object, e.g. the Journal entry.""" - 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 the loan transaction entry was extracted from.""" - - diff --git a/lending/src/codatlending/models/shared/directcostlineitem.py b/lending/src/codatlending/models/shared/directcostlineitem.py old mode 100755 new mode 100644 index ec421bbcb..d8eaeffe4 --- a/lending/src/codatlending/models/shared/directcostlineitem.py +++ b/lending/src/codatlending/models/shared/directcostlineitem.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import itemref as shared_itemref -from ..shared import taxrateref as shared_taxrateref -from ..shared import tracking as shared_tracking -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .propertie_itemref import PropertieItemRef +from .taxrateref import TaxRateRef +from .tracking import Tracking +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -25,7 +25,7 @@ class DirectCostLineItem: r"""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. """ - 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 }}) + account_ref: Optional[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') }}) r"""Friendly name of the goods or services.""" @@ -33,13 +33,13 @@ class DirectCostLineItem: 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 }}) 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 }}) + item_ref: Optional[PropertieItemRef] = 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 }}) 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 }}) 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 }}) + tax_rate_ref: Optional[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. Found on: @@ -53,8 +53,8 @@ class DirectCostLineItem: """ 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') }}) + tracking: Optional[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[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/directcostprototype.py b/lending/src/codatlending/models/shared/directcostprototype.py new file mode 100644 index 000000000..bcada845c --- /dev/null +++ b/lending/src/codatlending/models/shared/directcostprototype.py @@ -0,0 +1,109 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .accountingpaymentallocation import AccountingPaymentAllocation +from .datatype import DataType +from .directcostlineitem import DirectCostLineItem +from .supplementaldata import SupplementalData +from codatlending import utils +from dataclasses_json import Undefined, dataclass_json +from decimal import Decimal +from typing import List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DirectCostPrototypeContactRef: + r"""A customer or supplier associated with the direct cost.""" + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + r"""Unique identifier for a customer or supplier.""" + data_type: Optional[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 DirectCostPrototype: + 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_. + + ## 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. + """ + issue_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate') }}) + 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. + """ + line_items: List[DirectCostLineItem] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lineItems') }}) + r"""An array of line items.""" + payment_allocations: List[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.""" + tax_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('taxAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""The total amount of tax on the direct costs.""" + total_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) + r"""The amount of the direct costs, inclusive of tax.""" + contact_ref: Optional[DirectCostPrototypeContactRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('contactRef'), 'exclude': lambda f: f is None }}) + r"""A customer or supplier associated with the direct cost.""" + 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. + + 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 | + """ + 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') }}) + r"""User-friendly reference for the direct cost.""" + supplemental_data: Optional[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/directincomelineitem.py b/lending/src/codatlending/models/shared/directincomelineitem.py old mode 100755 new mode 100644 index e89f12647..fba16f854 --- a/lending/src/codatlending/models/shared/directincomelineitem.py +++ b/lending/src/codatlending/models/shared/directincomelineitem.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import itemref as shared_itemref -from ..shared import taxrateref as shared_taxrateref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .propertie_itemref import PropertieItemRef +from .taxrateref import TaxRateRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -24,7 +24,7 @@ class DirectIncomeLineItem: r"""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. """ - 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 }}) + account_ref: Optional[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') }}) r"""A user-friendly name of the goods or services.""" @@ -32,7 +32,7 @@ class DirectIncomeLineItem: 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 }}) 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 }}) + item_ref: Optional[PropertieItemRef] = 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 }}) r"""The amount of the line, inclusive of discounts, but exclusive of tax.""" @@ -40,7 +40,7 @@ class DirectIncomeLineItem: 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. """ - 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 }}) + tax_rate_ref: Optional[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. Found on: @@ -54,7 +54,7 @@ class DirectIncomeLineItem: """ 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') }}) + tracking_category_refs: Optional[List[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/disputestatus.py b/lending/src/codatlending/models/shared/disputestatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/enhancedcashflowitem.py b/lending/src/codatlending/models/shared/enhancedcashflowitem.py old mode 100755 new mode 100644 index cc8d2ece0..4b07156ef --- a/lending/src/codatlending/models/shared/enhancedcashflowitem.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowitem.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedcashflowtransaction as shared_enhancedcashflowtransaction +from .enhancedcashflowtransaction import EnhancedCashFlowTransaction from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 index 2df7a2c31..59029d988 --- a/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowtransaction.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import sourceref as shared_sourceref -from ..shared import transactioncategory as shared_transactioncategory +from .accountref import AccountRef +from .sourceref import SourceRef +from .transactioncategory import TransactionCategory from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ @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 }}) + account_ref: Optional[AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) r"""An account reference containing the account id and name.""" 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.""" @@ -54,8 +54,8 @@ class EnhancedCashFlowTransaction: r"""The unique identifier of the bank transaction.""" platform_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformName'), 'exclude': lambda f: f is None }}) r"""Returns the payment processor responsible for the transaction.""" - source_ref: Optional[shared_sourceref.SourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceRef'), 'exclude': lambda f: f is None }}) + source_ref: Optional[SourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceRef'), 'exclude': lambda f: f is None }}) r"""A source reference containing the `sourceType` object \\"Banking\\".""" - transaction_category: Optional[shared_transactioncategory.TransactionCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionCategory'), 'exclude': lambda f: f is None }}) + transaction_category: Optional[TransactionCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionCategory'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py b/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py old mode 100755 new mode 100644 index b5e023d90..cce796530 --- a/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py +++ b/lending/src/codatlending/models/shared/enhancedcashflowtransactions.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import datasource as shared_datasource -from ..shared import enhancedcashflowitem as shared_enhancedcashflowitem -from ..shared import reportinfo as shared_reportinfo +from .datasource import DataSource +from .enhancedcashflowitem import EnhancedCashFlowItem +from .reportinfo import ReportInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -19,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 }}) - 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 }}) + data_sources: Optional[List[DataSource]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSources'), 'exclude': lambda f: f is None }}) + report_info: Optional[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 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 }}) + report_items: Optional[List[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 old mode 100755 new mode 100644 index fd7063017..9fd533482 --- a/lending/src/codatlending/models/shared/enhancedfinancialreport.py +++ b/lending/src/codatlending/models/shared/enhancedfinancialreport.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedreportaccountcategory as shared_enhancedreportaccountcategory -from ..shared import enhancedreportinfo as shared_enhancedreportinfo +from .enhancedreportaccountcategory import EnhancedReportAccountCategory +from .enhancedreportinfo import EnhancedReportInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,8 +12,8 @@ @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 }}) +class ReportItem: + account_category: Optional[EnhancedReportAccountCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountCategory'), 'exclude': lambda f: f is None }}) 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"""The unique account ID.""" account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) @@ -48,8 +48,8 @@ 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_info: Optional[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[ReportItem]] = 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 old mode 100755 new mode 100644 index 1875ab4d0..6b0f0fff0 --- a/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py +++ b/lending/src/codatlending/models/shared/enhancedinvoicereportitem.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import invoicestatus as shared_invoicestatus -from ..shared import lendingcustomerref as shared_lendingcustomerref -from ..shared import payment as shared_payment +from .invoicestatus import InvoiceStatus +from .lendingcustomerref import LendingCustomerRef +from .payment import Payment from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -25,7 +25,7 @@ class EnhancedInvoiceReportItem: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - customer_ref: Optional[shared_lendingcustomerref.LendingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) + customer_ref: Optional[LendingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) 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: @@ -94,9 +94,9 @@ 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[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 }}) + status: Optional[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: - `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. diff --git a/lending/src/codatlending/models/shared/enhancedinvoicesreport.py b/lending/src/codatlending/models/shared/enhancedinvoicesreport.py old mode 100755 new mode 100644 index 3bbe44f61..3e1d84b93 --- a/lending/src/codatlending/models/shared/enhancedinvoicesreport.py +++ b/lending/src/codatlending/models/shared/enhancedinvoicesreport.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedinvoicereportitem as shared_enhancedinvoicereportitem -from ..shared import reportinfo as shared_reportinfo +from .enhancedinvoicereportitem import EnhancedInvoiceReportItem +from .reportinfo import ReportInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -13,8 +13,8 @@ @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 }}) + report_info: Optional[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 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 }}) + report_items: Optional[List[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 old mode 100755 new mode 100644 index f4ebd2b10..22f9b6af3 --- a/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py +++ b/lending/src/codatlending/models/shared/enhancedreportaccountcategory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountcategorylevel as shared_accountcategorylevel +from .accountcategorylevel import AccountCategoryLevel from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/excelreporttypes.py b/lending/src/codatlending/models/shared/excelreporttypes.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/excelstatus.py b/lending/src/codatlending/models/shared/excelstatus.py old mode 100755 new mode 100644 index 98cd97500..da4600f4f --- a/lending/src/codatlending/models/shared/excelstatus.py +++ b/lending/src/codatlending/models/shared/excelstatus.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import excelreporttypes as shared_excelreporttypes +from .excelreporttypes import ExcelReportTypes from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -42,7 +42,7 @@ class ExcelStatus: r"""A unique ID generated for this request.""" queued: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('queued'), 'exclude': lambda f: f is None }}) r"""The date and time of when a successful request was queued for the most recent report.""" - report_type: Optional[shared_excelreporttypes.ExcelReportTypes] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportType'), 'exclude': lambda f: f is None }}) + report_type: Optional[ExcelReportTypes] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportType'), 'exclude': lambda f: f is None }}) r"""The type of the report requested in the query string.""" success: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('success'), 'exclude': lambda f: f is None }}) r"""True if the requested report was successfully queued and false if the requested report was not able to be queued.""" diff --git a/lending/src/codatlending/models/shared/file.py b/lending/src/codatlending/models/shared/file.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/halref.py b/lending/src/codatlending/models/shared/halref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/integritystatus.py b/lending/src/codatlending/models/shared/integritystatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/invoicelineitem.py b/lending/src/codatlending/models/shared/invoicelineitem.py old mode 100755 new mode 100644 index c6a188d33..bfb40220b --- a/lending/src/codatlending/models/shared/invoicelineitem.py +++ b/lending/src/codatlending/models/shared/invoicelineitem.py @@ -2,11 +2,11 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import accountsreceivabletracking as shared_accountsreceivabletracking -from ..shared import itemref as shared_itemref -from ..shared import taxrateref as shared_taxrateref -from ..shared import trackingcategoryref as shared_trackingcategoryref +from .accountref import AccountRef +from .accountsreceivabletracking import AccountsReceivableTracking +from .propertie_itemref import PropertieItemRef +from .taxrateref import TaxRateRef +from .trackingcategoryref import TrackingCategoryRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -20,7 +20,7 @@ class InvoiceLineItem: r"""Number of units of goods or services provided.""" unit_amount: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('unitAmount'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) 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 }}) + account_ref: Optional[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') }}) r"""Friendly name of the goods or services provided.""" @@ -30,13 +30,13 @@ class InvoiceLineItem: 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 }}) + item_ref: Optional[PropertieItemRef] = 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 }}) 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 }}) 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 }}) + tax_rate_ref: Optional[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. Found on: @@ -50,9 +50,9 @@ class InvoiceLineItem: """ 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 }}) + tracking: Optional[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') }}) + tracking_category_refs: Optional[List[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/invoicestatus.py b/lending/src/codatlending/models/shared/invoicestatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/itemref.py b/lending/src/codatlending/models/shared/itemref.py old mode 100755 new mode 100644 index d51c18366..1fdf00951 --- a/lending/src/codatlending/models/shared/itemref.py +++ b/lending/src/codatlending/models/shared/itemref.py @@ -10,10 +10,11 @@ @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') }}) - r"""Name of the item in the accounting platform.""" + 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"""The data connection id being referenced.""" + id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) + r"""The id of the object, e.g. the Journal entry.""" + 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 the loan transaction entry was extracted from.""" diff --git a/lending/src/codatlending/models/shared/items.py b/lending/src/codatlending/models/shared/items.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/journalline.py b/lending/src/codatlending/models/shared/journalline.py old mode 100755 new mode 100644 index d3cdc53ed..5e67a565a --- a/lending/src/codatlending/models/shared/journalline.py +++ b/lending/src/codatlending/models/shared/journalline.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref -from ..shared import recordref as shared_recordref +from .accountref import AccountRef +from .recordref import RecordRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ @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') }}) + record_refs: Optional[List[RecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) @@ -24,7 +24,7 @@ class JournalLineTracking: 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 }}) + account_ref: Optional[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') }}) r"""Currency for the journal line item.""" diff --git a/lending/src/codatlending/models/shared/journalref.py b/lending/src/codatlending/models/shared/journalref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/journalstatus.py b/lending/src/codatlending/models/shared/journalstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/lendingcustomerref.py b/lending/src/codatlending/models/shared/lendingcustomerref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/links.py b/lending/src/codatlending/models/shared/links.py old mode 100755 new mode 100644 index d7f906cfd..0642f6ec3 --- a/lending/src/codatlending/models/shared/links.py +++ b/lending/src/codatlending/models/shared/links.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import halref as shared_halref +from .halref import HalRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,9 +11,9 @@ @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') }}) - self_: shared_halref.HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('self') }}) - next: Optional[shared_halref.HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('next'), 'exclude': lambda f: f is None }}) - previous: Optional[shared_halref.HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('previous'), 'exclude': lambda f: f is None }}) + current: HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current') }}) + self_: HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('self') }}) + next: Optional[HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('next'), 'exclude': lambda f: f is None }}) + previous: Optional[HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('previous'), 'exclude': lambda f: f is None }}) diff --git a/lending/src/codatlending/models/shared/loanref.py b/lending/src/codatlending/models/shared/loanref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/loansummary.py b/lending/src/codatlending/models/shared/loansummary.py old mode 100755 new mode 100644 index c7690ddfa..ebb14585d --- a/lending/src/codatlending/models/shared/loansummary.py +++ b/lending/src/codatlending/models/shared/loansummary.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryreportinfo as shared_loansummaryreportinfo -from ..shared import loansummaryreportitem as shared_loansummaryreportitem +from .loansummaryreportinfo import LoanSummaryReportInfo +from .loansummaryreportitem import LoanSummaryReportItem from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,8 +12,8 @@ @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_info: Optional[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[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/loansummaryintegrationtype.py b/lending/src/codatlending/models/shared/loansummaryintegrationtype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/loansummaryrecordref.py b/lending/src/codatlending/models/shared/loansummaryrecordref.py old mode 100755 new mode 100644 index e8f367e6d..743dd9681 --- a/lending/src/codatlending/models/shared/loansummaryrecordref.py +++ b/lending/src/codatlending/models/shared/loansummaryrecordref.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryintegrationtype as shared_loansummaryintegrationtype -from ..shared import loansummaryrecordreftype as shared_loansummaryrecordreftype +from .loansummaryintegrationtype import LoanSummaryIntegrationType +from .loansummaryrecordreftype import LoanSummaryRecordRefType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -16,9 +16,9 @@ class LoanSummaryRecordRef: r"""The dataConnectionId the object being referred to is associated with.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""The id of the object being referred to.""" - integration_type: Optional[shared_loansummaryintegrationtype.LoanSummaryIntegrationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType'), 'exclude': lambda f: f is None }}) + integration_type: Optional[LoanSummaryIntegrationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType'), 'exclude': lambda f: f is None }}) r"""The integration type begin referred to.""" - record_ref_type: Optional[shared_loansummaryrecordreftype.LoanSummaryRecordRefType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefType'), 'exclude': lambda f: f is None }}) + record_ref_type: Optional[LoanSummaryRecordRefType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefType'), 'exclude': lambda f: f is None }}) r"""The datatype being referred to.""" diff --git a/lending/src/codatlending/models/shared/loansummaryrecordreftype.py b/lending/src/codatlending/models/shared/loansummaryrecordreftype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/loansummaryreportinfo.py b/lending/src/codatlending/models/shared/loansummaryreportinfo.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/loansummaryreportitem.py b/lending/src/codatlending/models/shared/loansummaryreportitem.py old mode 100755 new mode 100644 index 538e70413..7623ba9f9 --- a/lending/src/codatlending/models/shared/loansummaryreportitem.py +++ b/lending/src/codatlending/models/shared/loansummaryreportitem.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryrecordref as shared_loansummaryrecordref +from .loansummaryrecordref import LoanSummaryRecordRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -18,7 +18,7 @@ class LoanSummaryReportItem: 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 }}) + record_ref: Optional[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 old mode 100755 new mode 100644 index 6c17c4ed5..de10f532e --- a/lending/src/codatlending/models/shared/loantransactions.py +++ b/lending/src/codatlending/models/shared/loantransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loantransactionsreportinfo as shared_loantransactionsreportinfo -from ..shared import reportitems as shared_reportitems +from .loantransactionsreportinfo import LoanTransactionsReportInfo +from .reportitems import ReportItems from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Any, List, Optional @@ -14,8 +14,8 @@ 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 }}) 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_info: Optional[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[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/locationref.py b/lending/src/codatlending/models/shared/locationref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/metadata.py b/lending/src/codatlending/models/shared/metadata.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/orderdiscountallocation.py b/lending/src/codatlending/models/shared/orderdiscountallocation.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/orderlineitem.py b/lending/src/codatlending/models/shared/orderlineitem.py old mode 100755 new mode 100644 index d8048becd..1f914f741 --- a/lending/src/codatlending/models/shared/orderlineitem.py +++ b/lending/src/codatlending/models/shared/orderlineitem.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import orderdiscountallocation as shared_orderdiscountallocation -from ..shared import productref as shared_productref -from ..shared import productvariantref as shared_productvariantref -from ..shared import taxcomponentallocation as shared_taxcomponentallocation +from .orderdiscountallocation import OrderDiscountAllocation +from .productref import ProductRef +from .productvariantref import ProductVariantRef +from .taxcomponentallocation import TaxComponentAllocation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -17,16 +17,16 @@ 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 }}) - 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 }}) + discount_allocations: Optional[List[OrderDiscountAllocation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discountAllocations'), 'exclude': lambda f: f is None }}) + product_ref: Optional[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 }}) + product_variant_ref: Optional[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 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[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 sales tax applied to the unit price.""" diff --git a/lending/src/codatlending/models/shared/payment.py b/lending/src/codatlending/models/shared/payment.py old mode 100755 new mode 100644 index 93f9047ea..bd2da5947 --- a/lending/src/codatlending/models/shared/payment.py +++ b/lending/src/codatlending/models/shared/payment.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import bankingtransactionref as shared_bankingtransactionref +from .bankingtransactionref import BankingTransactionRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ 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 }}) 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 }}) + banking_transaction_refs: Optional[List[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_. diff --git a/lending/src/codatlending/models/shared/paymentallocationpayment.py b/lending/src/codatlending/models/shared/paymentallocationpayment.py old mode 100755 new mode 100644 index 48b218f0d..7f43d20fc --- a/lending/src/codatlending/models/shared/paymentallocationpayment.py +++ b/lending/src/codatlending/models/shared/paymentallocationpayment.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref +from .accountref import AccountRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,7 +12,7 @@ @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 }}) + account_ref: Optional[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 }}) 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/paymentline.py b/lending/src/codatlending/models/shared/paymentline.py old mode 100755 new mode 100644 index 1d9b1f5c2..98954e875 --- a/lending/src/codatlending/models/shared/paymentline.py +++ b/lending/src/codatlending/models/shared/paymentline.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import paymentlinelink as shared_paymentlinelink +from .paymentlinelink import PaymentLineLink from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -35,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') }}) + links: Optional[List[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 old mode 100755 new mode 100644 index 187eac5b3..c37b4c2c5 --- a/lending/src/codatlending/models/shared/paymentlinelink.py +++ b/lending/src/codatlending/models/shared/paymentlinelink.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import paymentlinktype as shared_paymentlinktype +from .paymentlinktype import PaymentLinkType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,7 +12,7 @@ @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') }}) + type: PaymentLinkType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""Types of payment line links, either: `Unknown` `Unlinked` - Not used diff --git a/lending/src/codatlending/models/shared/paymentlinktype.py b/lending/src/codatlending/models/shared/paymentlinktype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/paymentmethodref.py b/lending/src/codatlending/models/shared/paymentmethodref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/paymentref.py b/lending/src/codatlending/models/shared/paymentref.py old mode 100755 new mode 100644 index a58176903..633a8eeb8 --- a/lending/src/codatlending/models/shared/paymentref.py +++ b/lending/src/codatlending/models/shared/paymentref.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import paymentstatus as shared_paymentstatus -from ..shared import paymenttype as shared_paymenttype +from .paymentstatus import PaymentStatus +from .paymenttype import PaymentType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -72,9 +72,9 @@ class PaymentRef: 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 }}) + status: Optional[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') }}) + type: Optional[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/paymentstatus.py b/lending/src/codatlending/models/shared/paymentstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/paymenttype.py b/lending/src/codatlending/models/shared/paymenttype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/periodunit.py b/lending/src/codatlending/models/shared/periodunit.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/phonenumber.py b/lending/src/codatlending/models/shared/phonenumber.py old mode 100755 new mode 100644 index f7bd640ff..c1f5d469b --- a/lending/src/codatlending/models/shared/phonenumber.py +++ b/lending/src/codatlending/models/shared/phonenumber.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import phonenumbertype as shared_phonenumbertype +from .phonenumbertype import PhoneNumberType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -13,7 +13,7 @@ class PhoneNumber: 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') }}) + type: 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/phonenumbertype.py b/lending/src/codatlending/models/shared/phonenumbertype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/productinventory.py b/lending/src/codatlending/models/shared/productinventory.py old mode 100755 new mode 100644 index fed37ec01..03cf40cfc --- a/lending/src/codatlending/models/shared/productinventory.py +++ b/lending/src/codatlending/models/shared/productinventory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import productinventorylocation as shared_productinventorylocation +from .productinventorylocation import ProductInventoryLocation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -13,7 +13,7 @@ @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 }}) + locations: Optional[List[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 old mode 100755 new mode 100644 index ce7281b13..09f170cb8 --- a/lending/src/codatlending/models/shared/productinventorylocation.py +++ b/lending/src/codatlending/models/shared/productinventorylocation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import locationref as shared_locationref +from .locationref import LocationRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,7 +12,7 @@ @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 }}) + location_ref: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/productref.py b/lending/src/codatlending/models/shared/productref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/productvariant.py b/lending/src/codatlending/models/shared/productvariant.py old mode 100755 new mode 100644 index eb2750103..cbcfc6a53 --- a/lending/src/codatlending/models/shared/productvariant.py +++ b/lending/src/codatlending/models/shared/productvariant.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import productinventory as shared_productinventory -from ..shared import productprice as shared_productprice -from ..shared import productvariantstatus as shared_productvariantstatus +from .productinventory import ProductInventory +from .productprice import ProductPrice +from .productvariantstatus import ProductVariantStatus from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -40,21 +40,21 @@ class ProductVariant: > 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. """ - inventory: Optional[shared_productinventory.ProductInventory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inventory'), 'exclude': lambda f: f is None }}) + inventory: Optional[ProductInventory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inventory'), 'exclude': lambda f: f is None }}) r"""Information about the total inventory as well as the locations inventory is in.""" is_tax_enabled: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('isTaxEnabled'), 'exclude': lambda f: f is None }}) r"""Whether sales taxes are enabled for this product variant.""" 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[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.""" sku: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sku'), 'exclude': lambda f: f is None }}) 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 }}) + status: Optional[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`.""" diff --git a/lending/src/codatlending/models/shared/productvariantref.py b/lending/src/codatlending/models/shared/productvariantref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/productvariantstatus.py b/lending/src/codatlending/models/shared/productvariantstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/profitandlossreport.py b/lending/src/codatlending/models/shared/profitandlossreport.py old mode 100755 new mode 100644 index 97d8f9253..9ebb2ff70 --- a/lending/src/codatlending/models/shared/profitandlossreport.py +++ b/lending/src/codatlending/models/shared/profitandlossreport.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import reportline as shared_reportline +from .reportline_input import ReportLineInput from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -20,8 +20,8 @@ class ProfitAndLossReport: r"""Net other income of the company in the given date range.""" net_profit: Decimal = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('netProfit'), 'encoder': utils.decimalencoder(False, False), 'decoder': utils.decimaldecoder }}) r"""Net profit of the company in the given date range.""" - cost_of_sales: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('costOfSales'), 'exclude': lambda f: f is None }}) - expenses: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expenses'), 'exclude': lambda f: f is None }}) + cost_of_sales: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('costOfSales'), 'exclude': lambda f: f is None }}) + expenses: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expenses'), 'exclude': lambda f: f is None }}) 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: @@ -43,9 +43,9 @@ class ProfitAndLossReport: > 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. """ - income: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('income'), 'exclude': lambda f: f is None }}) - other_expenses: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('otherExpenses'), 'exclude': lambda f: f is None }}) - other_income: Optional[shared_reportline.ReportLine] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('otherIncome'), 'exclude': lambda f: f is None }}) + income: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('income'), 'exclude': lambda f: f is None }}) + other_expenses: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('otherExpenses'), 'exclude': lambda f: f is None }}) + other_income: Optional[ReportLineInput] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('otherIncome'), 'exclude': lambda f: f is None }}) to_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('toDate'), '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/projectref.py b/lending/src/codatlending/models/shared/projectref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/propertie_itemref.py b/lending/src/codatlending/models/shared/propertie_itemref.py new file mode 100644 index 000000000..ac6519171 --- /dev/null +++ b/lending/src/codatlending/models/shared/propertie_itemref.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 PropertieItemRef: + 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') }}) + r"""Name of the item in the accounting platform.""" + + diff --git a/lending/src/codatlending/models/shared/pulloperation.py b/lending/src/codatlending/models/shared/pulloperation.py old mode 100755 new mode 100644 index 55e792581..dc1c3ed35 --- a/lending/src/codatlending/models/shared/pulloperation.py +++ b/lending/src/codatlending/models/shared/pulloperation.py @@ -2,7 +2,6 @@ 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 @@ -45,12 +44,12 @@ class PullOperation: 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') }}) 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""" + data_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType') }}) + r"""The data type you are requesting in a pull operation.""" 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.""" + r"""`True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead.""" 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') }}) @@ -101,5 +100,7 @@ class PullOperation: """ 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.""" + status_description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusDescription') }}) + r"""Additional information about the dataset status.""" diff --git a/lending/src/codatlending/models/shared/pulloperations.py b/lending/src/codatlending/models/shared/pulloperations.py old mode 100755 new mode 100644 index cce0e7ccb..061fa584b --- a/lending/src/codatlending/models/shared/pulloperations.py +++ b/lending/src/codatlending/models/shared/pulloperations.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import links as shared_links -from ..shared import pulloperation as shared_pulloperation +from .links import Links +from .pulloperation import PullOperation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/pushfieldvalidation.py b/lending/src/codatlending/models/shared/pushfieldvalidation.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/pushoperation.py b/lending/src/codatlending/models/shared/pushoperation.py old mode 100755 new mode 100644 index 25a9caa38..3773d1144 --- a/lending/src/codatlending/models/shared/pushoperation.py +++ b/lending/src/codatlending/models/shared/pushoperation.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -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 .datatype import DataType +from .pushoperationchange import PushOperationChange +from .pushoperationstatus import PushOperationStatus +from .validation import Validation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -41,11 +41,11 @@ class PushOperation: > 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') }}) + status: 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') }}) + changes: Optional[List[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: @@ -68,7 +68,7 @@ class PushOperation: > 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_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 }}) + data_type: Optional[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.""" @@ -79,7 +79,7 @@ class PushOperation: 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 }}) + validation: Optional[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 old mode 100755 new mode 100644 index 72ec1573d..696684405 --- a/lending/src/codatlending/models/shared/pushoperationchange.py +++ b/lending/src/codatlending/models/shared/pushoperationchange.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import pushchangetype as shared_pushchangetype -from ..shared import pushoperationref as shared_pushoperationref +from .pushchangetype import PushChangeType +from .pushoperationref import PushOperationRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -14,8 +14,8 @@ class PushOperationChange: 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 }}) + record_ref: Optional[PushOperationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) + type: Optional[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 old mode 100755 new mode 100644 index 865b3abd2..952547e95 --- a/lending/src/codatlending/models/shared/pushoperationref.py +++ b/lending/src/codatlending/models/shared/pushoperationref.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import datatype as shared_datatype +from .datatype import DataType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,7 +11,7 @@ @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 }}) + data_type: Optional[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 old mode 100755 new mode 100644 index dad57c66f..82de2e823 --- a/lending/src/codatlending/models/shared/pushoperations.py +++ b/lending/src/codatlending/models/shared/pushoperations.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import links as shared_links -from ..shared import pushoperation as shared_pushoperation +from .links import Links +from .pushoperation import PushOperation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @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') }}) + 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') }}) 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 }}) + results: Optional[List[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/pushoperationstatus.py b/lending/src/codatlending/models/shared/pushoperationstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/pushoption.py b/lending/src/codatlending/models/shared/pushoption.py old mode 100755 new mode 100644 index 9a7be7c9c..b85ea7dac --- a/lending/src/codatlending/models/shared/pushoption.py +++ b/lending/src/codatlending/models/shared/pushoption.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import pushoptionchoice as shared_pushoptionchoice -from ..shared import pushoptionproperty as shared_pushoptionproperty -from ..shared import pushoptiontype as shared_pushoptiontype -from ..shared import pushvalidationinfo as shared_pushvalidationinfo +from .pushoptionchoice import PushOptionChoice +from .pushoptionproperty import PushOptionProperty +from .pushoptiontype import PushOptionType +from .pushvalidationinfo import PushValidationInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -18,12 +18,12 @@ class PushOption: 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') }}) + type: 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 }}) 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 }}) + options: Optional[List[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[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 old mode 100755 new mode 100644 index 785fd3d70..7c65dc891 --- a/lending/src/codatlending/models/shared/pushoptionchoice.py +++ b/lending/src/codatlending/models/shared/pushoptionchoice.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import pushoptiontype as shared_pushoptiontype +from .pushoptiontype import PushOptionType from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -17,7 +17,7 @@ class PushOptionChoice: 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 }}) + type: Optional[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 old mode 100755 new mode 100644 index 50ce9d133..48136cf72 --- a/lending/src/codatlending/models/shared/pushoptionproperty.py +++ b/lending/src/codatlending/models/shared/pushoptionproperty.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import pushoptionchoice as shared_pushoptionchoice -from ..shared import pushoptiontype as shared_pushoptiontype -from ..shared import pushvalidationinfo as shared_pushvalidationinfo +from .pushoptionchoice import PushOptionChoice +from .pushoptiontype import PushOptionType +from .pushvalidationinfo import PushValidationInfo from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -19,10 +19,10 @@ class PushOptionProperty: 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') }}) + type: PushOptionType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The option type.""" - options: Optional[List[shared_pushoptionchoice.PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) + options: Optional[List[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 }}) + validation: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/pushvalidationinfo.py b/lending/src/codatlending/models/shared/pushvalidationinfo.py old mode 100755 new mode 100644 index 5fe00da4e..950eecd0a --- a/lending/src/codatlending/models/shared/pushvalidationinfo.py +++ b/lending/src/codatlending/models/shared/pushvalidationinfo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import pushfieldvalidation as shared_pushfieldvalidation +from .pushfieldvalidation import PushFieldValidation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @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') }}) - warnings: Optional[List[shared_pushfieldvalidation.PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + information: Optional[List[PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information') }}) + warnings: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportbasis.py b/lending/src/codatlending/models/shared/reportbasis.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportcomponentmeasure.py b/lending/src/codatlending/models/shared/reportcomponentmeasure.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportinfo.py b/lending/src/codatlending/models/shared/reportinfo.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportinput.py b/lending/src/codatlending/models/shared/reportinput.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportitems.py b/lending/src/codatlending/models/shared/reportitems.py old mode 100755 new mode 100644 index d09195270..85a72a09b --- a/lending/src/codatlending/models/shared/reportitems.py +++ b/lending/src/codatlending/models/shared/reportitems.py @@ -2,15 +2,15 @@ from __future__ import annotations import dataclasses -from ..shared import definitionsitemref as shared_definitionsitemref -from ..shared import loanref as shared_loanref +from .itemref import ItemRef +from .loanref import LoanRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum from typing import Optional -class ReportItemsLoanTransactionType(str, Enum): +class LoanTransactionType(str, Enum): r"""The type of loan transaction.""" INVESTMENT = 'Investment' REPAYMENT = 'Repayment' @@ -44,11 +44,11 @@ class ReportItems: > 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. """ - 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 }}) + item_ref: Optional[ItemRef] = 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 }}) + loan_ref: Optional[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[LoanTransactionType] = 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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/reportline_input.py b/lending/src/codatlending/models/shared/reportline_input.py new file mode 100644 index 000000000..b424033ec --- /dev/null +++ b/lending/src/codatlending/models/shared/reportline_input.py @@ -0,0 +1,24 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .reportline import ReportLine +from codatlending import utils +from dataclasses_json import Undefined, dataclass_json +from decimal import Decimal +from typing import List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ReportLineInput: + 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') }}) + 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') }}) + r"""An array of ReportLine items.""" + 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/schema_datatype.py b/lending/src/codatlending/models/shared/schema_datatype.py new file mode 100644 index 000000000..c6811c63c --- /dev/null +++ b/lending/src/codatlending/models/shared/schema_datatype.py @@ -0,0 +1,50 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + +class SchemaDataType(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' + ITEM_RECEIPTS = 'itemReceipts' + 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' diff --git a/lending/src/codatlending/models/shared/security.py b/lending/src/codatlending/models/shared/security.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/servicecharge.py b/lending/src/codatlending/models/shared/servicecharge.py old mode 100755 new mode 100644 index 38ca8228e..13190fb3f --- a/lending/src/codatlending/models/shared/servicecharge.py +++ b/lending/src/codatlending/models/shared/servicecharge.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import servicechargetype as shared_servicechargetype -from ..shared import taxcomponentallocation as shared_taxcomponentallocation +from .servicechargetype import ServiceChargeType +from .taxcomponentallocation import TaxComponentAllocation from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -19,13 +19,13 @@ 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[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 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 }}) + type: Optional[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/servicechargetype.py b/lending/src/codatlending/models/shared/servicechargetype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/sourceref.py b/lending/src/codatlending/models/shared/sourceref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/supplementaldata.py b/lending/src/codatlending/models/shared/supplementaldata.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/supplierref.py b/lending/src/codatlending/models/shared/supplierref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/supplierstatus.py b/lending/src/codatlending/models/shared/supplierstatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/taxcomponentallocation.py b/lending/src/codatlending/models/shared/taxcomponentallocation.py old mode 100755 new mode 100644 index 3d5f04acf..e6022085d --- a/lending/src/codatlending/models/shared/taxcomponentallocation.py +++ b/lending/src/codatlending/models/shared/taxcomponentallocation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import taxcomponentref as shared_taxcomponentref +from .taxcomponentref import TaxComponentRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ 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 }}) 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 }}) + tax_component_ref: Optional[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/taxrateref.py b/lending/src/codatlending/models/shared/taxrateref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/tracking.py b/lending/src/codatlending/models/shared/tracking.py old mode 100755 new mode 100644 index 77f8f7d79..3f0c826b4 --- a/lending/src/codatlending/models/shared/tracking.py +++ b/lending/src/codatlending/models/shared/tracking.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import recordref as shared_recordref +from .recordref import RecordRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,8 +11,8 @@ @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') }}) - 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 }}) + record_refs: List[RecordRef] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefs') }}) + invoice_to: Optional[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. 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. diff --git a/lending/src/codatlending/models/shared/trackingcategoryref.py b/lending/src/codatlending/models/shared/trackingcategoryref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactioncategory.py b/lending/src/codatlending/models/shared/transactioncategory.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactioncategoryref.py b/lending/src/codatlending/models/shared/transactioncategoryref.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactioncategorystatus.py b/lending/src/codatlending/models/shared/transactioncategorystatus.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactioncode.py b/lending/src/codatlending/models/shared/transactioncode.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactionsourceref.py b/lending/src/codatlending/models/shared/transactionsourceref.py old mode 100755 new mode 100644 index 6bac47373..e3bcfc450 --- a/lending/src/codatlending/models/shared/transactionsourceref.py +++ b/lending/src/codatlending/models/shared/transactionsourceref.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import transactionsourcetype as shared_transactionsourcetype +from .transactionsourcetype import TransactionSourceType from codatlending import utils from dataclasses_json import Undefined, dataclass_json @@ -12,7 +12,7 @@ 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') }}) + type: 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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transactiontype.py b/lending/src/codatlending/models/shared/transactiontype.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/transferaccount.py b/lending/src/codatlending/models/shared/transferaccount.py old mode 100755 new mode 100644 index c921dbcf5..ef43a2d82 --- a/lending/src/codatlending/models/shared/transferaccount.py +++ b/lending/src/codatlending/models/shared/transferaccount.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountref as shared_accountref +from .accountref import AccountRef from codatlending import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -13,7 +13,7 @@ @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 }}) + account_ref: Optional[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 }}) r"""The amount transferred between accounts.""" diff --git a/lending/src/codatlending/models/shared/validation.py b/lending/src/codatlending/models/shared/validation.py old mode 100755 new mode 100644 index 9eb278a39..c7e1927e6 --- a/lending/src/codatlending/models/shared/validation.py +++ b/lending/src/codatlending/models/shared/validation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import validationitem as shared_validationitem +from .validationitem import ValidationItem from codatlending import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,7 +12,7 @@ @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') }}) - warnings: Optional[List[shared_validationitem.ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + errors: Optional[List[ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors') }}) + warnings: Optional[List[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 old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/shared/weblink.py b/lending/src/codatlending/models/shared/weblink.py old mode 100755 new mode 100644 index 0209ecfea..86d4b877f --- a/lending/src/codatlending/models/shared/weblink.py +++ b/lending/src/codatlending/models/shared/weblink.py @@ -7,7 +7,7 @@ from enum import Enum from typing import Optional -class WebLinkType(str, Enum): +class Type(str, Enum): r"""The type of the weblink.""" WEBSITE = 'Website' SOCIAL = 'Social' @@ -18,7 +18,7 @@ class WebLinkType(str, Enum): @dataclasses.dataclass class WebLink: r"""Weblink associated with the company.""" - type: Optional[WebLinkType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + type: Optional[Type] = 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 weblink.""" url: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('url'), 'exclude': lambda f: f is None }}) r"""The full URL for the weblink.""" diff --git a/lending/src/codatlending/models/webhooks/__init__.py b/lending/src/codatlending/models/webhooks/__init__.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/models/webhooks/account_categories_updated.py b/lending/src/codatlending/models/webhooks/account_categories_updated.py old mode 100755 new mode 100644 index 0e103b30c..3a7846f65 --- a/lending/src/codatlending/models/webhooks/account_categories_updated.py +++ b/lending/src/codatlending/models/webhooks/account_categories_updated.py @@ -3,16 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Optional @dataclasses.dataclass class AccountCategoriesUpdatedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 20c411599..2e236f1a6 --- a/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py +++ b/lending/src/codatlending/models/webhooks/client_rate_limit_reached.py @@ -3,16 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Optional @dataclasses.dataclass class ClientRateLimitReachedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 7e4b65419..27dbf5cb4 --- a/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py +++ b/lending/src/codatlending/models/webhooks/client_rate_limit_reset.py @@ -3,16 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Optional @dataclasses.dataclass class ClientRateLimitResetResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" 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_orders.py b/lending/src/codatlending/orders.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/sales_orders.py rename to lending/src/codatlending/orders.py index e592f27f1..f0af7cd4d --- a/lending/src/codatlending/sales_orders.py +++ b/lending/src/codatlending/orders.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesOrders: +class Orders: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceOrderRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceOrderResponse: r"""Get order The *Get order* endpoint returns a single order for a given orderId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceOrderRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceOrderResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_order = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Order) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceOrdersRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceOrdersResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_orders = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_payment_methods.py b/lending/src/codatlending/payment_methods.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_payment_methods.py rename to lending/src/codatlending/payment_methods.py index 7b12468be..2a9730986 --- a/lending/src/codatlending/sales_payment_methods.py +++ b/lending/src/codatlending/payment_methods.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesPaymentMethods: +class PaymentMethods: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommercePaymentMethodRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommercePaymentMethodResponse: r"""Get payment method The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommercePaymentMethodRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommercePaymentMethodResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_payment_method = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/PaymentMethod) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommercePaymentMethodsRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommercePaymentMethodsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_payment_methods = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_receivable_payments.py b/lending/src/codatlending/payments.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/accounts_receivable_payments.py rename to lending/src/codatlending/payments.py index 0d2e05067..8a098423a --- a/lending/src/codatlending/accounts_receivable_payments.py +++ b/lending/src/codatlending/payments.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountsReceivablePayments: +class Payments: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingPaymentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingPaymentResponse: r"""Get payment The *Get payment* endpoint returns a single payment for a given paymentId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetAccountingPaymentRequest, retries: Optional headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingPaymentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.accounting_payment = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Payment) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListAccountingPaymentsRequest, retries: Optio headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingPaymentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.accounting_payments = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_product_categories.py b/lending/src/codatlending/product_categories.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_product_categories.py rename to lending/src/codatlending/product_categories.py index 1b6505f95..2b44d4069 --- a/lending/src/codatlending/sales_product_categories.py +++ b/lending/src/codatlending/product_categories.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesProductCategories: +class ProductCategories: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceProductCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceProductCategoryResponse: r"""Get product category The *Get product* endpoint returns a single product for a given productId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceProductCategoryRequest, retries: Op headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceProductCategoryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_product_category = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/ProductCategory) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceProductCategoriesRequest, retries headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceProductCategoriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_product_categories = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales_products.py b/lending/src/codatlending/products.py old mode 100755 new mode 100644 similarity index 78% rename from lending/src/codatlending/sales_products.py rename to lending/src/codatlending/products.py index a684626dd..44be4baaa --- a/lending/src/codatlending/sales_products.py +++ b/lending/src/codatlending/products.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class SalesProducts: +class Products: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetCommerceProductRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceProductResponse: r"""Get product The *Get product* endpoint returns a single product for a given productId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetCommerceProductRequest, retries: Optional[u headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceProductResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,16 +61,20 @@ def do_request(): res.commerce_product = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Product) for a given company's connection. @@ -83,7 +91,10 @@ def list(self, request: operations.ListCommerceProductsRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -102,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListCommerceProductsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -111,12 +122,15 @@ def do_request(): res.commerce_products = 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, 409, 429]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/financial_statements_profit_and_loss.py b/lending/src/codatlending/profit_and_loss.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/financial_statements_profit_and_loss.py rename to lending/src/codatlending/profit_and_loss.py index ad23263b6..427c183cb --- a/lending/src/codatlending/financial_statements_profit_and_loss.py +++ b/lending/src/codatlending/profit_and_loss.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class FinancialStatementsProfitAndLoss: +class ProfitAndLoss: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetAccountingProfitAndLossRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingProfitAndLossResponse: r"""Get profit and loss Gets the latest profit and loss for a company. @@ -24,7 +25,10 @@ def get(self, request: operations.GetAccountingProfitAndLossRequest, retries: Op headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -43,7 +47,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingProfitAndLossResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -52,16 +56,20 @@ def do_request(): res.accounting_profit_and_loss_report = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_categorized_accounts(self, request: operations.GetCategorizedProfitAndLossStatementRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCategorizedProfitAndLossStatementResponse: r"""Get categorized profit and loss statement The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. @@ -76,7 +84,10 @@ def get_categorized_accounts(self, request: operations.GetCategorizedProfitAndLo headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -95,7 +106,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCategorizedProfitAndLossStatementResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -104,12 +115,15 @@ def do_request(): res.enhanced_financial_report = 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 [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/manage_data_pull_operations.py b/lending/src/codatlending/pull_operations.py old mode 100755 new mode 100644 similarity index 74% rename from lending/src/codatlending/manage_data_pull_operations.py rename to lending/src/codatlending/pull_operations.py index 4f9ec65db..da1bda6fd --- a/lending/src/codatlending/manage_data_pull_operations.py +++ b/lending/src/codatlending/pull_operations.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class ManageDataPullOperations: +class PullOperations: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetPullOperationRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetPullOperationResponse: r"""Get pull operation Retrieve information about a single dataset or pull operation. @@ -23,7 +24,10 @@ def get(self, request: operations.GetPullOperationRequest, retries: Optional[uti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -42,7 +46,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetPullOperationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -51,16 +55,20 @@ def do_request(): res.pull_operation = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list(self, request: operations.ListPullOperationsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListPullOperationsResponse: r"""List pull operations Gets the pull operation history (datasets) for a given company. @@ -73,7 +81,10 @@ def list(self, request: operations.ListPullOperationsRequest, retries: Optional[ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -92,7 +103,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListPullOperationsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -101,12 +112,15 @@ def do_request(): res.pull_operations = 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/manage_data_refresh.py b/lending/src/codatlending/refresh.py old mode 100755 new mode 100644 similarity index 75% rename from lending/src/codatlending/manage_data_refresh.py rename to lending/src/codatlending/refresh.py index e8940ac15..9226d7af1 --- a/lending/src/codatlending/manage_data_refresh.py +++ b/lending/src/codatlending/refresh.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class ManageDataRefresh: +class Refresh: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def all_data_types(self, request: operations.RefreshAllDataTypesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.RefreshAllDataTypesResponse: r"""Refresh all data Refreshes all data types with `fetch on first link` set to `true` for a given company. @@ -27,7 +28,10 @@ def all_data_types(self, request: operations.RefreshAllDataTypesRequest, retries headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -46,21 +50,25 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.RefreshAllDataTypesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 204: pass - elif http_res.status_code in [401, 404, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def data_type(self, request: operations.RefreshDataTypeRequest, retries: Optional[utils.RetryConfig] = None) -> operations.RefreshDataTypeResponse: r"""Refresh data type Refreshes a given data type for a given company. @@ -75,7 +83,10 @@ def data_type(self, request: operations.RefreshDataTypeRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -94,7 +105,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.RefreshDataTypeResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -103,12 +114,15 @@ def do_request(): res.pull_operation = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/accounts_receivable_reports.py b/lending/src/codatlending/reports.py old mode 100755 new mode 100644 similarity index 70% rename from lending/src/codatlending/accounts_receivable_reports.py rename to lending/src/codatlending/reports.py index e115ff3d3..24ac7b686 --- a/lending/src/codatlending/accounts_receivable_reports.py +++ b/lending/src/codatlending/reports.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class AccountsReceivableReports: +class Reports: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get_aged_creditors(self, request: operations.GetAccountingAgedCreditorsReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingAgedCreditorsReportResponse: r"""Aged creditors report Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. @@ -24,7 +25,10 @@ def get_aged_creditors(self, request: operations.GetAccountingAgedCreditorsRepor headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -43,7 +47,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingAgedCreditorsReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -52,16 +56,20 @@ def do_request(): res.accounting_aged_creditor_report = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_aged_debtors(self, request: operations.GetAccountingAgedDebtorsReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingAgedDebtorsReportResponse: r"""Aged debtors report Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. @@ -74,7 +82,10 @@ def get_aged_debtors(self, request: operations.GetAccountingAgedDebtorsReportReq headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -93,7 +104,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingAgedDebtorsReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -102,16 +113,20 @@ def do_request(): res.accounting_aged_debtor_report = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def is_aged_creditors_available(self, request: operations.IsAgedCreditorsReportAvailableRequest, retries: Optional[utils.RetryConfig] = None) -> operations.IsAgedCreditorsReportAvailableResponse: r"""Aged creditors report available Indicates whether the aged creditor report is available for the company. @@ -123,7 +138,10 @@ def is_aged_creditors_available(self, request: operations.IsAgedCreditorsReportA headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -142,19 +160,29 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.IsAgedCreditorsReportAvailableResponse(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[bool]) - res.is_aged_creditors_report_available_200_application_json_boolean = out + res.boolean = 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, 402, 403, 404, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def is_aged_debtors_available(self, request: operations.IsAgedDebtorsReportAvailableRequest, retries: Optional[utils.RetryConfig] = None) -> operations.IsAgedDebtorsReportAvailableResponse: r"""Aged debtors report available Indicates whether the aged debtors report is available for the company. @@ -166,7 +194,10 @@ def is_aged_debtors_available(self, request: operations.IsAgedDebtorsReportAvail headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -185,15 +216,24 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.IsAgedDebtorsReportAvailableResponse(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[bool]) - res.is_aged_debtors_report_available_200_application_json_boolean = out + res.boolean = 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, 402, 403, 404, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/sales.py b/lending/src/codatlending/sales.py old mode 100755 new mode 100644 index 2d43ff9d2..9049e8baa --- a/lending/src/codatlending/sales.py +++ b/lending/src/codatlending/sales.py @@ -1,30 +1,30 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .sales_customers import SalesCustomers -from .sales_disputes import SalesDisputes -from .sales_locations import SalesLocations -from .sales_metrics import SalesMetrics -from .sales_orders import SalesOrders -from .sales_payment_methods import SalesPaymentMethods -from .sales_payments import SalesPayments -from .sales_product_categories import SalesProductCategories -from .sales_products import SalesProducts -from .sales_reports import SalesReports -from .sales_transactions import SalesTransactions +from .codatlending_customers import CodatLendingCustomers +from .codatlending_reports import CodatLendingReports +from .codatlending_sales_payments import CodatLendingSalesPayments +from .codatlending_transactions import CodatLendingTransactions +from .disputes import Disputes +from .locations import Locations +from .metrics import Metrics +from .orders import Orders +from .payment_methods import PaymentMethods +from .product_categories import ProductCategories +from .products import Products from .sdkconfiguration import SDKConfiguration class Sales: - customers: SalesCustomers - disputes: SalesDisputes - locations: SalesLocations - metrics: SalesMetrics - orders: SalesOrders - payment_methods: SalesPaymentMethods - payments: SalesPayments - product_categories: SalesProductCategories - products: SalesProducts - reports: SalesReports - transactions: SalesTransactions + customers: CodatLendingCustomers + disputes: Disputes + locations: Locations + orders: Orders + payment_methods: PaymentMethods + payments: CodatLendingSalesPayments + product_categories: ProductCategories + products: Products + transactions: CodatLendingTransactions + metrics: Metrics + reports: CodatLendingReports sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -32,16 +32,16 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.customers = SalesCustomers(self.sdk_configuration) - self.disputes = SalesDisputes(self.sdk_configuration) - self.locations = SalesLocations(self.sdk_configuration) - self.metrics = SalesMetrics(self.sdk_configuration) - self.orders = SalesOrders(self.sdk_configuration) - self.payment_methods = SalesPaymentMethods(self.sdk_configuration) - self.payments = SalesPayments(self.sdk_configuration) - self.product_categories = SalesProductCategories(self.sdk_configuration) - self.products = SalesProducts(self.sdk_configuration) - self.reports = SalesReports(self.sdk_configuration) - self.transactions = SalesTransactions(self.sdk_configuration) + self.customers = CodatLendingCustomers(self.sdk_configuration) + self.disputes = Disputes(self.sdk_configuration) + self.locations = Locations(self.sdk_configuration) + self.orders = Orders(self.sdk_configuration) + self.payment_methods = PaymentMethods(self.sdk_configuration) + self.payments = CodatLendingSalesPayments(self.sdk_configuration) + self.product_categories = ProductCategories(self.sdk_configuration) + self.products = Products(self.sdk_configuration) + self.transactions = CodatLendingTransactions(self.sdk_configuration) + self.metrics = Metrics(self.sdk_configuration) + self.reports = CodatLendingReports(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/sdk.py b/lending/src/codatlending/sdk.py old mode 100755 new mode 100644 index 8127a13ba..bc47fb606 --- a/lending/src/codatlending/sdk.py +++ b/lending/src/codatlending/sdk.py @@ -1,10 +1,10 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" import requests as requests_http -from .accounting_bank_data import AccountingBankData from .accounts_payable import AccountsPayable from .accounts_receivable import AccountsReceivable from .banking import Banking +from .codatlending_accounting_bank_data import CodatLendingAccountingBankData from .companies import Companies from .company_info import CompanyInfo from .connections import Connections @@ -20,7 +20,7 @@ from .transactions import Transactions from codatlending import utils from codatlending.models import shared -from typing import Dict +from typing import Callable, Dict, Union 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. @@ -51,35 +51,35 @@ class CodatLending: | Manage data | Control how data is retrieved from an integration. | | File upload | Endpoints to manage uploaded files. | """ - accounting_bank_data: AccountingBankData - r"""Access bank transactions from an accounting platform.""" companies: Companies r"""Create and manage your Codat companies.""" - company_info: CompanyInfo - r"""View company information fetched from the source platform.""" connections: Connections r"""Manage your companies' data connections.""" - data_integrity: DataIntegrity - r"""Match mutable accounting data with immutable banking data to increase confidence in financial data.""" - excel_reports: ExcelReports - r"""Download reports in Excel format.""" - file_upload: FileUpload - r"""Endpoints to manage uploaded files.""" - liabilities: Liabilities - r"""Debt and other liabilities.""" + transactions: Transactions + accounting_bank_data: CodatLendingAccountingBankData + r"""Access bank transactions from an accounting platform.""" + banking: Banking accounts_payable: AccountsPayable + sales: Sales + company_info: CompanyInfo + r"""View company information fetched from the source platform.""" accounts_receivable: AccountsReceivable - banking: Banking - financial_statements: FinancialStatements + file_upload: FileUpload + r"""Endpoints to manage uploaded files.""" loan_writeback: LoanWriteback + financial_statements: FinancialStatements manage_data: ManageData - sales: Sales - transactions: Transactions + liabilities: Liabilities + r"""Debt and other liabilities.""" + data_integrity: DataIntegrity + r"""Match mutable accounting data with immutable banking data to increase confidence in financial data.""" + excel_reports: ExcelReports + r"""Download reports in Excel format.""" sdk_configuration: SDKConfiguration def __init__(self, - security: shared.Security = None, + security: Union[shared.Security,Callable[[], shared.Security]] = None, server_idx: int = None, server_url: str = None, url_params: Dict[str, str] = None, @@ -89,7 +89,7 @@ def __init__(self, """Instantiates the SDK configuring it with the provided parameters. :param security: The security details required for authentication - :type security: shared.Security + :type security: Union[shared.Security,Callable[[], shared.Security]] :param server_idx: The index of the server to use for all operations :type server_idx: int :param server_url: The server URL to use for all operations @@ -104,33 +104,29 @@ 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) - self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx, retry_config=retry_config) + self.sdk_configuration = SDKConfiguration(client, security, server_url, server_idx, retry_config=retry_config) self._init_sdks() def _init_sdks(self): - self.accounting_bank_data = AccountingBankData(self.sdk_configuration) self.companies = Companies(self.sdk_configuration) - self.company_info = CompanyInfo(self.sdk_configuration) self.connections = Connections(self.sdk_configuration) - self.data_integrity = DataIntegrity(self.sdk_configuration) - self.excel_reports = ExcelReports(self.sdk_configuration) - self.file_upload = FileUpload(self.sdk_configuration) - self.liabilities = Liabilities(self.sdk_configuration) + self.transactions = Transactions(self.sdk_configuration) + self.accounting_bank_data = CodatLendingAccountingBankData(self.sdk_configuration) + self.banking = Banking(self.sdk_configuration) self.accounts_payable = AccountsPayable(self.sdk_configuration) + self.sales = Sales(self.sdk_configuration) + self.company_info = CompanyInfo(self.sdk_configuration) self.accounts_receivable = AccountsReceivable(self.sdk_configuration) - self.banking = Banking(self.sdk_configuration) - self.financial_statements = FinancialStatements(self.sdk_configuration) + self.file_upload = FileUpload(self.sdk_configuration) self.loan_writeback = LoanWriteback(self.sdk_configuration) + self.financial_statements = FinancialStatements(self.sdk_configuration) self.manage_data = ManageData(self.sdk_configuration) - self.sales = Sales(self.sdk_configuration) - self.transactions = Transactions(self.sdk_configuration) + self.liabilities = Liabilities(self.sdk_configuration) + self.data_integrity = DataIntegrity(self.sdk_configuration) + self.excel_reports = ExcelReports(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/sdkconfiguration.py b/lending/src/codatlending/sdkconfiguration.py old mode 100755 new mode 100644 index 9f5651f21..d03572e27 --- a/lending/src/codatlending/sdkconfiguration.py +++ b/lending/src/codatlending/sdkconfiguration.py @@ -2,9 +2,10 @@ import requests from dataclasses import dataclass -from typing import Dict, Tuple +from typing import Dict, Tuple, Callable, Union from .utils.retries import RetryConfig from .utils import utils +from codatlending.models import shared SERVERS = [ @@ -16,14 +17,14 @@ @dataclass class SDKConfiguration: client: requests.Session - security_client: requests.Session + security: Union[shared.Security,Callable[[], shared.Security]] = None server_url: str = '' server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '3.0.0' - 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' + sdk_version: str = '6.0.0' + gen_version: str = '2.210.3' + user_agent: str = 'speakeasy-sdk/python 6.0.0 2.210.3 3.0.0 codat-lending' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: diff --git a/lending/src/codatlending/accounts_payable_suppliers.py b/lending/src/codatlending/suppliers.py old mode 100755 new mode 100644 similarity index 77% rename from lending/src/codatlending/accounts_payable_suppliers.py rename to lending/src/codatlending/suppliers.py index bd7e29e47..81306fe1c --- a/lending/src/codatlending/accounts_payable_suppliers.py +++ b/lending/src/codatlending/suppliers.py @@ -10,13 +10,14 @@ class DownloadAttachmentAcceptEnum(str, Enum): APPLICATION_JSON = "application/json" APPLICATION_OCTET_STREAM = "application/octet-stream" -class AccountsPayableSuppliers: +class Suppliers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def download_attachment(self, request: operations.DownloadAccountingSupplierAttachmentRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[DownloadAttachmentAcceptEnum] = None) -> operations.DownloadAccountingSupplierAttachmentResponse: r"""Download supplier attachment The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. @@ -35,7 +36,10 @@ def download_attachment(self, request: operations.DownloadAccountingSupplierAtta headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.DownloadAccountingSupplierAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -62,16 +66,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get(self, request: operations.GetAccountingSupplierRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingSupplierResponse: r"""Get supplier The *Get supplier* endpoint returns a single supplier for a given supplierId. @@ -89,7 +97,10 @@ def get(self, request: operations.GetAccountingSupplierRequest, retries: Optiona headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -108,7 +119,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingSupplierResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -117,16 +128,20 @@ def do_request(): res.accounting_supplier = 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, 409, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_attachment(self, request: operations.GetAccountingSupplierAttachmentRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingSupplierAttachmentResponse: r"""Get supplier attachment The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. @@ -142,7 +157,10 @@ def get_attachment(self, request: operations.GetAccountingSupplierAttachmentRequ headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -161,7 +179,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingSupplierAttachmentResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -170,16 +188,20 @@ def do_request(): res.accounting_attachment = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Supplier) for a given company's connection. @@ -196,7 +218,10 @@ def list(self, request: operations.ListAccountingSuppliersRequest, retries: Opti headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -215,7 +240,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingSuppliersResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -224,16 +249,20 @@ def do_request(): res.accounting_suppliers = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_attachments(self, request: operations.ListAccountingSupplierAttachmentsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountingSupplierAttachmentsResponse: r"""List supplier attachments The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. @@ -249,7 +278,10 @@ def list_attachments(self, request: operations.ListAccountingSupplierAttachments headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -268,7 +300,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListAccountingSupplierAttachmentsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -277,12 +309,15 @@ def do_request(): res.attachments = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/banking_transaction_categories.py b/lending/src/codatlending/transaction_categories.py old mode 100755 new mode 100644 similarity index 76% rename from lending/src/codatlending/banking_transaction_categories.py rename to lending/src/codatlending/transaction_categories.py index e03b360c3..ec002acee --- a/lending/src/codatlending/banking_transaction_categories.py +++ b/lending/src/codatlending/transaction_categories.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class BankingTransactionCategories: +class TransactionCategories: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def get(self, request: operations.GetBankingTransactionCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetBankingTransactionCategoryResponse: r"""Get transaction category The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. @@ -29,7 +30,10 @@ def get(self, request: operations.GetBankingTransactionCategoryRequest, retries: headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,7 +52,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetBankingTransactionCategoryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -57,10 +61,20 @@ def do_request(): res.banking_transaction_category = 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, 402, 403, 404, 409, 429, 500, 503]: + if utils.match_content_type(content_type, 'application/json'): + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/TransactionCategory) for a given company's connection. @@ -77,7 +91,10 @@ def list(self, request: operations.ListBankingTransactionCategoriesRequest, retr headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -96,7 +113,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListBankingTransactionCategoriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -105,12 +122,15 @@ def do_request(): res.banking_transaction_categories = 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, 409]: + elif http_res.status_code in [400, 401, 402, 403, 404, 409, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/transactions.py b/lending/src/codatlending/transactions.py old mode 100755 new mode 100644 index 1fb5a8658..41da820cf --- a/lending/src/codatlending/transactions.py +++ b/lending/src/codatlending/transactions.py @@ -1,18 +1,18 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +from .account_transactions import AccountTransactions +from .codatlending_direct_costs import CodatLendingDirectCosts +from .codatlending_transfers import CodatLendingTransfers +from .journal_entries import JournalEntries +from .journals import Journals from .sdkconfiguration import SDKConfiguration -from .transactions_account_transactions import TransactionsAccountTransactions -from .transactions_direct_costs import TransactionsDirectCosts -from .transactions_journal_entries import TransactionsJournalEntries -from .transactions_journals import TransactionsJournals -from .transactions_transfers import TransactionsTransfers class Transactions: - account_transactions: TransactionsAccountTransactions - direct_costs: TransactionsDirectCosts - journal_entries: TransactionsJournalEntries - journals: TransactionsJournals - transfers: TransactionsTransfers + account_transactions: AccountTransactions + direct_costs: CodatLendingDirectCosts + transfers: CodatLendingTransfers + journal_entries: JournalEntries + journals: Journals sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -20,10 +20,10 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self._init_sdks() def _init_sdks(self): - self.account_transactions = TransactionsAccountTransactions(self.sdk_configuration) - self.direct_costs = TransactionsDirectCosts(self.sdk_configuration) - self.journal_entries = TransactionsJournalEntries(self.sdk_configuration) - self.journals = TransactionsJournals(self.sdk_configuration) - self.transfers = TransactionsTransfers(self.sdk_configuration) + self.account_transactions = AccountTransactions(self.sdk_configuration) + self.direct_costs = CodatLendingDirectCosts(self.sdk_configuration) + self.transfers = CodatLendingTransfers(self.sdk_configuration) + self.journal_entries = JournalEntries(self.sdk_configuration) + self.journals = Journals(self.sdk_configuration) \ No newline at end of file diff --git a/lending/src/codatlending/loan_writeback_transfers.py b/lending/src/codatlending/transfers.py old mode 100755 new mode 100644 similarity index 80% rename from lending/src/codatlending/loan_writeback_transfers.py rename to lending/src/codatlending/transfers.py index 6561dd59e..2b5c5da53 --- a/lending/src/codatlending/loan_writeback_transfers.py +++ b/lending/src/codatlending/transfers.py @@ -5,13 +5,14 @@ from codatlending.models import errors, operations, shared from typing import Optional -class LoanWritebackTransfers: +class Transfers: sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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/lending-api#/schemas/Transfer) for a given company's connection. @@ -35,7 +36,10 @@ def create(self, request: operations.CreateTransferRequest, retries: Optional[ut headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -54,7 +58,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.CreateTransferResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -63,16 +67,20 @@ def do_request(): res.accounting_create_transfer_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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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/lending-api#/schemas/Transfer) for a given company and integration. @@ -92,7 +100,10 @@ def get_create_model(self, request: operations.GetCreateTransfersModelRequest, r headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -111,7 +122,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCreateTransfersModelResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -120,12 +131,15 @@ def do_request(): res.push_option = 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, 429]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/lending/src/codatlending/utils/__init__.py b/lending/src/codatlending/utils/__init__.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/utils/retries.py b/lending/src/codatlending/utils/retries.py old mode 100755 new mode 100644 diff --git a/lending/src/codatlending/utils/utils.py b/lending/src/codatlending/utils/utils.py old mode 100755 new mode 100644 index ccfad9f7a..416ef7949 --- a/lending/src/codatlending/utils/utils.py +++ b/lending/src/codatlending/utils/utils.py @@ -705,7 +705,7 @@ def marshal_json(val, encoder=None): val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) - return json.dumps(val) + return json.dumps(val, separators=(',', ':'), sort_keys=True) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -759,6 +759,8 @@ def bigintencode(val: int): def bigintdecoder(val): + if isinstance(val, float): + raise ValueError(f"{val} is a float") return int(val) @@ -828,6 +830,24 @@ def list_decode(val: List): return list_decode +def union_encoder(all_encoders: Dict[str, Callable]): + def selective_encoder(val: any): + if type(val) in all_encoders: + return all_encoders[type(val)](val) + return val + return selective_encoder + +def union_decoder(all_decoders: List[Callable]): + def selective_decoder(val: any): + decoded = val + for decoder in all_decoders: + try: + decoded = decoder(val) + break + except (TypeError, ValueError): + continue + return decoded + return selective_decoder def get_field_name(name): def override(_, _field_name=name): diff --git a/lending/tests/helpers.py b/lending/tests/helpers.py new file mode 100644 index 000000000..b3d095040 --- /dev/null +++ b/lending/tests/helpers.py @@ -0,0 +1,61 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import re + + +def sort_query_parameters(url): + parts = url.split("?") + + if len(parts) == 1: + return url + + query = parts[1] + params = query.split("&") + + params.sort(key=lambda x: x.split('=')[0]) + + return parts[0] + "?" + "&".join(params) + + +def sort_serialized_maps(inp: any, regex: str, delim: str): + + def sort_map(m): + entire_match = m.group(0) + + groups = m.groups() + + for group in groups: + pairs = [] + if '=' in group: + pairs = group.split(delim) + + pairs.sort(key=lambda x: x.split('=')[0]) + else: + values = group.split(delim) + + if len(values) == 1: + pairs = values + else: + pairs = [''] * int(len(values)/2) + # loop though every 2nd item + for i in range(0, len(values), 2): + pairs[int(i/2)] = values[i] + delim + values[i+1] + + pairs.sort(key=lambda x: x.split(delim)[0]) + + entire_match = entire_match.replace(group, delim.join(pairs)) + + return entire_match + + if isinstance(inp, str): + return re.sub(regex, sort_map, inp) + elif isinstance(inp, list): + for i, v in enumerate(inp): + inp[i] = sort_serialized_maps(v, regex, delim) + return inp + elif isinstance(inp, dict): + for k, v in inp.items(): + inp[k] = sort_serialized_maps(v, regex, delim) + return inp + else: + raise Exception("Unsupported type")