@codat/lending 4.1.0 → 4.3.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 (291) hide show
  1. package/README.md +36 -1
  2. package/dist/sdk/companies.d.ts +22 -7
  3. package/dist/sdk/companies.js +22 -7
  4. package/dist/sdk/fileupload.js +1 -1
  5. package/dist/sdk/models/operations/getcreateoperation.d.ts +1 -1
  6. package/dist/sdk/models/operations/uploadfiles.d.ts +1 -5
  7. package/dist/sdk/models/operations/uploadfiles.js +4 -22
  8. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +2 -2
  9. package/dist/sdk/models/shared/accountingbillcreditnote.js +3 -3
  10. package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts +171 -34
  11. package/dist/sdk/models/shared/accountingcreateaccountresponse.js +194 -4
  12. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.d.ts +116 -22
  13. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.js +118 -4
  14. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.d.ts +12 -2
  15. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.js +26 -4
  16. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.d.ts +165 -18
  17. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.js +150 -4
  18. package/dist/sdk/models/shared/accountingcreatepaymentresponse.d.ts +797 -675
  19. package/dist/sdk/models/shared/accountingcreatepaymentresponse.js +782 -4
  20. package/dist/sdk/models/shared/accountingcreatesupplierresponse.d.ts +69 -11
  21. package/dist/sdk/models/shared/accountingcreatesupplierresponse.js +99 -4
  22. package/dist/sdk/models/shared/accountingcreatetransferresponse.d.ts +81 -9
  23. package/dist/sdk/models/shared/accountingcreatetransferresponse.js +93 -4
  24. package/dist/sdk/models/shared/accountingcreditnote.d.ts +2 -2
  25. package/dist/sdk/models/shared/accountingcreditnote.js +3 -3
  26. package/dist/sdk/models/shared/accountingdirectcost.d.ts +11 -5
  27. package/dist/sdk/models/shared/accountingdirectcost.js +18 -11
  28. package/dist/sdk/models/shared/accountinginvoice.d.ts +10 -5
  29. package/dist/sdk/models/shared/accountinginvoice.js +11 -5
  30. package/dist/sdk/models/shared/accountingjournalentry.d.ts +3 -7
  31. package/dist/sdk/models/shared/accountingjournalentry.js +3 -3
  32. package/dist/sdk/models/shared/accounttransactionline.d.ts +3 -7
  33. package/dist/sdk/models/shared/accounttransactionline.js +3 -3
  34. package/dist/sdk/models/shared/accounttransactionlinerecordref.d.ts +30 -0
  35. package/dist/sdk/models/shared/accounttransactionlinerecordref.js +70 -0
  36. package/dist/sdk/models/shared/bankingtransactioncategory.d.ts +5 -1
  37. package/dist/sdk/models/shared/bankingtransactioncategory.js +5 -1
  38. package/dist/sdk/models/shared/codatfile.d.ts +5 -0
  39. package/dist/sdk/models/shared/codatfile.js +47 -0
  40. package/dist/sdk/models/shared/company.d.ts +10 -0
  41. package/dist/sdk/models/shared/company.js +20 -1
  42. package/dist/sdk/models/shared/companyrequestbody.d.ts +5 -0
  43. package/dist/sdk/models/shared/companyrequestbody.js +7 -0
  44. package/dist/sdk/models/shared/connection.d.ts +2 -0
  45. package/dist/sdk/models/shared/connection.js +2 -0
  46. package/dist/sdk/models/shared/contactref.d.ts +9 -3
  47. package/dist/sdk/models/shared/contactref.js +9 -2
  48. package/dist/sdk/models/shared/directcostprototype.d.ts +11 -5
  49. package/dist/sdk/models/shared/directcostprototype.js +18 -11
  50. package/dist/sdk/models/shared/errormessage.d.ts +5 -0
  51. package/dist/sdk/models/shared/errormessage.js +7 -0
  52. package/dist/sdk/models/shared/errorvalidation.d.ts +9 -0
  53. package/dist/sdk/models/shared/errorvalidation.js +56 -0
  54. package/dist/sdk/models/shared/errorvalidationitem.d.ts +15 -0
  55. package/dist/sdk/models/shared/errorvalidationitem.js +55 -0
  56. package/dist/sdk/models/shared/fileupload.d.ts +8 -0
  57. package/dist/sdk/models/shared/fileupload.js +44 -0
  58. package/dist/sdk/models/shared/index.d.ts +8 -0
  59. package/dist/sdk/models/shared/index.js +8 -0
  60. package/dist/sdk/models/shared/invoicelineitem.d.ts +0 -2
  61. package/dist/sdk/models/shared/items.d.ts +2 -6
  62. package/dist/sdk/models/shared/items.js +2 -7
  63. package/dist/sdk/models/shared/journalentryrecordref.d.ts +30 -0
  64. package/dist/sdk/models/shared/journalentryrecordref.js +70 -0
  65. package/dist/sdk/models/shared/journalline.d.ts +2 -2
  66. package/dist/sdk/models/shared/journalline.js +3 -3
  67. package/dist/sdk/models/shared/tracking.d.ts +2 -1
  68. package/dist/sdk/models/shared/tracking.js +3 -2
  69. package/dist/sdk/models/shared/trackingrecordref.d.ts +22 -0
  70. package/dist/sdk/models/shared/trackingrecordref.js +62 -0
  71. package/dist/sdk/models/shared/withholdingtaxitems.d.ts +11 -0
  72. package/dist/sdk/models/shared/withholdingtaxitems.js +50 -0
  73. package/dist/sdk/sdk.js +3 -3
  74. package/docs/sdk/models/operations/createcompanyresponse.md +7 -7
  75. package/docs/sdk/models/operations/createconnectionresponse.md +7 -7
  76. package/docs/sdk/models/operations/createsupplierrequest.md +7 -7
  77. package/docs/sdk/models/operations/getaccountingagedcreditorsreportresponse.md +7 -7
  78. package/docs/sdk/models/operations/getaccountingageddebtorsreportresponse.md +7 -7
  79. package/docs/sdk/models/operations/getaccountingbillcreditnoteresponse.md +7 -7
  80. package/docs/sdk/models/operations/getaccountingbillpaymentresponse.md +7 -7
  81. package/docs/sdk/models/operations/getaccountingcreditnoteresponse.md +7 -7
  82. package/docs/sdk/models/operations/getaccountingprofileresponse.md +7 -7
  83. package/docs/sdk/models/operations/getaccountingsupplierresponse.md +7 -7
  84. package/docs/sdk/models/operations/getbankingaccountresponse.md +7 -7
  85. package/docs/sdk/models/operations/getbankingtransactioncategoryresponse.md +7 -7
  86. package/docs/sdk/models/operations/getbankingtransactionresponse.md +7 -7
  87. package/docs/sdk/models/operations/getcategorizedbalancesheetstatementresponse.md +7 -7
  88. package/docs/sdk/models/operations/getcategorizedprofitandlossstatementresponse.md +7 -7
  89. package/docs/sdk/models/operations/getcommercecustomerresponse.md +7 -7
  90. package/docs/sdk/models/operations/getcommercedisputeresponse.md +7 -7
  91. package/docs/sdk/models/operations/getcommercelocationresponse.md +7 -7
  92. package/docs/sdk/models/operations/getcommerceorderresponse.md +7 -7
  93. package/docs/sdk/models/operations/getcommerceproductcategoryresponse.md +7 -7
  94. package/docs/sdk/models/operations/getcompanyresponse.md +7 -7
  95. package/docs/sdk/models/operations/getconnectionresponse.md +7 -7
  96. package/docs/sdk/models/operations/getcreateoperationrequest.md +4 -4
  97. package/docs/sdk/models/operations/getloansummaryresponse.md +7 -7
  98. package/docs/sdk/models/operations/getpulloperationresponse.md +7 -7
  99. package/docs/sdk/models/operations/listaccountingaccountsresponse.md +7 -7
  100. package/docs/sdk/models/operations/listaccountingaccounttransactionsresponse.md +7 -7
  101. package/docs/sdk/models/operations/listaccountingbankaccountsresponse.md +7 -7
  102. package/docs/sdk/models/operations/listaccountingbankaccounttransactionsresponse.md +7 -7
  103. package/docs/sdk/models/operations/listaccountingbillcreditnotesresponse.md +7 -7
  104. package/docs/sdk/models/operations/listaccountingbillpaymentsresponse.md +7 -7
  105. package/docs/sdk/models/operations/listaccountingbillsresponse.md +7 -7
  106. package/docs/sdk/models/operations/listaccountingcreditnotesresponse.md +7 -7
  107. package/docs/sdk/models/operations/listaccountingcustomersresponse.md +7 -7
  108. package/docs/sdk/models/operations/listaccountingdirectcostsresponse.md +7 -7
  109. package/docs/sdk/models/operations/listaccountingdirectincomesresponse.md +7 -7
  110. package/docs/sdk/models/operations/listaccountinginvoicesresponse.md +7 -7
  111. package/docs/sdk/models/operations/listaccountingjournalentriesresponse.md +7 -7
  112. package/docs/sdk/models/operations/listaccountingjournalsresponse.md +7 -7
  113. package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +7 -7
  114. package/docs/sdk/models/operations/listaccountingsuppliersresponse.md +7 -7
  115. package/docs/sdk/models/operations/listaccountingtransfersresponse.md +7 -7
  116. package/docs/sdk/models/operations/listbankingaccountbalancesresponse.md +7 -7
  117. package/docs/sdk/models/operations/listbankingaccountsresponse.md +7 -7
  118. package/docs/sdk/models/operations/listbankingtransactioncategoriesresponse.md +7 -7
  119. package/docs/sdk/models/operations/listbankingtransactionsresponse.md +7 -7
  120. package/docs/sdk/models/operations/listcommercecustomersresponse.md +7 -7
  121. package/docs/sdk/models/operations/listcommercedisputesresponse.md +7 -7
  122. package/docs/sdk/models/operations/listcommercelocationsresponse.md +7 -7
  123. package/docs/sdk/models/operations/listcommerceordersresponse.md +7 -7
  124. package/docs/sdk/models/operations/listcommercepaymentmethodsresponse.md +7 -7
  125. package/docs/sdk/models/operations/listcommercepaymentsresponse.md +7 -7
  126. package/docs/sdk/models/operations/listcommerceproductcategoriesresponse.md +7 -7
  127. package/docs/sdk/models/operations/listcommerceproductsresponse.md +7 -7
  128. package/docs/sdk/models/operations/listcommercetransactionsresponse.md +7 -7
  129. package/docs/sdk/models/operations/listcompaniesresponse.md +7 -7
  130. package/docs/sdk/models/operations/listconnectionsresponse.md +7 -7
  131. package/docs/sdk/models/operations/listcreateoperationsresponse.md +7 -7
  132. package/docs/sdk/models/operations/listdataintegritydetailsresponse.md +7 -7
  133. package/docs/sdk/models/operations/listloantransactionsresponse.md +7 -7
  134. package/docs/sdk/models/operations/listpulloperationsresponse.md +7 -7
  135. package/docs/sdk/models/operations/refreshdatatyperesponse.md +7 -7
  136. package/docs/sdk/models/operations/unlinkconnectionresponse.md +7 -7
  137. package/docs/sdk/models/operations/updatecompanyresponse.md +7 -7
  138. package/docs/sdk/models/operations/uploadfilesrequest.md +5 -5
  139. package/docs/sdk/models/shared/accountingaccounts.md +7 -7
  140. package/docs/sdk/models/shared/accountingaccounttransactions.md +7 -7
  141. package/docs/sdk/models/shared/accountingbankaccounts.md +7 -7
  142. package/docs/sdk/models/shared/accountingbanktransactions.md +7 -7
  143. package/docs/sdk/models/shared/accountingbillcreditnote.md +1 -1
  144. package/docs/sdk/models/shared/accountingbillcreditnotes.md +7 -7
  145. package/docs/sdk/models/shared/accountingbillpayment.md +1 -1
  146. package/docs/sdk/models/shared/accountingbillpayments.md +7 -7
  147. package/docs/sdk/models/shared/accountingbills.md +7 -7
  148. package/docs/sdk/models/shared/accountingcreateaccountresponse.md +16 -16
  149. package/docs/sdk/models/shared/accountingcreateaccountresponseaccountingaccount.md +54 -0
  150. package/docs/sdk/models/shared/accountingcreateaccountresponsevaliddatatypelinks.md +50 -0
  151. package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +16 -16
  152. package/docs/sdk/models/shared/accountingcreatebankaccountresponseaccountingbankaccount.md +42 -0
  153. package/docs/sdk/models/shared/accountingcreatebankaccounttransactions.md +11 -0
  154. package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +1 -1
  155. package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +16 -16
  156. package/docs/sdk/models/shared/accountingcreatedirectcostresponseaccountingdirectcost.md +41 -0
  157. package/docs/sdk/models/shared/accountingcreatedirectcostresponsecontactreference.md +11 -0
  158. package/docs/sdk/models/shared/accountingcreatedirectcostresponsedatatype.md +11 -0
  159. package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +16 -16
  160. package/docs/sdk/models/shared/accountingcreatepaymentresponseaccountingpayment.md +703 -0
  161. package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +1 -1
  162. package/docs/sdk/models/shared/accountingcreatesupplierresponseaccountingsupplier.md +29 -0
  163. package/docs/sdk/models/shared/accountingcreatetransferresponse.md +1 -1
  164. package/docs/sdk/models/shared/accountingcreatetransferresponseaccountingtransfer.md +25 -0
  165. package/docs/sdk/models/shared/accountingcreditnote.md +1 -1
  166. package/docs/sdk/models/shared/accountingcreditnotes.md +7 -7
  167. package/docs/sdk/models/shared/accountingcustomers.md +7 -7
  168. package/docs/sdk/models/shared/accountingdirectcost.md +1 -1
  169. package/docs/sdk/models/shared/accountingdirectcostcontactreference.md +11 -0
  170. package/docs/sdk/models/shared/accountingdirectcostdatatype.md +11 -0
  171. package/docs/sdk/models/shared/accountingdirectcosts.md +7 -7
  172. package/docs/sdk/models/shared/accountingdirectincomes.md +7 -7
  173. package/docs/sdk/models/shared/accountinginvoice.md +1 -1
  174. package/docs/sdk/models/shared/accountinginvoicedatatype.md +10 -0
  175. package/docs/sdk/models/shared/accountinginvoices.md +7 -7
  176. package/docs/sdk/models/shared/accountingjournalentries.md +7 -7
  177. package/docs/sdk/models/shared/accountingjournalentry.md +1 -1
  178. package/docs/sdk/models/shared/accountingjournals.md +7 -7
  179. package/docs/sdk/models/shared/accountingpayment.md +1 -1
  180. package/docs/sdk/models/shared/accountingpayments.md +7 -7
  181. package/docs/sdk/models/shared/accountingsuppliers.md +7 -7
  182. package/docs/sdk/models/shared/accountingtransfers.md +7 -7
  183. package/docs/sdk/models/shared/accounts.md +1 -1
  184. package/docs/sdk/models/shared/accounttransactionline.md +5 -5
  185. package/docs/sdk/models/shared/accounttransactionlinerecordref.md +11 -0
  186. package/docs/sdk/models/shared/accounttransactionlinerecordrefdatatype.md +20 -0
  187. package/docs/sdk/models/shared/bankingaccountbalances.md +7 -7
  188. package/docs/sdk/models/shared/bankingaccounts.md +7 -7
  189. package/docs/sdk/models/shared/bankingtransactioncategories.md +7 -7
  190. package/docs/sdk/models/shared/bankingtransactioncategory.md +3 -1
  191. package/docs/sdk/models/shared/bankingtransactions.md +7 -7
  192. package/docs/sdk/models/{operations/uploadfilesrequestbody.md → shared/codatfile.md} +1 -1
  193. package/docs/sdk/models/shared/commercecustomers.md +7 -7
  194. package/docs/sdk/models/shared/commercedisputes.md +7 -7
  195. package/docs/sdk/models/shared/commercelocations.md +7 -7
  196. package/docs/sdk/models/shared/commerceorders.md +7 -7
  197. package/docs/sdk/models/shared/commercepayment.md +1 -1
  198. package/docs/sdk/models/shared/commercepaymentmethods.md +7 -7
  199. package/docs/sdk/models/shared/commercepayments.md +7 -7
  200. package/docs/sdk/models/shared/commerceproductcategories.md +7 -7
  201. package/docs/sdk/models/shared/commerceproducts.md +7 -7
  202. package/docs/sdk/models/shared/commercetransactions.md +7 -7
  203. package/docs/sdk/models/shared/companies.md +7 -7
  204. package/docs/sdk/models/shared/company.md +1 -0
  205. package/docs/sdk/models/shared/companyrequestbody.md +1 -0
  206. package/docs/sdk/models/shared/connections.md +7 -7
  207. package/docs/sdk/models/shared/contactref.md +4 -4
  208. package/docs/sdk/models/shared/contactrefdatatype.md +11 -0
  209. package/docs/sdk/models/shared/contactreference.md +11 -0
  210. package/docs/sdk/models/shared/dataintegritydetails.md +7 -7
  211. package/docs/sdk/models/shared/directcostprototype.md +1 -1
  212. package/docs/sdk/models/shared/directcostprototypedatatype.md +11 -0
  213. package/docs/sdk/models/shared/enhancedcashflowtransaction.md +2 -2
  214. package/docs/sdk/models/shared/enhancedcashflowtransactions.md +5 -5
  215. package/docs/sdk/models/shared/enhancedinvoicesreport.md +4 -4
  216. package/docs/sdk/models/shared/errormessage.md +9 -8
  217. package/docs/sdk/models/shared/errorvalidation.md +11 -0
  218. package/docs/sdk/models/shared/errorvalidationitem.md +10 -0
  219. package/docs/sdk/models/shared/fileupload.md +8 -0
  220. package/docs/sdk/models/shared/groupreference.md +8 -0
  221. package/docs/sdk/models/shared/invoicelineitem.md +1 -1
  222. package/docs/sdk/models/shared/items.md +3 -4
  223. package/docs/sdk/models/shared/journalentryrecordref.md +11 -0
  224. package/docs/sdk/models/shared/journalentryrecordrefdatatype.md +20 -0
  225. package/docs/sdk/models/shared/journallinetracking.md +3 -3
  226. package/docs/sdk/models/shared/pulloperations.md +7 -7
  227. package/docs/sdk/models/shared/pushoperations.md +7 -7
  228. package/docs/sdk/models/shared/salesorderreference.md +4 -4
  229. package/docs/sdk/models/shared/sourcetype.md +2 -0
  230. package/docs/sdk/models/shared/tracking.md +1 -1
  231. package/docs/sdk/models/shared/trackingrecordref.md +11 -0
  232. package/docs/sdk/models/shared/trackingrecordrefdatatype.md +12 -0
  233. package/docs/sdk/models/shared/withholdingtaxitems.md +9 -0
  234. package/docs/sdks/accountbalances/README.md +1 -1
  235. package/docs/sdks/accounts/README.md +2 -2
  236. package/docs/sdks/accounttransactions/README.md +2 -2
  237. package/docs/sdks/balancesheet/README.md +2 -2
  238. package/docs/sdks/bankaccounts/README.md +2 -2
  239. package/docs/sdks/banktransactions/README.md +2 -2
  240. package/docs/sdks/billcreditnotes/README.md +2 -2
  241. package/docs/sdks/billpayments/README.md +2 -2
  242. package/docs/sdks/bills/README.md +5 -5
  243. package/docs/sdks/cashflow/README.md +1 -1
  244. package/docs/sdks/categorizedstatement/README.md +1 -1
  245. package/docs/sdks/codatlendingaccountingbankdata/README.md +1 -1
  246. package/docs/sdks/codatlendingaccounts/README.md +2 -2
  247. package/docs/sdks/codatlendingbankingtransactions/README.md +2 -2
  248. package/docs/sdks/codatlendingcustomers/README.md +2 -2
  249. package/docs/sdks/codatlendingdirectcosts/README.md +5 -5
  250. package/docs/sdks/codatlendingfinancialstatementsaccounts/README.md +2 -2
  251. package/docs/sdks/codatlendingloanwritebackaccounts/README.md +2 -2
  252. package/docs/sdks/codatlendingpayments/README.md +4 -3
  253. package/docs/sdks/codatlendingreports/README.md +2 -2
  254. package/docs/sdks/codatlendingsalespayments/README.md +2 -2
  255. package/docs/sdks/codatlendingsuppliers/README.md +26 -7
  256. package/docs/sdks/codatlendingtransactions/README.md +2 -2
  257. package/docs/sdks/codatlendingtransfers/README.md +2 -2
  258. package/docs/sdks/companies/README.md +38 -13
  259. package/docs/sdks/companyinfo/README.md +2 -2
  260. package/docs/sdks/connections/README.md +5 -5
  261. package/docs/sdks/createoperations/README.md +2 -2
  262. package/docs/sdks/creditnotes/README.md +2 -2
  263. package/docs/sdks/customers/README.md +5 -5
  264. package/docs/sdks/dataintegrity/README.md +3 -3
  265. package/docs/sdks/directcosts/README.md +10 -11
  266. package/docs/sdks/directincomes/README.md +5 -5
  267. package/docs/sdks/disputes/README.md +2 -2
  268. package/docs/sdks/excelreports/README.md +3 -3
  269. package/docs/sdks/fileupload/README.md +8 -6
  270. package/docs/sdks/invoices/README.md +7 -7
  271. package/docs/sdks/journalentries/README.md +2 -2
  272. package/docs/sdks/journals/README.md +2 -2
  273. package/docs/sdks/liabilities/README.md +4 -4
  274. package/docs/sdks/locations/README.md +2 -2
  275. package/docs/sdks/managedata/README.md +1 -1
  276. package/docs/sdks/metrics/README.md +3 -3
  277. package/docs/sdks/orders/README.md +2 -2
  278. package/docs/sdks/paymentmethods/README.md +2 -2
  279. package/docs/sdks/payments/README.md +2 -2
  280. package/docs/sdks/productcategories/README.md +2 -2
  281. package/docs/sdks/products/README.md +2 -2
  282. package/docs/sdks/profitandloss/README.md +2 -2
  283. package/docs/sdks/pulloperations/README.md +2 -2
  284. package/docs/sdks/refresh/README.md +2 -2
  285. package/docs/sdks/reports/README.md +4 -4
  286. package/docs/sdks/suppliers/README.md +5 -5
  287. package/docs/sdks/transactioncategories/README.md +2 -2
  288. package/docs/sdks/transfers/README.md +3 -4
  289. package/package.json +1 -1
  290. package/docs/sdk/models/shared/accountingdirectcostcontactref.md +0 -11
  291. package/docs/sdk/models/shared/directcostprototypecontactref.md +0 -11
