@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.
Files changed (389) hide show
  1. package/README.md +312 -1
  2. package/dist/internal/utils/requestbody.d.ts +1 -1
  3. package/dist/internal/utils/retries.d.ts +2 -2
  4. package/dist/internal/utils/security.d.ts +5 -2
  5. package/dist/internal/utils/security.js +28 -28
  6. package/dist/sdk/accountingbankdata.d.ts +2 -26
  7. package/dist/sdk/accountingbankdata.js +24 -146
  8. package/dist/sdk/accountingbankdataaccounts.d.ts +34 -0
  9. package/dist/sdk/accountingbankdataaccounts.js +262 -0
  10. package/dist/sdk/accountspayable.d.ts +8 -170
  11. package/dist/sdk/accountspayable.js +53 -983
  12. package/dist/sdk/accountspayablebillcreditnotes.d.ts +34 -0
  13. package/dist/sdk/accountspayablebillcreditnotes.js +262 -0
  14. package/dist/sdk/accountspayablebillpayments.d.ts +34 -0
  15. package/dist/sdk/accountspayablebillpayments.js +262 -0
  16. package/dist/sdk/accountspayablebills.d.ts +46 -0
  17. package/dist/sdk/accountspayablebills.js +348 -0
  18. package/dist/sdk/accountspayablesuppliers.d.ts +74 -0
  19. package/dist/sdk/accountspayablesuppliers.js +530 -0
  20. package/dist/sdk/accountsreceivable.d.ts +12 -284
  21. package/dist/sdk/accountsreceivable.js +13 -1677
  22. package/dist/sdk/accountsreceivablecreditnotes.d.ts +34 -0
  23. package/dist/sdk/accountsreceivablecreditnotes.js +262 -0
  24. package/dist/sdk/accountsreceivablecustomers.d.ts +74 -0
  25. package/dist/sdk/accountsreceivablecustomers.js +530 -0
  26. package/dist/sdk/accountsreceivabledirectincomes.d.ts +74 -0
  27. package/dist/sdk/{financials.js → accountsreceivabledirectincomes.js} +183 -211
  28. package/dist/sdk/accountsreceivableinvoices.d.ts +93 -0
  29. package/dist/sdk/{cashflow.js → accountsreceivableinvoices.js} +250 -189
  30. package/dist/sdk/accountsreceivablepayments.d.ts +34 -0
  31. package/dist/sdk/accountsreceivablepayments.js +262 -0
  32. package/dist/sdk/accountsreceivablereports.d.ts +36 -0
  33. package/dist/sdk/accountsreceivablereports.js +399 -0
  34. package/dist/sdk/banking.d.ts +15 -0
  35. package/dist/sdk/banking.js +23 -0
  36. package/dist/sdk/bankingaccountbalances.d.ts +20 -0
  37. package/dist/sdk/bankingaccountbalances.js +174 -0
  38. package/dist/sdk/bankingaccounts.d.ts +34 -0
  39. package/dist/sdk/bankingaccounts.js +254 -0
  40. package/dist/sdk/bankingcategorizedstatement.d.ts +19 -0
  41. package/dist/sdk/bankingcategorizedstatement.js +173 -0
  42. package/dist/sdk/bankingtransactioncategories.d.ts +34 -0
  43. package/dist/sdk/bankingtransactioncategories.js +254 -0
  44. package/dist/sdk/bankingtransactions.d.ts +34 -0
  45. package/dist/sdk/bankingtransactions.js +254 -0
  46. package/dist/sdk/companies.js +110 -25
  47. package/dist/sdk/companyinfo.d.ts +4 -4
  48. package/dist/sdk/companyinfo.js +52 -18
  49. package/dist/sdk/connections.js +110 -25
  50. package/dist/sdk/dataintegrity.js +66 -15
  51. package/dist/sdk/excelreports.d.ts +10 -2
  52. package/dist/sdk/excelreports.js +76 -17
  53. package/dist/sdk/fileupload.js +66 -15
  54. package/dist/sdk/financialstatements.d.ts +13 -0
  55. package/dist/sdk/financialstatements.js +21 -0
  56. package/dist/sdk/financialstatementsaccounts.d.ts +33 -0
  57. package/dist/sdk/financialstatementsaccounts.js +261 -0
  58. package/dist/sdk/financialstatementsbalancesheet.d.ts +24 -0
  59. package/dist/sdk/financialstatementsbalancesheet.js +253 -0
  60. package/dist/sdk/financialstatementscashflow.d.ts +15 -0
  61. package/dist/sdk/financialstatementscashflow.js +169 -0
  62. package/dist/sdk/financialstatementsprofitandloss.d.ts +24 -0
  63. package/dist/sdk/financialstatementsprofitandloss.js +253 -0
  64. package/dist/sdk/liabilities.d.ts +4 -4
  65. package/dist/sdk/liabilities.js +48 -14
  66. package/dist/sdk/managedata.d.ts +5 -38
  67. package/dist/sdk/managedata.js +27 -267
  68. package/dist/sdk/managedatapulloperations.d.ts +22 -0
  69. package/dist/sdk/managedatapulloperations.js +250 -0
  70. package/dist/sdk/managedatarefresh.d.ts +28 -0
  71. package/dist/sdk/managedatarefresh.js +250 -0
  72. package/dist/sdk/models/operations/{getaccountingcompanyinfo.d.ts → getaccountingprofile.d.ts} +2 -2
  73. package/dist/sdk/models/operations/{getaccountingcompanyinfo.js → getaccountingprofile.js} +17 -17
  74. package/dist/sdk/models/operations/{getenhancedprofitandlossaccounts.d.ts → getcategorizedbalancesheetstatement.d.ts} +2 -2
  75. package/dist/sdk/models/operations/{getenhancedbalancesheetaccounts.js → getcategorizedbalancesheetstatement.js} +19 -19
  76. package/dist/sdk/models/operations/{getenhancedcashflowtransactions.d.ts → getcategorizedbankstatement.d.ts} +2 -2
  77. package/dist/sdk/models/operations/{getenhancedcashflowtransactions.js → getcategorizedbankstatement.js} +20 -20
  78. package/dist/sdk/models/operations/{getenhancedbalancesheetaccounts.d.ts → getcategorizedprofitandlossstatement.d.ts} +2 -2
  79. package/dist/sdk/models/operations/{getenhancedprofitandlossaccounts.js → getcategorizedprofitandlossstatement.js} +19 -19
  80. package/dist/sdk/models/operations/{getcommercecompanyinfo.d.ts → getcommerceprofile.d.ts} +2 -2
  81. package/dist/sdk/models/operations/{getcommercecompanyinfo.js → getcommerceprofile.js} +18 -18
  82. package/dist/sdk/models/operations/{getcommercerefundsmetrics.d.ts → getcommercerefundsreport.d.ts} +2 -2
  83. package/dist/sdk/models/operations/{getcommercerefundsmetrics.js → getcommercerefundsreport.js} +23 -23
  84. package/dist/sdk/models/operations/index.d.ts +8 -8
  85. package/dist/sdk/models/operations/index.js +8 -8
  86. package/dist/sdk/models/operations/{isageddebtorreportavailable.d.ts → isageddebtorsreportavailable.d.ts} +3 -3
  87. package/dist/sdk/models/operations/{isageddebtorreportavailable.js → isageddebtorsreportavailable.js} +16 -16
  88. package/dist/sdk/models/operations/{getenhancedinvoicesreport.d.ts → listreconciledinvoices.d.ts} +2 -2
  89. package/dist/sdk/models/operations/{getenhancedinvoicesreport.js → listreconciledinvoices.js} +20 -20
  90. package/dist/sdk/models/operations/unlinkconnection.d.ts +6 -3
  91. package/dist/sdk/models/operations/unlinkconnection.js +8 -8
  92. package/dist/sdk/models/shared/accountbalance.d.ts +1 -1
  93. package/dist/sdk/models/shared/accountbalance.js +1 -1
  94. package/dist/sdk/models/shared/accountingaccounts.d.ts +0 -3
  95. package/dist/sdk/models/shared/accountingaccounts.js +0 -3
  96. package/dist/sdk/models/shared/accountingaccounttransactions.d.ts +0 -3
  97. package/dist/sdk/models/shared/accountingaccounttransactions.js +0 -3
  98. package/dist/sdk/models/shared/accountingbankaccounts.d.ts +0 -3
  99. package/dist/sdk/models/shared/accountingbankaccounts.js +0 -3
  100. package/dist/sdk/models/shared/accountingbanktransactions.d.ts +0 -3
  101. package/dist/sdk/models/shared/accountingbanktransactions.js +0 -3
  102. package/dist/sdk/models/shared/accountingbill.d.ts +1 -1
  103. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +1 -1
  104. package/dist/sdk/models/shared/accountingbillcreditnotes.d.ts +0 -3
  105. package/dist/sdk/models/shared/accountingbillcreditnotes.js +0 -3
  106. package/dist/sdk/models/shared/accountingbillpayment.d.ts +1 -1
  107. package/dist/sdk/models/shared/accountingbillpayments.d.ts +0 -3
  108. package/dist/sdk/models/shared/accountingbillpayments.js +0 -3
  109. package/dist/sdk/models/shared/accountingbills.d.ts +0 -3
  110. package/dist/sdk/models/shared/accountingbills.js +0 -3
  111. package/dist/sdk/models/shared/accountingcompanyinfo.d.ts +32 -2
  112. package/dist/sdk/models/shared/accountingcompanyinfo.js +47 -4
  113. package/dist/sdk/models/shared/accountingcreditnote.d.ts +1 -1
  114. package/dist/sdk/models/shared/accountingcreditnotes.d.ts +0 -3
  115. package/dist/sdk/models/shared/accountingcreditnotes.js +0 -3
  116. package/dist/sdk/models/shared/accountingcustomer.d.ts +3 -3
  117. package/dist/sdk/models/shared/accountingcustomer.js +3 -3
  118. package/dist/sdk/models/shared/accountingcustomers.d.ts +0 -3
  119. package/dist/sdk/models/shared/accountingcustomers.js +0 -3
  120. package/dist/sdk/models/shared/accountingdirectcost.d.ts +1 -1
  121. package/dist/sdk/models/shared/accountingdirectcosts.d.ts +0 -3
  122. package/dist/sdk/models/shared/accountingdirectcosts.js +0 -3
  123. package/dist/sdk/models/shared/accountingdirectincome.d.ts +1 -1
  124. package/dist/sdk/models/shared/accountingdirectincomes.d.ts +0 -3
  125. package/dist/sdk/models/shared/accountingdirectincomes.js +0 -3
  126. package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -1
  127. package/dist/sdk/models/shared/accountinginvoices.d.ts +0 -3
  128. package/dist/sdk/models/shared/accountinginvoices.js +0 -3
  129. package/dist/sdk/models/shared/accountingjournalentries.d.ts +0 -3
  130. package/dist/sdk/models/shared/accountingjournalentries.js +0 -3
  131. package/dist/sdk/models/shared/accountingjournalentry.d.ts +1 -1
  132. package/dist/sdk/models/shared/accountingjournals.d.ts +0 -3
  133. package/dist/sdk/models/shared/accountingjournals.js +0 -3
  134. package/dist/sdk/models/shared/accountingpayment.d.ts +1 -1
  135. package/dist/sdk/models/shared/accountingpayments.d.ts +0 -3
  136. package/dist/sdk/models/shared/accountingpayments.js +0 -3
  137. package/dist/sdk/models/shared/accountingsupplier.d.ts +3 -3
  138. package/dist/sdk/models/shared/accountingsupplier.js +3 -3
  139. package/dist/sdk/models/shared/accountingsuppliers.d.ts +0 -3
  140. package/dist/sdk/models/shared/accountingsuppliers.js +0 -3
  141. package/dist/sdk/models/shared/accountingtransfer.d.ts +1 -1
  142. package/dist/sdk/models/shared/accountingtransfers.d.ts +0 -3
  143. package/dist/sdk/models/shared/accountingtransfers.js +0 -3
  144. package/dist/sdk/models/shared/{accountingaddress.d.ts → addressesitems.d.ts} +1 -1
  145. package/dist/sdk/models/shared/{accountingaddress.js → addressesitems.js} +13 -13
  146. package/dist/sdk/models/shared/attachments.d.ts +0 -3
  147. package/dist/sdk/models/shared/attachments.js +0 -3
  148. package/dist/sdk/models/shared/bankingaccountbalances.d.ts +0 -3
  149. package/dist/sdk/models/shared/bankingaccountbalances.js +0 -3
  150. package/dist/sdk/models/shared/bankingaccounts.d.ts +0 -3
  151. package/dist/sdk/models/shared/bankingaccounts.js +0 -3
  152. package/dist/sdk/models/shared/bankingtransactioncategories.d.ts +0 -3
  153. package/dist/sdk/models/shared/bankingtransactioncategories.js +0 -3
  154. package/dist/sdk/models/shared/bankingtransactions.d.ts +0 -3
  155. package/dist/sdk/models/shared/bankingtransactions.js +0 -3
  156. package/dist/sdk/models/shared/commercecustomers.d.ts +0 -3
  157. package/dist/sdk/models/shared/commercecustomers.js +0 -3
  158. package/dist/sdk/models/shared/commercedispute.d.ts +1 -1
  159. package/dist/sdk/models/shared/commercedispute.js +1 -1
  160. package/dist/sdk/models/shared/commercedisputes.d.ts +0 -3
  161. package/dist/sdk/models/shared/commercedisputes.js +0 -3
  162. package/dist/sdk/models/shared/commercelocations.d.ts +0 -3
  163. package/dist/sdk/models/shared/commercelocations.js +0 -3
  164. package/dist/sdk/models/shared/commerceorder.d.ts +2 -2
  165. package/dist/sdk/models/shared/commerceorder.js +1 -1
  166. package/dist/sdk/models/shared/commerceorders.d.ts +0 -3
  167. package/dist/sdk/models/shared/commerceorders.js +0 -3
  168. package/dist/sdk/models/shared/commercepaymentmethods.d.ts +0 -3
  169. package/dist/sdk/models/shared/commercepaymentmethods.js +0 -3
  170. package/dist/sdk/models/shared/commercepayments.d.ts +0 -3
  171. package/dist/sdk/models/shared/commercepayments.js +0 -3
  172. package/dist/sdk/models/shared/commerceproductcategories.d.ts +0 -3
  173. package/dist/sdk/models/shared/commerceproductcategories.js +0 -3
  174. package/dist/sdk/models/shared/commerceproducts.d.ts +0 -3
  175. package/dist/sdk/models/shared/commerceproducts.js +0 -3
  176. package/dist/sdk/models/shared/commercetransactions.d.ts +0 -3
  177. package/dist/sdk/models/shared/commercetransactions.js +0 -3
  178. package/dist/sdk/models/shared/companies.d.ts +0 -3
  179. package/dist/sdk/models/shared/companies.js +0 -3
  180. package/dist/sdk/models/shared/connections.d.ts +0 -3
  181. package/dist/sdk/models/shared/connections.js +0 -3
  182. package/dist/sdk/models/shared/contact.d.ts +2 -2
  183. package/dist/sdk/models/shared/contact.js +3 -3
  184. package/dist/sdk/models/shared/dataintegritydatatype.d.ts +0 -3
  185. package/dist/sdk/models/shared/dataintegritydatatype.js +0 -3
  186. package/dist/sdk/models/shared/dataintegritydetails.d.ts +0 -3
  187. package/dist/sdk/models/shared/dataintegritydetails.js +0 -3
  188. package/dist/sdk/models/shared/dataintegritystatuses.d.ts +0 -3
  189. package/dist/sdk/models/shared/dataintegritystatuses.js +0 -3
  190. package/dist/sdk/models/shared/dataintegritysummaries.d.ts +0 -3
  191. package/dist/sdk/models/shared/dataintegritysummaries.js +0 -3
  192. package/dist/sdk/models/shared/enhancedfinancialreport.d.ts +0 -3
  193. package/dist/sdk/models/shared/enhancedfinancialreport.js +0 -3
  194. package/dist/sdk/models/shared/errormessage.d.ts +0 -3
  195. package/dist/sdk/models/shared/errormessage.js +0 -3
  196. package/dist/sdk/models/shared/excelstatus.d.ts +0 -3
  197. package/dist/sdk/models/shared/excelstatus.js +0 -3
  198. package/dist/sdk/models/shared/index.d.ts +1 -1
  199. package/dist/sdk/models/shared/index.js +1 -1
  200. package/dist/sdk/models/shared/loansummary.d.ts +0 -3
  201. package/dist/sdk/models/shared/loansummary.js +0 -3
  202. package/dist/sdk/models/shared/loantransactions.d.ts +0 -3
  203. package/dist/sdk/models/shared/loantransactions.js +0 -3
  204. package/dist/sdk/models/shared/periodunit.d.ts +0 -3
  205. package/dist/sdk/models/shared/periodunit.js +0 -3
  206. package/dist/sdk/models/shared/pulloperations.d.ts +0 -3
  207. package/dist/sdk/models/shared/pulloperations.js +0 -3
  208. package/dist/sdk/models/shared/supplementaldata.d.ts +1 -1
  209. package/dist/sdk/models/shared/supplementaldata.js +1 -1
  210. package/dist/sdk/sales.d.ts +22 -372
  211. package/dist/sdk/sales.js +22 -1767
  212. package/dist/sdk/salescustomers.d.ts +34 -0
  213. package/dist/sdk/salescustomers.js +262 -0
  214. package/dist/sdk/salesdisputes.d.ts +34 -0
  215. package/dist/sdk/salesdisputes.js +262 -0
  216. package/dist/sdk/saleslocations.d.ts +34 -0
  217. package/dist/sdk/saleslocations.js +261 -0
  218. package/dist/sdk/salesmetrics.d.ts +102 -0
  219. package/dist/sdk/salesmetrics.js +406 -0
  220. package/dist/sdk/salesorders.d.ts +34 -0
  221. package/dist/sdk/salesorders.js +262 -0
  222. package/dist/sdk/salespaymentmethods.d.ts +34 -0
  223. package/dist/sdk/salespaymentmethods.js +262 -0
  224. package/dist/sdk/salespayments.d.ts +34 -0
  225. package/dist/sdk/salespayments.js +262 -0
  226. package/dist/sdk/salesproductcategories.d.ts +34 -0
  227. package/dist/sdk/salesproductcategories.js +262 -0
  228. package/dist/sdk/salesproducts.d.ts +34 -0
  229. package/dist/sdk/salesproducts.js +262 -0
  230. package/dist/sdk/salesreports.d.ts +69 -0
  231. package/dist/sdk/salesreports.js +298 -0
  232. package/dist/sdk/salestransactions.d.ts +34 -0
  233. package/dist/sdk/salestransactions.js +262 -0
  234. package/dist/sdk/sdk.d.ts +38 -30
  235. package/dist/sdk/sdk.js +33 -45
  236. package/dist/sdk/transactions.d.ts +10 -176
  237. package/dist/sdk/transactions.js +11 -1000
  238. package/dist/sdk/transactionsaccounttransactions.d.ts +34 -0
  239. package/dist/sdk/transactionsaccounttransactions.js +262 -0
  240. package/dist/sdk/transactionsdirectcosts.d.ts +74 -0
  241. package/dist/sdk/transactionsdirectcosts.js +530 -0
  242. package/dist/sdk/transactionsjournalentries.d.ts +34 -0
  243. package/dist/sdk/transactionsjournalentries.js +262 -0
  244. package/dist/sdk/transactionsjournals.d.ts +34 -0
  245. package/dist/sdk/transactionsjournals.js +262 -0
  246. package/dist/sdk/transactionstransfers.d.ts +34 -0
  247. package/dist/sdk/transactionstransfers.js +262 -0
  248. package/docs/models/operations/{getaccountingcompanyinforequest.md → getaccountingprofilerequest.md} +1 -1
  249. package/docs/models/operations/{getaccountingcompanyinforesponse.md → getaccountingprofileresponse.md} +1 -1
  250. package/docs/models/operations/{getenhancedbalancesheetaccountsrequest.md → getcategorizedbalancesheetstatementrequest.md} +1 -1
  251. package/docs/models/operations/{getenhancedprofitandlossaccountsresponse.md → getcategorizedbalancesheetstatementresponse.md} +1 -1
  252. package/docs/models/operations/{getenhancedcashflowtransactionsrequest.md → getcategorizedbankstatementrequest.md} +1 -1
  253. package/docs/models/operations/{getenhancedcashflowtransactionsresponse.md → getcategorizedbankstatementresponse.md} +1 -1
  254. package/docs/models/operations/{getenhancedprofitandlossaccountsrequest.md → getcategorizedprofitandlossstatementrequest.md} +1 -1
  255. package/docs/models/operations/{getenhancedbalancesheetaccountsresponse.md → getcategorizedprofitandlossstatementresponse.md} +1 -1
  256. package/docs/models/operations/{getcommercecompanyinforequest.md → getcommerceprofilerequest.md} +1 -1
  257. package/docs/models/operations/{getcommercecompanyinforesponse.md → getcommerceprofileresponse.md} +1 -1
  258. package/docs/models/operations/{getcommercerefundsmetricsrequest.md → getcommercerefundsreportrequest.md} +1 -1
  259. package/docs/models/operations/{getcommercerefundsmetricsresponse.md → getcommercerefundsreportresponse.md} +1 -1
  260. package/docs/models/operations/{isageddebtorreportavailablerequest.md → isageddebtorsreportavailablerequest.md} +1 -1
  261. package/docs/models/operations/{isageddebtorreportavailableresponse.md → isageddebtorsreportavailableresponse.md} +2 -2
  262. package/docs/models/operations/{getenhancedinvoicesreportrequest.md → listreconciledinvoicesrequest.md} +1 -1
  263. package/docs/models/operations/{getenhancedinvoicesreportresponse.md → listreconciledinvoicesresponse.md} +1 -1
  264. package/docs/models/operations/unlinkconnectionrequest.md +5 -5
  265. package/docs/models/operations/unlinkconnectionupdateconnection.md +8 -0
  266. package/docs/models/shared/accountbalance.md +1 -1
  267. package/docs/models/shared/accountingaccounts.md +0 -2
  268. package/docs/models/shared/accountingaccounttransactions.md +0 -2
  269. package/docs/models/shared/accountingbankaccounts.md +0 -2
  270. package/docs/models/shared/accountingbanktransactions.md +0 -2
  271. package/docs/models/shared/accountingbill.md +1 -1
  272. package/docs/models/shared/accountingbillcreditnote.md +1 -1
  273. package/docs/models/shared/accountingbillcreditnotes.md +0 -2
  274. package/docs/models/shared/accountingbillpayment.md +1 -1
  275. package/docs/models/shared/accountingbillpayments.md +0 -2
  276. package/docs/models/shared/accountingbills.md +0 -2
  277. package/docs/models/shared/accountingcompanyinfo.md +1 -1
  278. package/docs/models/shared/accountingcompanyinfoaccountingaddress.md +14 -0
  279. package/docs/models/shared/accountingcreditnote.md +1 -1
  280. package/docs/models/shared/accountingcreditnotes.md +0 -2
  281. package/docs/models/shared/accountingcustomer.md +2 -2
  282. package/docs/models/shared/accountingcustomers.md +0 -2
  283. package/docs/models/shared/accountingdirectcost.md +1 -1
  284. package/docs/models/shared/accountingdirectcosts.md +0 -2
  285. package/docs/models/shared/accountingdirectincome.md +1 -1
  286. package/docs/models/shared/accountingdirectincomes.md +0 -2
  287. package/docs/models/shared/accountinginvoice.md +1 -1
  288. package/docs/models/shared/accountinginvoices.md +0 -2
  289. package/docs/models/shared/accountingjournalentries.md +0 -2
  290. package/docs/models/shared/accountingjournalentry.md +1 -1
  291. package/docs/models/shared/accountingjournals.md +0 -2
  292. package/docs/models/shared/accountingpayment.md +1 -1
  293. package/docs/models/shared/accountingpayments.md +0 -2
  294. package/docs/models/shared/accountingsupplier.md +16 -16
  295. package/docs/models/shared/accountingsuppliers.md +0 -2
  296. package/docs/models/shared/accountingtransfer.md +1 -1
  297. package/docs/models/shared/accountingtransfers.md +0 -2
  298. package/docs/models/shared/{accountingaddress.md → addressesitems.md} +1 -1
  299. package/docs/models/shared/attachments.md +0 -2
  300. package/docs/models/shared/bankingaccountbalances.md +0 -2
  301. package/docs/models/shared/bankingaccounts.md +0 -2
  302. package/docs/models/shared/bankingtransactioncategories.md +0 -2
  303. package/docs/models/shared/bankingtransactions.md +0 -2
  304. package/docs/models/shared/commercecustomers.md +0 -2
  305. package/docs/models/shared/commercedispute.md +1 -1
  306. package/docs/models/shared/commercedisputes.md +0 -2
  307. package/docs/models/shared/commercelocations.md +0 -2
  308. package/docs/models/shared/commerceorder.md +1 -1
  309. package/docs/models/shared/commerceorders.md +0 -2
  310. package/docs/models/shared/commerceordersupplementaldata.md +1 -1
  311. package/docs/models/shared/commercepaymentmethods.md +0 -2
  312. package/docs/models/shared/commercepayments.md +0 -2
  313. package/docs/models/shared/commerceproductcategories.md +0 -2
  314. package/docs/models/shared/commerceproducts.md +0 -2
  315. package/docs/models/shared/commercetransactions.md +0 -2
  316. package/docs/models/shared/companies.md +0 -2
  317. package/docs/models/shared/connections.md +0 -2
  318. package/docs/models/shared/contact.md +1 -1
  319. package/docs/models/shared/dataintegritydatatype.md +0 -2
  320. package/docs/models/shared/dataintegritydetails.md +0 -2
  321. package/docs/models/shared/dataintegritystatuses.md +0 -2
  322. package/docs/models/shared/dataintegritysummaries.md +0 -2
  323. package/docs/models/shared/enhancedfinancialreport.md +0 -2
  324. package/docs/models/shared/errormessage.md +0 -2
  325. package/docs/models/shared/excelstatus.md +0 -2
  326. package/docs/models/shared/loansummary.md +0 -2
  327. package/docs/models/shared/loantransactions.md +0 -2
  328. package/docs/models/shared/periodunit.md +0 -2
  329. package/docs/models/shared/pulloperations.md +0 -2
  330. package/docs/models/shared/supplementaldata.md +1 -1
  331. package/docs/sdks/accountingbankdata/README.md +2 -101
  332. package/docs/sdks/accountingbankdataaccounts/README.md +103 -0
  333. package/docs/sdks/accountspayable/README.md +2 -664
  334. package/docs/sdks/accountspayablebillcreditnotes/README.md +101 -0
  335. package/docs/sdks/accountspayablebillpayments/README.md +101 -0
  336. package/docs/sdks/accountspayablebills/README.md +148 -0
  337. package/docs/sdks/accountspayablesuppliers/README.md +244 -0
  338. package/docs/sdks/accountsreceivable/README.md +0 -1089
  339. package/docs/sdks/accountsreceivablecreditnotes/README.md +101 -0
  340. package/docs/sdks/accountsreceivablecustomers/README.md +244 -0
  341. package/docs/sdks/accountsreceivabledirectincomes/README.md +247 -0
  342. package/docs/sdks/{financials → accountsreceivableinvoices}/README.md +123 -111
  343. package/docs/sdks/accountsreceivablepayments/README.md +101 -0
  344. package/docs/sdks/accountsreceivablereports/README.md +172 -0
  345. package/docs/sdks/banking/README.md +4 -0
  346. package/docs/sdks/bankingaccountbalances/README.md +54 -0
  347. package/docs/sdks/bankingaccounts/README.md +103 -0
  348. package/docs/sdks/bankingcategorizedstatement/README.md +51 -0
  349. package/docs/sdks/bankingtransactioncategories/README.md +103 -0
  350. package/docs/sdks/bankingtransactions/README.md +103 -0
  351. package/docs/sdks/codatlending/README.md +24 -4
  352. package/docs/sdks/companies/README.md +1 -1
  353. package/docs/sdks/companyinfo/README.md +22 -22
  354. package/docs/sdks/connections/README.md +4 -3
  355. package/docs/sdks/dataintegrity/README.md +5 -5
  356. package/docs/sdks/excelreports/README.md +12 -4
  357. package/docs/sdks/fileupload/README.md +2 -2
  358. package/docs/sdks/financialstatements/README.md +4 -0
  359. package/docs/sdks/financialstatementsaccounts/README.md +100 -0
  360. package/docs/sdks/financialstatementsbalancesheet/README.md +91 -0
  361. package/docs/sdks/financialstatementscashflow/README.md +47 -0
  362. package/docs/sdks/financialstatementsprofitandloss/README.md +91 -0
  363. package/docs/sdks/liabilities/README.md +4 -4
  364. package/docs/sdks/managedata/README.md +3 -181
  365. package/docs/sdks/managedatapulloperations/README.md +89 -0
  366. package/docs/sdks/managedatarefresh/README.md +93 -0
  367. package/docs/sdks/sales/README.md +0 -1223
  368. package/docs/sdks/salescustomers/README.md +103 -0
  369. package/docs/sdks/salesdisputes/README.md +103 -0
  370. package/docs/sdks/saleslocations/README.md +99 -0
  371. package/docs/sdks/salesmetrics/README.md +218 -0
  372. package/docs/sdks/salesorders/README.md +103 -0
  373. package/docs/sdks/salespaymentmethods/README.md +103 -0
  374. package/docs/sdks/salespayments/README.md +103 -0
  375. package/docs/sdks/salesproductcategories/README.md +103 -0
  376. package/docs/sdks/salesproducts/README.md +103 -0
  377. package/docs/sdks/salesreports/README.md +145 -0
  378. package/docs/sdks/salestransactions/README.md +103 -0
  379. package/docs/sdks/transactions/README.md +0 -638
  380. package/docs/sdks/transactionsaccounttransactions/README.md +103 -0
  381. package/docs/sdks/transactionsdirectcosts/README.md +246 -0
  382. package/docs/sdks/transactionsjournalentries/README.md +101 -0
  383. package/docs/sdks/transactionsjournals/README.md +101 -0
  384. package/docs/sdks/transactionstransfers/README.md +103 -0
  385. package/package.json +1 -1
  386. package/dist/sdk/cashflow.d.ts +0 -112
  387. package/dist/sdk/financials.d.ts +0 -75
  388. package/docs/models/operations/unlinkconnectionrequestbody.md +0 -8
  389. package/docs/sdks/cashflow/README.md +0 -402
@@ -1,35 +1,29 @@
1
- # financials
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
- * [getAccount](#getaccount) - Get account
10
- * [getBalanceSheet](#getbalancesheet) - Get balance sheet
11
- * [getCashFlowStatement](#getcashflowstatement) - Get cash flow statement
12
- * [getEnhancedBalanceSheetAccounts](#getenhancedbalancesheetaccounts) - Get enhanced balance sheet accounts
13
- * [getEnhancedProfitAndLossAccounts](#getenhancedprofitandlossaccounts) - Get enhanced profit and loss accounts
14
- * [getProfitAndLoss](#getprofitandloss) - Get profit and loss
15
- * [listAccounts](#listaccounts) - List accounts
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
- ## getAccount
13
+ ## downloadAttachment
18
14
 
19
- The *Get account* endpoint returns a single account for a given accountId.
15
+ The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
20
16
 
21
- [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
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=chartOfAccounts) for integrations that support getting a specific account.
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 { GetAccountingAccountResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getAccount({
41
- accountId: "qui",
34
+ sdk.accountsReceivableInvoices.downloadAttachment({
35
+ attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
42
36
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
43
- }).then((res: GetAccountingAccountResponse) => {
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 | Type | Required | Description |
53
- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
54
- | `request` | [operations.GetAccountingAccountRequest](../../models/operations/getaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
55
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
56
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetAccountingAccountResponse](../../models/operations/getaccountingaccountresponse.md)>**
57
+ **Promise<[operations.DownloadAccountingInvoiceAttachmentResponse](../../models/operations/downloadaccountinginvoiceattachmentresponse.md)>**
62
58
 
63
59
 
64
- ## getBalanceSheet
60
+ ## downloadPdf
65
61
 
66
- Gets the latest balance sheet for a company.
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 { GetAccountingBalanceSheetResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getBalanceSheet({
76
+ sdk.accountsReceivableInvoices.downloadPdf({
81
77
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
82
- periodLength: 4,
83
- periodsToCompare: 20,
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 | Type | Required | Description |
95
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
96
- | `request` | [operations.GetAccountingBalanceSheetRequest](../../models/operations/getaccountingbalancesheetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
97
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
98
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetAccountingBalanceSheetResponse](../../models/operations/getaccountingbalancesheetresponse.md)>**
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
- ## getCashFlowStatement
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
- Gets the latest cash flow statement for a company.
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 { GetAccountingCashFlowStatementResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getCashFlowStatement({
122
+ sdk.accountsReceivableInvoices.get({
123
123
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
124
- periodLength: 4,
125
- periodsToCompare: 20,
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 | Type | Required | Description |
137
- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
138
- | `request` | [operations.GetAccountingCashFlowStatementRequest](../../models/operations/getaccountingcashflowstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. |
139
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
140
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetAccountingCashFlowStatementResponse](../../models/operations/getaccountingcashflowstatementresponse.md)>**
143
+ **Promise<[operations.GetAccountingInvoiceResponse](../../models/operations/getaccountinginvoiceresponse.md)>**
146
144
 
147
145
 
148
- ## getEnhancedBalanceSheetAccounts
146
+ ## getAttachment
149
147
 
150
- The *Get enhanced balance sheet accounts* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date.
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 { GetEnhancedBalanceSheetAccountsResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getEnhancedBalanceSheetAccounts({
167
+ sdk.accountsReceivableInvoices.getAttachment({
168
+ attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
167
169
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
168
- numberOfPeriods: 456150,
169
- reportDate: "29-09-2020",
170
- }).then((res: GetEnhancedBalanceSheetAccountsResponse) => {
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 | Type | Required | Description |
180
- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
181
- | `request` | [operations.GetEnhancedBalanceSheetAccountsRequest](../../models/operations/getenhancedbalancesheetaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
182
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
183
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetEnhancedBalanceSheetAccountsResponse](../../models/operations/getenhancedbalancesheetaccountsresponse.md)>**
190
+ **Promise<[operations.GetAccountingInvoiceAttachmentResponse](../../models/operations/getaccountinginvoiceattachmentresponse.md)>**
189
191
 
190
192
 
191
- ## getEnhancedProfitAndLossAccounts
193
+ ## list
192
194
 
193
- The *Get enhanced profit and loss accounts* endpoint returns a list of categorized accounts that appear on a companys Profit and Loss statement. It also includes a balance as of the financial statement date.
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
- 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.
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 { GetEnhancedProfitAndLossAccountsResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getEnhancedProfitAndLossAccounts({
220
+ sdk.accountsReceivableInvoices.list({
210
221
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
211
- numberOfPeriods: 216550,
212
- reportDate: "29-09-2020",
213
- }).then((res: GetEnhancedProfitAndLossAccountsResponse) => {
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 | Type | Required | Description |
223
- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
224
- | `request` | [operations.GetEnhancedProfitAndLossAccountsRequest](../../models/operations/getenhancedprofitandlossaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
225
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
226
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetEnhancedProfitAndLossAccountsResponse](../../models/operations/getenhancedprofitandlossaccountsresponse.md)>**
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
- ## getProfitAndLoss
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 { GetAccountingProfitAndLossResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.getProfitAndLoss({
268
+ sdk.accountsReceivableInvoices.listAttachments({
251
269
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
252
- periodLength: 4,
253
- periodsToCompare: 20,
254
- startMonth: "2022-10-23T00:00:00.000Z",
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 | Type | Required | Description |
265
- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
266
- | `request` | [operations.GetAccountingProfitAndLossRequest](../../models/operations/getaccountingprofitandlossrequest.md) | :heavy_check_mark: | The request object to use for the request. |
267
- | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
268
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
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.GetAccountingProfitAndLossResponse](../../models/operations/getaccountingprofitandlossresponse.md)>**
274
-
290
+ **Promise<[operations.ListAccountingInvoiceAttachmentsResponse](../../models/operations/listaccountinginvoiceattachmentsresponse.md)>**
275
291
 
276
- ## listAccounts
277
292
 
278
- The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.
293
+ ## listReconciled
279
294
 
280
- [Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
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 { ListAccountingAccountsResponse } from "@codat/lending/dist/sdk/models/operations";
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.financials.listAccounts({
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: "aspernatur",
302
- }).then((res: ListAccountingAccountsResponse) => {
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.ListAccountingAccountsRequest](../../models/operations/listaccountingaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
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.ListAccountingAccountsResponse](../../models/operations/listaccountingaccountsresponse.md)>**
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
+