@codat/lending 2.1.0 → 3.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 (280) hide show
  1. package/README.md +70 -34
  2. package/dist/sdk/companies.js +2 -2
  3. package/dist/sdk/connections.js +2 -2
  4. package/dist/sdk/fileupload.js +1 -1
  5. package/dist/sdk/loanwriteback.d.ts +19 -0
  6. package/dist/sdk/loanwriteback.js +27 -0
  7. package/dist/sdk/loanwritebackaccounts.d.ts +40 -0
  8. package/dist/sdk/loanwritebackaccounts.js +294 -0
  9. package/dist/sdk/loanwritebackbankaccounts.d.ts +39 -0
  10. package/dist/sdk/loanwritebackbankaccounts.js +293 -0
  11. package/dist/sdk/loanwritebackbanktransactions.d.ts +40 -0
  12. package/dist/sdk/loanwritebackbanktransactions.js +294 -0
  13. package/dist/sdk/loanwritebackcreateoperations.d.ts +22 -0
  14. package/dist/sdk/loanwritebackcreateoperations.js +250 -0
  15. package/dist/sdk/loanwritebackdirectcosts.d.ts +40 -0
  16. package/dist/sdk/loanwritebackdirectcosts.js +294 -0
  17. package/dist/sdk/loanwritebacksuppliers.d.ts +40 -0
  18. package/dist/sdk/loanwritebacksuppliers.js +294 -0
  19. package/dist/sdk/loanwritebacktransfers.d.ts +40 -0
  20. package/dist/sdk/loanwritebacktransfers.js +294 -0
  21. package/dist/sdk/models/operations/createaccount.d.ts +27 -0
  22. package/dist/sdk/models/operations/createaccount.js +115 -0
  23. package/dist/sdk/models/operations/createbankaccount.d.ts +27 -0
  24. package/dist/sdk/models/operations/createbankaccount.js +115 -0
  25. package/dist/sdk/models/operations/createbanktransactions.d.ts +31 -0
  26. package/dist/sdk/models/operations/createbanktransactions.js +119 -0
  27. package/dist/sdk/models/operations/createdirectcost.d.ts +27 -0
  28. package/dist/sdk/models/operations/createdirectcost.js +115 -0
  29. package/dist/sdk/models/operations/createsupplier.d.ts +27 -0
  30. package/dist/sdk/models/operations/createsupplier.js +115 -0
  31. package/dist/sdk/models/operations/createtransfer.d.ts +27 -0
  32. package/dist/sdk/models/operations/createtransfer.js +115 -0
  33. package/dist/sdk/models/operations/getcreatebanktransactionsmodel.d.ts +24 -0
  34. package/dist/sdk/models/operations/getcreatebanktransactionsmodel.js +103 -0
  35. package/dist/sdk/models/operations/getcreatechartofaccountsmodel.d.ts +20 -0
  36. package/dist/sdk/models/operations/getcreatechartofaccountsmodel.js +99 -0
  37. package/dist/sdk/models/operations/getcreatedirectcostsmodel.d.ts +20 -0
  38. package/dist/sdk/models/operations/getcreatedirectcostsmodel.js +99 -0
  39. package/dist/sdk/models/operations/getcreateoperation.d.ts +23 -0
  40. package/dist/sdk/models/operations/getcreateoperation.js +99 -0
  41. package/dist/sdk/models/operations/getcreatetransfersmodel.d.ts +20 -0
  42. package/dist/sdk/models/operations/getcreatetransfersmodel.js +99 -0
  43. package/dist/sdk/models/operations/getcreateupdatebankaccountsmodel.d.ts +20 -0
  44. package/dist/sdk/models/operations/getcreateupdatebankaccountsmodel.js +99 -0
  45. package/dist/sdk/models/operations/getcreateupdatesuppliersmodel.d.ts +20 -0
  46. package/dist/sdk/models/operations/getcreateupdatesuppliersmodel.js +99 -0
  47. package/dist/sdk/models/operations/index.d.ts +14 -0
  48. package/dist/sdk/models/operations/index.js +14 -0
  49. package/dist/sdk/models/operations/listcreateoperations.d.ts +35 -0
  50. package/dist/sdk/models/operations/listcreateoperations.js +111 -0
  51. package/dist/sdk/models/shared/accountcategoriesupdatedwebhook.d.ts +40 -0
  52. package/dist/sdk/models/shared/accountcategoriesupdatedwebhook.js +90 -0
  53. package/dist/sdk/models/shared/accountcategoriesupdatedwebhookdata.d.ts +7 -0
  54. package/dist/sdk/models/shared/accountcategoriesupdatedwebhookdata.js +45 -0
  55. package/dist/sdk/models/shared/{addressesitems.d.ts → accountingaddress.d.ts} +1 -1
  56. package/dist/sdk/models/shared/{addressesitems.js → accountingaddress.js} +13 -13
  57. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +2 -2
  58. package/dist/sdk/models/shared/accountingbillcreditnote.js +3 -3
  59. package/dist/sdk/models/shared/accountingcompanyinfo.d.ts +6 -66
  60. package/dist/sdk/models/shared/accountingcompanyinfo.js +10 -100
  61. package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts +124 -0
  62. package/dist/sdk/models/shared/accountingcreateaccountresponse.js +118 -0
  63. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.d.ts +112 -0
  64. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.js +118 -0
  65. package/dist/sdk/models/shared/accountingcreatebanktransactions.d.ts +6 -0
  66. package/dist/sdk/models/shared/accountingcreatebanktransactions.js +52 -0
  67. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.d.ts +92 -0
  68. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.js +118 -0
  69. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.d.ts +111 -0
  70. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.js +118 -0
  71. package/dist/sdk/models/shared/accountingcreatesupplierresponse.d.ts +101 -0
  72. package/dist/sdk/models/shared/accountingcreatesupplierresponse.js +118 -0
  73. package/dist/sdk/models/shared/accountingcreatetransferresponse.d.ts +99 -0
  74. package/dist/sdk/models/shared/accountingcreatetransferresponse.js +118 -0
  75. package/dist/sdk/models/shared/accountingcreditnote.d.ts +2 -2
  76. package/dist/sdk/models/shared/accountingcreditnote.js +3 -3
  77. package/dist/sdk/models/shared/accountingcustomer.d.ts +2 -2
  78. package/dist/sdk/models/shared/accountingcustomer.js +3 -3
  79. package/dist/sdk/models/shared/accountinginvoice.d.ts +2 -2
  80. package/dist/sdk/models/shared/accountinginvoice.js +3 -3
  81. package/dist/sdk/models/shared/accountingsupplier.d.ts +2 -2
  82. package/dist/sdk/models/shared/accountingsupplier.js +3 -3
  83. package/dist/sdk/models/shared/clientratelimitreachedwebhook.d.ts +32 -0
  84. package/dist/sdk/models/shared/clientratelimitreachedwebhook.js +80 -0
  85. package/dist/sdk/models/shared/clientratelimitreachedwebhookdata.d.ts +31 -0
  86. package/dist/sdk/models/shared/clientratelimitreachedwebhookdata.js +50 -0
  87. package/dist/sdk/models/shared/clientratelimitresetwebhook.d.ts +32 -0
  88. package/dist/sdk/models/shared/clientratelimitresetwebhook.js +80 -0
  89. package/dist/sdk/models/shared/clientratelimitresetwebhookdata.d.ts +39 -0
  90. package/dist/sdk/models/shared/clientratelimitresetwebhookdata.js +60 -0
  91. package/dist/sdk/models/shared/commercecompanyinfo.d.ts +4 -4
  92. package/dist/sdk/models/shared/commercecompanyinfo.js +6 -6
  93. package/dist/sdk/models/shared/contact.d.ts +4 -4
  94. package/dist/sdk/models/shared/contact.js +6 -6
  95. package/dist/sdk/models/shared/createbankaccounttransaction.d.ts +31 -0
  96. package/dist/sdk/models/shared/createbankaccounttransaction.js +65 -0
  97. package/dist/sdk/models/shared/index.d.ts +31 -3
  98. package/dist/sdk/models/shared/index.js +31 -3
  99. package/dist/sdk/models/shared/items.d.ts +2 -9
  100. package/dist/sdk/models/shared/items.js +5 -6
  101. package/dist/sdk/models/shared/phonenumber.d.ts +12 -0
  102. package/dist/sdk/models/shared/{withholdingtaxitems.js → phonenumber.js} +12 -11
  103. package/dist/sdk/models/shared/pushchangetype.d.ts +7 -0
  104. package/dist/sdk/models/shared/pushchangetype.js +14 -0
  105. package/dist/sdk/models/shared/pushfieldvalidation.d.ts +6 -0
  106. package/dist/sdk/models/shared/pushfieldvalidation.js +55 -0
  107. package/dist/sdk/models/shared/pushoperation.d.ts +90 -0
  108. package/dist/sdk/models/shared/pushoperation.js +111 -0
  109. package/dist/sdk/models/shared/pushoperationchange.d.ts +8 -0
  110. package/dist/sdk/models/shared/pushoperationchange.js +58 -0
  111. package/dist/sdk/models/shared/pushoperationref.d.ts +9 -0
  112. package/dist/sdk/models/shared/pushoperationref.js +51 -0
  113. package/dist/sdk/models/shared/pushoperations.d.ts +10 -0
  114. package/dist/sdk/models/shared/pushoperations.js +69 -0
  115. package/dist/sdk/models/shared/pushoperationstatus.d.ts +9 -0
  116. package/dist/sdk/models/shared/pushoperationstatus.js +16 -0
  117. package/dist/sdk/models/shared/pushoption.d.ts +14 -0
  118. package/dist/sdk/models/shared/pushoption.js +89 -0
  119. package/dist/sdk/models/shared/pushoptionchoice.d.ts +12 -0
  120. package/dist/sdk/models/shared/pushoptionchoice.js +66 -0
  121. package/dist/sdk/models/shared/pushoptionproperty.d.ts +13 -0
  122. package/dist/sdk/models/shared/pushoptionproperty.js +88 -0
  123. package/dist/sdk/models/shared/pushoptiontype.d.ts +10 -0
  124. package/dist/sdk/models/shared/pushoptiontype.js +17 -0
  125. package/dist/sdk/models/shared/pushvalidationinfo.d.ts +6 -0
  126. package/dist/sdk/models/shared/pushvalidationinfo.js +53 -0
  127. package/dist/sdk/models/shared/validation.d.ts +9 -0
  128. package/dist/sdk/models/shared/validation.js +56 -0
  129. package/dist/sdk/models/shared/validationitem.d.ts +6 -0
  130. package/dist/sdk/models/shared/validationitem.js +55 -0
  131. package/dist/sdk/models/shared/{weblinksitems.d.ts → weblink.d.ts} +3 -3
  132. package/dist/sdk/models/shared/{weblinksitems.js → weblink.js} +14 -14
  133. package/dist/sdk/models/webhooks/accountcategoriesupdated.d.ts +7 -0
  134. package/dist/sdk/models/webhooks/accountcategoriesupdated.js +51 -0
  135. package/dist/sdk/models/webhooks/clientratelimitreached.d.ts +7 -0
  136. package/dist/sdk/models/webhooks/clientratelimitreached.js +51 -0
  137. package/dist/sdk/models/webhooks/clientratelimitreset.d.ts +7 -0
  138. package/dist/sdk/models/webhooks/clientratelimitreset.js +51 -0
  139. package/dist/sdk/models/webhooks/index.d.ts +3 -0
  140. package/dist/sdk/models/webhooks/index.js +22 -0
  141. package/dist/sdk/sdk.d.ts +2 -0
  142. package/dist/sdk/sdk.js +4 -2
  143. package/docs/models/operations/createaccountrequest.md +13 -0
  144. package/docs/models/operations/createaccountresponse.md +12 -0
  145. package/docs/models/operations/createbankaccountrequest.md +13 -0
  146. package/docs/models/operations/createbankaccountresponse.md +12 -0
  147. package/docs/models/operations/createbanktransactionsrequest.md +14 -0
  148. package/docs/models/operations/createbanktransactionsresponse.md +12 -0
  149. package/docs/models/operations/createdirectcostrequest.md +13 -0
  150. package/docs/models/operations/createdirectcostresponse.md +12 -0
  151. package/docs/models/operations/createsupplierrequest.md +13 -0
  152. package/docs/models/operations/createsupplierresponse.md +12 -0
  153. package/docs/models/operations/createtransferrequest.md +13 -0
  154. package/docs/models/operations/createtransferresponse.md +12 -0
  155. package/docs/models/operations/getcreatebanktransactionsmodelrequest.md +10 -0
  156. package/docs/models/operations/getcreatebanktransactionsmodelresponse.md +12 -0
  157. package/docs/models/operations/getcreatechartofaccountsmodelrequest.md +9 -0
  158. package/docs/models/operations/getcreatechartofaccountsmodelresponse.md +12 -0
  159. package/docs/models/operations/getcreatedirectcostsmodelrequest.md +9 -0
  160. package/docs/models/operations/getcreatedirectcostsmodelresponse.md +12 -0
  161. package/docs/models/operations/getcreateoperationrequest.md +9 -0
  162. package/docs/models/operations/getcreateoperationresponse.md +12 -0
  163. package/docs/models/operations/getcreatetransfersmodelrequest.md +9 -0
  164. package/docs/models/operations/getcreatetransfersmodelresponse.md +12 -0
  165. package/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md +9 -0
  166. package/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md +12 -0
  167. package/docs/models/operations/getcreateupdatesuppliersmodelrequest.md +9 -0
  168. package/docs/models/operations/getcreateupdatesuppliersmodelresponse.md +12 -0
  169. package/docs/models/operations/listcreateoperationsrequest.md +12 -0
  170. package/docs/models/operations/listcreateoperationsresponse.md +12 -0
  171. package/docs/models/shared/accountcategoriesupdatedwebhook.md +18 -0
  172. package/docs/models/shared/accountcategoriesupdatedwebhookdata.md +8 -0
  173. package/docs/models/shared/{addressesitems.md → accountingaddress.md} +1 -1
  174. package/docs/models/shared/accountingbillcreditnote.md +1 -1
  175. package/docs/models/shared/accountingcompanyinfo.md +3 -3
  176. package/docs/models/shared/accountingcreateaccountresponse.md +21 -0
  177. package/docs/models/shared/accountingcreatebankaccountresponse.md +21 -0
  178. package/docs/models/shared/accountingcreatebanktransactions.md +9 -0
  179. package/docs/models/shared/accountingcreatebanktransactionsresponse.md +21 -0
  180. package/docs/models/shared/accountingcreatedirectcostresponse.md +21 -0
  181. package/docs/models/shared/accountingcreatesupplierresponse.md +21 -0
  182. package/docs/models/shared/accountingcreatetransferresponse.md +21 -0
  183. package/docs/models/shared/accountingcreditnote.md +1 -1
  184. package/docs/models/shared/accountingcustomer.md +1 -1
  185. package/docs/models/shared/accountinginvoice.md +1 -1
  186. package/docs/models/shared/accountingsupplier.md +1 -1
  187. package/docs/models/shared/clientratelimitreachedwebhook.md +16 -0
  188. package/docs/models/shared/clientratelimitreachedwebhookdata.md +9 -0
  189. package/docs/models/shared/clientratelimitresetwebhook.md +16 -0
  190. package/docs/models/shared/clientratelimitresetwebhookdata.md +11 -0
  191. package/docs/models/shared/commercecompanyinfo.md +2 -2
  192. package/docs/models/shared/contact.md +2 -2
  193. package/docs/models/shared/createbankaccounttransaction.md +12 -0
  194. package/docs/models/shared/items.md +4 -4
  195. package/docs/models/shared/{accountingcompanyinfophone.md → phonenumber.md} +1 -1
  196. package/docs/models/shared/pushchangetype.md +12 -0
  197. package/docs/models/shared/pushfieldvalidation.md +10 -0
  198. package/docs/models/shared/pushoperation.md +20 -0
  199. package/docs/models/shared/pushoperationchange.md +10 -0
  200. package/docs/models/shared/pushoperationref.md +9 -0
  201. package/docs/models/shared/pushoperations.md +12 -0
  202. package/docs/models/shared/pushoperationstatus.md +13 -0
  203. package/docs/models/shared/pushoption.md +14 -0
  204. package/docs/models/shared/pushoptionchoice.md +12 -0
  205. package/docs/models/shared/pushoptionproperty.md +14 -0
  206. package/docs/models/shared/pushoptiontype.md +15 -0
  207. package/docs/models/shared/pushvalidationinfo.md +9 -0
  208. package/docs/models/shared/validation.md +11 -0
  209. package/docs/models/shared/validationitem.md +10 -0
  210. package/docs/models/shared/weblink.md +11 -0
  211. package/docs/models/shared/{itemstype.md → weblinktype.md} +1 -1
  212. package/docs/models/webhooks/accountcategoriesupdatedresponse.md +10 -0
  213. package/docs/models/webhooks/clientratelimitreachedresponse.md +10 -0
  214. package/docs/models/webhooks/clientratelimitresetresponse.md +10 -0
  215. package/docs/sdks/accountingbankdata/README.md +1 -1
  216. package/docs/sdks/accountingbankdataaccounts/README.md +3 -3
  217. package/docs/sdks/accountspayable/README.md +1 -1
  218. package/docs/sdks/accountspayablebillcreditnotes/README.md +3 -3
  219. package/docs/sdks/accountspayablebillpayments/README.md +3 -3
  220. package/docs/sdks/accountspayablebills/README.md +6 -6
  221. package/docs/sdks/accountspayablesuppliers/README.md +6 -6
  222. package/docs/sdks/accountsreceivable/README.md +1 -1
  223. package/docs/sdks/accountsreceivablecreditnotes/README.md +3 -3
  224. package/docs/sdks/accountsreceivablecustomers/README.md +6 -6
  225. package/docs/sdks/accountsreceivabledirectincomes/README.md +6 -6
  226. package/docs/sdks/accountsreceivableinvoices/README.md +8 -8
  227. package/docs/sdks/accountsreceivablepayments/README.md +3 -3
  228. package/docs/sdks/accountsreceivablereports/README.md +5 -5
  229. package/docs/sdks/banking/README.md +1 -1
  230. package/docs/sdks/bankingaccountbalances/README.md +2 -2
  231. package/docs/sdks/bankingcategorizedstatement/README.md +2 -2
  232. package/docs/sdks/bankingtransactioncategories/README.md +3 -3
  233. package/docs/sdks/companies/README.md +1 -1
  234. package/docs/sdks/companyinfo/README.md +1 -1
  235. package/docs/sdks/connections/README.md +1 -1
  236. package/docs/sdks/dataintegrity/README.md +1 -1
  237. package/docs/sdks/excelreports/README.md +1 -1
  238. package/docs/sdks/fileupload/README.md +1 -1
  239. package/docs/sdks/financialstatements/README.md +1 -1
  240. package/docs/sdks/financialstatementsaccounts/README.md +3 -3
  241. package/docs/sdks/financialstatementsbalancesheet/README.md +3 -3
  242. package/docs/sdks/financialstatementscashflow/README.md +2 -2
  243. package/docs/sdks/financialstatementsprofitandloss/README.md +3 -3
  244. package/docs/sdks/liabilities/README.md +1 -1
  245. package/docs/sdks/loanwriteback/README.md +4 -0
  246. package/docs/sdks/loanwritebackaccounts/README.md +134 -0
  247. package/docs/sdks/loanwritebackbankaccounts/README.md +126 -0
  248. package/docs/sdks/loanwritebackbanktransactions/README.md +121 -0
  249. package/docs/sdks/loanwritebackcreateoperations/README.md +89 -0
  250. package/docs/sdks/loanwritebackdirectcosts/README.md +200 -0
  251. package/docs/sdks/loanwritebacksuppliers/README.md +142 -0
  252. package/docs/sdks/loanwritebacktransfers/README.md +156 -0
  253. package/docs/sdks/managedata/README.md +1 -1
  254. package/docs/sdks/managedatapulloperations/README.md +4 -4
  255. package/docs/sdks/managedatarefresh/README.md +4 -4
  256. package/docs/sdks/sales/README.md +1 -1
  257. package/docs/sdks/salescustomers/README.md +2 -2
  258. package/docs/sdks/salesdisputes/README.md +2 -2
  259. package/docs/sdks/saleslocations/README.md +1 -1
  260. package/docs/sdks/salesmetrics/README.md +9 -9
  261. package/docs/sdks/salesorders/README.md +2 -2
  262. package/docs/sdks/salespaymentmethods/README.md +5 -5
  263. package/docs/sdks/salespayments/README.md +2 -2
  264. package/docs/sdks/salesproductcategories/README.md +5 -5
  265. package/docs/sdks/salesproducts/README.md +2 -2
  266. package/docs/sdks/salesreports/README.md +5 -5
  267. package/docs/sdks/salestransactions/README.md +2 -2
  268. package/docs/sdks/transactions/README.md +1 -1
  269. package/docs/sdks/transactionsaccounttransactions/README.md +5 -5
  270. package/docs/sdks/transactionsdirectcosts/README.md +11 -11
  271. package/docs/sdks/transactionsjournalentries/README.md +5 -5
  272. package/docs/sdks/transactionsjournals/README.md +2 -2
  273. package/docs/sdks/transactionstransfers/README.md +2 -2
  274. package/package.json +1 -1
  275. package/dist/sdk/models/shared/withholdingtaxitems.d.ts +0 -5
  276. package/docs/models/shared/accountingcompanyinfoaccountingaddress.md +0 -14
  277. package/docs/models/shared/accountingcompanyinfoweblink.md +0 -11
  278. package/docs/models/shared/accountingcompanyinfoweblinktype.md +0 -12
  279. package/docs/models/shared/weblinksitems.md +0 -11
  280. package/docs/models/shared/withholdingtaxitems.md +0 -9