package/docs/sdk/models/shared/accountingcreatesupplierresponse.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | `changes` | [shared.PushOperationChange](../../../sdk/models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
9
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
10
10
  | `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC |
11
- | `data` | [shared.AccountingSupplier](../../../sdk/models/shared/accountingsupplier.md) | :heavy_minus_sign: | > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>.<br/><br/>## Overview<br/><br/>From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). | |
11
+ | `data` | [shared.AccountingCreateSupplierResponseAccountingSupplier](../../../sdk/models/shared/accountingcreatesupplierresponseaccountingsupplier.md) | :heavy_minus_sign: | N/A | {"id":"C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F","supplierName":"Kelly's Industrial Supplies","contactName":"Kelly's Industrial Supplies","emailAddress":"sales@kellysupplies.com","phone":"07999 999999","addresses":[{"type":"Billing","line1":"Unit 51","line2":"Bakersfield Industrial Estate","city":"Bakersfield","region":"California","country":"USA","postalcode":"93308"}],"registrationNumber":"string","taxNumber":"string","status":"Unknown","defaultCurrency":"string","metadata":{"isDeleted":true},"supplementalData":{"content":{"property1":{"property1":null,"property2":null},"property2":{"property1":null,"property2":null}}},"modifiedDate":"2022-10-23T00:00:00Z","sourceModifiedDate":"2022-10-23T00:00:00Z"} |
12
12
  | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
13
  | `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
14
  | `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
package/docs/sdk/models/shared/accountingcreatesupplierresponseaccountingsupplier.md ADDED
@@ -0,0 +1,29 @@
1
+ # ~~AccountingCreateSupplierResponseAccountingSupplier~~
2
+
3
+ > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>.
4
+
5
+ ## Overview
6
+
7
+ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill).
8
+
9
+ > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
10
+
11
+
12
+ ## Fields
13
+
14
+ | Field | Type | Required | Description | Example |
15
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
+ | `addresses` | [shared.AccountingAddress](../../../sdk/models/shared/accountingaddress.md)[] | :heavy_minus_sign: | An array of Addresses. | |
17
+ | `contactName` | *string* | :heavy_minus_sign: | Name of the main contact for the supplier. | |
18
+ | `defaultCurrency` | *string* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | |
19
+ | `emailAddress` | *string* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | |
20
+ | `id` | *string* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting platform. | |
21
+ | `metadata` | [shared.Metadata](../../../sdk/models/shared/metadata.md) | :heavy_minus_sign: | N/A | |
22
+ | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
23
+ | `phone` | *string* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 |
24
+ | `registrationNumber` | *string* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | |
25
+ | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
26
+ | `status` | [shared.SupplierStatus](../../../sdk/models/shared/supplierstatus.md) | :heavy_check_mark: | Status of the supplier. | |
27
+ | `supplementalData` | [shared.SupplementalData](../../../sdk/models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types. <br/><br/>It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | |
28
+ | `supplierName` | *string* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | |
29
+ | `taxNumber` | *string* | :heavy_minus_sign: | Supplier's company tax number. | |
package/docs/sdk/models/shared/accountingcreatetransferresponse.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | `changes` | [shared.PushOperationChange](../../../sdk/models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
9
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
10
10
  | `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC |
11
- | `data` | [shared.AccountingTransfer](../../../sdk/models/shared/accountingtransfer.md) | :heavy_minus_sign: | > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.<br/><br/>A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). | |
11
+ | `data` | [shared.AccountingCreateTransferResponseAccountingTransfer](../../../sdk/models/shared/accountingcreatetransferresponseaccountingtransfer.md) | :heavy_minus_sign: | N/A | |
12
12
  | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
