@codat/lending 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/README.md +36 -0
  2. package/dist/sdk/companies.js +2 -2
  3. package/dist/sdk/connections.js +2 -2
  4. package/dist/sdk/fileupload.js +1 -1
  5. package/dist/sdk/loanwriteback.d.ts +19 -0
  6. package/dist/sdk/loanwriteback.js +27 -0
  7. package/dist/sdk/loanwritebackaccounts.d.ts +40 -0
  8. package/dist/sdk/loanwritebackaccounts.js +294 -0
  9. package/dist/sdk/loanwritebackbankaccounts.d.ts +39 -0
  10. package/dist/sdk/loanwritebackbankaccounts.js +293 -0
  11. package/dist/sdk/loanwritebackbanktransactions.d.ts +40 -0
  12. package/dist/sdk/loanwritebackbanktransactions.js +294 -0
  13. package/dist/sdk/loanwritebackcreateoperations.d.ts +22 -0
  14. package/dist/sdk/loanwritebackcreateoperations.js +250 -0
  15. package/dist/sdk/loanwritebackdirectcosts.d.ts +40 -0
  16. package/dist/sdk/loanwritebackdirectcosts.js +294 -0
  17. package/dist/sdk/loanwritebacksuppliers.d.ts +40 -0
  18. package/dist/sdk/loanwritebacksuppliers.js +294 -0
  19. package/dist/sdk/loanwritebacktransfers.d.ts +40 -0
  20. package/dist/sdk/loanwritebacktransfers.js +294 -0
  21. package/dist/sdk/models/operations/createaccount.d.ts +27 -0
  22. package/dist/sdk/models/operations/createaccount.js +115 -0
  23. package/dist/sdk/models/operations/createbankaccount.d.ts +27 -0
  24. package/dist/sdk/models/operations/createbankaccount.js +115 -0
  25. package/dist/sdk/models/operations/createbanktransactions.d.ts +31 -0
  26. package/dist/sdk/models/operations/createbanktransactions.js +119 -0
  27. package/dist/sdk/models/operations/createdirectcost.d.ts +27 -0
  28. package/dist/sdk/models/operations/createdirectcost.js +115 -0
  29. package/dist/sdk/models/operations/createsupplier.d.ts +27 -0
  30. package/dist/sdk/models/operations/createsupplier.js +115 -0
  31. package/dist/sdk/models/operations/createtransfer.d.ts +27 -0
  32. package/dist/sdk/models/operations/createtransfer.js +115 -0
  33. package/dist/sdk/models/operations/getcreatebanktransactionsmodel.d.ts +24 -0
  34. package/dist/sdk/models/operations/getcreatebanktransactionsmodel.js +103 -0
  35. package/dist/sdk/models/operations/getcreatechartofaccountsmodel.d.ts +20 -0
  36. package/dist/sdk/models/operations/getcreatechartofaccountsmodel.js +99 -0
  37. package/dist/sdk/models/operations/getcreatedirectcostsmodel.d.ts +20 -0
  38. package/dist/sdk/models/operations/getcreatedirectcostsmodel.js +99 -0
  39. package/dist/sdk/models/operations/getcreateoperation.d.ts +23 -0
  40. package/dist/sdk/models/operations/getcreateoperation.js +99 -0
  41. package/dist/sdk/models/operations/getcreatetransfersmodel.d.ts +20 -0
  42. package/dist/sdk/models/operations/getcreatetransfersmodel.js +99 -0
  43. package/dist/sdk/models/operations/getcreateupdatebankaccountsmodel.d.ts +20 -0
  44. package/dist/sdk/models/operations/getcreateupdatebankaccountsmodel.js +99 -0
  45. package/dist/sdk/models/operations/getcreateupdatesuppliersmodel.d.ts +20 -0
  46. package/dist/sdk/models/operations/getcreateupdatesuppliersmodel.js +99 -0
  47. package/dist/sdk/models/operations/index.d.ts +14 -0
  48. package/dist/sdk/models/operations/index.js +14 -0
  49. package/dist/sdk/models/operations/listcreateoperations.d.ts +35 -0
  50. package/dist/sdk/models/operations/listcreateoperations.js +111 -0
  51. package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts +124 -0
  52. package/dist/sdk/models/shared/accountingcreateaccountresponse.js +118 -0
  53. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.d.ts +112 -0
  54. package/dist/sdk/models/shared/accountingcreatebankaccountresponse.js +118 -0
  55. package/dist/sdk/models/shared/accountingcreatebanktransactions.d.ts +6 -0
  56. package/dist/sdk/models/shared/accountingcreatebanktransactions.js +52 -0
  57. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.d.ts +92 -0
  58. package/dist/sdk/models/shared/accountingcreatebanktransactionsresponse.js +118 -0
  59. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.d.ts +111 -0
  60. package/dist/sdk/models/shared/accountingcreatedirectcostresponse.js +118 -0
  61. package/dist/sdk/models/shared/accountingcreatesupplierresponse.d.ts +101 -0
  62. package/dist/sdk/models/shared/accountingcreatesupplierresponse.js +118 -0
  63. package/dist/sdk/models/shared/accountingcreatetransferresponse.d.ts +99 -0
  64. package/dist/sdk/models/shared/accountingcreatetransferresponse.js +118 -0
  65. package/dist/sdk/models/shared/createbankaccounttransaction.d.ts +31 -0
  66. package/dist/sdk/models/shared/createbankaccounttransaction.js +65 -0
  67. package/dist/sdk/models/shared/index.d.ts +22 -0
  68. package/dist/sdk/models/shared/index.js +22 -0
  69. package/dist/sdk/models/shared/pushchangetype.d.ts +7 -0
  70. package/dist/sdk/models/shared/pushchangetype.js +14 -0
  71. package/dist/sdk/models/shared/pushfieldvalidation.d.ts +6 -0
  72. package/dist/sdk/models/shared/pushfieldvalidation.js +55 -0
  73. package/dist/sdk/models/shared/pushoperation.d.ts +90 -0
  74. package/dist/sdk/models/shared/pushoperation.js +111 -0
  75. package/dist/sdk/models/shared/pushoperationchange.d.ts +8 -0
  76. package/dist/sdk/models/shared/pushoperationchange.js +58 -0
  77. package/dist/sdk/models/shared/pushoperationref.d.ts +9 -0
  78. package/dist/sdk/models/shared/pushoperationref.js +51 -0
  79. package/dist/sdk/models/shared/pushoperations.d.ts +10 -0
  80. package/dist/sdk/models/shared/pushoperations.js +69 -0
  81. package/dist/sdk/models/shared/pushoperationstatus.d.ts +9 -0
  82. package/dist/sdk/models/shared/pushoperationstatus.js +16 -0
  83. package/dist/sdk/models/shared/pushoption.d.ts +14 -0
  84. package/dist/sdk/models/shared/pushoption.js +89 -0
  85. package/dist/sdk/models/shared/pushoptionchoice.d.ts +12 -0
  86. package/dist/sdk/models/shared/pushoptionchoice.js +66 -0
  87. package/dist/sdk/models/shared/pushoptionproperty.d.ts +13 -0
  88. package/dist/sdk/models/shared/pushoptionproperty.js +88 -0
  89. package/dist/sdk/models/shared/pushoptiontype.d.ts +10 -0
  90. package/dist/sdk/models/shared/pushoptiontype.js +17 -0
  91. package/dist/sdk/models/shared/pushvalidationinfo.d.ts +6 -0
  92. package/dist/sdk/models/shared/pushvalidationinfo.js +53 -0
  93. package/dist/sdk/models/shared/validation.d.ts +9 -0
  94. package/dist/sdk/models/shared/validation.js +56 -0
  95. package/dist/sdk/models/shared/validationitem.d.ts +6 -0
  96. package/dist/sdk/models/shared/validationitem.js +55 -0
  97. package/dist/sdk/sdk.d.ts +2 -0
  98. package/dist/sdk/sdk.js +4 -2
  99. package/docs/models/operations/createaccountrequest.md +13 -0
  100. package/docs/models/operations/createaccountresponse.md +12 -0
  101. package/docs/models/operations/createbankaccountrequest.md +13 -0
  102. package/docs/models/operations/createbankaccountresponse.md +12 -0
  103. package/docs/models/operations/createbanktransactionsrequest.md +14 -0
  104. package/docs/models/operations/createbanktransactionsresponse.md +12 -0
  105. package/docs/models/operations/createdirectcostrequest.md +13 -0
  106. package/docs/models/operations/createdirectcostresponse.md +12 -0
  107. package/docs/models/operations/createsupplierrequest.md +13 -0
  108. package/docs/models/operations/createsupplierresponse.md +12 -0
  109. package/docs/models/operations/createtransferrequest.md +13 -0
  110. package/docs/models/operations/createtransferresponse.md +12 -0
  111. package/docs/models/operations/getcreatebanktransactionsmodelrequest.md +10 -0
  112. package/docs/models/operations/getcreatebanktransactionsmodelresponse.md +12 -0
  113. package/docs/models/operations/getcreatechartofaccountsmodelrequest.md +9 -0
  114. package/docs/models/operations/getcreatechartofaccountsmodelresponse.md +12 -0
  115. package/docs/models/operations/getcreatedirectcostsmodelrequest.md +9 -0
  116. package/docs/models/operations/getcreatedirectcostsmodelresponse.md +12 -0
  117. package/docs/models/operations/getcreateoperationrequest.md +9 -0
  118. package/docs/models/operations/getcreateoperationresponse.md +12 -0
  119. package/docs/models/operations/getcreatetransfersmodelrequest.md +9 -0
  120. package/docs/models/operations/getcreatetransfersmodelresponse.md +12 -0
  121. package/docs/models/operations/getcreateupdatebankaccountsmodelrequest.md +9 -0
  122. package/docs/models/operations/getcreateupdatebankaccountsmodelresponse.md +12 -0
  123. package/docs/models/operations/getcreateupdatesuppliersmodelrequest.md +9 -0
  124. package/docs/models/operations/getcreateupdatesuppliersmodelresponse.md +12 -0
  125. package/docs/models/operations/listcreateoperationsrequest.md +12 -0
  126. package/docs/models/operations/listcreateoperationsresponse.md +12 -0
  127. package/docs/models/shared/accountingcreateaccountresponse.md +21 -0
  128. package/docs/models/shared/accountingcreatebankaccountresponse.md +21 -0
  129. package/docs/models/shared/accountingcreatebanktransactions.md +9 -0
  130. package/docs/models/shared/accountingcreatebanktransactionsresponse.md +21 -0
  131. package/docs/models/shared/accountingcreatedirectcostresponse.md +21 -0
  132. package/docs/models/shared/accountingcreatesupplierresponse.md +21 -0
  133. package/docs/models/shared/accountingcreatetransferresponse.md +21 -0
  134. package/docs/models/shared/createbankaccounttransaction.md +12 -0
  135. package/docs/models/shared/pushchangetype.md +12 -0
  136. package/docs/models/shared/pushfieldvalidation.md +10 -0
  137. package/docs/models/shared/pushoperation.md +20 -0
  138. package/docs/models/shared/pushoperationchange.md +10 -0
  139. package/docs/models/shared/pushoperationref.md +9 -0
  140. package/docs/models/shared/pushoperations.md +12 -0
  141. package/docs/models/shared/pushoperationstatus.md +13 -0
  142. package/docs/models/shared/pushoption.md +14 -0
  143. package/docs/models/shared/pushoptionchoice.md +12 -0
  144. package/docs/models/shared/pushoptionproperty.md +14 -0
  145. package/docs/models/shared/pushoptiontype.md +15 -0
  146. package/docs/models/shared/pushvalidationinfo.md +9 -0
  147. package/docs/models/shared/validation.md +11 -0
  148. package/docs/models/shared/validationitem.md +10 -0
  149. package/docs/sdks/loanwriteback/README.md +4 -0
  150. package/docs/sdks/loanwritebackaccounts/README.md +134 -0
  151. package/docs/sdks/loanwritebackbankaccounts/README.md +126 -0
  152. package/docs/sdks/loanwritebackbanktransactions/README.md +121 -0
  153. package/docs/sdks/loanwritebackcreateoperations/README.md +89 -0
  154. package/docs/sdks/loanwritebackdirectcosts/README.md +200 -0
  155. package/docs/sdks/loanwritebacksuppliers/README.md +142 -0
  156. package/docs/sdks/loanwritebacktransfers/README.md +156 -0
  157. package/docs/sdks/managedatapulloperations/README.md +1 -1
  158. package/docs/sdks/managedatarefresh/README.md +1 -1
  159. package/docs/sdks/salescustomers/README.md +2 -2
  160. package/docs/sdks/salesdisputes/README.md +2 -2
  161. package/docs/sdks/saleslocations/README.md +1 -1
  162. package/docs/sdks/salesmetrics/README.md +9 -9
  163. package/docs/sdks/salesorders/README.md +2 -2
  164. package/docs/sdks/salespaymentmethods/README.md +2 -2
  165. package/docs/sdks/salespayments/README.md +2 -2
  166. package/docs/sdks/salesproductcategories/README.md +2 -2
  167. package/docs/sdks/salesproducts/README.md +2 -2
  168. package/docs/sdks/salesreports/README.md +5 -5
  169. package/docs/sdks/salestransactions/README.md +2 -2
  170. package/docs/sdks/transactionsaccounttransactions/README.md +2 -2
  171. package/docs/sdks/transactionsdirectcosts/README.md +5 -5
  172. package/docs/sdks/transactionsjournalentries/README.md +2 -2
  173. package/docs/sdks/transactionsjournals/README.md +2 -2
  174. package/docs/sdks/transactionstransfers/README.md +2 -2
  175. package/package.json +1 -1
package/docs/models/shared/accountingcreatetransferresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # AccountingCreateTransferResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `changes` | [PushOperationChange](../../models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
+ | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
10
+ | `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
11
+ | `data` | [AccountingTransfer](../../models/shared/accountingtransfer.md) | :heavy_minus_sign: | > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.<br/><br/>A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). | |
12
+ | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
13
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
14
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | |
15
+ | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
16
+ | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
17
+ | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
18
+ | `statusCode` | *number* | :heavy_check_mark: | N/A | |
19
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | N/A | |
20
+ | ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
21
+ | `validation` | [Validation](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
package/docs/models/shared/createbankaccounttransaction.md ADDED
@@ -0,0 +1,12 @@
1
+ # CreateBankAccountTransaction
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `amount` | *number* | :heavy_minus_sign: | N/A | |
9
+ | `balance` | *number* | :heavy_minus_sign: | N/A | |
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 |
11
+ | `description` | *string* | :heavy_minus_sign: | N/A | |
12
+ | `id` | *string* | :heavy_minus_sign: | N/A | |
package/docs/models/shared/pushchangetype.md ADDED
@@ -0,0 +1,12 @@
1
+ # PushChangeType
2
+
3
+
4
+ ## Values
5
+
6
+ | Name | Value |
7
+ | -------------------- | -------------------- |
8
+ | `Unknown` | Unknown |
9
+ | `Created` | Created |
10
+ | `Modified` | Modified |
11
+ | `Deleted` | Deleted |
12
+ | `AttachmentUploaded` | AttachmentUploaded |
package/docs/models/shared/pushfieldvalidation.md ADDED
@@ -0,0 +1,10 @@
1
+ # PushFieldValidation
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `details` | *string* | :heavy_check_mark: | N/A |
9
+ | `field` | *string* | :heavy_minus_sign: | N/A |
10
+ | `ref` | *string* | :heavy_minus_sign: | N/A |
package/docs/models/shared/pushoperation.md ADDED
@@ -0,0 +1,20 @@
1
+ # PushOperation
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `changes` | [PushOperationChange](../../models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
9
+ | `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
10
+ | `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
11
+ | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
12
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
13
+ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | |
14
+ | `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. | |
15
+ | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
16
+ | `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
17
+ | `statusCode` | *number* | :heavy_check_mark: | N/A | |
18
+ | `timeoutInMinutes` | *number* | :heavy_minus_sign: | N/A | |
19
+ | ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
20
+ | `validation` | [Validation](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
package/docs/models/shared/pushoperationchange.md ADDED
@@ -0,0 +1,10 @@
1
+ # PushOperationChange
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
8
+ | `attachmentId` | *string* | :heavy_minus_sign: | N/A |
9
+ | `recordRef` | [PushOperationRef](../../models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A |
10
+ | `type` | [PushChangeType](../../models/shared/pushchangetype.md) | :heavy_minus_sign: | N/A |
package/docs/models/shared/pushoperationref.md ADDED
@@ -0,0 +1,9 @@
1
+ # PushOperationRef
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
8
+ | `dataType` | [DataType](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices |
9
+ | `id` | *string* | :heavy_minus_sign: | N/A | |
package/docs/models/shared/pushoperations.md ADDED
@@ -0,0 +1,12 @@
1
+ # PushOperations
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A |
9
+ | `pageNumber` | *number* | :heavy_check_mark: | N/A |
10
+ | `pageSize` | *number* | :heavy_check_mark: | N/A |
11
+ | `results` | [PushOperation](../../models/shared/pushoperation.md)[] | :heavy_minus_sign: | N/A |
12
+ | `totalResults` | *number* | :heavy_check_mark: | N/A |
package/docs/models/shared/pushoperationstatus.md ADDED
@@ -0,0 +1,13 @@
1
+ # PushOperationStatus
2
+
3
+ The current status of the push operation.
4
+
5
+
6
+ ## Values
7
+
8
+ | Name | Value |
9
+ | ---------- | ---------- |
10
+ | `Pending` | Pending |
11
+ | `Failed` | Failed |
12
+ | `Success` | Success |
13
+ | `TimedOut` | TimedOut |
package/docs/models/shared/pushoption.md ADDED
@@ -0,0 +1,14 @@
1
+ # PushOption
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `displayName` | *string* | :heavy_check_mark: | N/A |
10
+ | `options` | [PushOptionChoice](../../models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
11
+ | `properties` | Record<string, [PushOptionProperty](../../models/shared/pushoptionproperty.md)> | :heavy_minus_sign: | N/A |
12
+ | `required` | *boolean* | :heavy_check_mark: | N/A |
13
+ | `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | N/A |
14
+ | `validation` | [PushValidationInfo](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A |
package/docs/models/shared/pushoptionchoice.md ADDED
@@ -0,0 +1,12 @@
1
+ # PushOptionChoice
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `displayName` | *string* | :heavy_minus_sign: | N/A |
10
+ | `required` | *boolean* | :heavy_minus_sign: | N/A |
11
+ | `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_minus_sign: | N/A |
12
+ | `value` | *string* | :heavy_minus_sign: | Allowed value for field. |
package/docs/models/shared/pushoptionproperty.md ADDED
@@ -0,0 +1,14 @@
1
+ # PushOptionProperty
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
8
+ | `description` | *string* | :heavy_check_mark: | N/A |
9
+ | `displayName` | *string* | :heavy_check_mark: | N/A |
10
+ | `options` | [PushOptionChoice](../../models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
11
+ | `properties` | Record<string, [PushOptionProperty](../../models/shared/pushoptionproperty.md)> | :heavy_minus_sign: | N/A |
12
+ | `required` | *boolean* | :heavy_check_mark: | N/A |
13
+ | `type` | [PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | N/A |
14
+ | `validation` | [PushValidationInfo](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A |
package/docs/models/shared/pushoptiontype.md ADDED
@@ -0,0 +1,15 @@
1
+ # PushOptionType
2
+
3
+
4
+ ## Values
5
+
6
+ | Name | Value |
7
+ | ----------- | ----------- |
8
+ | `Array` | Array |
9
+ | `Object` | Object |
10
+ | `String` | String |
11
+ | `Number` | Number |
12
+ | `Boolean` | Boolean |
13
+ | `DateTime` | DateTime |
14
+ | `File` | File |
15
+ | `MultiPart` | MultiPart |
package/docs/models/shared/pushvalidationinfo.md ADDED
@@ -0,0 +1,9 @@
1
+ # PushValidationInfo
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8
+ | `information` | [PushFieldValidation](../../models/shared/pushfieldvalidation.md)[] | :heavy_minus_sign: | N/A |
9
+ | `warnings` | [PushFieldValidation](../../models/shared/pushfieldvalidation.md)[] | :heavy_minus_sign: | N/A |
package/docs/models/shared/validation.md ADDED
@@ -0,0 +1,11 @@
1
+ # Validation
2
+
3
+ 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.
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
10
+ | `errors` | [ValidationItem](../../models/shared/validationitem.md)[] | :heavy_minus_sign: | N/A |
11
+ | `warnings` | [ValidationItem](../../models/shared/validationitem.md)[] | :heavy_minus_sign: | N/A |
package/docs/models/shared/validationitem.md ADDED
@@ -0,0 +1,10 @@
1
+ # ValidationItem
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `itemId` | *string* | :heavy_minus_sign: | N/A |
9
+ | `message` | *string* | :heavy_minus_sign: | N/A |
10
+ | `validatorName` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdks/loanwriteback/README.md ADDED
@@ -0,0 +1,4 @@
1
+ # LoanWriteback
2
+
3
+ ### Available Operations
4
+