@codat/lending 4.2.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 (281) 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/models/operations/getcreateoperation.d.ts +1 -1
  5. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +2 -2
  6. package/dist/sdk/models/shared/accountingbillcreditnote.js +3 -3
  7. package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts +171 -34
  8. package/dist/sdk/models/shared/accountingcreateaccountresponse.js +194 -4
  9. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.d.ts +116 -22
  10. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.js +118 -4
  11. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.d.ts +12 -2
  12. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.js +26 -4
  13. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.d.ts +165 -18
  14. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.js +150 -4
  15. package/dist/sdk/models/shared/accountingcreatepaymentresponse.d.ts +797 -675
  16. package/dist/sdk/models/shared/accountingcreatepaymentresponse.js +782 -4
  17. package/dist/sdk/models/shared/accountingcreatesupplierresponse.d.ts +69 -11
  18. package/dist/sdk/models/shared/accountingcreatesupplierresponse.js +99 -4
  19. package/dist/sdk/models/shared/accountingcreatetransferresponse.d.ts +81 -9
  20. package/dist/sdk/models/shared/accountingcreatetransferresponse.js +93 -4
  21. package/dist/sdk/models/shared/accountingcreditnote.d.ts +2 -2
  22. package/dist/sdk/models/shared/accountingcreditnote.js +3 -3
  23. package/dist/sdk/models/shared/accountingdirectcost.d.ts +11 -5
  24. package/dist/sdk/models/shared/accountingdirectcost.js +18 -11
  25. package/dist/sdk/models/shared/accountinginvoice.d.ts +10 -5
  26. package/dist/sdk/models/shared/accountinginvoice.js +11 -5
  27. package/dist/sdk/models/shared/accountingjournalentry.d.ts +3 -7
  28. package/dist/sdk/models/shared/accountingjournalentry.js +3 -3
  29. package/dist/sdk/models/shared/accounttransactionline.d.ts +3 -7
  30. package/dist/sdk/models/shared/accounttransactionline.js +3 -3
  31. package/dist/sdk/models/shared/accounttransactionlinerecordref.d.ts +30 -0
  32. package/dist/sdk/models/shared/accounttransactionlinerecordref.js +70 -0
  33. package/dist/sdk/models/shared/bankingtransactioncategory.d.ts +5 -1
  34. package/dist/sdk/models/shared/bankingtransactioncategory.js +5 -1
  35. package/dist/sdk/models/shared/company.d.ts +10 -0
  36. package/dist/sdk/models/shared/company.js +20 -1
  37. package/dist/sdk/models/shared/companyrequestbody.d.ts +5 -0
  38. package/dist/sdk/models/shared/companyrequestbody.js +7 -0
  39. package/dist/sdk/models/shared/connection.d.ts +2 -0
  40. package/dist/sdk/models/shared/connection.js +2 -0
  41. package/dist/sdk/models/shared/contactref.d.ts +9 -3
  42. package/dist/sdk/models/shared/contactref.js +9 -2
  43. package/dist/sdk/models/shared/directcostprototype.d.ts +11 -5
  44. package/dist/sdk/models/shared/directcostprototype.js +18 -11
  45. package/dist/sdk/models/shared/errormessage.d.ts +5 -0
  46. package/dist/sdk/models/shared/errormessage.js +7 -0
  47. package/dist/sdk/models/shared/errorvalidation.d.ts +9 -0
  48. package/dist/sdk/models/shared/errorvalidation.js +56 -0
  49. package/dist/sdk/models/shared/errorvalidationitem.d.ts +15 -0
  50. package/dist/sdk/models/shared/errorvalidationitem.js +55 -0
  51. package/dist/sdk/models/shared/index.d.ts +6 -0
  52. package/dist/sdk/models/shared/index.js +6 -0
  53. package/dist/sdk/models/shared/invoicelineitem.d.ts +0 -2
  54. package/dist/sdk/models/shared/items.d.ts +2 -6
  55. package/dist/sdk/models/shared/items.js +2 -7
  56. package/dist/sdk/models/shared/journalentryrecordref.d.ts +30 -0
  57. package/dist/sdk/models/shared/journalentryrecordref.js +70 -0
  58. package/dist/sdk/models/shared/journalline.d.ts +2 -2
  59. package/dist/sdk/models/shared/journalline.js +3 -3
  60. package/dist/sdk/models/shared/tracking.d.ts +2 -1
  61. package/dist/sdk/models/shared/tracking.js +3 -2
  62. package/dist/sdk/models/shared/trackingrecordref.d.ts +22 -0
  63. package/dist/sdk/models/shared/trackingrecordref.js +62 -0
  64. package/dist/sdk/models/shared/withholdingtaxitems.d.ts +11 -0
  65. package/dist/sdk/models/shared/withholdingtaxitems.js +50 -0
  66. package/dist/sdk/sdk.js +3 -3
  67. package/docs/sdk/models/operations/createcompanyresponse.md +7 -7
  68. package/docs/sdk/models/operations/createconnectionresponse.md +7 -7
  69. package/docs/sdk/models/operations/createsupplierrequest.md +7 -7
  70. package/docs/sdk/models/operations/getaccountingagedcreditorsreportresponse.md +7 -7
  71. package/docs/sdk/models/operations/getaccountingageddebtorsreportresponse.md +7 -7
  72. package/docs/sdk/models/operations/getaccountingbillcreditnoteresponse.md +7 -7
  73. package/docs/sdk/models/operations/getaccountingbillpaymentresponse.md +7 -7
  74. package/docs/sdk/models/operations/getaccountingcreditnoteresponse.md +7 -7
  75. package/docs/sdk/models/operations/getaccountingprofileresponse.md +7 -7
  76. package/docs/sdk/models/operations/getaccountingsupplierresponse.md +7 -7
  77. package/docs/sdk/models/operations/getbankingaccountresponse.md +7 -7
  78. package/docs/sdk/models/operations/getbankingtransactioncategoryresponse.md +7 -7
  79. package/docs/sdk/models/operations/getbankingtransactionresponse.md +7 -7
  80. package/docs/sdk/models/operations/getcategorizedbalancesheetstatementresponse.md +7 -7
  81. package/docs/sdk/models/operations/getcategorizedprofitandlossstatementresponse.md +7 -7
  82. package/docs/sdk/models/operations/getcommercecustomerresponse.md +7 -7
  83. package/docs/sdk/models/operations/getcommercedisputeresponse.md +7 -7
  84. package/docs/sdk/models/operations/getcommercelocationresponse.md +7 -7
  85. package/docs/sdk/models/operations/getcommerceorderresponse.md +7 -7
  86. package/docs/sdk/models/operations/getcommerceproductcategoryresponse.md +7 -7
  87. package/docs/sdk/models/operations/getcompanyresponse.md +7 -7
  88. package/docs/sdk/models/operations/getconnectionresponse.md +7 -7
  89. package/docs/sdk/models/operations/getcreateoperationrequest.md +4 -4
  90. package/docs/sdk/models/operations/getloansummaryresponse.md +7 -7
  91. package/docs/sdk/models/operations/getpulloperationresponse.md +7 -7
  92. package/docs/sdk/models/operations/listaccountingaccountsresponse.md +7 -7
  93. package/docs/sdk/models/operations/listaccountingaccounttransactionsresponse.md +7 -7
  94. package/docs/sdk/models/operations/listaccountingbankaccountsresponse.md +7 -7
  95. package/docs/sdk/models/operations/listaccountingbankaccounttransactionsresponse.md +7 -7
  96. package/docs/sdk/models/operations/listaccountingbillcreditnotesresponse.md +7 -7
  97. package/docs/sdk/models/operations/listaccountingbillpaymentsresponse.md +7 -7
  98. package/docs/sdk/models/operations/listaccountingbillsresponse.md +7 -7
  99. package/docs/sdk/models/operations/listaccountingcreditnotesresponse.md +7 -7
  100. package/docs/sdk/models/operations/listaccountingcustomersresponse.md +7 -7
  101. package/docs/sdk/models/operations/listaccountingdirectcostsresponse.md +7 -7
  102. package/docs/sdk/models/operations/listaccountingdirectincomesresponse.md +7 -7
  103. package/docs/sdk/models/operations/listaccountinginvoicesresponse.md +7 -7
  104. package/docs/sdk/models/operations/listaccountingjournalentriesresponse.md +7 -7
  105. package/docs/sdk/models/operations/listaccountingjournalsresponse.md +7 -7
  106. package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +7 -7
  107. package/docs/sdk/models/operations/listaccountingsuppliersresponse.md +7 -7
  108. package/docs/sdk/models/operations/listaccountingtransfersresponse.md +7 -7
  109. package/docs/sdk/models/operations/listbankingaccountbalancesresponse.md +7 -7
  110. package/docs/sdk/models/operations/listbankingaccountsresponse.md +7 -7
  111. package/docs/sdk/models/operations/listbankingtransactioncategoriesresponse.md +7 -7
  112. package/docs/sdk/models/operations/listbankingtransactionsresponse.md +7 -7
  113. package/docs/sdk/models/operations/listcommercecustomersresponse.md +7 -7
  114. package/docs/sdk/models/operations/listcommercedisputesresponse.md +7 -7
  115. package/docs/sdk/models/operations/listcommercelocationsresponse.md +7 -7
  116. package/docs/sdk/models/operations/listcommerceordersresponse.md +7 -7
  117. package/docs/sdk/models/operations/listcommercepaymentmethodsresponse.md +7 -7
  118. package/docs/sdk/models/operations/listcommercepaymentsresponse.md +7 -7
  119. package/docs/sdk/models/operations/listcommerceproductcategoriesresponse.md +7 -7
  120. package/docs/sdk/models/operations/listcommerceproductsresponse.md +7 -7
  121. package/docs/sdk/models/operations/listcommercetransactionsresponse.md +7 -7
  122. package/docs/sdk/models/operations/listcompaniesresponse.md +7 -7
  123. package/docs/sdk/models/operations/listconnectionsresponse.md +7 -7
  124. package/docs/sdk/models/operations/listcreateoperationsresponse.md +7 -7
  125. package/docs/sdk/models/operations/listdataintegritydetailsresponse.md +7 -7
  126. package/docs/sdk/models/operations/listloantransactionsresponse.md +7 -7
  127. package/docs/sdk/models/operations/listpulloperationsresponse.md +7 -7
  128. package/docs/sdk/models/operations/refreshdatatyperesponse.md +7 -7
  129. package/docs/sdk/models/operations/unlinkconnectionresponse.md +7 -7
  130. package/docs/sdk/models/operations/updatecompanyresponse.md +7 -7
  131. package/docs/sdk/models/shared/accountingaccounts.md +7 -7
  132. package/docs/sdk/models/shared/accountingaccounttransactions.md +7 -7
  133. package/docs/sdk/models/shared/accountingbankaccounts.md +7 -7
  134. package/docs/sdk/models/shared/accountingbanktransactions.md +7 -7
  135. package/docs/sdk/models/shared/accountingbillcreditnote.md +1 -1
  136. package/docs/sdk/models/shared/accountingbillcreditnotes.md +7 -7
  137. package/docs/sdk/models/shared/accountingbillpayment.md +1 -1
  138. package/docs/sdk/models/shared/accountingbillpayments.md +7 -7
  139. package/docs/sdk/models/shared/accountingbills.md +7 -7
  140. package/docs/sdk/models/shared/accountingcreateaccountresponse.md +16 -16
  141. package/docs/sdk/models/shared/accountingcreateaccountresponseaccountingaccount.md +54 -0
  142. package/docs/sdk/models/shared/accountingcreateaccountresponsevaliddatatypelinks.md +50 -0
  143. package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +16 -16
  144. package/docs/sdk/models/shared/accountingcreatebankaccountresponseaccountingbankaccount.md +42 -0
  145. package/docs/sdk/models/shared/accountingcreatebankaccounttransactions.md +11 -0
  146. package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +1 -1
  147. package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +16 -16
  148. package/docs/sdk/models/shared/accountingcreatedirectcostresponseaccountingdirectcost.md +41 -0
  149. package/docs/sdk/models/shared/accountingcreatedirectcostresponsecontactreference.md +11 -0
  150. package/docs/sdk/models/shared/accountingcreatedirectcostresponsedatatype.md +11 -0
  151. package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +16 -16
  152. package/docs/sdk/models/shared/accountingcreatepaymentresponseaccountingpayment.md +703 -0
  153. package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +1 -1
  154. package/docs/sdk/models/shared/accountingcreatesupplierresponseaccountingsupplier.md +29 -0
  155. package/docs/sdk/models/shared/accountingcreatetransferresponse.md +1 -1
  156. package/docs/sdk/models/shared/accountingcreatetransferresponseaccountingtransfer.md +25 -0
  157. package/docs/sdk/models/shared/accountingcreditnote.md +1 -1
  158. package/docs/sdk/models/shared/accountingcreditnotes.md +7 -7
  159. package/docs/sdk/models/shared/accountingcustomers.md +7 -7
  160. package/docs/sdk/models/shared/accountingdirectcost.md +1 -1
  161. package/docs/sdk/models/shared/accountingdirectcostcontactreference.md +11 -0
  162. package/docs/sdk/models/shared/accountingdirectcostdatatype.md +11 -0
  163. package/docs/sdk/models/shared/accountingdirectcosts.md +7 -7
  164. package/docs/sdk/models/shared/accountingdirectincomes.md +7 -7
  165. package/docs/sdk/models/shared/accountinginvoice.md +1 -1
  166. package/docs/sdk/models/shared/accountinginvoicedatatype.md +10 -0
  167. package/docs/sdk/models/shared/accountinginvoices.md +7 -7
  168. package/docs/sdk/models/shared/accountingjournalentries.md +7 -7
  169. package/docs/sdk/models/shared/accountingjournalentry.md +1 -1
  170. package/docs/sdk/models/shared/accountingjournals.md +7 -7
  171. package/docs/sdk/models/shared/accountingpayment.md +1 -1
  172. package/docs/sdk/models/shared/accountingpayments.md +7 -7
  173. package/docs/sdk/models/shared/accountingsuppliers.md +7 -7
  174. package/docs/sdk/models/shared/accountingtransfers.md +7 -7
  175. package/docs/sdk/models/shared/accounts.md +1 -1
  176. package/docs/sdk/models/shared/accounttransactionline.md +5 -5
  177. package/docs/sdk/models/shared/accounttransactionlinerecordref.md +11 -0
  178. package/docs/sdk/models/shared/accounttransactionlinerecordrefdatatype.md +20 -0
  179. package/docs/sdk/models/shared/bankingaccountbalances.md +7 -7
  180. package/docs/sdk/models/shared/bankingaccounts.md +7 -7
  181. package/docs/sdk/models/shared/bankingtransactioncategories.md +7 -7
  182. package/docs/sdk/models/shared/bankingtransactioncategory.md +3 -1
  183. package/docs/sdk/models/shared/bankingtransactions.md +7 -7
  184. package/docs/sdk/models/shared/commercecustomers.md +7 -7
  185. package/docs/sdk/models/shared/commercedisputes.md +7 -7
  186. package/docs/sdk/models/shared/commercelocations.md +7 -7
  187. package/docs/sdk/models/shared/commerceorders.md +7 -7
  188. package/docs/sdk/models/shared/commercepayment.md +1 -1
  189. package/docs/sdk/models/shared/commercepaymentmethods.md +7 -7
  190. package/docs/sdk/models/shared/commercepayments.md +7 -7
  191. package/docs/sdk/models/shared/commerceproductcategories.md +7 -7
  192. package/docs/sdk/models/shared/commerceproducts.md +7 -7
  193. package/docs/sdk/models/shared/commercetransactions.md +7 -7
  194. package/docs/sdk/models/shared/companies.md +7 -7
  195. package/docs/sdk/models/shared/company.md +1 -0
  196. package/docs/sdk/models/shared/companyrequestbody.md +1 -0
  197. package/docs/sdk/models/shared/connections.md +7 -7
  198. package/docs/sdk/models/shared/contactref.md +4 -4
  199. package/docs/sdk/models/shared/contactrefdatatype.md +11 -0
  200. package/docs/sdk/models/shared/contactreference.md +11 -0
  201. package/docs/sdk/models/shared/dataintegritydetails.md +7 -7
  202. package/docs/sdk/models/shared/directcostprototype.md +1 -1
  203. package/docs/sdk/models/shared/directcostprototypedatatype.md +11 -0
  204. package/docs/sdk/models/shared/enhancedcashflowtransaction.md +2 -2
  205. package/docs/sdk/models/shared/enhancedcashflowtransactions.md +5 -5
  206. package/docs/sdk/models/shared/enhancedinvoicesreport.md +4 -4
  207. package/docs/sdk/models/shared/errormessage.md +9 -8
  208. package/docs/sdk/models/shared/errorvalidation.md +11 -0
  209. package/docs/sdk/models/shared/errorvalidationitem.md +10 -0
  210. package/docs/sdk/models/shared/groupreference.md +8 -0
  211. package/docs/sdk/models/shared/invoicelineitem.md +1 -1
  212. package/docs/sdk/models/shared/items.md +3 -4
  213. package/docs/sdk/models/shared/journalentryrecordref.md +11 -0
  214. package/docs/sdk/models/shared/journalentryrecordrefdatatype.md +20 -0
  215. package/docs/sdk/models/shared/journallinetracking.md +3 -3
  216. package/docs/sdk/models/shared/pulloperations.md +7 -7
  217. package/docs/sdk/models/shared/pushoperations.md +7 -7
  218. package/docs/sdk/models/shared/salesorderreference.md +4 -4
  219. package/docs/sdk/models/shared/sourcetype.md +2 -0
  220. package/docs/sdk/models/shared/tracking.md +1 -1
  221. package/docs/sdk/models/shared/trackingrecordref.md +11 -0
  222. package/docs/sdk/models/shared/trackingrecordrefdatatype.md +12 -0
  223. package/docs/sdk/models/shared/withholdingtaxitems.md +9 -0
  224. package/docs/sdks/accountbalances/README.md +1 -1
  225. package/docs/sdks/accounts/README.md +2 -2
  226. package/docs/sdks/accounttransactions/README.md +2 -2
  227. package/docs/sdks/balancesheet/README.md +2 -2
  228. package/docs/sdks/bankaccounts/README.md +2 -2
  229. package/docs/sdks/banktransactions/README.md +2 -2
  230. package/docs/sdks/billcreditnotes/README.md +2 -2
  231. package/docs/sdks/billpayments/README.md +2 -2
  232. package/docs/sdks/bills/README.md +5 -5
  233. package/docs/sdks/cashflow/README.md +1 -1
  234. package/docs/sdks/categorizedstatement/README.md +1 -1
  235. package/docs/sdks/codatlendingaccountingbankdata/README.md +1 -1
  236. package/docs/sdks/codatlendingaccounts/README.md +2 -2
  237. package/docs/sdks/codatlendingbankingtransactions/README.md +2 -2
  238. package/docs/sdks/codatlendingcustomers/README.md +2 -2
  239. package/docs/sdks/codatlendingdirectcosts/README.md +5 -5
  240. package/docs/sdks/codatlendingfinancialstatementsaccounts/README.md +2 -2
  241. package/docs/sdks/codatlendingloanwritebackaccounts/README.md +2 -2
  242. package/docs/sdks/codatlendingpayments/README.md +4 -3
  243. package/docs/sdks/codatlendingreports/README.md +2 -2
  244. package/docs/sdks/codatlendingsalespayments/README.md +2 -2
  245. package/docs/sdks/codatlendingsuppliers/README.md +26 -7
  246. package/docs/sdks/codatlendingtransactions/README.md +2 -2
  247. package/docs/sdks/codatlendingtransfers/README.md +2 -2
  248. package/docs/sdks/companies/README.md +38 -13
  249. package/docs/sdks/companyinfo/README.md +2 -2
  250. package/docs/sdks/connections/README.md +5 -5
  251. package/docs/sdks/createoperations/README.md +2 -2
  252. package/docs/sdks/creditnotes/README.md +2 -2
  253. package/docs/sdks/customers/README.md +5 -5
  254. package/docs/sdks/dataintegrity/README.md +3 -3
  255. package/docs/sdks/directcosts/README.md +10 -11
  256. package/docs/sdks/directincomes/README.md +5 -5
  257. package/docs/sdks/disputes/README.md +2 -2
  258. package/docs/sdks/excelreports/README.md +3 -3
  259. package/docs/sdks/fileupload/README.md +3 -3
  260. package/docs/sdks/invoices/README.md +7 -7
  261. package/docs/sdks/journalentries/README.md +2 -2
  262. package/docs/sdks/journals/README.md +2 -2
  263. package/docs/sdks/liabilities/README.md +4 -4
  264. package/docs/sdks/locations/README.md +2 -2
  265. package/docs/sdks/managedata/README.md +1 -1
  266. package/docs/sdks/metrics/README.md +3 -3
  267. package/docs/sdks/orders/README.md +2 -2
  268. package/docs/sdks/paymentmethods/README.md +2 -2
  269. package/docs/sdks/payments/README.md +2 -2
  270. package/docs/sdks/productcategories/README.md +2 -2
  271. package/docs/sdks/products/README.md +2 -2
  272. package/docs/sdks/profitandloss/README.md +2 -2
  273. package/docs/sdks/pulloperations/README.md +2 -2
  274. package/docs/sdks/refresh/README.md +2 -2
  275. package/docs/sdks/reports/README.md +4 -4
  276. package/docs/sdks/suppliers/README.md +5 -5
  277. package/docs/sdks/transactioncategories/README.md +2 -2
  278. package/docs/sdks/transfers/README.md +3 -4
  279. package/package.json +1 -1
  280. package/docs/sdk/models/shared/accountingdirectcostcontactref.md +0 -11
  281. package/docs/sdk/models/shared/directcostprototypecontactref.md +0 -11