package/docs/models/shared/accountingcreatebankaccountresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # AccountingCreateBankAccountResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `changes` | [PushOperationChange](../../models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
+ | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
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-23T00:00:00.000Z |
11
+ | `data` | [AccountingBankAccount](../../models/shared/accountingbankaccount.md) | :heavy_minus_sign: | > **Accessing Bank Accounts through Banking API**<br/>> <br/>> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. <br/>> <br/>> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)<br/><br/>> View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>.<br/><br/>## Overview<br/><br/>A list of bank accounts associated with a company and a specific data connection.<br/><br/>Bank accounts data includes:<br/>* The name and ID of the account in the accounting platform.<br/>* The currency and balance of the account.<br/>* The sort code and account number. | |
12
+ | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | |
15
+ | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
16
+ | `requestedOnUtc` | *string* | :heavy_check_mark: | 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-23T00:00:00.000Z |
17
+ | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
+ | `statusCode` | *number* | :heavy_check_mark: | N/A | |
19
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | N/A | |
20
+ | ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
21
+ | `validation` | [Validation](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
package/docs/models/shared/accountingcreatebanktransactions.md ADDED
@@ -0,0 +1,9 @@
1
+ # AccountingCreateBankTransactions
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8
+ | `accountId` | *string* | :heavy_minus_sign: | N/A |
9
+ | `transactions` | [CreateBankAccountTransaction](../../models/shared/createbankaccounttransaction.md)[] | :heavy_minus_sign: | N/A |
package/docs/models/shared/accountingcreatebanktransactionsresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # AccountingCreateBankTransactionsResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `changes` | [PushOperationChange](../../models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
+ | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
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-23T00:00:00.000Z |
11
+ | `data` | [AccountingCreateBankTransactions](../../models/shared/accountingcreatebanktransactions.md) | :heavy_minus_sign: | N/A | |
12
+ | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | |
15
+ | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
16
+ | `requestedOnUtc` | *string* | :heavy_check_mark: | 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-23T00:00:00.000Z |
17
+ | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
+ | `statusCode` | *number* | :heavy_check_mark: | N/A | |
19
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | N/A | |
20
+ | ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
21
+ | `validation` | [Validation](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
package/docs/models/shared/accountingcreatedirectcostresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # AccountingCreateDirectCostResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `changes` | [PushOperationChange](../../models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
+ | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
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-23T00:00:00.000Z |
11
+ | `data` | [AccountingDirectCost](../../models/shared/accountingdirectcost.md) | :heavy_minus_sign: | > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.<br/><br/>> View the coverage for direct costs in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts" target="_blank">Data coverage explorer</a>.<br/><br/>## Overview<br/><br/>Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.<br/><br/>Direct costs include:<br/> * Purchasing an item and paying it off at the point of the purchase<br/> * Receiving cash from a refunded item if the refund is made by the supplier<br/> * Withdrawing money from a bank account <br/> * Writing a cheque<br/><br/>Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). | |
12
+ | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | |
15
+ | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
16
+ | `requestedOnUtc` | *string* | :heavy_check_mark: | 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-23T00:00:00.000Z |
17
+ | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
+ | `statusCode` | *number* | :heavy_check_mark: | N/A | |
19
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | N/A | |
20
+ | ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
21
+ | `validation` | [Validation](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |