@codat/lending 4.0.0 → 4.1.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 (118) hide show
  1. package/README.md +10 -1
  2. package/dist/sdk/models/shared/accountingaccounttransaction.d.ts +7 -0
  3. package/dist/sdk/models/shared/accountingattachment.d.ts +2 -1
  4. package/dist/sdk/models/shared/accountingattachment.js +2 -1
  5. package/dist/sdk/models/shared/accountingbill.d.ts +7 -0
  6. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +7 -0
  7. package/dist/sdk/models/shared/accountingbillpayment.d.ts +7 -0
  8. package/dist/sdk/models/shared/accountingcreditnote.d.ts +7 -0
  9. package/dist/sdk/models/shared/accountingdirectcost.d.ts +7 -0
  10. package/dist/sdk/models/shared/accountingdirectincome.d.ts +7 -0
  11. package/dist/sdk/models/shared/accountinginvoice.d.ts +7 -0
  12. package/dist/sdk/models/shared/accountingpayment.d.ts +7 -0
  13. package/dist/sdk/models/shared/accountingpaymentallocation.d.ts +7 -0
  14. package/dist/sdk/models/shared/billpaymentlinelink.d.ts +7 -0
  15. package/dist/sdk/models/shared/directcostprototype.d.ts +7 -0
  16. package/dist/sdk/models/shared/payment.d.ts +7 -0
  17. package/dist/sdk/models/shared/paymentallocationpayment.d.ts +7 -0
  18. package/dist/sdk/models/shared/paymentlinelink.d.ts +7 -0
  19. package/dist/sdk/sdk.js +3 -3
  20. package/docs/sdk/models/operations/downloadfilesrequest.md +1 -1
  21. package/docs/sdk/models/operations/getaccountingagedcreditorsreportrequest.md +1 -1
  22. package/docs/sdk/models/operations/getaccountingageddebtorsreportrequest.md +1 -1
  23. package/docs/sdk/models/operations/getaccountingbalancesheetrequest.md +1 -1
  24. package/docs/sdk/models/operations/getaccountingcashflowstatementrequest.md +1 -1
  25. package/docs/sdk/models/operations/getaccountingprofitandlossrequest.md +1 -1
  26. package/docs/sdk/models/shared/accountingaccount.md +2 -2
  27. package/docs/sdk/models/shared/accountingaccounttransaction.md +15 -15
  28. package/docs/sdk/models/shared/accountingagedcreditorreport.md +2 -2
  29. package/docs/sdk/models/shared/accountingageddebtorreport.md +2 -2
  30. package/docs/sdk/models/shared/accountingattachment.md +5 -4
  31. package/docs/sdk/models/shared/accountingbalancesheet.md +2 -2
  32. package/docs/sdk/models/shared/accountingbankaccount.md +2 -2
  33. package/docs/sdk/models/shared/accountingbanktransaction.md +3 -3
  34. package/docs/sdk/models/shared/accountingbill.md +23 -23
  35. package/docs/sdk/models/shared/accountingbillcreditnote.md +24 -24
  36. package/docs/sdk/models/shared/accountingbillpayment.md +17 -17
  37. package/docs/sdk/models/shared/accountingcashflowstatement.md +2 -2
  38. package/docs/sdk/models/shared/accountingcompanyinfo.md +3 -3
  39. package/docs/sdk/models/shared/accountingcreateaccountresponse.md +2 -2
  40. package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +2 -2
  41. package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +2 -2
  42. package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +2 -2
  43. package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +2 -2
  44. package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +2 -2
  45. package/docs/sdk/models/shared/accountingcreatetransferresponse.md +2 -2
  46. package/docs/sdk/models/shared/accountingcreditnote.md +26 -26
  47. package/docs/sdk/models/shared/accountingcustomer.md +2 -2
  48. package/docs/sdk/models/shared/accountingdirectcost.md +18 -18
  49. package/docs/sdk/models/shared/accountingdirectincome.md +18 -18
  50. package/docs/sdk/models/shared/accountinginvoice.md +28 -28
  51. package/docs/sdk/models/shared/accountingjournal.md +3 -3
  52. package/docs/sdk/models/shared/accountingjournalentry.md +5 -5
  53. package/docs/sdk/models/shared/accountingpayment.md +17 -17
  54. package/docs/sdk/models/shared/accountingprofitandlossreport.md +2 -2
  55. package/docs/sdk/models/shared/accountingsupplier.md +2 -2
  56. package/docs/sdk/models/shared/accountingtransfer.md +3 -3
  57. package/docs/sdk/models/shared/agedoutstandingamount.md +2 -2
  58. package/docs/sdk/models/shared/allocation.md +6 -6
  59. package/docs/sdk/models/shared/balancesheet.md +1 -1
  60. package/docs/sdk/models/shared/bankingaccount.md +2 -2
  61. package/docs/sdk/models/shared/bankingaccountbalance.md +3 -3
  62. package/docs/sdk/models/shared/bankingtransaction.md +4 -4
  63. package/docs/sdk/models/shared/bankingtransactioncategory.md +2 -2
  64. package/docs/sdk/models/shared/bankingtransactionref.md +1 -1
  65. package/docs/sdk/models/shared/billpaymentline.md +1 -1
  66. package/docs/sdk/models/shared/billpaymentlinelink.md +6 -6
  67. package/docs/sdk/models/shared/cashflowstatement.md +2 -2
  68. package/docs/sdk/models/shared/clientratelimitreachedwebhookdata.md +1 -1
  69. package/docs/sdk/models/shared/clientratelimitresetwebhookdata.md +1 -1
  70. package/docs/sdk/models/shared/commercecompanyinfo.md +3 -3
  71. package/docs/sdk/models/shared/commercecustomer.md +3 -3
  72. package/docs/sdk/models/shared/commercedispute.md +4 -4
  73. package/docs/sdk/models/shared/commercelocation.md +2 -2
  74. package/docs/sdk/models/shared/commerceorder.md +4 -4
  75. package/docs/sdk/models/shared/commercepayment.md +4 -4
  76. package/docs/sdk/models/shared/commercepaymentmethod.md +2 -2
  77. package/docs/sdk/models/shared/commerceproductcategory.md +2 -2
  78. package/docs/sdk/models/shared/commercetransaction.md +4 -4
  79. package/docs/sdk/models/shared/company.md +2 -2
  80. package/docs/sdk/models/shared/connection.md +2 -2
  81. package/docs/sdk/models/shared/contact.md +1 -1
  82. package/docs/sdk/models/shared/createbankaccounttransaction.md +1 -1
  83. package/docs/sdk/models/shared/dataconnectionerror.md +1 -1
  84. package/docs/sdk/models/shared/dataintegritydates.md +4 -4
  85. package/docs/sdk/models/shared/dataintegritydetail.md +1 -1
  86. package/docs/sdk/models/shared/dataintegritystatusinfo.md +1 -1
  87. package/docs/sdk/models/shared/datastatus.md +1 -1
  88. package/docs/sdk/models/shared/directcostprototype.md +14 -14
  89. package/docs/sdk/models/shared/enhancedcashflowtransaction.md +1 -1
  90. package/docs/sdk/models/shared/enhancedinvoicereportitem.md +5 -5
  91. package/docs/sdk/models/shared/enhancedreportinfo.md +1 -1
  92. package/docs/sdk/models/shared/excelstatus.md +1 -1
  93. package/docs/sdk/models/shared/file.md +1 -1
  94. package/docs/sdk/models/shared/loansummaryreportinfo.md +1 -1
  95. package/docs/sdk/models/shared/loansummaryreportitem.md +1 -1
  96. package/docs/sdk/models/shared/loantransactionsreportinfo.md +1 -1
  97. package/docs/sdk/models/shared/payment.md +9 -9
  98. package/docs/sdk/models/shared/paymentallocationpayment.md +10 -10
  99. package/docs/sdk/models/shared/paymentline.md +1 -1
  100. package/docs/sdk/models/shared/paymentlinelink.md +6 -6
  101. package/docs/sdk/models/shared/paymentref.md +4 -4
  102. package/docs/sdk/models/shared/productvariant.md +3 -3
  103. package/docs/sdk/models/shared/profitandlossreport.md +2 -2
  104. package/docs/sdk/models/shared/pulloperation.md +2 -2
  105. package/docs/sdk/models/shared/pushoperation.md +2 -2
  106. package/docs/sdk/models/shared/reportitem.md +1 -1
  107. package/docs/sdk/models/shared/reportitems.md +1 -1
  108. package/docs/sdks/balancesheet/README.md +1 -1
  109. package/docs/sdks/bankaccounts/README.md +2 -2
  110. package/docs/sdks/banktransactions/README.md +1 -1
  111. package/docs/sdks/cashflow/README.md +1 -1
  112. package/docs/sdks/codatlendingpayments/README.md +4 -4
  113. package/docs/sdks/codatlendingsuppliers/README.md +2 -2
  114. package/docs/sdks/directcosts/README.md +3 -3
  115. package/docs/sdks/fileupload/README.md +1 -1
  116. package/docs/sdks/profitandloss/README.md +1 -1
  117. package/docs/sdks/transfers/README.md +3 -3
  118. package/package.json +1 -1
package/docs/sdk/models/shared/createbankaccounttransaction.md CHANGED
@@ -7,6 +7,6 @@
7
7
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
8
  | `amount` | *number* | :heavy_minus_sign: | The amount transacted in the bank transaction. | |
9
9
  | `balance` | *number* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. | |
10
- | `date` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
10
+ | `date` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC |
11
11
  | `description` | *string* | :heavy_minus_sign: | Description of the bank transaction. | |
12
12
  | `id` | *string* | :heavy_minus_sign: | Identifier for the bank account transaction, unique for the company in the accounting platform. | |
package/docs/sdk/models/shared/dataconnectionerror.md CHANGED
@@ -6,6 +6,6 @@
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
8
  | `errorMessage` | *string* | :heavy_minus_sign: | A brief message about the error. | |
9
- | `erroredOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
9
+ | `erroredOnUtc` | *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 |
10
10
  | `statusCode` | *string* | :heavy_minus_sign: | The HTTP status code returned by the error. | |
11
11
  | `statusText` | *string* | :heavy_minus_sign: | A non-numeric status code/text. | |
package/docs/sdk/models/shared/dataintegritydates.md CHANGED
@@ -7,7 +7,7 @@ Only returned for transactions. For accounts, there is nothing returned.
7
7
 
8
8
  | Field | Type | Required | Description | Example |
9
9
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10
- | `maxDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
11
- | `maxOverlappingDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
12
- | `minDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
13
- | `minOverlappingDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
10
+ | `maxDate` | *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
+ | `maxOverlappingDate` | *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 |
12
+ | `minDate` | *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 |
13
+ | `minOverlappingDate` | *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 |
package/docs/sdk/models/shared/dataintegritydetail.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | `amount` | *number* | :heavy_minus_sign: | The transaction value. | |
9
9
  | `connectionId` | *string* | :heavy_minus_sign: | ID GUID representing the connection of the accounting or banking platform. | |
10
10
  | `currency` | *string* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.<br/><br/>## Unknown currencies<br/><br/>In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. <br/><br/>There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP |
11
- | `date` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
11
+ | `date` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC |
12
12
  | `description` | *string* | :heavy_minus_sign: | The transaction description. | |
13
13
  | `id` | *string* | :heavy_minus_sign: | ID GUID of the transaction. | |
14
14
  | `matches` | [shared.DataIntegrityMatch](../../../sdk/models/shared/dataintegritymatch.md)[] | :heavy_minus_sign: | N/A | |
package/docs/sdk/models/shared/dataintegritystatusinfo.md CHANGED
@@ -6,5 +6,5 @@
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
8
  | `currentStatus` | [shared.IntegrityStatus](../../../sdk/models/shared/integritystatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | |
9
- | `lastMatched` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
9
+ | `lastMatched` | *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 |
10
10
  | `statusMessage` | *string* | :heavy_minus_sign: | Detailed explanation supporting the status value. | |
package/docs/sdk/models/shared/datastatus.md CHANGED
@@ -9,6 +9,6 @@ Describes the state of data in the Codat cache for a company and data type
9
9
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10
10
  | `currentStatus` | *string* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | |
11
11
  | `dataType` | [shared.DataTypes](../../../sdk/models/shared/datatypes.md) | :heavy_check_mark: | Available Data types | invoices |
12
- | `lastSuccessfulSync` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
12
+ | `lastSuccessfulSync` | *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 |
13
13
  | `latestSuccessfulSyncId` | *string* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 |
14
14
  | `latestSyncId` | *string* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 |