@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
@@ -0,0 +1,200 @@
1
+ # LoanWriteback.DirectCosts
2
+
3
+ ### Available Operations
4
+
5
+ * [create](#create) - Create direct cost
6
+ * [getCreateModel](#getcreatemodel) - Get create direct cost model
7
+
8
+ ## create
9
+
10
+ The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.
11
+
12
+ [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs.
13
+
14
+ **Integration-specific behaviour**
15
+
16
+ Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/accounting-api#/operations/get-create-directCosts-model).
17
+
18
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account.
19
+
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { CodatLending } from "@codat/lending";
25
+ import { CreateDirectCostResponse } from "@codat/lending/dist/sdk/models/operations";
26
+
27
+ const sdk = new CodatLending({
28
+ security: {
29
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
30
+ },
31
+ });
32
+
33
+ sdk.loanWriteback.directCosts.create({
34
+ accountingDirectCost: {
35
+ contactRef: {
36
+ dataType: "quos",
37
+ id: "02d502a9-4bb4-4f63-8969-e9a3efa77dfb",
38
+ },
39
+ currency: "GBP",
40
+ currencyRate: 2974.37,
41
+ id: "cd66ae39-5efb-49ba-88f3-a66997074ba4",
42
+ issueDate: "2022-10-23T00:00:00.000Z",
43
+ lineItems: [
44
+ {
45
+ accountRef: {
46
+ id: "69b6e214-1959-4890-afa5-63e2516fe4c8",
47
+ name: "Dr. Arnold Bradtke",
48
+ },
49
+ description: "expedita",
50
+ discountAmount: 4692.49,
51
+ discountPercentage: 9988.48,
52
+ itemRef: {
53
+ id: "d2ed0289-21cd-4dc6-9260-1fb576b0d5f0",
54
+ name: "Vincent Anderson",
55
+ },
56
+ quantity: 9441.24,
57
+ subTotal: 7299.91,
58
+ taxAmount: 7499.99,
59
+ taxRateRef: {
60
+ effectiveTaxRate: 1716.29,
61
+ id: "58705320-2c73-4d5f-a9b9-0c28909b3fe4",
62
+ name: "Omar Leuschke",
63
+ },
64
+ totalAmount: 7508.44,
65
+ tracking: {
66
+ invoiceTo: {
67
+ dataType: "accountTransaction",
68
+ id: "f4863332-3f9b-477f-ba41-00674ebf6928",
69
+ },
70
+ recordRefs: [
71
+ {
72
+ dataType: "journalEntry",
73
+ id: "d1ba77a8-9ebf-4737-ae42-03ce5e6a95d8",
74
+ },
75
+ ],
76
+ },
77
+ trackingCategoryRefs: [
78
+ {
79
+ id: "a0d446ce-2af7-4a73-8f3b-e453f870b326",
80
+ name: "Glen Oberbrunner",
81
+ },
82
+ ],
83
+ unitAmount: 2776.28,
84
+ },
85
+ ],
86
+ metadata: {
87
+ isDeleted: false,
88
+ },
89
+ modifiedDate: "2022-10-23T00:00:00.000Z",
90
+ note: "cupiditate",
91
+ paymentAllocations: [
92
+ {
93
+ allocation: {
94
+ allocatedOnDate: "2022-10-23T00:00:00.000Z",
95
+ currency: "EUR",
96
+ currencyRate: 7470.8,
97
+ totalAmount: 1175.31,
98
+ },
99
+ payment: {
100
+ accountRef: {
101
+ id: "a8422bb6-79d2-4322-b15b-f0cbb1e31b8b",
102
+ name: "Kevin Willms",
103
+ },
104
+ currency: "GBP",
105
+ currencyRate: 2408.29,
106
+ id: "a1108e0a-dcf4-4b92-9879-fce953f73ef7",
107
+ note: "hic",
108
+ paidOnDate: "2022-10-23T00:00:00.000Z",
109
+ reference: "quod",
110
+ totalAmount: 4861.6,
111
+ },
112
+ },
113
+ ],
114
+ reference: "similique",
115
+ sourceModifiedDate: "2022-10-23T00:00:00.000Z",
116
+ subTotal: 8742.88,
117
+ supplementalData: {
118
+ content: {
119
+ "ducimus": {
120
+ "dolore": "quibusdam",
121
+ },
122
+ },
123
+ },
124
+ taxAmount: 8489.44,
125
+ totalAmount: 1943.42,
126
+ },
127
+ allowSyncOnPushComplete: false,
128
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
129
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
130
+ forceUpdate: false,
131
+ timeoutInMinutes: 617877,
132
+ }).then((res: CreateDirectCostResponse) => {
133
+ if (res.statusCode == 200) {
134
+ // handle response
135
+ }
136
+ });
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Parameter | Type | Required | Description |
142
+ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
143
+ | `request` | [operations.CreateDirectCostRequest](../../models/operations/createdirectcostrequest.md) | :heavy_check_mark: | The request object to use for the request. |
144
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
145
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
146
+
147
+
148
+ ### Response
149
+
150
+ **Promise<[operations.CreateDirectCostResponse](../../models/operations/createdirectcostresponse.md)>**
151
+
152
+
153
+ ## getCreateModel
154
+
155
+ The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company and integration.
156
+
157
+ [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
158
+
159
+ **Integration-specific behaviour**
160
+
161
+ See the *response examples* for integration-specific indicative models.
162
+
163
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating a direct cost.
164
+
165
+
166
+ ### Example Usage
167
+
168
+ ```typescript
169
+ import { CodatLending } from "@codat/lending";
170
+ import { GetCreateDirectCostsModelResponse } from "@codat/lending/dist/sdk/models/operations";
171
+
172
+ const sdk = new CodatLending({
173
+ security: {
174
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
175
+ },
176
+ });
177
+
178
+ sdk.loanWriteback.directCosts.getCreateModel({
179
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
180
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
181
+ }).then((res: GetCreateDirectCostsModelResponse) => {
182
+ if (res.statusCode == 200) {
183
+ // handle response
184
+ }
185
+ });
186
+ ```
187
+
188
+ ### Parameters
189
+
190
+ | Parameter | Type | Required | Description |
191
+ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
192
+ | `request` | [operations.GetCreateDirectCostsModelRequest](../../models/operations/getcreatedirectcostsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
193
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
194
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
195
+
196
+
197
+ ### Response
198
+
199
+ **Promise<[operations.GetCreateDirectCostsModelResponse](../../models/operations/getcreatedirectcostsmodelresponse.md)>**
200
+
@@ -0,0 +1,142 @@
1
+ # LoanWriteback.Suppliers
2
+
3
+ ### Available Operations
4
+
5
+ * [create](#create) - Create supplier
6
+ * [getCreateUpdateModel](#getcreateupdatemodel) - Get create/update supplier model
7
+
8
+ ## create
9
+
10
+ The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.
11
+
12
+ [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
13
+
14
+ **Integration-specific behaviour**
15
+
16
+ Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/accounting-api#/operations/get-create-update-suppliers-model).
17
+
18
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account.
19
+
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { CodatLending } from "@codat/lending";
25
+ import { CreateSupplierResponse } from "@codat/lending/dist/sdk/models/operations";
26
+ import { AccountingAddressType, SupplierStatus } from "@codat/lending/dist/sdk/models/shared";
27
+
28
+ const sdk = new CodatLending({
29
+ security: {
30
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
31
+ },
32
+ });
33
+
34
+ sdk.loanWriteback.suppliers.create({
35
+ accountingSupplier: {
36
+ addresses: [
37
+ {
38
+ city: "Ankundingworth",
39
+ country: "Guadeloupe",
40
+ line1: "nulla",
41
+ line2: "fugit",
42
+ postalCode: "99474-0623",
43
+ region: "ea",
44
+ type: AccountingAddressType.Unknown,
45
+ },
46
+ ],
47
+ contactName: "vel",
48
+ defaultCurrency: "possimus",
49
+ emailAddress: "magnam",
50
+ id: "36813f16-d9f5-4fce-ac55-6146c3e250fb",
51
+ metadata: {
52
+ isDeleted: false,
53
+ },
54
+ modifiedDate: "2022-10-23T00:00:00.000Z",
55
+ phone: "+44 25691 154789",
56
+ registrationNumber: "deleniti",
57
+ sourceModifiedDate: "2022-10-23T00:00:00.000Z",
58
+ status: SupplierStatus.Unknown,
59
+ supplementalData: {
60
+ content: {
61
+ "fugit": {
62
+ "accusamus": "inventore",
63
+ },
64
+ },
65
+ },
66
+ supplierName: "non",
67
+ taxNumber: "et",
68
+ },
69
+ allowSyncOnPushComplete: false,
70
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
71
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
72
+ forceUpdate: false,
73
+ timeoutInMinutes: 677412,
74
+ }).then((res: CreateSupplierResponse) => {
75
+ if (res.statusCode == 200) {
76
+ // handle response
77
+ }
78
+ });
79
+ ```
80
+
81
+ ### Parameters
82
+
83
+ | Parameter | Type | Required | Description |
84
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
85
+ | `request` | [operations.CreateSupplierRequest](../../models/operations/createsupplierrequest.md) | :heavy_check_mark: | The request object to use for the request. |
86
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
87
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
88
+
89
+
90
+ ### Response
91
+
92
+ **Promise<[operations.CreateSupplierResponse](../../models/operations/createsupplierresponse.md)>**
93
+
94
+
95
+ ## getCreateUpdateModel
96
+
97
+ The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company and integration.
98
+
99
+ [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
100
+
101
+ **Integration-specific behaviour**
102
+
103
+ See the *response examples* for integration-specific indicative models.
104
+
105
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating and updating a supplier.
106
+
107
+
108
+ ### Example Usage
109
+
110
+ ```typescript
111
+ import { CodatLending } from "@codat/lending";
112
+ import { GetCreateUpdateSuppliersModelResponse } from "@codat/lending/dist/sdk/models/operations";
113
+
114
+ const sdk = new CodatLending({
115
+ security: {
116
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
117
+ },
118
+ });
119
+
120
+ sdk.loanWriteback.suppliers.getCreateUpdateModel({
121
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
122
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
123
+ }).then((res: GetCreateUpdateSuppliersModelResponse) => {
124
+ if (res.statusCode == 200) {
125
+ // handle response
126
+ }
127
+ });
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+ | Parameter | Type | Required | Description |
133
+ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
134
+ | `request` | [operations.GetCreateUpdateSuppliersModelRequest](../../models/operations/getcreateupdatesuppliersmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
135
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
136
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
137
+
138
+
139
+ ### Response
140
+
141
+ **Promise<[operations.GetCreateUpdateSuppliersModelResponse](../../models/operations/getcreateupdatesuppliersmodelresponse.md)>**
142
+
@@ -0,0 +1,156 @@
1
+ # LoanWriteback.Transfers
2
+
3
+ ### Available Operations
4
+
5
+ * [create](#create) - Create transfer
6
+ * [getCreateModel](#getcreatemodel) - Get create transfer model
7
+
8
+ ## create
9
+
10
+ The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.
11
+
12
+ [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
13
+
14
+ **Integration-specific behaviour**
15
+
16
+ Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/accounting-api#/operations/get-create-transfers-model).
17
+
18
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account.
19
+
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { CodatLending } from "@codat/lending";
25
+ import { CreateTransferResponse } from "@codat/lending/dist/sdk/models/operations";
26
+
27
+ const sdk = new CodatLending({
28
+ security: {
29
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
30
+ },
31
+ });
32
+
33
+ sdk.loanWriteback.transfers.create({
34
+ accountingTransfer: {
35
+ contactRef: {
36
+ dataType: "laborum",
37
+ id: "c366c8dd-6b14-4429-8747-4778a7bd466d",
38
+ },
39
+ date: "2022-10-23T00:00:00.000Z",
40
+ depositedRecordRefs: [
41
+ {
42
+ dataType: "accountTransaction",
43
+ id: "c10ab3cd-ca42-4519-84e5-23c7e0bc7178",
44
+ },
45
+ ],
46
+ description: "accusamus",
47
+ from: {
48
+ accountRef: {
49
+ id: "4796f2a7-0c68-4828-aaa4-82562f222e98",
50
+ name: "Tamara Vandervort IV",
51
+ },
52
+ amount: 8003.79,
53
+ currency: "EUR",
54
+ },
55
+ id: "e61e6b7b-95bc-40ab-bc20-c4f3789fd871",
56
+ metadata: {
57
+ isDeleted: false,
58
+ },
59
+ modifiedDate: "2022-10-23T00:00:00.000Z",
60
+ sourceModifiedDate: "2022-10-23T00:00:00.000Z",
61
+ supplementalData: {
62
+ content: {
63
+ "sint": {
64
+ "pariatur": "possimus",
65
+ },
66
+ },
67
+ },
68
+ to: {
69
+ accountRef: {
70
+ id: "2efd121a-a6f1-4e67-8bdb-04f15756082d",
71
+ name: "Cassandra Ward V",
72
+ },
73
+ amount: 9453.02,
74
+ currency: "GBP",
75
+ },
76
+ trackingCategoryRefs: [
77
+ {
78
+ id: "d1705133-9d08-4086-a184-0394c26071f9",
79
+ name: "Camille Hirthe III",
80
+ },
81
+ ],
82
+ },
83
+ allowSyncOnPushComplete: false,
84
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
85
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
86
+ forceUpdate: false,
87
+ timeoutInMinutes: 310067,
88
+ }).then((res: CreateTransferResponse) => {
89
+ if (res.statusCode == 200) {
90
+ // handle response
91
+ }
92
+ });
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ | Parameter | Type | Required | Description |
98
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
99
+ | `request` | [operations.CreateTransferRequest](../../models/operations/createtransferrequest.md) | :heavy_check_mark: | The request object to use for the request. |
100
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
101
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
102
+
103
+
104
+ ### Response
105
+
106
+ **Promise<[operations.CreateTransferResponse](../../models/operations/createtransferresponse.md)>**
107
+
108
+
109
+ ## getCreateModel
110
+
111
+ The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company and integration.
112
+
113
+ [Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
114
+
115
+ **Integration-specific behaviour**
116
+
117
+ See the *response examples* for integration-specific indicative models.
118
+
119
+ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating a transfer.
120
+
121
+
122
+ ### Example Usage
123
+
124
+ ```typescript
125
+ import { CodatLending } from "@codat/lending";
126
+ import { GetCreateTransfersModelResponse } from "@codat/lending/dist/sdk/models/operations";
127
+
128
+ const sdk = new CodatLending({
129
+ security: {
130
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
131
+ },
132
+ });
133
+
134
+ sdk.loanWriteback.transfers.getCreateModel({
135
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
136
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
137
+ }).then((res: GetCreateTransfersModelResponse) => {
138
+ if (res.statusCode == 200) {
139
+ // handle response
140
+ }
141
+ });
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Parameter | Type | Required | Description |
147
+ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
148
+ | `request` | [operations.GetCreateTransfersModelRequest](../../models/operations/getcreatetransfersmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
149
+ | `retries` | [utils.RetryConfig](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
150
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
151
+
152
+
153
+ ### Response
154
+
155
+ **Promise<[operations.GetCreateTransfersModelResponse](../../models/operations/getcreatetransfersmodelresponse.md)>**
156
+
@@ -66,7 +66,7 @@ sdk.manageData.pullOperations.list({
66
66
  orderBy: "-modifiedDate",
67
67
  page: 1,
68
68
  pageSize: 100,
69
- query: "natus",
69
+ query: "consequuntur",
70
70
  }).then((res: ListPullOperationsResponse) => {
71
71
  if (res.statusCode == 200) {
72
72
  // handle response
@@ -69,7 +69,7 @@ const sdk = new CodatLending({
69
69
 
70
70
  sdk.manageData.refresh.dataType({
71
71
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
72
- connectionId: "29396fea-7596-4eb1-8faa-a2352c595590",
72
+ connectionId: "dac7af51-5cc4-413a-a63a-ae8d67864dbb",
73
73
  dataType: DataType.Invoices,
74
74
  }).then((res: RefreshDataTypeResponse) => {
75
75
  if (res.statusCode == 200) {
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.customers.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- customerId: "iure",
34
+ customerId: "commodi",
35
35
  }).then((res: GetCommerceCustomerResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -80,7 +80,7 @@ sdk.sales.customers.list({
80
80
  orderBy: "-modifiedDate",
81
81
  page: 1,
82
82
  pageSize: 100,
83
- query: "culpa",
83
+ query: "in",
84
84
  }).then((res: ListCommerceCustomersResponse) => {
85
85
  if (res.statusCode == 200) {
86
86
  // handle response
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.disputes.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- disputeId: "doloribus",
34
+ disputeId: "corporis",
35
35
  }).then((res: GetCommerceDisputeResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -80,7 +80,7 @@ sdk.sales.disputes.list({
80
80
  orderBy: "-modifiedDate",
81
81
  page: 1,
82
82
  pageSize: 100,
83
- query: "sapiente",
83
+ query: "reiciendis",
84
84
  }).then((res: ListCommerceDisputesResponse) => {
85
85
  if (res.statusCode == 200) {
86
86
  // handle response
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.locations.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- locationId: "architecto",
34
+ locationId: "assumenda",
35
35
  }).then((res: GetCommerceLocationResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -55,9 +55,9 @@ sdk.sales.metrics.getCustomerRetention({
55
55
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
56
56
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
57
57
  includeDisplayNames: false,
58
- numberOfPeriods: 652790,
59
- periodLength: 208876,
60
- periodUnit: PeriodUnit.Month,
58
+ numberOfPeriods: 363161,
59
+ periodLength: 924967,
60
+ periodUnit: PeriodUnit.Week,
61
61
  reportDate: "29-09-2020",
62
62
  }).then((res: GetCommerceCustomerRetentionMetricsResponse) => {
63
63
  if (res.statusCode == 200) {
@@ -123,9 +123,9 @@ sdk.sales.metrics.getLifetimeValue({
123
123
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
124
124
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
125
125
  includeDisplayNames: false,
126
- numberOfPeriods: 161309,
127
- periodLength: 995300,
128
- periodUnit: PeriodUnit.Month,
126
+ numberOfPeriods: 46007,
127
+ periodLength: 738683,
128
+ periodUnit: PeriodUnit.Day,
129
129
  reportDate: "29-09-2020",
130
130
  }).then((res: GetCommerceLifetimeValueMetricsResponse) => {
131
131
  if (res.statusCode == 200) {
@@ -192,9 +192,9 @@ sdk.sales.metrics.getRevenue({
192
192
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
193
193
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
194
194
  includeDisplayNames: false,
195
- numberOfPeriods: 581850,
196
- periodLength: 253291,
197
- periodUnit: PeriodUnit.Week,
195
+ numberOfPeriods: 449083,
196
+ periodLength: 348519,
197
+ periodUnit: PeriodUnit.Year,
198
198
  reportDate: "29-09-2020",
199
199
  }).then((res: GetCommerceRevenueMetricsResponse) => {
200
200
  if (res.statusCode == 200) {
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.orders.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- orderId: "quam",
34
+ orderId: "facere",
35
35
  }).then((res: GetCommerceOrderResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -80,7 +80,7 @@ sdk.sales.orders.list({
80
80
  orderBy: "-modifiedDate",
81
81
  page: 1,
82
82
  pageSize: 100,
83
- query: "molestiae",
83
+ query: "numquam",
84
84
  }).then((res: ListCommerceOrdersResponse) => {
85
85
  if (res.statusCode == 200) {
86
86
  // handle response
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.paymentMethods.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- paymentMethodId: "velit",
34
+ paymentMethodId: "doloribus",
35
35
  }).then((res: GetCommercePaymentMethodResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -80,7 +80,7 @@ sdk.sales.paymentMethods.list({
80
80
  orderBy: "-modifiedDate",
81
81
  page: 1,
82
82
  pageSize: 100,
83
- query: "error",
83
+ query: "suscipit",
84
84
  }).then((res: ListCommercePaymentMethodsResponse) => {
85
85
  if (res.statusCode == 200) {
86
86
  // handle response
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
31
31
  sdk.sales.payments.get({
32
32
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
33
33
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
34
- paymentId: "quia",
34
+ paymentId: "reiciendis",
35
35
  }).then((res: GetCommercePaymentResponse) => {
36
36
  if (res.statusCode == 200) {
37
37
  // handle response
@@ -80,7 +80,7 @@ sdk.sales.payments.list({
80
80
  orderBy: "-modifiedDate",
81
81
  page: 1,
82
82
  pageSize: 100,
83
- query: "quis",
83
+ query: "quidem",
84
84
  }).then((res: ListCommercePaymentsResponse) => {
85
85
  if (res.statusCode == 200) {
86
86
  // handle response