13
  | `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
14
  | `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
package/docs/sdk/models/shared/accountingcreatetransferresponseaccountingtransfer.md ADDED
@@ -0,0 +1,25 @@
1
+ # ~~AccountingCreateTransferResponseAccountingTransfer~~
2
+
3
+ > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.
4
+
5
+ A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
6
+
7
+ > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
8
+
9
+
10
+ ## Fields
11
+
12
+ | Field | Type | Required | Description | Example |
13
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14
+ | `contactRef` | [shared.ContactRef](../../../sdk/models/shared/contactref.md) | :heavy_minus_sign: | A customer or supplier associated with the direct cost. | |
15
+ | `date` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC |
16
+ | `depositedRecordRefs` | [shared.RecordRef](../../../sdk/models/shared/recordref.md)[] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | |
17
+ | `description` | *string* | :heavy_minus_sign: | Description of the transfer. | |
18
+ | `from` | [shared.TransferAccount](../../../sdk/models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | |
19
+ | `id` | *string* | :heavy_minus_sign: | Unique identifier for the transfer. | |
20
+ | `metadata` | [shared.Metadata](../../../sdk/models/shared/metadata.md) | :heavy_minus_sign: | N/A | |
21
+ | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
22
+ | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
23
+ | `supplementalData` | [shared.SupplementalData](../../../sdk/models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types. <br/><br/>It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | |
24
+ | `to` | [shared.TransferAccount](../../../sdk/models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | |
25
+ | `trackingCategoryRefs` | [shared.TrackingCategoryRef](../../../sdk/models/shared/trackingcategoryref.md)[] | :heavy_minus_sign: | Reference to the tracking categories this transfer is being tracked against. | |
package/docs/sdk/models/shared/accountingcreditnote.md CHANGED
@@ -41,4 +41,4 @@ It contains details of:
41
41
  | `totalAmount` | *number* | :heavy_check_mark: | Total amount of credit that has been applied to the customer's accounts receivable | |
42
42
  | `totalDiscount` | *number* | :heavy_check_mark: | Any discounts applied to the credit note amount. | |
43
43
  | `totalTaxAmount` | *number* | :heavy_check_mark: | Any tax applied to the credit note amount. | |
44
- | `withholdingTax` | [shared.Items](../../../sdk/models/shared/items.md)[] | :heavy_minus_sign: | N/A | |
44
+ | `withholdingTax` | [shared.WithholdingTaxItems](../../../sdk/models/shared/withholdingtaxitems.md)[] | :heavy_minus_sign: | N/A | |
package/docs/sdk/models/shared/accountingcreditnotes.md CHANGED
@@ -3,10 +3,10 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
8
- | `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
9
- | `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
10
- | `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
11
- | `results` | [shared.AccountingCreditNote](../../../sdk/models/shared/accountingcreditnote.md)[] | :heavy_minus_sign: | N/A |
12
- | `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
6
+ | Field | Type | Required | Description | Example |
7
+ | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
8
+ | `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
9
+ | `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
10
+ | `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
11
+ | `results` | [shared.AccountingCreditNote](../../../sdk/models/shared/accountingcreditnote.md)[] | :heavy_minus_sign: | N/A | |
12
+ | `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |