@codat/lending 0.1.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +315 -4
- package/dist/internal/utils/requestbody.d.ts +1 -1
- package/dist/internal/utils/retries.d.ts +2 -2
- package/dist/internal/utils/security.d.ts +5 -2
- package/dist/internal/utils/security.js +28 -28
- package/dist/sdk/accountingbankdata.d.ts +2 -26
- package/dist/sdk/accountingbankdata.js +24 -146
- package/dist/sdk/accountingbankdataaccounts.d.ts +34 -0
- package/dist/sdk/accountingbankdataaccounts.js +262 -0
- package/dist/sdk/accountspayable.d.ts +8 -170
- package/dist/sdk/accountspayable.js +53 -983
- package/dist/sdk/accountspayablebillcreditnotes.d.ts +34 -0
- package/dist/sdk/accountspayablebillcreditnotes.js +262 -0
- package/dist/sdk/accountspayablebillpayments.d.ts +34 -0
- package/dist/sdk/accountspayablebillpayments.js +262 -0
- package/dist/sdk/accountspayablebills.d.ts +46 -0
- package/dist/sdk/accountspayablebills.js +348 -0
- package/dist/sdk/accountspayablesuppliers.d.ts +74 -0
- package/dist/sdk/accountspayablesuppliers.js +530 -0
- package/dist/sdk/accountsreceivable.d.ts +12 -284
- package/dist/sdk/accountsreceivable.js +13 -1677
- package/dist/sdk/accountsreceivablecreditnotes.d.ts +34 -0
- package/dist/sdk/accountsreceivablecreditnotes.js +262 -0
- package/dist/sdk/accountsreceivablecustomers.d.ts +74 -0
- package/dist/sdk/accountsreceivablecustomers.js +530 -0
- package/dist/sdk/accountsreceivabledirectincomes.d.ts +74 -0
- package/dist/sdk/{financials.js → accountsreceivabledirectincomes.js} +183 -211
- package/dist/sdk/accountsreceivableinvoices.d.ts +93 -0
- package/dist/sdk/{cashflow.js → accountsreceivableinvoices.js} +250 -189
- package/dist/sdk/accountsreceivablepayments.d.ts +34 -0
- package/dist/sdk/accountsreceivablepayments.js +262 -0
- package/dist/sdk/accountsreceivablereports.d.ts +36 -0
- package/dist/sdk/accountsreceivablereports.js +399 -0
- package/dist/sdk/banking.d.ts +15 -0
- package/dist/sdk/banking.js +23 -0
- package/dist/sdk/bankingaccountbalances.d.ts +20 -0
- package/dist/sdk/bankingaccountbalances.js +174 -0
- package/dist/sdk/bankingaccounts.d.ts +34 -0
- package/dist/sdk/bankingaccounts.js +254 -0
- package/dist/sdk/bankingcategorizedstatement.d.ts +19 -0
- package/dist/sdk/bankingcategorizedstatement.js +173 -0
- package/dist/sdk/bankingtransactioncategories.d.ts +34 -0
- package/dist/sdk/bankingtransactioncategories.js +254 -0
- package/dist/sdk/bankingtransactions.d.ts +34 -0
- package/dist/sdk/bankingtransactions.js +254 -0
- package/dist/sdk/companies.js +110 -25
- package/dist/sdk/companyinfo.d.ts +4 -4
- package/dist/sdk/companyinfo.js +52 -18
- package/dist/sdk/connections.js +110 -25
- package/dist/sdk/dataintegrity.js +66 -15
- package/dist/sdk/excelreports.d.ts +10 -2
- package/dist/sdk/excelreports.js +76 -17
- package/dist/sdk/fileupload.js +66 -15
- package/dist/sdk/financialstatements.d.ts +13 -0
- package/dist/sdk/financialstatements.js +21 -0
- package/dist/sdk/financialstatementsaccounts.d.ts +33 -0
- package/dist/sdk/financialstatementsaccounts.js +261 -0
- package/dist/sdk/financialstatementsbalancesheet.d.ts +24 -0
- package/dist/sdk/financialstatementsbalancesheet.js +253 -0
- package/dist/sdk/financialstatementscashflow.d.ts +15 -0
- package/dist/sdk/financialstatementscashflow.js +169 -0
- package/dist/sdk/financialstatementsprofitandloss.d.ts +24 -0
- package/dist/sdk/financialstatementsprofitandloss.js +253 -0
- package/dist/sdk/liabilities.d.ts +4 -4
- package/dist/sdk/liabilities.js +48 -14
- package/dist/sdk/managedata.d.ts +5 -38
- package/dist/sdk/managedata.js +27 -267
- package/dist/sdk/managedatapulloperations.d.ts +22 -0
- package/dist/sdk/managedatapulloperations.js +250 -0
- package/dist/sdk/managedatarefresh.d.ts +28 -0
- package/dist/sdk/managedatarefresh.js +250 -0
- package/dist/sdk/models/operations/{getaccountingcompanyinfo.d.ts → getaccountingprofile.d.ts} +2 -2
- package/dist/sdk/models/operations/{getaccountingcompanyinfo.js → getaccountingprofile.js} +17 -17
- package/dist/sdk/models/operations/{getenhancedprofitandlossaccounts.d.ts → getcategorizedbalancesheetstatement.d.ts} +2 -2
- package/dist/sdk/models/operations/{getenhancedbalancesheetaccounts.js → getcategorizedbalancesheetstatement.js} +19 -19
- package/dist/sdk/models/operations/{getenhancedcashflowtransactions.d.ts → getcategorizedbankstatement.d.ts} +2 -2
- package/dist/sdk/models/operations/{getenhancedcashflowtransactions.js → getcategorizedbankstatement.js} +20 -20
- package/dist/sdk/models/operations/{getenhancedbalancesheetaccounts.d.ts → getcategorizedprofitandlossstatement.d.ts} +2 -2
- package/dist/sdk/models/operations/{getenhancedprofitandlossaccounts.js → getcategorizedprofitandlossstatement.js} +19 -19
- package/dist/sdk/models/operations/{getcommercecompanyinfo.d.ts → getcommerceprofile.d.ts} +2 -2
- package/dist/sdk/models/operations/{getcommercecompanyinfo.js → getcommerceprofile.js} +18 -18
- package/dist/sdk/models/operations/{getcommercerefundsmetrics.d.ts → getcommercerefundsreport.d.ts} +2 -2
- package/dist/sdk/models/operations/{getcommercerefundsmetrics.js → getcommercerefundsreport.js} +23 -23
- package/dist/sdk/models/operations/index.d.ts +8 -8
- package/dist/sdk/models/operations/index.js +8 -8
- package/dist/sdk/models/operations/{isageddebtorreportavailable.d.ts → isageddebtorsreportavailable.d.ts} +3 -3
- package/dist/sdk/models/operations/{isageddebtorreportavailable.js → isageddebtorsreportavailable.js} +16 -16
- package/dist/sdk/models/operations/{getenhancedinvoicesreport.d.ts → listreconciledinvoices.d.ts} +2 -2
- package/dist/sdk/models/operations/{getenhancedinvoicesreport.js → listreconciledinvoices.js} +20 -20
- package/dist/sdk/models/operations/unlinkconnection.d.ts +6 -3
- package/dist/sdk/models/operations/unlinkconnection.js +8 -8
- package/dist/sdk/models/shared/accountbalance.d.ts +1 -1
- package/dist/sdk/models/shared/accountbalance.js +1 -1
- package/dist/sdk/models/shared/accountingaccounts.d.ts +0 -3
- package/dist/sdk/models/shared/accountingaccounts.js +0 -3
- package/dist/sdk/models/shared/accountingaccounttransactions.d.ts +0 -3
- package/dist/sdk/models/shared/accountingaccounttransactions.js +0 -3
- package/dist/sdk/models/shared/accountingbankaccounts.d.ts +0 -3
- package/dist/sdk/models/shared/accountingbankaccounts.js +0 -3
- package/dist/sdk/models/shared/accountingbanktransactions.d.ts +0 -3
- package/dist/sdk/models/shared/accountingbanktransactions.js +0 -3
- package/dist/sdk/models/shared/accountingbill.d.ts +1 -1
- package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +1 -1
- package/dist/sdk/models/shared/accountingbillcreditnotes.d.ts +0 -3
- package/dist/sdk/models/shared/accountingbillcreditnotes.js +0 -3
- package/dist/sdk/models/shared/accountingbillpayment.d.ts +1 -1
- package/dist/sdk/models/shared/accountingbillpayments.d.ts +0 -3
- package/dist/sdk/models/shared/accountingbillpayments.js +0 -3
- package/dist/sdk/models/shared/accountingbills.d.ts +0 -3
- package/dist/sdk/models/shared/accountingbills.js +0 -3
- package/dist/sdk/models/shared/accountingcompanyinfo.d.ts +32 -2
- package/dist/sdk/models/shared/accountingcompanyinfo.js +47 -4
- package/dist/sdk/models/shared/accountingcreditnote.d.ts +1 -1
- package/dist/sdk/models/shared/accountingcreditnotes.d.ts +0 -3
- package/dist/sdk/models/shared/accountingcreditnotes.js +0 -3
- package/dist/sdk/models/shared/accountingcustomer.d.ts +3 -3
- package/dist/sdk/models/shared/accountingcustomer.js +3 -3
- package/dist/sdk/models/shared/accountingcustomers.d.ts +0 -3
- package/dist/sdk/models/shared/accountingcustomers.js +0 -3
- package/dist/sdk/models/shared/accountingdirectcost.d.ts +1 -1
- package/dist/sdk/models/shared/accountingdirectcosts.d.ts +0 -3
- package/dist/sdk/models/shared/accountingdirectcosts.js +0 -3
- package/dist/sdk/models/shared/accountingdirectincome.d.ts +1 -1
- package/dist/sdk/models/shared/accountingdirectincomes.d.ts +0 -3
- package/dist/sdk/models/shared/accountingdirectincomes.js +0 -3
- package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -1
- package/dist/sdk/models/shared/accountinginvoices.d.ts +0 -3
- package/dist/sdk/models/shared/accountinginvoices.js +0 -3
- package/dist/sdk/models/shared/accountingjournalentries.d.ts +0 -3
- package/dist/sdk/models/shared/accountingjournalentries.js +0 -3
- package/dist/sdk/models/shared/accountingjournalentry.d.ts +1 -1
- package/dist/sdk/models/shared/accountingjournals.d.ts +0 -3
- package/dist/sdk/models/shared/accountingjournals.js +0 -3
- package/dist/sdk/models/shared/accountingpayment.d.ts +1 -1
- package/dist/sdk/models/shared/accountingpayments.d.ts +0 -3
- package/dist/sdk/models/shared/accountingpayments.js +0 -3
- package/dist/sdk/models/shared/accountingsupplier.d.ts +3 -3
- package/dist/sdk/models/shared/accountingsupplier.js +3 -3
- package/dist/sdk/models/shared/accountingsuppliers.d.ts +0 -3
- package/dist/sdk/models/shared/accountingsuppliers.js +0 -3
- package/dist/sdk/models/shared/accountingtransfer.d.ts +1 -1
- package/dist/sdk/models/shared/accountingtransfers.d.ts +0 -3
- package/dist/sdk/models/shared/accountingtransfers.js +0 -3
- package/dist/sdk/models/shared/{accountingaddress.d.ts → addressesitems.d.ts} +1 -1
- package/dist/sdk/models/shared/{accountingaddress.js → addressesitems.js} +13 -13
- package/dist/sdk/models/shared/attachments.d.ts +0 -3
- package/dist/sdk/models/shared/attachments.js +0 -3
- package/dist/sdk/models/shared/bankingaccountbalances.d.ts +0 -3
- package/dist/sdk/models/shared/bankingaccountbalances.js +0 -3
- package/dist/sdk/models/shared/bankingaccounts.d.ts +0 -3
- package/dist/sdk/models/shared/bankingaccounts.js +0 -3
- package/dist/sdk/models/shared/bankingtransactioncategories.d.ts +0 -3
- package/dist/sdk/models/shared/bankingtransactioncategories.js +0 -3
- package/dist/sdk/models/shared/bankingtransactions.d.ts +0 -3
- package/dist/sdk/models/shared/bankingtransactions.js +0 -3
- package/dist/sdk/models/shared/commercecustomers.d.ts +0 -3
- package/dist/sdk/models/shared/commercecustomers.js +0 -3
- package/dist/sdk/models/shared/commercedispute.d.ts +1 -1
- package/dist/sdk/models/shared/commercedispute.js +1 -1
- package/dist/sdk/models/shared/commercedisputes.d.ts +0 -3
- package/dist/sdk/models/shared/commercedisputes.js +0 -3
- package/dist/sdk/models/shared/commercelocations.d.ts +0 -3
- package/dist/sdk/models/shared/commercelocations.js +0 -3
- package/dist/sdk/models/shared/commerceorder.d.ts +2 -2
- package/dist/sdk/models/shared/commerceorder.js +1 -1
- package/dist/sdk/models/shared/commerceorders.d.ts +0 -3
- package/dist/sdk/models/shared/commerceorders.js +0 -3
- package/dist/sdk/models/shared/commercepaymentmethods.d.ts +0 -3
- package/dist/sdk/models/shared/commercepaymentmethods.js +0 -3
- package/dist/sdk/models/shared/commercepayments.d.ts +0 -3
- package/dist/sdk/models/shared/commercepayments.js +0 -3
- package/dist/sdk/models/shared/commerceproductcategories.d.ts +0 -3
- package/dist/sdk/models/shared/commerceproductcategories.js +0 -3
- package/dist/sdk/models/shared/commerceproducts.d.ts +0 -3
- package/dist/sdk/models/shared/commerceproducts.js +0 -3
- package/dist/sdk/models/shared/commercetransactions.d.ts +0 -3
- package/dist/sdk/models/shared/commercetransactions.js +0 -3
- package/dist/sdk/models/shared/companies.d.ts +0 -3
- package/dist/sdk/models/shared/companies.js +0 -3
- package/dist/sdk/models/shared/connections.d.ts +0 -3
- package/dist/sdk/models/shared/connections.js +0 -3
- package/dist/sdk/models/shared/contact.d.ts +2 -2
- package/dist/sdk/models/shared/contact.js +3 -3
- package/dist/sdk/models/shared/dataintegritydatatype.d.ts +0 -3
- package/dist/sdk/models/shared/dataintegritydatatype.js +0 -3
- package/dist/sdk/models/shared/dataintegritydetails.d.ts +0 -3
- package/dist/sdk/models/shared/dataintegritydetails.js +0 -3
- package/dist/sdk/models/shared/dataintegritystatuses.d.ts +0 -3
- package/dist/sdk/models/shared/dataintegritystatuses.js +0 -3
- package/dist/sdk/models/shared/dataintegritysummaries.d.ts +0 -3
- package/dist/sdk/models/shared/dataintegritysummaries.js +0 -3
- package/dist/sdk/models/shared/enhancedfinancialreport.d.ts +0 -3
- package/dist/sdk/models/shared/enhancedfinancialreport.js +0 -3
- package/dist/sdk/models/shared/errormessage.d.ts +0 -3
- package/dist/sdk/models/shared/errormessage.js +0 -3
- package/dist/sdk/models/shared/excelstatus.d.ts +0 -3
- package/dist/sdk/models/shared/excelstatus.js +0 -3
- package/dist/sdk/models/shared/index.d.ts +1 -1
- package/dist/sdk/models/shared/index.js +1 -1
- package/dist/sdk/models/shared/loansummary.d.ts +0 -3
- package/dist/sdk/models/shared/loansummary.js +0 -3
- package/dist/sdk/models/shared/loantransactions.d.ts +0 -3
- package/dist/sdk/models/shared/loantransactions.js +0 -3
- package/dist/sdk/models/shared/periodunit.d.ts +0 -3
- package/dist/sdk/models/shared/periodunit.js +0 -3
- package/dist/sdk/models/shared/pulloperations.d.ts +0 -3
- package/dist/sdk/models/shared/pulloperations.js +0 -3
- package/dist/sdk/models/shared/supplementaldata.d.ts +1 -1
- package/dist/sdk/models/shared/supplementaldata.js +1 -1
- package/dist/sdk/sales.d.ts +22 -372
- package/dist/sdk/sales.js +22 -1767
- package/dist/sdk/salescustomers.d.ts +34 -0
- package/dist/sdk/salescustomers.js +262 -0
- package/dist/sdk/salesdisputes.d.ts +34 -0
- package/dist/sdk/salesdisputes.js +262 -0
- package/dist/sdk/saleslocations.d.ts +34 -0
- package/dist/sdk/saleslocations.js +261 -0
- package/dist/sdk/salesmetrics.d.ts +102 -0
- package/dist/sdk/salesmetrics.js +406 -0
- package/dist/sdk/salesorders.d.ts +34 -0
- package/dist/sdk/salesorders.js +262 -0
- package/dist/sdk/salespaymentmethods.d.ts +34 -0
- package/dist/sdk/salespaymentmethods.js +262 -0
- package/dist/sdk/salespayments.d.ts +34 -0
- package/dist/sdk/salespayments.js +262 -0
- package/dist/sdk/salesproductcategories.d.ts +34 -0
- package/dist/sdk/salesproductcategories.js +262 -0
- package/dist/sdk/salesproducts.d.ts +34 -0
- package/dist/sdk/salesproducts.js +262 -0
- package/dist/sdk/salesreports.d.ts +69 -0
- package/dist/sdk/salesreports.js +298 -0
- package/dist/sdk/salestransactions.d.ts +34 -0
- package/dist/sdk/salestransactions.js +262 -0
- package/dist/sdk/sdk.d.ts +38 -30
- package/dist/sdk/sdk.js +33 -45
- package/dist/sdk/transactions.d.ts +10 -176
- package/dist/sdk/transactions.js +11 -1000
- package/dist/sdk/transactionsaccounttransactions.d.ts +34 -0
- package/dist/sdk/transactionsaccounttransactions.js +262 -0
- package/dist/sdk/transactionsdirectcosts.d.ts +74 -0
- package/dist/sdk/transactionsdirectcosts.js +530 -0
- package/dist/sdk/transactionsjournalentries.d.ts +34 -0
- package/dist/sdk/transactionsjournalentries.js +262 -0
- package/dist/sdk/transactionsjournals.d.ts +34 -0
- package/dist/sdk/transactionsjournals.js +262 -0
- package/dist/sdk/transactionstransfers.d.ts +34 -0
- package/dist/sdk/transactionstransfers.js +262 -0
- package/docs/models/operations/{getaccountingcompanyinforequest.md → getaccountingprofilerequest.md} +1 -1
- package/docs/models/operations/{getaccountingcompanyinforesponse.md → getaccountingprofileresponse.md} +1 -1
- package/docs/models/operations/{getenhancedbalancesheetaccountsrequest.md → getcategorizedbalancesheetstatementrequest.md} +1 -1
- package/docs/models/operations/{getenhancedprofitandlossaccountsresponse.md → getcategorizedbalancesheetstatementresponse.md} +1 -1
- package/docs/models/operations/{getenhancedcashflowtransactionsrequest.md → getcategorizedbankstatementrequest.md} +1 -1
- package/docs/models/operations/{getenhancedcashflowtransactionsresponse.md → getcategorizedbankstatementresponse.md} +1 -1
- package/docs/models/operations/{getenhancedprofitandlossaccountsrequest.md → getcategorizedprofitandlossstatementrequest.md} +1 -1
- package/docs/models/operations/{getenhancedbalancesheetaccountsresponse.md → getcategorizedprofitandlossstatementresponse.md} +1 -1
- package/docs/models/operations/{getcommercecompanyinforequest.md → getcommerceprofilerequest.md} +1 -1
- package/docs/models/operations/{getcommercecompanyinforesponse.md → getcommerceprofileresponse.md} +1 -1
- package/docs/models/operations/{getcommercerefundsmetricsrequest.md → getcommercerefundsreportrequest.md} +1 -1
- package/docs/models/operations/{getcommercerefundsmetricsresponse.md → getcommercerefundsreportresponse.md} +1 -1
- package/docs/models/operations/{isageddebtorreportavailablerequest.md → isageddebtorsreportavailablerequest.md} +1 -1
- package/docs/models/operations/{isageddebtorreportavailableresponse.md → isageddebtorsreportavailableresponse.md} +2 -2
- package/docs/models/operations/{getenhancedinvoicesreportrequest.md → listreconciledinvoicesrequest.md} +1 -1
- package/docs/models/operations/{getenhancedinvoicesreportresponse.md → listreconciledinvoicesresponse.md} +1 -1
- package/docs/models/operations/unlinkconnectionrequest.md +5 -5
- package/docs/models/operations/unlinkconnectionupdateconnection.md +8 -0
- package/docs/models/shared/accountbalance.md +1 -1
- package/docs/models/shared/accountingaccounts.md +0 -2
- package/docs/models/shared/accountingaccounttransactions.md +0 -2
- package/docs/models/shared/accountingbankaccounts.md +0 -2
- package/docs/models/shared/accountingbanktransactions.md +0 -2
- package/docs/models/shared/accountingbill.md +1 -1
- package/docs/models/shared/accountingbillcreditnote.md +1 -1
- package/docs/models/shared/accountingbillcreditnotes.md +0 -2
- package/docs/models/shared/accountingbillpayment.md +1 -1
- package/docs/models/shared/accountingbillpayments.md +0 -2
- package/docs/models/shared/accountingbills.md +0 -2
- package/docs/models/shared/accountingcompanyinfo.md +1 -1
- package/docs/models/shared/accountingcompanyinfoaccountingaddress.md +14 -0
- package/docs/models/shared/accountingcreditnote.md +1 -1
- package/docs/models/shared/accountingcreditnotes.md +0 -2
- package/docs/models/shared/accountingcustomer.md +2 -2
- package/docs/models/shared/accountingcustomers.md +0 -2
- package/docs/models/shared/accountingdirectcost.md +1 -1
- package/docs/models/shared/accountingdirectcosts.md +0 -2
- package/docs/models/shared/accountingdirectincome.md +1 -1
- package/docs/models/shared/accountingdirectincomes.md +0 -2
- package/docs/models/shared/accountinginvoice.md +1 -1
- package/docs/models/shared/accountinginvoices.md +0 -2
- package/docs/models/shared/accountingjournalentries.md +0 -2
- package/docs/models/shared/accountingjournalentry.md +1 -1
- package/docs/models/shared/accountingjournals.md +0 -2
- package/docs/models/shared/accountingpayment.md +1 -1
- package/docs/models/shared/accountingpayments.md +0 -2
- package/docs/models/shared/accountingsupplier.md +16 -16
- package/docs/models/shared/accountingsuppliers.md +0 -2
- package/docs/models/shared/accountingtransfer.md +1 -1
- package/docs/models/shared/accountingtransfers.md +0 -2
- package/docs/models/shared/{accountingaddress.md → addressesitems.md} +1 -1
- package/docs/models/shared/attachments.md +0 -2
- package/docs/models/shared/bankingaccountbalances.md +0 -2
- package/docs/models/shared/bankingaccounts.md +0 -2
- package/docs/models/shared/bankingtransactioncategories.md +0 -2
- package/docs/models/shared/bankingtransactions.md +0 -2
- package/docs/models/shared/commercecustomers.md +0 -2
- package/docs/models/shared/commercedispute.md +1 -1
- package/docs/models/shared/commercedisputes.md +0 -2
- package/docs/models/shared/commercelocations.md +0 -2
- package/docs/models/shared/commerceorder.md +1 -1
- package/docs/models/shared/commerceorders.md +0 -2
- package/docs/models/shared/commerceordersupplementaldata.md +1 -1
- package/docs/models/shared/commercepaymentmethods.md +0 -2
- package/docs/models/shared/commercepayments.md +0 -2
- package/docs/models/shared/commerceproductcategories.md +0 -2
- package/docs/models/shared/commerceproducts.md +0 -2
- package/docs/models/shared/commercetransactions.md +0 -2
- package/docs/models/shared/companies.md +0 -2
- package/docs/models/shared/connections.md +0 -2
- package/docs/models/shared/contact.md +1 -1
- package/docs/models/shared/dataintegritydatatype.md +0 -2
- package/docs/models/shared/dataintegritydetails.md +0 -2
- package/docs/models/shared/dataintegritystatuses.md +0 -2
- package/docs/models/shared/dataintegritysummaries.md +0 -2
- package/docs/models/shared/enhancedfinancialreport.md +0 -2
- package/docs/models/shared/errormessage.md +0 -2
- package/docs/models/shared/excelstatus.md +0 -2
- package/docs/models/shared/loansummary.md +0 -2
- package/docs/models/shared/loantransactions.md +0 -2
- package/docs/models/shared/periodunit.md +0 -2
- package/docs/models/shared/pulloperations.md +0 -2
- package/docs/models/shared/supplementaldata.md +1 -1
- package/docs/sdks/accountingbankdata/README.md +2 -101
- package/docs/sdks/accountingbankdataaccounts/README.md +103 -0
- package/docs/sdks/accountspayable/README.md +2 -664
- package/docs/sdks/accountspayablebillcreditnotes/README.md +101 -0
- package/docs/sdks/accountspayablebillpayments/README.md +101 -0
- package/docs/sdks/accountspayablebills/README.md +148 -0
- package/docs/sdks/accountspayablesuppliers/README.md +244 -0
- package/docs/sdks/accountsreceivable/README.md +0 -1089
- package/docs/sdks/accountsreceivablecreditnotes/README.md +101 -0
- package/docs/sdks/accountsreceivablecustomers/README.md +244 -0
- package/docs/sdks/accountsreceivabledirectincomes/README.md +247 -0
- package/docs/sdks/{financials → accountsreceivableinvoices}/README.md +123 -111
- package/docs/sdks/accountsreceivablepayments/README.md +101 -0
- package/docs/sdks/accountsreceivablereports/README.md +172 -0
- package/docs/sdks/banking/README.md +4 -0
- package/docs/sdks/bankingaccountbalances/README.md +54 -0
- package/docs/sdks/bankingaccounts/README.md +103 -0
- package/docs/sdks/bankingcategorizedstatement/README.md +51 -0
- package/docs/sdks/bankingtransactioncategories/README.md +103 -0
- package/docs/sdks/bankingtransactions/README.md +103 -0
- package/docs/sdks/codatlending/README.md +24 -4
- package/docs/sdks/companies/README.md +1 -1
- package/docs/sdks/companyinfo/README.md +22 -22
- package/docs/sdks/connections/README.md +4 -3
- package/docs/sdks/dataintegrity/README.md +5 -5
- package/docs/sdks/excelreports/README.md +12 -4
- package/docs/sdks/fileupload/README.md +2 -2
- package/docs/sdks/financialstatements/README.md +4 -0
- package/docs/sdks/financialstatementsaccounts/README.md +100 -0
- package/docs/sdks/financialstatementsbalancesheet/README.md +91 -0
- package/docs/sdks/financialstatementscashflow/README.md +47 -0
- package/docs/sdks/financialstatementsprofitandloss/README.md +91 -0
- package/docs/sdks/liabilities/README.md +4 -4
- package/docs/sdks/managedata/README.md +3 -181
- package/docs/sdks/managedatapulloperations/README.md +89 -0
- package/docs/sdks/managedatarefresh/README.md +93 -0
- package/docs/sdks/sales/README.md +0 -1223
- package/docs/sdks/salescustomers/README.md +103 -0
- package/docs/sdks/salesdisputes/README.md +103 -0
- package/docs/sdks/saleslocations/README.md +99 -0
- package/docs/sdks/salesmetrics/README.md +218 -0
- package/docs/sdks/salesorders/README.md +103 -0
- package/docs/sdks/salespaymentmethods/README.md +103 -0
- package/docs/sdks/salespayments/README.md +103 -0
- package/docs/sdks/salesproductcategories/README.md +103 -0
- package/docs/sdks/salesproducts/README.md +103 -0
- package/docs/sdks/salesreports/README.md +145 -0
- package/docs/sdks/salestransactions/README.md +103 -0
- package/docs/sdks/transactions/README.md +0 -638
- package/docs/sdks/transactionsaccounttransactions/README.md +103 -0
- package/docs/sdks/transactionsdirectcosts/README.md +246 -0
- package/docs/sdks/transactionsjournalentries/README.md +101 -0
- package/docs/sdks/transactionsjournals/README.md +101 -0
- package/docs/sdks/transactionstransfers/README.md +103 -0
- package/package.json +1 -1
- package/dist/sdk/cashflow.d.ts +0 -112
- package/dist/sdk/financials.d.ts +0 -75
- package/docs/models/operations/unlinkconnectionrequestbody.md +0 -8
- package/docs/sdks/cashflow/README.md +0 -402
|
@@ -1,35 +1,29 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Financial data and reports from a linked accounting platform.
|
|
1
|
+
# accountsReceivableInvoices
|
|
6
2
|
|
|
7
3
|
### Available Operations
|
|
8
4
|
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [
|
|
14
|
-
* [
|
|
15
|
-
* [
|
|
5
|
+
* [downloadAttachment](#downloadattachment) - Download invoice attachment
|
|
6
|
+
* [downloadPdf](#downloadpdf) - Get invoice as PDF
|
|
7
|
+
* [get](#get) - Get invoice
|
|
8
|
+
* [getAttachment](#getattachment) - Get invoice attachment
|
|
9
|
+
* [list](#list) - List invoices
|
|
10
|
+
* [listAttachments](#listattachments) - List invoice attachments
|
|
11
|
+
* [listReconciled](#listreconciled) - List reconciled invoices
|
|
16
12
|
|
|
17
|
-
##
|
|
13
|
+
## downloadAttachment
|
|
18
14
|
|
|
19
|
-
The *
|
|
15
|
+
The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
|
|
20
16
|
|
|
21
|
-
[
|
|
17
|
+
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
22
18
|
|
|
23
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=
|
|
24
|
-
|
|
25
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
19
|
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.
|
|
26
20
|
|
|
27
21
|
|
|
28
22
|
### Example Usage
|
|
29
23
|
|
|
30
24
|
```typescript
|
|
31
25
|
import { CodatLending } from "@codat/lending";
|
|
32
|
-
import {
|
|
26
|
+
import { DownloadAccountingInvoiceAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
33
27
|
|
|
34
28
|
const sdk = new CodatLending({
|
|
35
29
|
security: {
|
|
@@ -37,10 +31,12 @@ const sdk = new CodatLending({
|
|
|
37
31
|
},
|
|
38
32
|
});
|
|
39
33
|
|
|
40
|
-
sdk.
|
|
41
|
-
|
|
34
|
+
sdk.accountsReceivableInvoices.downloadAttachment({
|
|
35
|
+
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
42
36
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
43
|
-
|
|
37
|
+
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
38
|
+
invoiceId: "porro",
|
|
39
|
+
}).then((res: DownloadAccountingInvoiceAttachmentResponse) => {
|
|
44
40
|
if (res.statusCode == 200) {
|
|
45
41
|
// handle response
|
|
46
42
|
}
|
|
@@ -49,27 +45,27 @@ sdk.financials.getAccount({
|
|
|
49
45
|
|
|
50
46
|
### Parameters
|
|
51
47
|
|
|
52
|
-
| Parameter
|
|
53
|
-
|
|
|
54
|
-
| `request`
|
|
55
|
-
| `retries`
|
|
56
|
-
| `config`
|
|
48
|
+
| Parameter | Type | Required | Description |
|
|
49
|
+
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
50
|
+
| `request` | [operations.DownloadAccountingInvoiceAttachmentRequest](../../models/operations/downloadaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
51
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
52
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
57
53
|
|
|
58
54
|
|
|
59
55
|
### Response
|
|
60
56
|
|
|
61
|
-
**Promise<[operations.
|
|
57
|
+
**Promise<[operations.DownloadAccountingInvoiceAttachmentResponse](../../models/operations/downloadaccountinginvoiceattachmentresponse.md)>**
|
|
62
58
|
|
|
63
59
|
|
|
64
|
-
##
|
|
60
|
+
## downloadPdf
|
|
65
61
|
|
|
66
|
-
|
|
62
|
+
Download invoice as a pdf.
|
|
67
63
|
|
|
68
64
|
### Example Usage
|
|
69
65
|
|
|
70
66
|
```typescript
|
|
71
67
|
import { CodatLending } from "@codat/lending";
|
|
72
|
-
import {
|
|
68
|
+
import { DownloadAccountingInvoicePdfResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
73
69
|
|
|
74
70
|
const sdk = new CodatLending({
|
|
75
71
|
security: {
|
|
@@ -77,12 +73,10 @@ const sdk = new CodatLending({
|
|
|
77
73
|
},
|
|
78
74
|
});
|
|
79
75
|
|
|
80
|
-
sdk.
|
|
76
|
+
sdk.accountsReceivableInvoices.downloadPdf({
|
|
81
77
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
startMonth: "2022-10-23T00:00:00.000Z",
|
|
85
|
-
}).then((res: GetAccountingBalanceSheetResponse) => {
|
|
78
|
+
invoiceId: "dolorum",
|
|
79
|
+
}).then((res: DownloadAccountingInvoicePdfResponse) => {
|
|
86
80
|
if (res.statusCode == 200) {
|
|
87
81
|
// handle response
|
|
88
82
|
}
|
|
@@ -91,27 +85,33 @@ sdk.financials.getBalanceSheet({
|
|
|
91
85
|
|
|
92
86
|
### Parameters
|
|
93
87
|
|
|
94
|
-
| Parameter
|
|
95
|
-
|
|
|
96
|
-
| `request`
|
|
97
|
-
| `retries`
|
|
98
|
-
| `config`
|
|
88
|
+
| Parameter | Type | Required | Description |
|
|
89
|
+
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
90
|
+
| `request` | [operations.DownloadAccountingInvoicePdfRequest](../../models/operations/downloadaccountinginvoicepdfrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
91
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
92
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
99
93
|
|
|
100
94
|
|
|
101
95
|
### Response
|
|
102
96
|
|
|
103
|
-
**Promise<[operations.
|
|
97
|
+
**Promise<[operations.DownloadAccountingInvoicePdfResponse](../../models/operations/downloadaccountinginvoicepdfresponse.md)>**
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## get
|
|
104
101
|
|
|
102
|
+
The *Get invoice* endpoint returns a single invoice for a given invoiceId.
|
|
105
103
|
|
|
106
|
-
|
|
104
|
+
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
107
105
|
|
|
108
|
-
|
|
106
|
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.
|
|
107
|
+
|
|
108
|
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
109
109
|
|
|
110
110
|
### Example Usage
|
|
111
111
|
|
|
112
112
|
```typescript
|
|
113
113
|
import { CodatLending } from "@codat/lending";
|
|
114
|
-
import {
|
|
114
|
+
import { GetAccountingInvoiceResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
115
115
|
|
|
116
116
|
const sdk = new CodatLending({
|
|
117
117
|
security: {
|
|
@@ -119,12 +119,10 @@ const sdk = new CodatLending({
|
|
|
119
119
|
},
|
|
120
120
|
});
|
|
121
121
|
|
|
122
|
-
sdk.
|
|
122
|
+
sdk.accountsReceivableInvoices.get({
|
|
123
123
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
startMonth: "2022-10-23T00:00:00.000Z",
|
|
127
|
-
}).then((res: GetAccountingCashFlowStatementResponse) => {
|
|
124
|
+
invoiceId: "dicta",
|
|
125
|
+
}).then((res: GetAccountingInvoiceResponse) => {
|
|
128
126
|
if (res.statusCode == 200) {
|
|
129
127
|
// handle response
|
|
130
128
|
}
|
|
@@ -133,29 +131,32 @@ sdk.financials.getCashFlowStatement({
|
|
|
133
131
|
|
|
134
132
|
### Parameters
|
|
135
133
|
|
|
136
|
-
| Parameter
|
|
137
|
-
|
|
|
138
|
-
| `request`
|
|
139
|
-
| `retries`
|
|
140
|
-
| `config`
|
|
134
|
+
| Parameter | Type | Required | Description |
|
|
135
|
+
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
136
|
+
| `request` | [operations.GetAccountingInvoiceRequest](../../models/operations/getaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
137
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
138
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
141
139
|
|
|
142
140
|
|
|
143
141
|
### Response
|
|
144
142
|
|
|
145
|
-
**Promise<[operations.
|
|
143
|
+
**Promise<[operations.GetAccountingInvoiceResponse](../../models/operations/getaccountinginvoiceresponse.md)>**
|
|
146
144
|
|
|
147
145
|
|
|
148
|
-
##
|
|
146
|
+
## getAttachment
|
|
149
147
|
|
|
150
|
-
|
|
148
|
+
The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
|
|
149
|
+
|
|
150
|
+
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
151
|
+
|
|
152
|
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.
|
|
151
153
|
|
|
152
|
-
Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/enhanced-financials/overview#categorize-accounts) to a more suitable one.
|
|
153
154
|
|
|
154
155
|
### Example Usage
|
|
155
156
|
|
|
156
157
|
```typescript
|
|
157
158
|
import { CodatLending } from "@codat/lending";
|
|
158
|
-
import {
|
|
159
|
+
import { GetAccountingInvoiceAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
159
160
|
|
|
160
161
|
const sdk = new CodatLending({
|
|
161
162
|
security: {
|
|
@@ -163,11 +164,12 @@ const sdk = new CodatLending({
|
|
|
163
164
|
},
|
|
164
165
|
});
|
|
165
166
|
|
|
166
|
-
sdk.
|
|
167
|
+
sdk.accountsReceivableInvoices.getAttachment({
|
|
168
|
+
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
167
169
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
}).then((res:
|
|
170
|
+
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
171
|
+
invoiceId: "nam",
|
|
172
|
+
}).then((res: GetAccountingInvoiceAttachmentResponse) => {
|
|
171
173
|
if (res.statusCode == 200) {
|
|
172
174
|
// handle response
|
|
173
175
|
}
|
|
@@ -176,29 +178,38 @@ sdk.financials.getEnhancedBalanceSheetAccounts({
|
|
|
176
178
|
|
|
177
179
|
### Parameters
|
|
178
180
|
|
|
179
|
-
| Parameter
|
|
180
|
-
|
|
|
181
|
-
| `request`
|
|
182
|
-
| `retries`
|
|
183
|
-
| `config`
|
|
181
|
+
| Parameter | Type | Required | Description |
|
|
182
|
+
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
183
|
+
| `request` | [operations.GetAccountingInvoiceAttachmentRequest](../../models/operations/getaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
184
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
185
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
184
186
|
|
|
185
187
|
|
|
186
188
|
### Response
|
|
187
189
|
|
|
188
|
-
**Promise<[operations.
|
|
190
|
+
**Promise<[operations.GetAccountingInvoiceAttachmentResponse](../../models/operations/getaccountinginvoiceattachmentresponse.md)>**
|
|
189
191
|
|
|
190
192
|
|
|
191
|
-
##
|
|
193
|
+
## list
|
|
192
194
|
|
|
193
|
-
|
|
195
|
+
The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.
|
|
194
196
|
|
|
195
|
-
|
|
197
|
+
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
198
|
+
|
|
199
|
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
200
|
+
|
|
201
|
+
### Useful queries
|
|
202
|
+
|
|
203
|
+
- Outstanding invoices - `query = amountDue > 0`
|
|
204
|
+
- Invoices due after a certain date: `query = dueDate > 2021-01-28`
|
|
205
|
+
|
|
206
|
+
[Read more about querying](https://docs.codat.io/using-the-api/querying).
|
|
196
207
|
|
|
197
208
|
### Example Usage
|
|
198
209
|
|
|
199
210
|
```typescript
|
|
200
211
|
import { CodatLending } from "@codat/lending";
|
|
201
|
-
import {
|
|
212
|
+
import { ListAccountingInvoicesResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
202
213
|
|
|
203
214
|
const sdk = new CodatLending({
|
|
204
215
|
security: {
|
|
@@ -206,11 +217,13 @@ const sdk = new CodatLending({
|
|
|
206
217
|
},
|
|
207
218
|
});
|
|
208
219
|
|
|
209
|
-
sdk.
|
|
220
|
+
sdk.accountsReceivableInvoices.list({
|
|
210
221
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
222
|
+
orderBy: "-modifiedDate",
|
|
223
|
+
page: 1,
|
|
224
|
+
pageSize: 100,
|
|
225
|
+
query: "officia",
|
|
226
|
+
}).then((res: ListAccountingInvoicesResponse) => {
|
|
214
227
|
if (res.statusCode == 200) {
|
|
215
228
|
// handle response
|
|
216
229
|
}
|
|
@@ -219,27 +232,32 @@ sdk.financials.getEnhancedProfitAndLossAccounts({
|
|
|
219
232
|
|
|
220
233
|
### Parameters
|
|
221
234
|
|
|
222
|
-
| Parameter
|
|
223
|
-
|
|
|
224
|
-
| `request`
|
|
225
|
-
| `retries`
|
|
226
|
-
| `config`
|
|
235
|
+
| Parameter | Type | Required | Description |
|
|
236
|
+
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
237
|
+
| `request` | [operations.ListAccountingInvoicesRequest](../../models/operations/listaccountinginvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
238
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
239
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
227
240
|
|
|
228
241
|
|
|
229
242
|
### Response
|
|
230
243
|
|
|
231
|
-
**Promise<[operations.
|
|
244
|
+
**Promise<[operations.ListAccountingInvoicesResponse](../../models/operations/listaccountinginvoicesresponse.md)>**
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## listAttachments
|
|
232
248
|
|
|
249
|
+
The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
|
|
233
250
|
|
|
234
|
-
|
|
251
|
+
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
252
|
+
|
|
253
|
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.
|
|
235
254
|
|
|
236
|
-
Gets the latest profit and loss for a company.
|
|
237
255
|
|
|
238
256
|
### Example Usage
|
|
239
257
|
|
|
240
258
|
```typescript
|
|
241
259
|
import { CodatLending } from "@codat/lending";
|
|
242
|
-
import {
|
|
260
|
+
import { ListAccountingInvoiceAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
243
261
|
|
|
244
262
|
const sdk = new CodatLending({
|
|
245
263
|
security: {
|
|
@@ -247,12 +265,11 @@ const sdk = new CodatLending({
|
|
|
247
265
|
},
|
|
248
266
|
});
|
|
249
267
|
|
|
250
|
-
sdk.
|
|
268
|
+
sdk.accountsReceivableInvoices.listAttachments({
|
|
251
269
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
}).then((res: GetAccountingProfitAndLossResponse) => {
|
|
270
|
+
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
271
|
+
invoiceId: "occaecati",
|
|
272
|
+
}).then((res: ListAccountingInvoiceAttachmentsResponse) => {
|
|
256
273
|
if (res.statusCode == 200) {
|
|
257
274
|
// handle response
|
|
258
275
|
}
|
|
@@ -261,31 +278,27 @@ sdk.financials.getProfitAndLoss({
|
|
|
261
278
|
|
|
262
279
|
### Parameters
|
|
263
280
|
|
|
264
|
-
| Parameter
|
|
265
|
-
|
|
|
266
|
-
| `request`
|
|
267
|
-
| `retries`
|
|
268
|
-
| `config`
|
|
281
|
+
| Parameter | Type | Required | Description |
|
|
282
|
+
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
283
|
+
| `request` | [operations.ListAccountingInvoiceAttachmentsRequest](../../models/operations/listaccountinginvoiceattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
284
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
285
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
269
286
|
|
|
270
287
|
|
|
271
288
|
### Response
|
|
272
289
|
|
|
273
|
-
**Promise<[operations.
|
|
274
|
-
|
|
290
|
+
**Promise<[operations.ListAccountingInvoiceAttachmentsResponse](../../models/operations/listaccountinginvoiceattachmentsresponse.md)>**
|
|
275
291
|
|
|
276
|
-
## listAccounts
|
|
277
292
|
|
|
278
|
-
|
|
293
|
+
## listReconciled
|
|
279
294
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
295
|
+
Gets a list of invoices linked to the corresponding banking transaction
|
|
283
296
|
|
|
284
297
|
### Example Usage
|
|
285
298
|
|
|
286
299
|
```typescript
|
|
287
300
|
import { CodatLending } from "@codat/lending";
|
|
288
|
-
import {
|
|
301
|
+
import { ListReconciledInvoicesResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
289
302
|
|
|
290
303
|
const sdk = new CodatLending({
|
|
291
304
|
security: {
|
|
@@ -293,13 +306,12 @@ const sdk = new CodatLending({
|
|
|
293
306
|
},
|
|
294
307
|
});
|
|
295
308
|
|
|
296
|
-
sdk.
|
|
309
|
+
sdk.accountsReceivableInvoices.listReconciled({
|
|
297
310
|
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
298
|
-
orderBy: "-modifiedDate",
|
|
299
311
|
page: 1,
|
|
300
312
|
pageSize: 100,
|
|
301
|
-
query: "
|
|
302
|
-
}).then((res:
|
|
313
|
+
query: "fugit",
|
|
314
|
+
}).then((res: ListReconciledInvoicesResponse) => {
|
|
303
315
|
if (res.statusCode == 200) {
|
|
304
316
|
// handle response
|
|
305
317
|
}
|
|
@@ -310,12 +322,12 @@ sdk.financials.listAccounts({
|
|
|
310
322
|
|
|
311
323
|
| Parameter | Type | Required | Description |
|
|
312
324
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
313
|
-
| `request` | [operations.
|
|
325
|
+
| `request` | [operations.ListReconciledInvoicesRequest](../../models/operations/listreconciledinvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
314
326
|
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
315
327
|
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
316
328
|
|
|
317
329
|
|
|
318
330
|
### Response
|
|
319
331
|
|
|
320
|
-
**Promise<[operations.
|
|
332
|
+
**Promise<[operations.ListReconciledInvoicesResponse](../../models/operations/listreconciledinvoicesresponse.md)>**
|
|
321
333
|
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# accountsReceivablePayments
|
|
2
|
+
|
|
3
|
+
### Available Operations
|
|
4
|
+
|
|
5
|
+
* [get](#get) - Get payment
|
|
6
|
+
* [list](#list) - List payments
|
|
7
|
+
|
|
8
|
+
## get
|
|
9
|
+
|
|
10
|
+
The *Get payment* endpoint returns a single payment for a given paymentId.
|
|
11
|
+
|
|
12
|
+
[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
|
|
13
|
+
|
|
14
|
+
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment.
|
|
15
|
+
|
|
16
|
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Example Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { CodatLending } from "@codat/lending";
|
|
23
|
+
import { GetAccountingPaymentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
24
|
+
|
|
25
|
+
const sdk = new CodatLending({
|
|
26
|
+
security: {
|
|
27
|
+
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
28
|
+
},
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
sdk.accountsReceivablePayments.get({
|
|
32
|
+
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
33
|
+
paymentId: "deleniti",
|
|
34
|
+
}).then((res: GetAccountingPaymentResponse) => {
|
|
35
|
+
if (res.statusCode == 200) {
|
|
36
|
+
// handle response
|
|
37
|
+
}
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
| Parameter | Type | Required | Description |
|
|
44
|
+
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
45
|
+
| `request` | [operations.GetAccountingPaymentRequest](../../models/operations/getaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
46
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
47
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Response
|
|
51
|
+
|
|
52
|
+
**Promise<[operations.GetAccountingPaymentResponse](../../models/operations/getaccountingpaymentresponse.md)>**
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## list
|
|
56
|
+
|
|
57
|
+
The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.
|
|
58
|
+
|
|
59
|
+
[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
|
|
60
|
+
|
|
61
|
+
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Example Usage
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
import { CodatLending } from "@codat/lending";
|
|
68
|
+
import { ListAccountingPaymentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
69
|
+
|
|
70
|
+
const sdk = new CodatLending({
|
|
71
|
+
security: {
|
|
72
|
+
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
73
|
+
},
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
sdk.accountsReceivablePayments.list({
|
|
77
|
+
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
78
|
+
orderBy: "-modifiedDate",
|
|
79
|
+
page: 1,
|
|
80
|
+
pageSize: 100,
|
|
81
|
+
query: "hic",
|
|
82
|
+
}).then((res: ListAccountingPaymentsResponse) => {
|
|
83
|
+
if (res.statusCode == 200) {
|
|
84
|
+
// handle response
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
| Parameter | Type | Required | Description |
|
|
92
|
+
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
93
|
+
| `request` | [operations.ListAccountingPaymentsRequest](../../models/operations/listaccountingpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
94
|
+
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
95
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
### Response
|
|
99
|
+
|
|
100
|
+
**Promise<[operations.ListAccountingPaymentsResponse](../../models/operations/listaccountingpaymentsresponse.md)>**
|
|
101
|
+
|