package/docs/sdk/models/shared/accountingcreatepaymentresponse.md CHANGED
@@ -3,19 +3,19 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description | Example |
7
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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
- | `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-23 00:00:00 +0000 UTC |
11
- | `data` | [shared.AccountingPayment](../../../sdk/models/shared/accountingpayment.md) | :heavy_minus_sign: | > **Payments or bill payments?**<br/>><br/>> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.<br/><br/>> View the coverage for payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments" target="_blank">Data coverage explorer</a>.<br/><br/>## Overview<br/><br/>Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).<br/><br/>A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:<br/><br/>- A payment made against an invoice, like a credit card, cheque, or cash payment.<br/>- An allocation of a customer's credit note, either to an invoice or maybe a refund.<br/>- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.<br/><br/>Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details.<br/><br/>In Codat, a payment contains details of:<br/><br/>- When the payment was recorded in the accounting system.<br/>- How much it is for and in what currency that amount is in.<br/>- Who the payment was _paid by_ – the _customer_.<br/>- The payment method used.<br/>- The breakdown of the types of payments – the _line items_.<br/><br/>Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).<br/><br/>## Payment types<br/><br/>## Payment of an invoice<br/><br/>A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:<br/><br/>- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.<br/>- A **links** array containing one element with the following properties:<br/> - A **type** that indicates the type of **link**, in this case an `Invoice`.<br/> - An **id** that contains the ID of the invoice that was paid.<br/> - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.<br/><br/>The **amount** field on the **line** equals the **totalAmount** on the payment.<br/><br/>## Payment of multiple invoices<br/><br/>A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:<br/><br/>- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).<br/>- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.<br/><br/>Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.<br/><br/>## Payments and refunds on account<br/><br/>A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:<br/><br/>- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.<br/>- A **links** array containing one element with the following properties:<br/>- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.<br/>- The **id** containing the ID of the customer.<br/>- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.<br/><br/>It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.<br/><br/>## Using a credit note to pay an invoice<br/><br/>The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:<br/><br/>- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.<br/>- A **links** array containing two elements:<br/> - The first **link** has:<br/> - A **type** that indicates the type of **link**, in this case an `Invoice`.<br/> - An **id** that contains the ID of the invoice that was paid.<br/> - The second **link** has:<br/> - A **type** that indicates the type of **link**, in this case a `CreditNote`.<br/> - An **id** that contains the ID of the credit note used by this payment.<br/><br/>The **amount** field on the **line** equals the **totalAmount** on the payment.<br/><br/>## Refunding a credit note<br/><br/>A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:<br/><br/>- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.<br/>- A **links** array that contains one element with the following properties:<br/> - A **type** that indicates the type of **link**, in this case a `CreditNote`.<br/> - An **id** that contains the ID of the credit note that was refunded.<br/><br/>The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.<br/><br/>## Refunding a payment<br/><br/>If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:<br/><br/>- One for the incoming over payment.<br/>- Another for the outgoing refund.<br/><br/>The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:<br/><br/>- An **amount** that indicates the amount that was refunded. This is always negative.<br/>- A **links** array that contains one element with the following properties:<br/> - A **type** that indicates the type of **link**, in this case a `Payment`.<br/> - An **id** that contains the ID of the payment that was refunded.<br/><br/>The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.<br/><br/>The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.<br/><br/>For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:<br/><br/>- One for £1,000 linked to the invoice that was paid.<br/>- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.<br/><br/>The **line** linked to the payment has the following properties:<br/><br/>- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.<br/>- A **links** array containing one element with the following properties:<br/> - A **type** that indicates the type of **link**, in this case a `Refund`.<br/> - An **id** that contains the ID of the payment that refunded this line.<br/><br/>> **Support for linked payments**<br/>><br/>> Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.<br/><br/>## Foreign currencies<br/><br/>There are two types of currency rate that are included in the payments data type:<br/><br/>Payment currency rate:<br/><br/>- Base currency of the accounts receivable account.<br/>- Foreign currency of the payment.<br/><br/>Payment line link currency rate:<br/><br/>- Base currency of the item the link represents.<br/>- Foreign currency of the payment.<br/><br/>These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:<br/><br/>- The base currency for the accounts receivable account.<br/>- The currency of the item.<br/><br/> ```json title="Currency rate example"<br/> {<br/> "id": "123",<br/> "note": "",<br/> "totalAmount": 99.99,<br/> "currency": "GBP",<br/> "lines": [<br/> {<br/> "amount": 99.99,<br/> "links": [<br/> {<br/> "type": "Invoice",<br/> "id": "178",<br/> "amount": -50,<br/> "currencyRate": 1.9998<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/>## Example data<br/><br/>> **Object properties**<br/>><br/>> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).<br/><br/>## Simple examples<br/><br/> ```json title="Payment for invoice"<br/> {<br/> "totalAmount": 1000,<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Allocation of credit note"<br/> {<br/> "totalAmount": 0,<br/> "lines": [<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Payment of invoice and payment on account"<br/> {<br/> "totalAmount": 2000,<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "PaymentOnAccount",<br/> "id" : "y",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Refund of credit note"<br/> {<br/> "totalAmount": -1000,<br/> "lines": [<br/> {<br/> "amount" : -1000,<br/> "links" : [<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Refund on accounts receivable account"<br/> {<br/> "totalAmount": -1000,<br/> "lines": [<br/> {<br/> "amount" : -1000,<br/> "links" : [<br/> {<br/> "type" : "PaymentOnAccount",<br/> "id" : "y",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Linked refund on accounts receivable account"<br/> {<br/> "id" : "payment-001",<br/> "totalAmount": 1000,<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Refund",<br/> "id" : "refund-001",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> {<br/> "id" : "refund-001",<br/> "totalAmount": -1000,<br/> "lines": [<br/> {<br/> "amount" : -1000,<br/> "links" : [<br/> {<br/> "type" : "Payment",<br/> "id" : "payment-001",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Using a credit note and cash to pay an invoice"<br/> {<br/> "totalAmount": 250,<br/> "lines": [<br/> {<br/> "amount": 0,<br/> "links": [<br/> {<br/> "type": "Invoice",<br/> "id": "x",<br/> "amount": -750<br/> }, <br/> {<br/> "type": "CreditNote",<br/> "id": "y",<br/> "amount": 750<br/> }<br/> ]<br/> },<br/> {<br/> "amount": 250,<br/> "links": [<br/> {<br/> "type": "Invoice",<br/> "id": "x",<br/> "amount": -250<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/>## Complex examples<br/><br/> ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"<br/> {<br/> "totalAmount": 1000,<br/> "lines": [<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "z",<br/> "amount" : 1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"<br/> {<br/> "totalAmount": 2000,<br/> "lines": [<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "z",<br/> "amount" : 1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "PaymentOnAccount",<br/> "id" : "customer-001",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Two credit notes pay two invoices with no allocation amount specified"<br/> {<br/> "totalAmount": 0,<br/> "lines": [<br/> {<br/> "amount" : 0,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "w",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "z",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"<br/> {<br/> "totalAmount": 2000,<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "w",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "Invoice",<br/> "id" : "x",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "Invoice",<br/> "id" : "u",<br/> "amount" : -1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "y",<br/> "amount" : 1000<br/> },<br/> {<br/> "type" : "CreditNote",<br/> "id" : "z",<br/> "amount" : 1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Refund",<br/> "id" : "refund-001",<br/> "amount" : -1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> {<br/> "id" : "refund-001",<br/> "totalAmount": -1000,<br/> "lines": [<br/> {<br/> "amount" : -1000,<br/> "links" : [<br/> {<br/> "type" : "Payment",<br/> "id" : "payment-001",<br/> "amount" : 1000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/>In this example, a payment on account is used to pay the same invoice in January and again in February.<br/><br/> ```json title="January"<br/> {<br/> "id": "001",<br/> "totalAmount": 5000,<br/> "date" : "1901-01-01",<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "Invoice-x",<br/> "amount" : -1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 4000,<br/> "links" : [<br/> {<br/> "type" : "PaymentOnAccount",<br/> "id" : "PaymentOnAccount-y",<br/> "amount" : -4000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="February"<br/> {<br/> "id": "001",<br/> "totalAmount": 5000,<br/> "date" : "1901-02-01",<br/> "lines": [<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "Invoice-x",<br/> "amount" : -1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 1000,<br/> "links" : [<br/> {<br/> "type" : "Invoice",<br/> "id" : "Invoice-y",<br/> "amount" : -1000<br/> }<br/> ]<br/> },<br/> {<br/> "amount" : 3000,<br/> "links" : [<br/> {<br/> "type" : "PaymentOnAccount",<br/> "id" : "PaymentOnAccount-y",<br/> "amount" : -3000<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ```<br/><br/><br/><br/> ```json title="Two credit notes and some cash pay two invoices with no allocations specified"<br/> {<br/> "totalAmount": 500,<br/> "lines": [<br/> {<br/> "amount": 500,<br/> "links": [{<br/> "type": "Invoice",<br/> "id": "a",<br/> "amount": -1000<br/> }, {<br/> "type": "Invoice",<br/> "id": "b",<br/> "amount": -1000<br/> }, {<br/> "type": "CreditNote",<br/> "id": "y",<br/> "amount": 750<br/> },{<br/> "type": "CreditNote",<br/> "id": "z",<br/> "amount": 750<br/> }<br/> ]<br/> }<br/> ]<br/> }<br/> ``` | |
12
- | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
- | `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
- | `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
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-23 00:00:00 +0000 UTC |
17
- | `status` | [shared.PushOperationStatus](../../../sdk/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
- | `statusCode` | *number* | :heavy_check_mark: | Push status code. | |
19
- | `timeoutInMinutes` | *number* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | |
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.<br/><br/>Number of seconds the push operation must complete within before it times out. | |
21
- | `validation` | [shared.Validation](../../../sdk/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. | |
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
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
+ | `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-23 00:00:00 +0000 UTC |
11
+ | `data` | [shared.AccountingCreatePaymentResponseAccountingPayment](../../../sdk/models/shared/accountingcreatepaymentresponseaccountingpayment.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` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
+ | `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
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-23 00:00:00 +0000 UTC |
17
+ | `status` | [shared.PushOperationStatus](../../../sdk/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
+ | `statusCode` | *number* | :heavy_check_mark: | Push status code. | |
19
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | |
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.<br/><br/>Number of seconds the push operation must complete within before it times out. | |
21
+ | `validation` | [shared.Validation](../../../sdk/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. | |