@codat/lending 0.1.0 → 1.2.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 +312 -1
- 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,1093 +1,4 @@
|
|
|
1
1
|
# accountsReceivable
|
|
2
2
|
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Data from a linked accounting platform representing money owed to the business for sold goods or services.
|
|
6
|
-
|
|
7
3
|
### Available Operations
|
|
8
4
|
|
|
9
|
-
* [downloadCustomerAttachment](#downloadcustomerattachment) - Download customer attachment
|
|
10
|
-
* [downloadDirectIncomeAttachment](#downloaddirectincomeattachment) - Download direct income attachment
|
|
11
|
-
* [downloadInvoiceAttachment](#downloadinvoiceattachment) - Download invoice attachment
|
|
12
|
-
* [downloadInvoicePdf](#downloadinvoicepdf) - Get invoice as PDF
|
|
13
|
-
* [getAgedDebtorsReport](#getageddebtorsreport) - Aged debtors report
|
|
14
|
-
* [getCreditNote](#getcreditnote) - Get credit note
|
|
15
|
-
* [getCustomer](#getcustomer) - Get customer
|
|
16
|
-
* [getCustomerAttachment](#getcustomerattachment) - Get customer attachment
|
|
17
|
-
* [getDirectIncome](#getdirectincome) - Get direct income
|
|
18
|
-
* [getDirectIncomeAttachment](#getdirectincomeattachment) - Get direct income attachment
|
|
19
|
-
* [getEnhancedInvoicesReport](#getenhancedinvoicesreport) - Get enhanced invoices report
|
|
20
|
-
* [getInvoice](#getinvoice) - Get invoice
|
|
21
|
-
* [getInvoiceAttachment](#getinvoiceattachment) - Get invoice attachment
|
|
22
|
-
* [getPayment](#getpayment) - Get payment
|
|
23
|
-
* [isAgedDebtorReportAvailable](#isageddebtorreportavailable) - Aged debtors report available
|
|
24
|
-
* [listCreditNotes](#listcreditnotes) - List credit notes
|
|
25
|
-
* [listCustomerAttachments](#listcustomerattachments) - List customer attachments
|
|
26
|
-
* [listCustomers](#listcustomers) - List customers
|
|
27
|
-
* [listDirectIncomeAttachments](#listdirectincomeattachments) - List direct income attachments
|
|
28
|
-
* [listDirectIncomes](#listdirectincomes) - List direct incomes
|
|
29
|
-
* [listInvoiceAttachments](#listinvoiceattachments) - List invoice attachments
|
|
30
|
-
* [listInvoices](#listinvoices) - List invoices
|
|
31
|
-
* [listPayments](#listpayments) - List payments
|
|
32
|
-
|
|
33
|
-
## downloadCustomerAttachment
|
|
34
|
-
|
|
35
|
-
The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.
|
|
36
|
-
|
|
37
|
-
[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
|
|
38
|
-
|
|
39
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment.
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
### Example Usage
|
|
43
|
-
|
|
44
|
-
```typescript
|
|
45
|
-
import { CodatLending } from "@codat/lending";
|
|
46
|
-
import { DownloadAccountingCustomerAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
47
|
-
|
|
48
|
-
const sdk = new CodatLending({
|
|
49
|
-
security: {
|
|
50
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
51
|
-
},
|
|
52
|
-
});
|
|
53
|
-
|
|
54
|
-
sdk.accountsReceivable.downloadCustomerAttachment({
|
|
55
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
56
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
57
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
58
|
-
customerId: "molestiae",
|
|
59
|
-
}).then((res: DownloadAccountingCustomerAttachmentResponse) => {
|
|
60
|
-
if (res.statusCode == 200) {
|
|
61
|
-
// handle response
|
|
62
|
-
}
|
|
63
|
-
});
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### Parameters
|
|
67
|
-
|
|
68
|
-
| Parameter | Type | Required | Description |
|
|
69
|
-
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
70
|
-
| `request` | [operations.DownloadAccountingCustomerAttachmentRequest](../../models/operations/downloadaccountingcustomerattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
71
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
72
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
### Response
|
|
76
|
-
|
|
77
|
-
**Promise<[operations.DownloadAccountingCustomerAttachmentResponse](../../models/operations/downloadaccountingcustomerattachmentresponse.md)>**
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
## downloadDirectIncomeAttachment
|
|
81
|
-
|
|
82
|
-
The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.
|
|
83
|
-
|
|
84
|
-
[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
|
|
85
|
-
|
|
86
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment.
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
### Example Usage
|
|
90
|
-
|
|
91
|
-
```typescript
|
|
92
|
-
import { CodatLending } from "@codat/lending";
|
|
93
|
-
import { DownloadAccountingDirectIncomeAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
94
|
-
|
|
95
|
-
const sdk = new CodatLending({
|
|
96
|
-
security: {
|
|
97
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
98
|
-
},
|
|
99
|
-
});
|
|
100
|
-
|
|
101
|
-
sdk.accountsReceivable.downloadDirectIncomeAttachment({
|
|
102
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
103
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
104
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
105
|
-
directIncomeId: "minus",
|
|
106
|
-
}).then((res: DownloadAccountingDirectIncomeAttachmentResponse) => {
|
|
107
|
-
if (res.statusCode == 200) {
|
|
108
|
-
// handle response
|
|
109
|
-
}
|
|
110
|
-
});
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### Parameters
|
|
114
|
-
|
|
115
|
-
| Parameter | Type | Required | Description |
|
|
116
|
-
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
117
|
-
| `request` | [operations.DownloadAccountingDirectIncomeAttachmentRequest](../../models/operations/downloadaccountingdirectincomeattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
118
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
119
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
### Response
|
|
123
|
-
|
|
124
|
-
**Promise<[operations.DownloadAccountingDirectIncomeAttachmentResponse](../../models/operations/downloadaccountingdirectincomeattachmentresponse.md)>**
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
## downloadInvoiceAttachment
|
|
128
|
-
|
|
129
|
-
The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
|
|
130
|
-
|
|
131
|
-
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
132
|
-
|
|
133
|
-
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.
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
### Example Usage
|
|
137
|
-
|
|
138
|
-
```typescript
|
|
139
|
-
import { CodatLending } from "@codat/lending";
|
|
140
|
-
import { DownloadAccountingInvoiceAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
141
|
-
|
|
142
|
-
const sdk = new CodatLending({
|
|
143
|
-
security: {
|
|
144
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
145
|
-
},
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
sdk.accountsReceivable.downloadInvoiceAttachment({
|
|
149
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
150
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
151
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
152
|
-
invoiceId: "placeat",
|
|
153
|
-
}).then((res: DownloadAccountingInvoiceAttachmentResponse) => {
|
|
154
|
-
if (res.statusCode == 200) {
|
|
155
|
-
// handle response
|
|
156
|
-
}
|
|
157
|
-
});
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### Parameters
|
|
161
|
-
|
|
162
|
-
| Parameter | Type | Required | Description |
|
|
163
|
-
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
164
|
-
| `request` | [operations.DownloadAccountingInvoiceAttachmentRequest](../../models/operations/downloadaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
165
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
166
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
### Response
|
|
170
|
-
|
|
171
|
-
**Promise<[operations.DownloadAccountingInvoiceAttachmentResponse](../../models/operations/downloadaccountinginvoiceattachmentresponse.md)>**
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
## downloadInvoicePdf
|
|
175
|
-
|
|
176
|
-
Download invoice as a pdf.
|
|
177
|
-
|
|
178
|
-
### Example Usage
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
import { CodatLending } from "@codat/lending";
|
|
182
|
-
import { DownloadAccountingInvoicePdfResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
183
|
-
|
|
184
|
-
const sdk = new CodatLending({
|
|
185
|
-
security: {
|
|
186
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
187
|
-
},
|
|
188
|
-
});
|
|
189
|
-
|
|
190
|
-
sdk.accountsReceivable.downloadInvoicePdf({
|
|
191
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
192
|
-
invoiceId: "voluptatum",
|
|
193
|
-
}).then((res: DownloadAccountingInvoicePdfResponse) => {
|
|
194
|
-
if (res.statusCode == 200) {
|
|
195
|
-
// handle response
|
|
196
|
-
}
|
|
197
|
-
});
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Parameters
|
|
201
|
-
|
|
202
|
-
| Parameter | Type | Required | Description |
|
|
203
|
-
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
204
|
-
| `request` | [operations.DownloadAccountingInvoicePdfRequest](../../models/operations/downloadaccountinginvoicepdfrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
205
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
206
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
### Response
|
|
210
|
-
|
|
211
|
-
**Promise<[operations.DownloadAccountingInvoicePdfResponse](../../models/operations/downloadaccountinginvoicepdfresponse.md)>**
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
## getAgedDebtorsReport
|
|
215
|
-
|
|
216
|
-
Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time.
|
|
217
|
-
|
|
218
|
-
### Example Usage
|
|
219
|
-
|
|
220
|
-
```typescript
|
|
221
|
-
import { CodatLending } from "@codat/lending";
|
|
222
|
-
import { GetAccountingAgedDebtorsReportResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
223
|
-
import { RFCDate } from "@codat/lending/dist/sdk/types";
|
|
224
|
-
|
|
225
|
-
const sdk = new CodatLending({
|
|
226
|
-
security: {
|
|
227
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
228
|
-
},
|
|
229
|
-
});
|
|
230
|
-
|
|
231
|
-
sdk.accountsReceivable.getAgedDebtorsReport({
|
|
232
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
233
|
-
numberOfPeriods: 12,
|
|
234
|
-
periodLengthDays: 30,
|
|
235
|
-
reportDate: new RFCDate("2022-12-31"),
|
|
236
|
-
}).then((res: GetAccountingAgedDebtorsReportResponse) => {
|
|
237
|
-
if (res.statusCode == 200) {
|
|
238
|
-
// handle response
|
|
239
|
-
}
|
|
240
|
-
});
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
### Parameters
|
|
244
|
-
|
|
245
|
-
| Parameter | Type | Required | Description |
|
|
246
|
-
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
247
|
-
| `request` | [operations.GetAccountingAgedDebtorsReportRequest](../../models/operations/getaccountingageddebtorsreportrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
248
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
249
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
### Response
|
|
253
|
-
|
|
254
|
-
**Promise<[operations.GetAccountingAgedDebtorsReportResponse](../../models/operations/getaccountingageddebtorsreportresponse.md)>**
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
## getCreditNote
|
|
258
|
-
|
|
259
|
-
The *Get credit note* endpoint returns a single credit note for a given creditNoteId.
|
|
260
|
-
|
|
261
|
-
[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
|
|
262
|
-
|
|
263
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.
|
|
264
|
-
|
|
265
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
### Example Usage
|
|
269
|
-
|
|
270
|
-
```typescript
|
|
271
|
-
import { CodatLending } from "@codat/lending";
|
|
272
|
-
import { GetAccountingCreditNoteResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
273
|
-
|
|
274
|
-
const sdk = new CodatLending({
|
|
275
|
-
security: {
|
|
276
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
277
|
-
},
|
|
278
|
-
});
|
|
279
|
-
|
|
280
|
-
sdk.accountsReceivable.getCreditNote({
|
|
281
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
282
|
-
creditNoteId: "iusto",
|
|
283
|
-
}).then((res: GetAccountingCreditNoteResponse) => {
|
|
284
|
-
if (res.statusCode == 200) {
|
|
285
|
-
// handle response
|
|
286
|
-
}
|
|
287
|
-
});
|
|
288
|
-
```
|
|
289
|
-
|
|
290
|
-
### Parameters
|
|
291
|
-
|
|
292
|
-
| Parameter | Type | Required | Description |
|
|
293
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
294
|
-
| `request` | [operations.GetAccountingCreditNoteRequest](../../models/operations/getaccountingcreditnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
295
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
296
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
### Response
|
|
300
|
-
|
|
301
|
-
**Promise<[operations.GetAccountingCreditNoteResponse](../../models/operations/getaccountingcreditnoteresponse.md)>**
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
## getCustomer
|
|
305
|
-
|
|
306
|
-
The *Get customer* endpoint returns a single customer for a given customerId.
|
|
307
|
-
|
|
308
|
-
[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
|
|
309
|
-
|
|
310
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer.
|
|
311
|
-
|
|
312
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
### Example Usage
|
|
316
|
-
|
|
317
|
-
```typescript
|
|
318
|
-
import { CodatLending } from "@codat/lending";
|
|
319
|
-
import { GetAccountingCustomerResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
320
|
-
|
|
321
|
-
const sdk = new CodatLending({
|
|
322
|
-
security: {
|
|
323
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
324
|
-
},
|
|
325
|
-
});
|
|
326
|
-
|
|
327
|
-
sdk.accountsReceivable.getCustomer({
|
|
328
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
329
|
-
customerId: "excepturi",
|
|
330
|
-
}).then((res: GetAccountingCustomerResponse) => {
|
|
331
|
-
if (res.statusCode == 200) {
|
|
332
|
-
// handle response
|
|
333
|
-
}
|
|
334
|
-
});
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
### Parameters
|
|
338
|
-
|
|
339
|
-
| Parameter | Type | Required | Description |
|
|
340
|
-
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
341
|
-
| `request` | [operations.GetAccountingCustomerRequest](../../models/operations/getaccountingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
342
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
343
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
### Response
|
|
347
|
-
|
|
348
|
-
**Promise<[operations.GetAccountingCustomerResponse](../../models/operations/getaccountingcustomerresponse.md)>**
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
## getCustomerAttachment
|
|
352
|
-
|
|
353
|
-
The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.
|
|
354
|
-
|
|
355
|
-
[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
|
|
356
|
-
|
|
357
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment.
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
### Example Usage
|
|
361
|
-
|
|
362
|
-
```typescript
|
|
363
|
-
import { CodatLending } from "@codat/lending";
|
|
364
|
-
import { GetAccountingCustomerAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
365
|
-
|
|
366
|
-
const sdk = new CodatLending({
|
|
367
|
-
security: {
|
|
368
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
369
|
-
},
|
|
370
|
-
});
|
|
371
|
-
|
|
372
|
-
sdk.accountsReceivable.getCustomerAttachment({
|
|
373
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
374
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
375
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
376
|
-
customerId: "nisi",
|
|
377
|
-
}).then((res: GetAccountingCustomerAttachmentResponse) => {
|
|
378
|
-
if (res.statusCode == 200) {
|
|
379
|
-
// handle response
|
|
380
|
-
}
|
|
381
|
-
});
|
|
382
|
-
```
|
|
383
|
-
|
|
384
|
-
### Parameters
|
|
385
|
-
|
|
386
|
-
| Parameter | Type | Required | Description |
|
|
387
|
-
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
388
|
-
| `request` | [operations.GetAccountingCustomerAttachmentRequest](../../models/operations/getaccountingcustomerattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
389
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
390
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
### Response
|
|
394
|
-
|
|
395
|
-
**Promise<[operations.GetAccountingCustomerAttachmentResponse](../../models/operations/getaccountingcustomerattachmentresponse.md)>**
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
## getDirectIncome
|
|
399
|
-
|
|
400
|
-
The *Get direct income* endpoint returns a single direct income for a given directIncomeId.
|
|
401
|
-
|
|
402
|
-
[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
|
|
403
|
-
|
|
404
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income.
|
|
405
|
-
|
|
406
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
### Example Usage
|
|
410
|
-
|
|
411
|
-
```typescript
|
|
412
|
-
import { CodatLending } from "@codat/lending";
|
|
413
|
-
import { GetAccountingDirectIncomeResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
414
|
-
|
|
415
|
-
const sdk = new CodatLending({
|
|
416
|
-
security: {
|
|
417
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
418
|
-
},
|
|
419
|
-
});
|
|
420
|
-
|
|
421
|
-
sdk.accountsReceivable.getDirectIncome({
|
|
422
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
423
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
424
|
-
directIncomeId: "recusandae",
|
|
425
|
-
}).then((res: GetAccountingDirectIncomeResponse) => {
|
|
426
|
-
if (res.statusCode == 200) {
|
|
427
|
-
// handle response
|
|
428
|
-
}
|
|
429
|
-
});
|
|
430
|
-
```
|
|
431
|
-
|
|
432
|
-
### Parameters
|
|
433
|
-
|
|
434
|
-
| Parameter | Type | Required | Description |
|
|
435
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
436
|
-
| `request` | [operations.GetAccountingDirectIncomeRequest](../../models/operations/getaccountingdirectincomerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
437
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
438
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
### Response
|
|
442
|
-
|
|
443
|
-
**Promise<[operations.GetAccountingDirectIncomeResponse](../../models/operations/getaccountingdirectincomeresponse.md)>**
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
## getDirectIncomeAttachment
|
|
447
|
-
|
|
448
|
-
The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.
|
|
449
|
-
|
|
450
|
-
[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
|
|
451
|
-
|
|
452
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment.
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
### Example Usage
|
|
456
|
-
|
|
457
|
-
```typescript
|
|
458
|
-
import { CodatLending } from "@codat/lending";
|
|
459
|
-
import { GetAccountingDirectIncomeAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
460
|
-
|
|
461
|
-
const sdk = new CodatLending({
|
|
462
|
-
security: {
|
|
463
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
464
|
-
},
|
|
465
|
-
});
|
|
466
|
-
|
|
467
|
-
sdk.accountsReceivable.getDirectIncomeAttachment({
|
|
468
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
469
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
470
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
471
|
-
directIncomeId: "temporibus",
|
|
472
|
-
timeoutInMinutes: 71036,
|
|
473
|
-
}).then((res: GetAccountingDirectIncomeAttachmentResponse) => {
|
|
474
|
-
if (res.statusCode == 200) {
|
|
475
|
-
// handle response
|
|
476
|
-
}
|
|
477
|
-
});
|
|
478
|
-
```
|
|
479
|
-
|
|
480
|
-
### Parameters
|
|
481
|
-
|
|
482
|
-
| Parameter | Type | Required | Description |
|
|
483
|
-
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
484
|
-
| `request` | [operations.GetAccountingDirectIncomeAttachmentRequest](../../models/operations/getaccountingdirectincomeattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
485
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
486
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
### Response
|
|
490
|
-
|
|
491
|
-
**Promise<[operations.GetAccountingDirectIncomeAttachmentResponse](../../models/operations/getaccountingdirectincomeattachmentresponse.md)>**
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
## getEnhancedInvoicesReport
|
|
495
|
-
|
|
496
|
-
Gets a list of invoices linked to the corresponding banking transaction
|
|
497
|
-
|
|
498
|
-
### Example Usage
|
|
499
|
-
|
|
500
|
-
```typescript
|
|
501
|
-
import { CodatLending } from "@codat/lending";
|
|
502
|
-
import { GetEnhancedInvoicesReportResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
503
|
-
|
|
504
|
-
const sdk = new CodatLending({
|
|
505
|
-
security: {
|
|
506
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
507
|
-
},
|
|
508
|
-
});
|
|
509
|
-
|
|
510
|
-
sdk.accountsReceivable.getEnhancedInvoicesReport({
|
|
511
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
512
|
-
page: 1,
|
|
513
|
-
pageSize: 100,
|
|
514
|
-
query: "quis",
|
|
515
|
-
}).then((res: GetEnhancedInvoicesReportResponse) => {
|
|
516
|
-
if (res.statusCode == 200) {
|
|
517
|
-
// handle response
|
|
518
|
-
}
|
|
519
|
-
});
|
|
520
|
-
```
|
|
521
|
-
|
|
522
|
-
### Parameters
|
|
523
|
-
|
|
524
|
-
| Parameter | Type | Required | Description |
|
|
525
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
526
|
-
| `request` | [operations.GetEnhancedInvoicesReportRequest](../../models/operations/getenhancedinvoicesreportrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
527
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
528
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
### Response
|
|
532
|
-
|
|
533
|
-
**Promise<[operations.GetEnhancedInvoicesReportResponse](../../models/operations/getenhancedinvoicesreportresponse.md)>**
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
## getInvoice
|
|
537
|
-
|
|
538
|
-
The *Get invoice* endpoint returns a single invoice for a given invoiceId.
|
|
539
|
-
|
|
540
|
-
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
541
|
-
|
|
542
|
-
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.
|
|
543
|
-
|
|
544
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
### Example Usage
|
|
548
|
-
|
|
549
|
-
```typescript
|
|
550
|
-
import { CodatLending } from "@codat/lending";
|
|
551
|
-
import { GetAccountingInvoiceResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
552
|
-
|
|
553
|
-
const sdk = new CodatLending({
|
|
554
|
-
security: {
|
|
555
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
556
|
-
},
|
|
557
|
-
});
|
|
558
|
-
|
|
559
|
-
sdk.accountsReceivable.getInvoice({
|
|
560
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
561
|
-
invoiceId: "veritatis",
|
|
562
|
-
}).then((res: GetAccountingInvoiceResponse) => {
|
|
563
|
-
if (res.statusCode == 200) {
|
|
564
|
-
// handle response
|
|
565
|
-
}
|
|
566
|
-
});
|
|
567
|
-
```
|
|
568
|
-
|
|
569
|
-
### Parameters
|
|
570
|
-
|
|
571
|
-
| Parameter | Type | Required | Description |
|
|
572
|
-
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
573
|
-
| `request` | [operations.GetAccountingInvoiceRequest](../../models/operations/getaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
574
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
575
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
### Response
|
|
579
|
-
|
|
580
|
-
**Promise<[operations.GetAccountingInvoiceResponse](../../models/operations/getaccountinginvoiceresponse.md)>**
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
## getInvoiceAttachment
|
|
584
|
-
|
|
585
|
-
The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
|
|
586
|
-
|
|
587
|
-
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
588
|
-
|
|
589
|
-
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.
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
### Example Usage
|
|
593
|
-
|
|
594
|
-
```typescript
|
|
595
|
-
import { CodatLending } from "@codat/lending";
|
|
596
|
-
import { GetAccountingInvoiceAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
597
|
-
|
|
598
|
-
const sdk = new CodatLending({
|
|
599
|
-
security: {
|
|
600
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
601
|
-
},
|
|
602
|
-
});
|
|
603
|
-
|
|
604
|
-
sdk.accountsReceivable.getInvoiceAttachment({
|
|
605
|
-
attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
606
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
607
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
608
|
-
invoiceId: "deserunt",
|
|
609
|
-
}).then((res: GetAccountingInvoiceAttachmentResponse) => {
|
|
610
|
-
if (res.statusCode == 200) {
|
|
611
|
-
// handle response
|
|
612
|
-
}
|
|
613
|
-
});
|
|
614
|
-
```
|
|
615
|
-
|
|
616
|
-
### Parameters
|
|
617
|
-
|
|
618
|
-
| Parameter | Type | Required | Description |
|
|
619
|
-
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
620
|
-
| `request` | [operations.GetAccountingInvoiceAttachmentRequest](../../models/operations/getaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
621
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
622
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
### Response
|
|
626
|
-
|
|
627
|
-
**Promise<[operations.GetAccountingInvoiceAttachmentResponse](../../models/operations/getaccountinginvoiceattachmentresponse.md)>**
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
## getPayment
|
|
631
|
-
|
|
632
|
-
The *Get payment* endpoint returns a single payment for a given paymentId.
|
|
633
|
-
|
|
634
|
-
[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
|
|
635
|
-
|
|
636
|
-
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.
|
|
637
|
-
|
|
638
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
### Example Usage
|
|
642
|
-
|
|
643
|
-
```typescript
|
|
644
|
-
import { CodatLending } from "@codat/lending";
|
|
645
|
-
import { GetAccountingPaymentResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
646
|
-
|
|
647
|
-
const sdk = new CodatLending({
|
|
648
|
-
security: {
|
|
649
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
650
|
-
},
|
|
651
|
-
});
|
|
652
|
-
|
|
653
|
-
sdk.accountsReceivable.getPayment({
|
|
654
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
655
|
-
paymentId: "perferendis",
|
|
656
|
-
}).then((res: GetAccountingPaymentResponse) => {
|
|
657
|
-
if (res.statusCode == 200) {
|
|
658
|
-
// handle response
|
|
659
|
-
}
|
|
660
|
-
});
|
|
661
|
-
```
|
|
662
|
-
|
|
663
|
-
### Parameters
|
|
664
|
-
|
|
665
|
-
| Parameter | Type | Required | Description |
|
|
666
|
-
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
667
|
-
| `request` | [operations.GetAccountingPaymentRequest](../../models/operations/getaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
668
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
669
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
### Response
|
|
673
|
-
|
|
674
|
-
**Promise<[operations.GetAccountingPaymentResponse](../../models/operations/getaccountingpaymentresponse.md)>**
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
## isAgedDebtorReportAvailable
|
|
678
|
-
|
|
679
|
-
Indicates whether the aged debtor report is available for the company.
|
|
680
|
-
|
|
681
|
-
### Example Usage
|
|
682
|
-
|
|
683
|
-
```typescript
|
|
684
|
-
import { CodatLending } from "@codat/lending";
|
|
685
|
-
import { IsAgedDebtorReportAvailableResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
686
|
-
|
|
687
|
-
const sdk = new CodatLending({
|
|
688
|
-
security: {
|
|
689
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
690
|
-
},
|
|
691
|
-
});
|
|
692
|
-
|
|
693
|
-
sdk.accountsReceivable.isAgedDebtorReportAvailable({
|
|
694
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
695
|
-
}).then((res: IsAgedDebtorReportAvailableResponse) => {
|
|
696
|
-
if (res.statusCode == 200) {
|
|
697
|
-
// handle response
|
|
698
|
-
}
|
|
699
|
-
});
|
|
700
|
-
```
|
|
701
|
-
|
|
702
|
-
### Parameters
|
|
703
|
-
|
|
704
|
-
| Parameter | Type | Required | Description |
|
|
705
|
-
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
706
|
-
| `request` | [operations.IsAgedDebtorReportAvailableRequest](../../models/operations/isageddebtorreportavailablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
707
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
708
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
### Response
|
|
712
|
-
|
|
713
|
-
**Promise<[operations.IsAgedDebtorReportAvailableResponse](../../models/operations/isageddebtorreportavailableresponse.md)>**
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
## listCreditNotes
|
|
717
|
-
|
|
718
|
-
The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.
|
|
719
|
-
|
|
720
|
-
[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.
|
|
721
|
-
|
|
722
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
### Example Usage
|
|
726
|
-
|
|
727
|
-
```typescript
|
|
728
|
-
import { CodatLending } from "@codat/lending";
|
|
729
|
-
import { ListAccountingCreditNotesResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
730
|
-
|
|
731
|
-
const sdk = new CodatLending({
|
|
732
|
-
security: {
|
|
733
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
734
|
-
},
|
|
735
|
-
});
|
|
736
|
-
|
|
737
|
-
sdk.accountsReceivable.listCreditNotes({
|
|
738
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
739
|
-
orderBy: "-modifiedDate",
|
|
740
|
-
page: 1,
|
|
741
|
-
pageSize: 100,
|
|
742
|
-
query: "ipsam",
|
|
743
|
-
}).then((res: ListAccountingCreditNotesResponse) => {
|
|
744
|
-
if (res.statusCode == 200) {
|
|
745
|
-
// handle response
|
|
746
|
-
}
|
|
747
|
-
});
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
### Parameters
|
|
751
|
-
|
|
752
|
-
| Parameter | Type | Required | Description |
|
|
753
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
754
|
-
| `request` | [operations.ListAccountingCreditNotesRequest](../../models/operations/listaccountingcreditnotesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
755
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
756
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
### Response
|
|
760
|
-
|
|
761
|
-
**Promise<[operations.ListAccountingCreditNotesResponse](../../models/operations/listaccountingcreditnotesresponse.md)>**
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
## listCustomerAttachments
|
|
765
|
-
|
|
766
|
-
The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.
|
|
767
|
-
|
|
768
|
-
[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
|
|
769
|
-
|
|
770
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments.
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
### Example Usage
|
|
774
|
-
|
|
775
|
-
```typescript
|
|
776
|
-
import { CodatLending } from "@codat/lending";
|
|
777
|
-
import { ListAccountingCustomerAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
778
|
-
|
|
779
|
-
const sdk = new CodatLending({
|
|
780
|
-
security: {
|
|
781
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
782
|
-
},
|
|
783
|
-
});
|
|
784
|
-
|
|
785
|
-
sdk.accountsReceivable.listCustomerAttachments({
|
|
786
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
787
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
788
|
-
customerId: "repellendus",
|
|
789
|
-
}).then((res: ListAccountingCustomerAttachmentsResponse) => {
|
|
790
|
-
if (res.statusCode == 200) {
|
|
791
|
-
// handle response
|
|
792
|
-
}
|
|
793
|
-
});
|
|
794
|
-
```
|
|
795
|
-
|
|
796
|
-
### Parameters
|
|
797
|
-
|
|
798
|
-
| Parameter | Type | Required | Description |
|
|
799
|
-
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
800
|
-
| `request` | [operations.ListAccountingCustomerAttachmentsRequest](../../models/operations/listaccountingcustomerattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
801
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
802
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
### Response
|
|
806
|
-
|
|
807
|
-
**Promise<[operations.ListAccountingCustomerAttachmentsResponse](../../models/operations/listaccountingcustomerattachmentsresponse.md)>**
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
## listCustomers
|
|
811
|
-
|
|
812
|
-
The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.
|
|
813
|
-
|
|
814
|
-
[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.
|
|
815
|
-
|
|
816
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
### Example Usage
|
|
820
|
-
|
|
821
|
-
```typescript
|
|
822
|
-
import { CodatLending } from "@codat/lending";
|
|
823
|
-
import { ListAccountingCustomersResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
824
|
-
|
|
825
|
-
const sdk = new CodatLending({
|
|
826
|
-
security: {
|
|
827
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
828
|
-
},
|
|
829
|
-
});
|
|
830
|
-
|
|
831
|
-
sdk.accountsReceivable.listCustomers({
|
|
832
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
833
|
-
orderBy: "-modifiedDate",
|
|
834
|
-
page: 1,
|
|
835
|
-
pageSize: 100,
|
|
836
|
-
query: "sapiente",
|
|
837
|
-
}).then((res: ListAccountingCustomersResponse) => {
|
|
838
|
-
if (res.statusCode == 200) {
|
|
839
|
-
// handle response
|
|
840
|
-
}
|
|
841
|
-
});
|
|
842
|
-
```
|
|
843
|
-
|
|
844
|
-
### Parameters
|
|
845
|
-
|
|
846
|
-
| Parameter | Type | Required | Description |
|
|
847
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
848
|
-
| `request` | [operations.ListAccountingCustomersRequest](../../models/operations/listaccountingcustomersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
849
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
850
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
### Response
|
|
854
|
-
|
|
855
|
-
**Promise<[operations.ListAccountingCustomersResponse](../../models/operations/listaccountingcustomersresponse.md)>**
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
## listDirectIncomeAttachments
|
|
859
|
-
|
|
860
|
-
The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.
|
|
861
|
-
|
|
862
|
-
[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
|
|
863
|
-
|
|
864
|
-
Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments.
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
### Example Usage
|
|
868
|
-
|
|
869
|
-
```typescript
|
|
870
|
-
import { CodatLending } from "@codat/lending";
|
|
871
|
-
import { ListAccountingDirectIncomeAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
872
|
-
|
|
873
|
-
const sdk = new CodatLending({
|
|
874
|
-
security: {
|
|
875
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
876
|
-
},
|
|
877
|
-
});
|
|
878
|
-
|
|
879
|
-
sdk.accountsReceivable.listDirectIncomeAttachments({
|
|
880
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
881
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
882
|
-
directIncomeId: "quo",
|
|
883
|
-
}).then((res: ListAccountingDirectIncomeAttachmentsResponse) => {
|
|
884
|
-
if (res.statusCode == 200) {
|
|
885
|
-
// handle response
|
|
886
|
-
}
|
|
887
|
-
});
|
|
888
|
-
```
|
|
889
|
-
|
|
890
|
-
### Parameters
|
|
891
|
-
|
|
892
|
-
| Parameter | Type | Required | Description |
|
|
893
|
-
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
894
|
-
| `request` | [operations.ListAccountingDirectIncomeAttachmentsRequest](../../models/operations/listaccountingdirectincomeattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
895
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
896
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
### Response
|
|
900
|
-
|
|
901
|
-
**Promise<[operations.ListAccountingDirectIncomeAttachmentsResponse](../../models/operations/listaccountingdirectincomeattachmentsresponse.md)>**
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
## listDirectIncomes
|
|
905
|
-
|
|
906
|
-
The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection.
|
|
907
|
-
|
|
908
|
-
[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.
|
|
909
|
-
|
|
910
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
### Example Usage
|
|
914
|
-
|
|
915
|
-
```typescript
|
|
916
|
-
import { CodatLending } from "@codat/lending";
|
|
917
|
-
import { ListAccountingDirectIncomesResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
918
|
-
|
|
919
|
-
const sdk = new CodatLending({
|
|
920
|
-
security: {
|
|
921
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
922
|
-
},
|
|
923
|
-
});
|
|
924
|
-
|
|
925
|
-
sdk.accountsReceivable.listDirectIncomes({
|
|
926
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
927
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
928
|
-
orderBy: "-modifiedDate",
|
|
929
|
-
page: 1,
|
|
930
|
-
pageSize: 100,
|
|
931
|
-
query: "odit",
|
|
932
|
-
}).then((res: ListAccountingDirectIncomesResponse) => {
|
|
933
|
-
if (res.statusCode == 200) {
|
|
934
|
-
// handle response
|
|
935
|
-
}
|
|
936
|
-
});
|
|
937
|
-
```
|
|
938
|
-
|
|
939
|
-
### Parameters
|
|
940
|
-
|
|
941
|
-
| Parameter | Type | Required | Description |
|
|
942
|
-
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
943
|
-
| `request` | [operations.ListAccountingDirectIncomesRequest](../../models/operations/listaccountingdirectincomesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
944
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
945
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
### Response
|
|
949
|
-
|
|
950
|
-
**Promise<[operations.ListAccountingDirectIncomesResponse](../../models/operations/listaccountingdirectincomesresponse.md)>**
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
## listInvoiceAttachments
|
|
954
|
-
|
|
955
|
-
The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
|
|
956
|
-
|
|
957
|
-
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
958
|
-
|
|
959
|
-
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.
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
### Example Usage
|
|
963
|
-
|
|
964
|
-
```typescript
|
|
965
|
-
import { CodatLending } from "@codat/lending";
|
|
966
|
-
import { ListAccountingInvoiceAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
967
|
-
|
|
968
|
-
const sdk = new CodatLending({
|
|
969
|
-
security: {
|
|
970
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
971
|
-
},
|
|
972
|
-
});
|
|
973
|
-
|
|
974
|
-
sdk.accountsReceivable.listInvoiceAttachments({
|
|
975
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
976
|
-
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
|
|
977
|
-
invoiceId: "at",
|
|
978
|
-
}).then((res: ListAccountingInvoiceAttachmentsResponse) => {
|
|
979
|
-
if (res.statusCode == 200) {
|
|
980
|
-
// handle response
|
|
981
|
-
}
|
|
982
|
-
});
|
|
983
|
-
```
|
|
984
|
-
|
|
985
|
-
### Parameters
|
|
986
|
-
|
|
987
|
-
| Parameter | Type | Required | Description |
|
|
988
|
-
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
989
|
-
| `request` | [operations.ListAccountingInvoiceAttachmentsRequest](../../models/operations/listaccountinginvoiceattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
990
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
991
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
### Response
|
|
995
|
-
|
|
996
|
-
**Promise<[operations.ListAccountingInvoiceAttachmentsResponse](../../models/operations/listaccountinginvoiceattachmentsresponse.md)>**
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
## listInvoices
|
|
1000
|
-
|
|
1001
|
-
The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.
|
|
1002
|
-
|
|
1003
|
-
[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
|
|
1004
|
-
|
|
1005
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
### Example Usage
|
|
1009
|
-
|
|
1010
|
-
```typescript
|
|
1011
|
-
import { CodatLending } from "@codat/lending";
|
|
1012
|
-
import { ListAccountingInvoicesResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
1013
|
-
|
|
1014
|
-
const sdk = new CodatLending({
|
|
1015
|
-
security: {
|
|
1016
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
1017
|
-
},
|
|
1018
|
-
});
|
|
1019
|
-
|
|
1020
|
-
sdk.accountsReceivable.listInvoices({
|
|
1021
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
1022
|
-
orderBy: "-modifiedDate",
|
|
1023
|
-
page: 1,
|
|
1024
|
-
pageSize: 100,
|
|
1025
|
-
query: "at",
|
|
1026
|
-
}).then((res: ListAccountingInvoicesResponse) => {
|
|
1027
|
-
if (res.statusCode == 200) {
|
|
1028
|
-
// handle response
|
|
1029
|
-
}
|
|
1030
|
-
});
|
|
1031
|
-
```
|
|
1032
|
-
|
|
1033
|
-
### Parameters
|
|
1034
|
-
|
|
1035
|
-
| Parameter | Type | Required | Description |
|
|
1036
|
-
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
1037
|
-
| `request` | [operations.ListAccountingInvoicesRequest](../../models/operations/listaccountinginvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1038
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
1039
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
### Response
|
|
1043
|
-
|
|
1044
|
-
**Promise<[operations.ListAccountingInvoicesResponse](../../models/operations/listaccountinginvoicesresponse.md)>**
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
## listPayments
|
|
1048
|
-
|
|
1049
|
-
The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.
|
|
1050
|
-
|
|
1051
|
-
[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.
|
|
1052
|
-
|
|
1053
|
-
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
### Example Usage
|
|
1057
|
-
|
|
1058
|
-
```typescript
|
|
1059
|
-
import { CodatLending } from "@codat/lending";
|
|
1060
|
-
import { ListAccountingPaymentsResponse } from "@codat/lending/dist/sdk/models/operations";
|
|
1061
|
-
|
|
1062
|
-
const sdk = new CodatLending({
|
|
1063
|
-
security: {
|
|
1064
|
-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
|
|
1065
|
-
},
|
|
1066
|
-
});
|
|
1067
|
-
|
|
1068
|
-
sdk.accountsReceivable.listPayments({
|
|
1069
|
-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
|
|
1070
|
-
orderBy: "-modifiedDate",
|
|
1071
|
-
page: 1,
|
|
1072
|
-
pageSize: 100,
|
|
1073
|
-
query: "maiores",
|
|
1074
|
-
}).then((res: ListAccountingPaymentsResponse) => {
|
|
1075
|
-
if (res.statusCode == 200) {
|
|
1076
|
-
// handle response
|
|
1077
|
-
}
|
|
1078
|
-
});
|
|
1079
|
-
```
|
|
1080
|
-
|
|
1081
|
-
### Parameters
|
|
1082
|
-
|
|
1083
|
-
| Parameter | Type | Required | Description |
|
|
1084
|
-
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
1085
|
-
| `request` | [operations.ListAccountingPaymentsRequest](../../models/operations/listaccountingpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1086
|
-
| `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
1087
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
### Response
|
|
1091
|
-
|
|
1092
|
-
**Promise<[operations.ListAccountingPaymentsResponse](../../models/operations/listaccountingpaymentsresponse.md)>**
|
|
1093
|
-
|