@unified-api/typescript-sdk 1.0.0 → 1.0.2

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 (196) hide show
  1. package/README.md +54 -700
  2. package/dist/sdk/accounting.d.ts +0 -40
  3. package/dist/sdk/accounting.js +44 -696
  4. package/dist/sdk/link.d.ts +31 -0
  5. package/dist/sdk/link.js +503 -0
  6. package/dist/sdk/models/operations/{createaccountingpayment.d.ts → createpaymentlink.d.ts} +7 -7
  7. package/dist/sdk/models/operations/createpaymentlink.js +95 -0
  8. package/dist/sdk/models/operations/createpaymentpayment.d.ts +28 -0
  9. package/dist/sdk/models/operations/{createaccountingpayment.js → createpaymentpayment.js} +20 -20
  10. package/dist/sdk/models/operations/getpaymentlink.d.ts +35 -0
  11. package/dist/sdk/models/operations/getpaymentlink.js +99 -0
  12. package/dist/sdk/models/operations/{getaccountingpayment.d.ts → getpaymentpayment.d.ts} +6 -6
  13. package/dist/sdk/models/operations/{getaccountingpayment.js → getpaymentpayment.js} +20 -20
  14. package/dist/sdk/models/operations/{getaccountingpayout.d.ts → getpaymentpayout.d.ts} +6 -6
  15. package/dist/sdk/models/operations/{getaccountingpayout.js → getpaymentpayout.js} +20 -20
  16. package/dist/sdk/models/operations/{getaccountingrefund.d.ts → getpaymentrefund.d.ts} +6 -6
  17. package/dist/sdk/models/operations/{getaccountingrefund.js → getpaymentrefund.js} +20 -20
  18. package/dist/sdk/models/operations/getunifiedintegrationauth.d.ts +6 -4
  19. package/dist/sdk/models/operations/getunifiedintegrationauth.js +6 -4
  20. package/dist/sdk/models/operations/index.d.ts +16 -10
  21. package/dist/sdk/models/operations/index.js +16 -10
  22. package/dist/sdk/models/operations/listpaymentlinks.d.ts +51 -0
  23. package/dist/sdk/models/operations/listpaymentlinks.js +127 -0
  24. package/dist/sdk/models/operations/{listaccountingpayments.d.ts → listpaymentpayments.d.ts} +6 -6
  25. package/dist/sdk/models/operations/{listaccountingpayments.js → listpaymentpayments.js} +28 -28
  26. package/dist/sdk/models/operations/{listaccountingpayouts.d.ts → listpaymentpayouts.d.ts} +6 -6
  27. package/dist/sdk/models/operations/{listaccountingpayouts.js → listpaymentpayouts.js} +26 -26
  28. package/dist/sdk/models/operations/{listaccountingrefunds.d.ts → listpaymentrefunds.d.ts} +6 -6
  29. package/dist/sdk/models/operations/{listaccountingrefunds.js → listpaymentrefunds.js} +27 -27
  30. package/dist/sdk/models/operations/listunifiedconnections.d.ts +2 -1
  31. package/dist/sdk/models/operations/listunifiedconnections.js +1 -0
  32. package/dist/sdk/models/operations/listunifiedintegrations.d.ts +2 -1
  33. package/dist/sdk/models/operations/listunifiedintegrations.js +1 -0
  34. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.d.ts +2 -1
  35. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.js +1 -0
  36. package/dist/sdk/models/operations/patchpaymentlink.d.ts +32 -0
  37. package/dist/sdk/models/operations/patchpaymentlink.js +99 -0
  38. package/dist/sdk/models/operations/{patchaccountingpayment.d.ts → patchpaymentpayment.d.ts} +7 -7
  39. package/dist/sdk/models/operations/{patchaccountingpayment.js → patchpaymentpayment.js} +21 -21
  40. package/dist/sdk/models/operations/removepaymentlink.d.ts +30 -0
  41. package/dist/sdk/models/operations/{removeaccountingpayment.js → removepaymentlink.js} +17 -17
  42. package/dist/sdk/models/operations/{removeaccountingpayment.d.ts → removepaymentpayment.d.ts} +2 -2
  43. package/dist/sdk/models/operations/removepaymentpayment.js +71 -0
  44. package/dist/sdk/models/operations/updatepaymentlink.d.ts +32 -0
  45. package/dist/sdk/models/operations/updatepaymentlink.js +99 -0
  46. package/dist/sdk/models/operations/{updateaccountingpayment.d.ts → updatepaymentpayment.d.ts} +7 -7
  47. package/dist/sdk/models/operations/{updateaccountingpayment.js → updatepaymentpayment.js} +21 -21
  48. package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -0
  49. package/dist/sdk/models/shared/accountinginvoice.js +5 -0
  50. package/dist/sdk/models/shared/index.d.ts +5 -3
  51. package/dist/sdk/models/shared/index.js +5 -3
  52. package/dist/sdk/models/shared/paymenntlinklineitem.d.ts +20 -0
  53. package/dist/sdk/models/shared/paymenntlinklineitem.js +137 -0
  54. package/dist/sdk/models/shared/paymentlink.d.ts +15 -0
  55. package/dist/sdk/models/shared/paymentlink.js +105 -0
  56. package/dist/sdk/models/shared/{accountingpayment.d.ts → paymentpayment.d.ts} +1 -1
  57. package/dist/sdk/models/shared/{accountingpayment.js → paymentpayment.js} +18 -18
  58. package/dist/sdk/models/shared/{accountingpayout.d.ts → paymentpayout.d.ts} +3 -3
  59. package/dist/sdk/models/shared/{accountingpayout.js → paymentpayout.js} +21 -21
  60. package/dist/sdk/models/shared/{accountingrefund.d.ts → paymentrefund.d.ts} +3 -3
  61. package/dist/sdk/models/shared/{accountingrefund.js → paymentrefund.js} +23 -23
  62. package/dist/sdk/models/shared/propertyconnectioncategories.d.ts +2 -1
  63. package/dist/sdk/models/shared/propertyconnectioncategories.js +1 -0
  64. package/dist/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -4
  65. package/dist/sdk/models/shared/propertyconnectionpermissions.js +6 -4
  66. package/dist/sdk/models/shared/propertyintegrationcategories.d.ts +2 -1
  67. package/dist/sdk/models/shared/propertyintegrationcategories.js +1 -0
  68. package/dist/sdk/models/shared/webhook.d.ts +4 -3
  69. package/dist/sdk/models/shared/webhook.js +4 -3
  70. package/dist/sdk/payment.d.ts +46 -6
  71. package/dist/sdk/payment.js +705 -53
  72. package/dist/sdk/payout.d.ts +2 -2
  73. package/dist/sdk/payout.js +11 -11
  74. package/dist/sdk/refund.d.ts +2 -2
  75. package/dist/sdk/refund.js +11 -11
  76. package/dist/sdk/sdk.d.ts +5 -3
  77. package/dist/sdk/sdk.js +7 -5
  78. package/docs/sdk/models/operations/categories.md +2 -1
  79. package/docs/sdk/models/operations/createpaymentlinkrequest.md +9 -0
  80. package/docs/sdk/models/operations/createpaymentlinkresponse.md +11 -0
  81. package/docs/sdk/models/operations/createpaymentpaymentrequest.md +9 -0
  82. package/docs/sdk/models/operations/createpaymentpaymentresponse.md +11 -0
  83. package/docs/sdk/models/operations/getpaymentlinkrequest.md +10 -0
  84. package/docs/sdk/models/operations/getpaymentlinkresponse.md +11 -0
  85. package/docs/sdk/models/operations/{getaccountingpaymentrequest.md → getpaymentpaymentrequest.md} +1 -1
  86. package/docs/sdk/models/operations/getpaymentpaymentresponse.md +11 -0
  87. package/docs/sdk/models/operations/{getaccountingpayoutrequest.md → getpaymentpayoutrequest.md} +1 -1
  88. package/docs/sdk/models/operations/getpaymentpayoutresponse.md +11 -0
  89. package/docs/sdk/models/operations/{getaccountingrefundrequest.md → getpaymentrefundrequest.md} +1 -1
  90. package/docs/sdk/models/operations/getpaymentrefundresponse.md +11 -0
  91. package/docs/sdk/models/operations/listpaymentlinksrequest.md +17 -0
  92. package/docs/sdk/models/operations/listpaymentlinksresponse.md +11 -0
  93. package/docs/sdk/models/operations/{listaccountingpaymentsrequest.md → listpaymentpaymentsrequest.md} +1 -1
  94. package/docs/sdk/models/operations/listpaymentpaymentsresponse.md +11 -0
  95. package/docs/sdk/models/operations/{listaccountingpayoutsrequest.md → listpaymentpayoutsrequest.md} +1 -1
  96. package/docs/sdk/models/operations/listpaymentpayoutsresponse.md +11 -0
  97. package/docs/sdk/models/operations/{listaccountingrefundsrequest.md → listpaymentrefundsrequest.md} +1 -1
  98. package/docs/sdk/models/operations/listpaymentrefundsresponse.md +11 -0
  99. package/docs/sdk/models/operations/listunifiedintegrationsqueryparamcategories.md +2 -1
  100. package/docs/sdk/models/operations/patchpaymentlinkrequest.md +10 -0
  101. package/docs/sdk/models/operations/patchpaymentlinkresponse.md +11 -0
  102. package/docs/sdk/models/operations/patchpaymentpaymentrequest.md +10 -0
  103. package/docs/sdk/models/operations/patchpaymentpaymentresponse.md +11 -0
  104. package/docs/sdk/models/operations/queryparamcategories.md +2 -1
  105. package/docs/sdk/models/operations/{removeaccountingpaymentrequest.md → removepaymentlinkrequest.md} +2 -2
  106. package/docs/sdk/models/operations/{removeaccountingpaymentresponse.md → removepaymentlinkresponse.md} +1 -1
  107. package/docs/sdk/models/operations/removepaymentpaymentrequest.md +9 -0
  108. package/docs/sdk/models/operations/removepaymentpaymentresponse.md +11 -0
  109. package/docs/sdk/models/operations/scopes.md +6 -4
  110. package/docs/sdk/models/operations/updatepaymentlinkrequest.md +10 -0
  111. package/docs/sdk/models/operations/updatepaymentlinkresponse.md +11 -0
  112. package/docs/sdk/models/operations/updatepaymentpaymentrequest.md +10 -0
  113. package/docs/sdk/models/operations/updatepaymentpaymentresponse.md +11 -0
  114. package/docs/sdk/models/shared/accountinginvoice.md +2 -1
  115. package/docs/sdk/models/shared/objecttype.md +4 -3
  116. package/docs/sdk/models/shared/paymenntlinklineitem.md +24 -0
  117. package/docs/sdk/models/shared/paymentlink.md +18 -0
  118. package/docs/sdk/models/shared/{accountingpayment.md → paymentpayment.md} +1 -1
  119. package/docs/sdk/models/shared/paymentpayout.md +15 -0
  120. package/docs/sdk/models/shared/{accountingpayoutstatus.md → paymentpayoutstatus.md} +1 -1
  121. package/docs/sdk/models/shared/paymentrefund.md +17 -0
  122. package/docs/sdk/models/shared/{accountingrefundstatus.md → paymentrefundstatus.md} +1 -1
  123. package/docs/sdk/models/shared/propertyconnectioncategories.md +2 -1
  124. package/docs/sdk/models/shared/propertyconnectionpermissions.md +6 -4
  125. package/docs/sdk/models/shared/propertyintegrationcategories.md +2 -1
  126. package/package.json +1 -1
  127. package/docs/sdk/models/operations/createaccountingpaymentrequest.md +0 -9
  128. package/docs/sdk/models/operations/createaccountingpaymentresponse.md +0 -11
  129. package/docs/sdk/models/operations/getaccountingpaymentresponse.md +0 -11
  130. package/docs/sdk/models/operations/getaccountingpayoutresponse.md +0 -11
  131. package/docs/sdk/models/operations/getaccountingrefundresponse.md +0 -11
  132. package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +0 -11
  133. package/docs/sdk/models/operations/listaccountingpayoutsresponse.md +0 -11
  134. package/docs/sdk/models/operations/listaccountingrefundsresponse.md +0 -11
  135. package/docs/sdk/models/operations/patchaccountingpaymentrequest.md +0 -10
  136. package/docs/sdk/models/operations/patchaccountingpaymentresponse.md +0 -11
  137. package/docs/sdk/models/operations/updateaccountingpaymentrequest.md +0 -10
  138. package/docs/sdk/models/operations/updateaccountingpaymentresponse.md +0 -11
  139. package/docs/sdk/models/shared/accountingpayout.md +0 -15
  140. package/docs/sdk/models/shared/accountingrefund.md +0 -17
  141. package/docs/sdks/account/README.md +0 -312
  142. package/docs/sdks/accounting/README.md +0 -2198
  143. package/docs/sdks/activity/README.md +0 -321
  144. package/docs/sdks/apicall/README.md +0 -95
  145. package/docs/sdks/application/README.md +0 -333
  146. package/docs/sdks/applicationstatus/README.md +0 -54
  147. package/docs/sdks/ats/README.md +0 -2488
  148. package/docs/sdks/auth/README.md +0 -103
  149. package/docs/sdks/call/README.md +0 -54
  150. package/docs/sdks/candidate/README.md +0 -369
  151. package/docs/sdks/collection/README.md +0 -348
  152. package/docs/sdks/commerce/README.md +0 -1371
  153. package/docs/sdks/company/README.md +0 -517
  154. package/docs/sdks/connection/README.md +0 -359
  155. package/docs/sdks/contact/README.md +0 -1028
  156. package/docs/sdks/crm/README.md +0 -2048
  157. package/docs/sdks/customer/README.md +0 -348
  158. package/docs/sdks/deal/README.md +0 -315
  159. package/docs/sdks/document/README.md +0 -309
  160. package/docs/sdks/employee/README.md +0 -363
  161. package/docs/sdks/enrich/README.md +0 -97
  162. package/docs/sdks/event/README.md +0 -390
  163. package/docs/sdks/file/README.md +0 -330
  164. package/docs/sdks/group/README.md +0 -327
  165. package/docs/sdks/hris/README.md +0 -685
  166. package/docs/sdks/integration/README.md +0 -155
  167. package/docs/sdks/interview/README.md +0 -318
  168. package/docs/sdks/inventory/README.md +0 -309
  169. package/docs/sdks/invoice/README.md +0 -324
  170. package/docs/sdks/issue/README.md +0 -49
  171. package/docs/sdks/item/README.md +0 -417
  172. package/docs/sdks/job/README.md +0 -396
  173. package/docs/sdks/lead/README.md +0 -336
  174. package/docs/sdks/list/README.md +0 -306
  175. package/docs/sdks/location/README.md +0 -312
  176. package/docs/sdks/login/README.md +0 -52
  177. package/docs/sdks/martech/README.md +0 -643
  178. package/docs/sdks/member/README.md +0 -342
  179. package/docs/sdks/note/README.md +0 -306
  180. package/docs/sdks/organization/README.md +0 -104
  181. package/docs/sdks/passthrough/README.md +0 -249
  182. package/docs/sdks/payment/README.md +0 -306
  183. package/docs/sdks/payout/README.md +0 -104
  184. package/docs/sdks/person/README.md +0 -51
  185. package/docs/sdks/pipeline/README.md +0 -306
  186. package/docs/sdks/refund/README.md +0 -104
  187. package/docs/sdks/scorecard/README.md +0 -324
  188. package/docs/sdks/storage/README.md +0 -330
  189. package/docs/sdks/taxrate/README.md +0 -312
  190. package/docs/sdks/ticket/README.md +0 -318
  191. package/docs/sdks/ticketing/README.md +0 -962
  192. package/docs/sdks/transaction/README.md +0 -327
  193. package/docs/sdks/uc/README.md +0 -388
  194. package/docs/sdks/unified/README.md +0 -929
  195. package/docs/sdks/unifiedto/README.md +0 -9
  196. package/docs/sdks/webhook/README.md +0 -291
@@ -1,2198 +0,0 @@
1
- # Accounting
2
- (*accounting*)
3
-
4
- ### Available Operations
5
-
6
- * [createAccountingAccount](#createaccountingaccount) - Create an account
7
- * [createAccountingContact](#createaccountingcontact) - Create a contact
8
- * [createAccountingInvoice](#createaccountinginvoice) - Create a invoice
9
- * [createAccountingPayment](#createaccountingpayment) - Create a payment
10
- * [createAccountingTaxrate](#createaccountingtaxrate) - Create a taxrate
11
- * [createAccountingTransaction](#createaccountingtransaction) - Create a transaction
12
- * [getAccountingAccount](#getaccountingaccount) - Retrieve an account
13
- * [getAccountingContact](#getaccountingcontact) - Retrieve a contact
14
- * [getAccountingInvoice](#getaccountinginvoice) - Retrieve a invoice
15
- * [getAccountingOrganization](#getaccountingorganization) - Retrieve an organization
16
- * [getAccountingPayment](#getaccountingpayment) - Retrieve a payment
17
- * [getAccountingPayout](#getaccountingpayout) - Retrieve a payout
18
- * [getAccountingRefund](#getaccountingrefund) - Retrieve a refund
19
- * [getAccountingTaxrate](#getaccountingtaxrate) - Retrieve a taxrate
20
- * [getAccountingTransaction](#getaccountingtransaction) - Retrieve a transaction
21
- * [listAccountingAccounts](#listaccountingaccounts) - List all accounts
22
- * [listAccountingContacts](#listaccountingcontacts) - List all contacts
23
- * [listAccountingInvoices](#listaccountinginvoices) - List all invoices
24
- * [listAccountingOrganizations](#listaccountingorganizations) - List all organizations
25
- * [listAccountingPayments](#listaccountingpayments) - List all payments
26
- * [listAccountingPayouts](#listaccountingpayouts) - List all payouts
27
- * [listAccountingRefunds](#listaccountingrefunds) - List all refunds
28
- * [listAccountingTaxrates](#listaccountingtaxrates) - List all taxrates
29
- * [listAccountingTransactions](#listaccountingtransactions) - List all transactions
30
- * [patchAccountingAccount](#patchaccountingaccount) - Update an account
31
- * [patchAccountingContact](#patchaccountingcontact) - Update a contact
32
- * [patchAccountingInvoice](#patchaccountinginvoice) - Update a invoice
33
- * [patchAccountingPayment](#patchaccountingpayment) - Update a payment
34
- * [patchAccountingTaxrate](#patchaccountingtaxrate) - Update a taxrate
35
- * [patchAccountingTransaction](#patchaccountingtransaction) - Update a transaction
36
- * [removeAccountingAccount](#removeaccountingaccount) - Remove an account
37
- * [removeAccountingContact](#removeaccountingcontact) - Remove a contact
38
- * [removeAccountingInvoice](#removeaccountinginvoice) - Remove a invoice
39
- * [removeAccountingPayment](#removeaccountingpayment) - Remove a payment
40
- * [removeAccountingTaxrate](#removeaccountingtaxrate) - Remove a taxrate
41
- * [removeAccountingTransaction](#removeaccountingtransaction) - Remove a transaction
42
- * [updateAccountingAccount](#updateaccountingaccount) - Update an account
43
- * [updateAccountingContact](#updateaccountingcontact) - Update a contact
44
- * [updateAccountingInvoice](#updateaccountinginvoice) - Update a invoice
45
- * [updateAccountingPayment](#updateaccountingpayment) - Update a payment
46
- * [updateAccountingTaxrate](#updateaccountingtaxrate) - Update a taxrate
47
- * [updateAccountingTransaction](#updateaccountingtransaction) - Update a transaction
48
-
49
- ## createAccountingAccount
50
-
51
- Create an account
52
-
53
- ### Example Usage
54
-
55
- ```typescript
56
- import { UnifiedTo } from "@unified-api/typescript-sdk";
57
- import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
58
-
59
- async function run() {
60
- const sdk = new UnifiedTo({
61
- security: {
62
- jwt: "<YOUR_API_KEY_HERE>",
63
- },
64
- });
65
-
66
- const res = await sdk.accounting.createAccountingAccount({
67
- accountingAccount: {
68
- name: "<value>",
69
- raw: {
70
- "key": "<value>",
71
- },
72
- },
73
- connectionId: "<value>",
74
- });
75
-
76
- if (res.statusCode == 200) {
77
- // handle response
78
- }
79
- }
80
-
81
- run();
82
- ```
83
-
84
- ### Parameters
85
-
86
- | Parameter | Type | Required | Description |
87
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
88
- | `request` | [operations.CreateAccountingAccountRequest](../../sdk/models/operations/createaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
89
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
90
-
91
-
92
- ### Response
93
-
94
- **Promise<[operations.CreateAccountingAccountResponse](../../sdk/models/operations/createaccountingaccountresponse.md)>**
95
- ### Errors
96
-
97
- | Error Object | Status Code | Content Type |
98
- | --------------- | --------------- | --------------- |
99
- | errors.SDKError | 4xx-5xx | */* |
100
-
101
- ## createAccountingContact
102
-
103
- Create a contact
104
-
105
- ### Example Usage
106
-
107
- ```typescript
108
- import { UnifiedTo } from "@unified-api/typescript-sdk";
109
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
110
-
111
- async function run() {
112
- const sdk = new UnifiedTo({
113
- security: {
114
- jwt: "<YOUR_API_KEY_HERE>",
115
- },
116
- });
117
-
118
- const res = await sdk.accounting.createAccountingContact({
119
- accountingContact: {
120
- billingAddress: {},
121
- emails: [
122
- {
123
- email: "Mac36@gmail.com",
124
- },
125
- ],
126
- raw: {
127
- "key": "<value>",
128
- },
129
- shippingAddress: {},
130
- telephones: [
131
- {
132
- telephone: "<value>",
133
- },
134
- ],
135
- },
136
- connectionId: "<value>",
137
- });
138
-
139
- if (res.statusCode == 200) {
140
- // handle response
141
- }
142
- }
143
-
144
- run();
145
- ```
146
-
147
- ### Parameters
148
-
149
- | Parameter | Type | Required | Description |
150
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
151
- | `request` | [operations.CreateAccountingContactRequest](../../sdk/models/operations/createaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
152
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
153
-
154
-
155
- ### Response
156
-
157
- **Promise<[operations.CreateAccountingContactResponse](../../sdk/models/operations/createaccountingcontactresponse.md)>**
158
- ### Errors
159
-
160
- | Error Object | Status Code | Content Type |
161
- | --------------- | --------------- | --------------- |
162
- | errors.SDKError | 4xx-5xx | */* |
163
-
164
- ## createAccountingInvoice
165
-
166
- Create a invoice
167
-
168
- ### Example Usage
169
-
170
- ```typescript
171
- import { UnifiedTo } from "@unified-api/typescript-sdk";
172
- import { AccountingInvoiceStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
173
-
174
- async function run() {
175
- const sdk = new UnifiedTo({
176
- security: {
177
- jwt: "<YOUR_API_KEY_HERE>",
178
- },
179
- });
180
-
181
- const res = await sdk.accounting.createAccountingInvoice({
182
- accountingInvoice: {
183
- lineitems: [
184
- {
185
- totalAmount: 6736.06,
186
- },
187
- ],
188
- raw: {
189
- "key": "<value>",
190
- },
191
- },
192
- connectionId: "<value>",
193
- });
194
-
195
- if (res.statusCode == 200) {
196
- // handle response
197
- }
198
- }
199
-
200
- run();
201
- ```
202
-
203
- ### Parameters
204
-
205
- | Parameter | Type | Required | Description |
206
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
207
- | `request` | [operations.CreateAccountingInvoiceRequest](../../sdk/models/operations/createaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
208
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
209
-
210
-
211
- ### Response
212
-
213
- **Promise<[operations.CreateAccountingInvoiceResponse](../../sdk/models/operations/createaccountinginvoiceresponse.md)>**
214
- ### Errors
215
-
216
- | Error Object | Status Code | Content Type |
217
- | --------------- | --------------- | --------------- |
218
- | errors.SDKError | 4xx-5xx | */* |
219
-
220
- ## createAccountingPayment
221
-
222
- Create a payment
223
-
224
- ### Example Usage
225
-
226
- ```typescript
227
- import { UnifiedTo } from "@unified-api/typescript-sdk";
228
-
229
- async function run() {
230
- const sdk = new UnifiedTo({
231
- security: {
232
- jwt: "<YOUR_API_KEY_HERE>",
233
- },
234
- });
235
-
236
- const res = await sdk.accounting.createAccountingPayment({
237
- accountingPayment: {
238
- raw: {
239
- "key": "<value>",
240
- },
241
- },
242
- connectionId: "<value>",
243
- });
244
-
245
- if (res.statusCode == 200) {
246
- // handle response
247
- }
248
- }
249
-
250
- run();
251
- ```
252
-
253
- ### Parameters
254
-
255
- | Parameter | Type | Required | Description |
256
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
257
- | `request` | [operations.CreateAccountingPaymentRequest](../../sdk/models/operations/createaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
258
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
259
-
260
-
261
- ### Response
262
-
263
- **Promise<[operations.CreateAccountingPaymentResponse](../../sdk/models/operations/createaccountingpaymentresponse.md)>**
264
- ### Errors
265
-
266
- | Error Object | Status Code | Content Type |
267
- | --------------- | --------------- | --------------- |
268
- | errors.SDKError | 4xx-5xx | */* |
269
-
270
- ## createAccountingTaxrate
271
-
272
- Create a taxrate
273
-
274
- ### Example Usage
275
-
276
- ```typescript
277
- import { UnifiedTo } from "@unified-api/typescript-sdk";
278
-
279
- async function run() {
280
- const sdk = new UnifiedTo({
281
- security: {
282
- jwt: "<YOUR_API_KEY_HERE>",
283
- },
284
- });
285
-
286
- const res = await sdk.accounting.createAccountingTaxrate({
287
- accountingTaxrate: {
288
- name: "<value>",
289
- rate: 1719.1,
290
- raw: {
291
- "key": "<value>",
292
- },
293
- },
294
- connectionId: "<value>",
295
- });
296
-
297
- if (res.statusCode == 200) {
298
- // handle response
299
- }
300
- }
301
-
302
- run();
303
- ```
304
-
305
- ### Parameters
306
-
307
- | Parameter | Type | Required | Description |
308
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
309
- | `request` | [operations.CreateAccountingTaxrateRequest](../../sdk/models/operations/createaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
310
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
311
-
312
-
313
- ### Response
314
-
315
- **Promise<[operations.CreateAccountingTaxrateResponse](../../sdk/models/operations/createaccountingtaxrateresponse.md)>**
316
- ### Errors
317
-
318
- | Error Object | Status Code | Content Type |
319
- | --------------- | --------------- | --------------- |
320
- | errors.SDKError | 4xx-5xx | */* |
321
-
322
- ## createAccountingTransaction
323
-
324
- Create a transaction
325
-
326
- ### Example Usage
327
-
328
- ```typescript
329
- import { UnifiedTo } from "@unified-api/typescript-sdk";
330
-
331
- async function run() {
332
- const sdk = new UnifiedTo({
333
- security: {
334
- jwt: "<YOUR_API_KEY_HERE>",
335
- },
336
- });
337
-
338
- const res = await sdk.accounting.createAccountingTransaction({
339
- accountingTransaction: {
340
- id: "<id>",
341
- lineitems: [
342
- {
343
- accountId: "<value>",
344
- totalAmount: 4969.62,
345
- },
346
- ],
347
- raw: {
348
- "key": "<value>",
349
- },
350
- },
351
- connectionId: "<value>",
352
- });
353
-
354
- if (res.statusCode == 200) {
355
- // handle response
356
- }
357
- }
358
-
359
- run();
360
- ```
361
-
362
- ### Parameters
363
-
364
- | Parameter | Type | Required | Description |
365
- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
366
- | `request` | [operations.CreateAccountingTransactionRequest](../../sdk/models/operations/createaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
367
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
368
-
369
-
370
- ### Response
371
-
372
- **Promise<[operations.CreateAccountingTransactionResponse](../../sdk/models/operations/createaccountingtransactionresponse.md)>**
373
- ### Errors
374
-
375
- | Error Object | Status Code | Content Type |
376
- | --------------- | --------------- | --------------- |
377
- | errors.SDKError | 4xx-5xx | */* |
378
-
379
- ## getAccountingAccount
380
-
381
- Retrieve an account
382
-
383
- ### Example Usage
384
-
385
- ```typescript
386
- import { UnifiedTo } from "@unified-api/typescript-sdk";
387
-
388
- async function run() {
389
- const sdk = new UnifiedTo({
390
- security: {
391
- jwt: "<YOUR_API_KEY_HERE>",
392
- },
393
- });
394
-
395
- const res = await sdk.accounting.getAccountingAccount({
396
- connectionId: "<value>",
397
- fields: [
398
- "<value>",
399
- ],
400
- id: "<id>",
401
- });
402
-
403
- if (res.statusCode == 200) {
404
- // handle response
405
- }
406
- }
407
-
408
- run();
409
- ```
410
-
411
- ### Parameters
412
-
413
- | Parameter | Type | Required | Description |
414
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
415
- | `request` | [operations.GetAccountingAccountRequest](../../sdk/models/operations/getaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
416
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
417
-
418
-
419
- ### Response
420
-
421
- **Promise<[operations.GetAccountingAccountResponse](../../sdk/models/operations/getaccountingaccountresponse.md)>**
422
- ### Errors
423
-
424
- | Error Object | Status Code | Content Type |
425
- | --------------- | --------------- | --------------- |
426
- | errors.SDKError | 4xx-5xx | */* |
427
-
428
- ## getAccountingContact
429
-
430
- Retrieve a contact
431
-
432
- ### Example Usage
433
-
434
- ```typescript
435
- import { UnifiedTo } from "@unified-api/typescript-sdk";
436
-
437
- async function run() {
438
- const sdk = new UnifiedTo({
439
- security: {
440
- jwt: "<YOUR_API_KEY_HERE>",
441
- },
442
- });
443
-
444
- const res = await sdk.accounting.getAccountingContact({
445
- connectionId: "<value>",
446
- fields: [
447
- "<value>",
448
- ],
449
- id: "<id>",
450
- });
451
-
452
- if (res.statusCode == 200) {
453
- // handle response
454
- }
455
- }
456
-
457
- run();
458
- ```
459
-
460
- ### Parameters
461
-
462
- | Parameter | Type | Required | Description |
463
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
464
- | `request` | [operations.GetAccountingContactRequest](../../sdk/models/operations/getaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
465
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
466
-
467
-
468
- ### Response
469
-
470
- **Promise<[operations.GetAccountingContactResponse](../../sdk/models/operations/getaccountingcontactresponse.md)>**
471
- ### Errors
472
-
473
- | Error Object | Status Code | Content Type |
474
- | --------------- | --------------- | --------------- |
475
- | errors.SDKError | 4xx-5xx | */* |
476
-
477
- ## getAccountingInvoice
478
-
479
- Retrieve a invoice
480
-
481
- ### Example Usage
482
-
483
- ```typescript
484
- import { UnifiedTo } from "@unified-api/typescript-sdk";
485
-
486
- async function run() {
487
- const sdk = new UnifiedTo({
488
- security: {
489
- jwt: "<YOUR_API_KEY_HERE>",
490
- },
491
- });
492
-
493
- const res = await sdk.accounting.getAccountingInvoice({
494
- connectionId: "<value>",
495
- fields: [
496
- "<value>",
497
- ],
498
- id: "<id>",
499
- });
500
-
501
- if (res.statusCode == 200) {
502
- // handle response
503
- }
504
- }
505
-
506
- run();
507
- ```
508
-
509
- ### Parameters
510
-
511
- | Parameter | Type | Required | Description |
512
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
513
- | `request` | [operations.GetAccountingInvoiceRequest](../../sdk/models/operations/getaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
514
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
515
-
516
-
517
- ### Response
518
-
519
- **Promise<[operations.GetAccountingInvoiceResponse](../../sdk/models/operations/getaccountinginvoiceresponse.md)>**
520
- ### Errors
521
-
522
- | Error Object | Status Code | Content Type |
523
- | --------------- | --------------- | --------------- |
524
- | errors.SDKError | 4xx-5xx | */* |
525
-
526
- ## getAccountingOrganization
527
-
528
- Retrieve an organization
529
-
530
- ### Example Usage
531
-
532
- ```typescript
533
- import { UnifiedTo } from "@unified-api/typescript-sdk";
534
-
535
- async function run() {
536
- const sdk = new UnifiedTo({
537
- security: {
538
- jwt: "<YOUR_API_KEY_HERE>",
539
- },
540
- });
541
-
542
- const res = await sdk.accounting.getAccountingOrganization({
543
- connectionId: "<value>",
544
- fields: [
545
- "<value>",
546
- ],
547
- id: "<id>",
548
- });
549
-
550
- if (res.statusCode == 200) {
551
- // handle response
552
- }
553
- }
554
-
555
- run();
556
- ```
557
-
558
- ### Parameters
559
-
560
- | Parameter | Type | Required | Description |
561
- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
562
- | `request` | [operations.GetAccountingOrganizationRequest](../../sdk/models/operations/getaccountingorganizationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
563
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
564
-
565
-
566
- ### Response
567
-
568
- **Promise<[operations.GetAccountingOrganizationResponse](../../sdk/models/operations/getaccountingorganizationresponse.md)>**
569
- ### Errors
570
-
571
- | Error Object | Status Code | Content Type |
572
- | --------------- | --------------- | --------------- |
573
- | errors.SDKError | 4xx-5xx | */* |
574
-
575
- ## getAccountingPayment
576
-
577
- Retrieve a payment
578
-
579
- ### Example Usage
580
-
581
- ```typescript
582
- import { UnifiedTo } from "@unified-api/typescript-sdk";
583
-
584
- async function run() {
585
- const sdk = new UnifiedTo({
586
- security: {
587
- jwt: "<YOUR_API_KEY_HERE>",
588
- },
589
- });
590
-
591
- const res = await sdk.accounting.getAccountingPayment({
592
- connectionId: "<value>",
593
- fields: [
594
- "<value>",
595
- ],
596
- id: "<id>",
597
- });
598
-
599
- if (res.statusCode == 200) {
600
- // handle response
601
- }
602
- }
603
-
604
- run();
605
- ```
606
-
607
- ### Parameters
608
-
609
- | Parameter | Type | Required | Description |
610
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
611
- | `request` | [operations.GetAccountingPaymentRequest](../../sdk/models/operations/getaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
612
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
613
-
614
-
615
- ### Response
616
-
617
- **Promise<[operations.GetAccountingPaymentResponse](../../sdk/models/operations/getaccountingpaymentresponse.md)>**
618
- ### Errors
619
-
620
- | Error Object | Status Code | Content Type |
621
- | --------------- | --------------- | --------------- |
622
- | errors.SDKError | 4xx-5xx | */* |
623
-
624
- ## getAccountingPayout
625
-
626
- Retrieve a payout
627
-
628
- ### Example Usage
629
-
630
- ```typescript
631
- import { UnifiedTo } from "@unified-api/typescript-sdk";
632
-
633
- async function run() {
634
- const sdk = new UnifiedTo({
635
- security: {
636
- jwt: "<YOUR_API_KEY_HERE>",
637
- },
638
- });
639
-
640
- const res = await sdk.accounting.getAccountingPayout({
641
- connectionId: "<value>",
642
- fields: [
643
- "<value>",
644
- ],
645
- id: "<id>",
646
- });
647
-
648
- if (res.statusCode == 200) {
649
- // handle response
650
- }
651
- }
652
-
653
- run();
654
- ```
655
-
656
- ### Parameters
657
-
658
- | Parameter | Type | Required | Description |
659
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
660
- | `request` | [operations.GetAccountingPayoutRequest](../../sdk/models/operations/getaccountingpayoutrequest.md) | :heavy_check_mark: | The request object to use for the request. |
661
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
662
-
663
-
664
- ### Response
665
-
666
- **Promise<[operations.GetAccountingPayoutResponse](../../sdk/models/operations/getaccountingpayoutresponse.md)>**
667
- ### Errors
668
-
669
- | Error Object | Status Code | Content Type |
670
- | --------------- | --------------- | --------------- |
671
- | errors.SDKError | 4xx-5xx | */* |
672
-
673
- ## getAccountingRefund
674
-
675
- Retrieve a refund
676
-
677
- ### Example Usage
678
-
679
- ```typescript
680
- import { UnifiedTo } from "@unified-api/typescript-sdk";
681
-
682
- async function run() {
683
- const sdk = new UnifiedTo({
684
- security: {
685
- jwt: "<YOUR_API_KEY_HERE>",
686
- },
687
- });
688
-
689
- const res = await sdk.accounting.getAccountingRefund({
690
- connectionId: "<value>",
691
- fields: [
692
- "<value>",
693
- ],
694
- id: "<id>",
695
- });
696
-
697
- if (res.statusCode == 200) {
698
- // handle response
699
- }
700
- }
701
-
702
- run();
703
- ```
704
-
705
- ### Parameters
706
-
707
- | Parameter | Type | Required | Description |
708
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
709
- | `request` | [operations.GetAccountingRefundRequest](../../sdk/models/operations/getaccountingrefundrequest.md) | :heavy_check_mark: | The request object to use for the request. |
710
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
711
-
712
-
713
- ### Response
714
-
715
- **Promise<[operations.GetAccountingRefundResponse](../../sdk/models/operations/getaccountingrefundresponse.md)>**
716
- ### Errors
717
-
718
- | Error Object | Status Code | Content Type |
719
- | --------------- | --------------- | --------------- |
720
- | errors.SDKError | 4xx-5xx | */* |
721
-
722
- ## getAccountingTaxrate
723
-
724
- Retrieve a taxrate
725
-
726
- ### Example Usage
727
-
728
- ```typescript
729
- import { UnifiedTo } from "@unified-api/typescript-sdk";
730
-
731
- async function run() {
732
- const sdk = new UnifiedTo({
733
- security: {
734
- jwt: "<YOUR_API_KEY_HERE>",
735
- },
736
- });
737
-
738
- const res = await sdk.accounting.getAccountingTaxrate({
739
- connectionId: "<value>",
740
- fields: [
741
- "<value>",
742
- ],
743
- id: "<id>",
744
- });
745
-
746
- if (res.statusCode == 200) {
747
- // handle response
748
- }
749
- }
750
-
751
- run();
752
- ```
753
-
754
- ### Parameters
755
-
756
- | Parameter | Type | Required | Description |
757
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
758
- | `request` | [operations.GetAccountingTaxrateRequest](../../sdk/models/operations/getaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
759
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
760
-
761
-
762
- ### Response
763
-
764
- **Promise<[operations.GetAccountingTaxrateResponse](../../sdk/models/operations/getaccountingtaxrateresponse.md)>**
765
- ### Errors
766
-
767
- | Error Object | Status Code | Content Type |
768
- | --------------- | --------------- | --------------- |
769
- | errors.SDKError | 4xx-5xx | */* |
770
-
771
- ## getAccountingTransaction
772
-
773
- Retrieve a transaction
774
-
775
- ### Example Usage
776
-
777
- ```typescript
778
- import { UnifiedTo } from "@unified-api/typescript-sdk";
779
-
780
- async function run() {
781
- const sdk = new UnifiedTo({
782
- security: {
783
- jwt: "<YOUR_API_KEY_HERE>",
784
- },
785
- });
786
-
787
- const res = await sdk.accounting.getAccountingTransaction({
788
- connectionId: "<value>",
789
- fields: [
790
- "<value>",
791
- ],
792
- id: "<id>",
793
- });
794
-
795
- if (res.statusCode == 200) {
796
- // handle response
797
- }
798
- }
799
-
800
- run();
801
- ```
802
-
803
- ### Parameters
804
-
805
- | Parameter | Type | Required | Description |
806
- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
807
- | `request` | [operations.GetAccountingTransactionRequest](../../sdk/models/operations/getaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
808
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
809
-
810
-
811
- ### Response
812
-
813
- **Promise<[operations.GetAccountingTransactionResponse](../../sdk/models/operations/getaccountingtransactionresponse.md)>**
814
- ### Errors
815
-
816
- | Error Object | Status Code | Content Type |
817
- | --------------- | --------------- | --------------- |
818
- | errors.SDKError | 4xx-5xx | */* |
819
-
820
- ## listAccountingAccounts
821
-
822
- List all accounts
823
-
824
- ### Example Usage
825
-
826
- ```typescript
827
- import { UnifiedTo } from "@unified-api/typescript-sdk";
828
-
829
- async function run() {
830
- const sdk = new UnifiedTo({
831
- security: {
832
- jwt: "<YOUR_API_KEY_HERE>",
833
- },
834
- });
835
-
836
- const res = await sdk.accounting.listAccountingAccounts({
837
- connectionId: "<value>",
838
- fields: [
839
- "<value>",
840
- ],
841
- });
842
-
843
- if (res.statusCode == 200) {
844
- // handle response
845
- }
846
- }
847
-
848
- run();
849
- ```
850
-
851
- ### Parameters
852
-
853
- | Parameter | Type | Required | Description |
854
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
855
- | `request` | [operations.ListAccountingAccountsRequest](../../sdk/models/operations/listaccountingaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
856
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
857
-
858
-
859
- ### Response
860
-
861
- **Promise<[operations.ListAccountingAccountsResponse](../../sdk/models/operations/listaccountingaccountsresponse.md)>**
862
- ### Errors
863
-
864
- | Error Object | Status Code | Content Type |
865
- | --------------- | --------------- | --------------- |
866
- | errors.SDKError | 4xx-5xx | */* |
867
-
868
- ## listAccountingContacts
869
-
870
- List all contacts
871
-
872
- ### Example Usage
873
-
874
- ```typescript
875
- import { UnifiedTo } from "@unified-api/typescript-sdk";
876
-
877
- async function run() {
878
- const sdk = new UnifiedTo({
879
- security: {
880
- jwt: "<YOUR_API_KEY_HERE>",
881
- },
882
- });
883
-
884
- const res = await sdk.accounting.listAccountingContacts({
885
- connectionId: "<value>",
886
- fields: [
887
- "<value>",
888
- ],
889
- });
890
-
891
- if (res.statusCode == 200) {
892
- // handle response
893
- }
894
- }
895
-
896
- run();
897
- ```
898
-
899
- ### Parameters
900
-
901
- | Parameter | Type | Required | Description |
902
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
903
- | `request` | [operations.ListAccountingContactsRequest](../../sdk/models/operations/listaccountingcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
904
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
905
-
906
-
907
- ### Response
908
-
909
- **Promise<[operations.ListAccountingContactsResponse](../../sdk/models/operations/listaccountingcontactsresponse.md)>**
910
- ### Errors
911
-
912
- | Error Object | Status Code | Content Type |
913
- | --------------- | --------------- | --------------- |
914
- | errors.SDKError | 4xx-5xx | */* |
915
-
916
- ## listAccountingInvoices
917
-
918
- List all invoices
919
-
920
- ### Example Usage
921
-
922
- ```typescript
923
- import { UnifiedTo } from "@unified-api/typescript-sdk";
924
-
925
- async function run() {
926
- const sdk = new UnifiedTo({
927
- security: {
928
- jwt: "<YOUR_API_KEY_HERE>",
929
- },
930
- });
931
-
932
- const res = await sdk.accounting.listAccountingInvoices({
933
- connectionId: "<value>",
934
- fields: [
935
- "<value>",
936
- ],
937
- });
938
-
939
- if (res.statusCode == 200) {
940
- // handle response
941
- }
942
- }
943
-
944
- run();
945
- ```
946
-
947
- ### Parameters
948
-
949
- | Parameter | Type | Required | Description |
950
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
951
- | `request` | [operations.ListAccountingInvoicesRequest](../../sdk/models/operations/listaccountinginvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
952
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
953
-
954
-
955
- ### Response
956
-
957
- **Promise<[operations.ListAccountingInvoicesResponse](../../sdk/models/operations/listaccountinginvoicesresponse.md)>**
958
- ### Errors
959
-
960
- | Error Object | Status Code | Content Type |
961
- | --------------- | --------------- | --------------- |
962
- | errors.SDKError | 4xx-5xx | */* |
963
-
964
- ## listAccountingOrganizations
965
-
966
- List all organizations
967
-
968
- ### Example Usage
969
-
970
- ```typescript
971
- import { UnifiedTo } from "@unified-api/typescript-sdk";
972
-
973
- async function run() {
974
- const sdk = new UnifiedTo({
975
- security: {
976
- jwt: "<YOUR_API_KEY_HERE>",
977
- },
978
- });
979
-
980
- const res = await sdk.accounting.listAccountingOrganizations({
981
- connectionId: "<value>",
982
- fields: [
983
- "<value>",
984
- ],
985
- });
986
-
987
- if (res.statusCode == 200) {
988
- // handle response
989
- }
990
- }
991
-
992
- run();
993
- ```
994
-
995
- ### Parameters
996
-
997
- | Parameter | Type | Required | Description |
998
- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
999
- | `request` | [operations.ListAccountingOrganizationsRequest](../../sdk/models/operations/listaccountingorganizationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1000
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1001
-
1002
-
1003
- ### Response
1004
-
1005
- **Promise<[operations.ListAccountingOrganizationsResponse](../../sdk/models/operations/listaccountingorganizationsresponse.md)>**
1006
- ### Errors
1007
-
1008
- | Error Object | Status Code | Content Type |
1009
- | --------------- | --------------- | --------------- |
1010
- | errors.SDKError | 4xx-5xx | */* |
1011
-
1012
- ## listAccountingPayments
1013
-
1014
- List all payments
1015
-
1016
- ### Example Usage
1017
-
1018
- ```typescript
1019
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1020
-
1021
- async function run() {
1022
- const sdk = new UnifiedTo({
1023
- security: {
1024
- jwt: "<YOUR_API_KEY_HERE>",
1025
- },
1026
- });
1027
-
1028
- const res = await sdk.accounting.listAccountingPayments({
1029
- connectionId: "<value>",
1030
- fields: [
1031
- "<value>",
1032
- ],
1033
- });
1034
-
1035
- if (res.statusCode == 200) {
1036
- // handle response
1037
- }
1038
- }
1039
-
1040
- run();
1041
- ```
1042
-
1043
- ### Parameters
1044
-
1045
- | Parameter | Type | Required | Description |
1046
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1047
- | `request` | [operations.ListAccountingPaymentsRequest](../../sdk/models/operations/listaccountingpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1048
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1049
-
1050
-
1051
- ### Response
1052
-
1053
- **Promise<[operations.ListAccountingPaymentsResponse](../../sdk/models/operations/listaccountingpaymentsresponse.md)>**
1054
- ### Errors
1055
-
1056
- | Error Object | Status Code | Content Type |
1057
- | --------------- | --------------- | --------------- |
1058
- | errors.SDKError | 4xx-5xx | */* |
1059
-
1060
- ## listAccountingPayouts
1061
-
1062
- List all payouts
1063
-
1064
- ### Example Usage
1065
-
1066
- ```typescript
1067
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1068
-
1069
- async function run() {
1070
- const sdk = new UnifiedTo({
1071
- security: {
1072
- jwt: "<YOUR_API_KEY_HERE>",
1073
- },
1074
- });
1075
-
1076
- const res = await sdk.accounting.listAccountingPayouts({
1077
- connectionId: "<value>",
1078
- fields: [
1079
- "<value>",
1080
- ],
1081
- });
1082
-
1083
- if (res.statusCode == 200) {
1084
- // handle response
1085
- }
1086
- }
1087
-
1088
- run();
1089
- ```
1090
-
1091
- ### Parameters
1092
-
1093
- | Parameter | Type | Required | Description |
1094
- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
1095
- | `request` | [operations.ListAccountingPayoutsRequest](../../sdk/models/operations/listaccountingpayoutsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1096
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1097
-
1098
-
1099
- ### Response
1100
-
1101
- **Promise<[operations.ListAccountingPayoutsResponse](../../sdk/models/operations/listaccountingpayoutsresponse.md)>**
1102
- ### Errors
1103
-
1104
- | Error Object | Status Code | Content Type |
1105
- | --------------- | --------------- | --------------- |
1106
- | errors.SDKError | 4xx-5xx | */* |
1107
-
1108
- ## listAccountingRefunds
1109
-
1110
- List all refunds
1111
-
1112
- ### Example Usage
1113
-
1114
- ```typescript
1115
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1116
-
1117
- async function run() {
1118
- const sdk = new UnifiedTo({
1119
- security: {
1120
- jwt: "<YOUR_API_KEY_HERE>",
1121
- },
1122
- });
1123
-
1124
- const res = await sdk.accounting.listAccountingRefunds({
1125
- connectionId: "<value>",
1126
- fields: [
1127
- "<value>",
1128
- ],
1129
- });
1130
-
1131
- if (res.statusCode == 200) {
1132
- // handle response
1133
- }
1134
- }
1135
-
1136
- run();
1137
- ```
1138
-
1139
- ### Parameters
1140
-
1141
- | Parameter | Type | Required | Description |
1142
- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
1143
- | `request` | [operations.ListAccountingRefundsRequest](../../sdk/models/operations/listaccountingrefundsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1144
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1145
-
1146
-
1147
- ### Response
1148
-
1149
- **Promise<[operations.ListAccountingRefundsResponse](../../sdk/models/operations/listaccountingrefundsresponse.md)>**
1150
- ### Errors
1151
-
1152
- | Error Object | Status Code | Content Type |
1153
- | --------------- | --------------- | --------------- |
1154
- | errors.SDKError | 4xx-5xx | */* |
1155
-
1156
- ## listAccountingTaxrates
1157
-
1158
- List all taxrates
1159
-
1160
- ### Example Usage
1161
-
1162
- ```typescript
1163
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1164
-
1165
- async function run() {
1166
- const sdk = new UnifiedTo({
1167
- security: {
1168
- jwt: "<YOUR_API_KEY_HERE>",
1169
- },
1170
- });
1171
-
1172
- const res = await sdk.accounting.listAccountingTaxrates({
1173
- connectionId: "<value>",
1174
- fields: [
1175
- "<value>",
1176
- ],
1177
- });
1178
-
1179
- if (res.statusCode == 200) {
1180
- // handle response
1181
- }
1182
- }
1183
-
1184
- run();
1185
- ```
1186
-
1187
- ### Parameters
1188
-
1189
- | Parameter | Type | Required | Description |
1190
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1191
- | `request` | [operations.ListAccountingTaxratesRequest](../../sdk/models/operations/listaccountingtaxratesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1192
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1193
-
1194
-
1195
- ### Response
1196
-
1197
- **Promise<[operations.ListAccountingTaxratesResponse](../../sdk/models/operations/listaccountingtaxratesresponse.md)>**
1198
- ### Errors
1199
-
1200
- | Error Object | Status Code | Content Type |
1201
- | --------------- | --------------- | --------------- |
1202
- | errors.SDKError | 4xx-5xx | */* |
1203
-
1204
- ## listAccountingTransactions
1205
-
1206
- List all transactions
1207
-
1208
- ### Example Usage
1209
-
1210
- ```typescript
1211
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1212
-
1213
- async function run() {
1214
- const sdk = new UnifiedTo({
1215
- security: {
1216
- jwt: "<YOUR_API_KEY_HERE>",
1217
- },
1218
- });
1219
-
1220
- const res = await sdk.accounting.listAccountingTransactions({
1221
- connectionId: "<value>",
1222
- fields: [
1223
- "<value>",
1224
- ],
1225
- });
1226
-
1227
- if (res.statusCode == 200) {
1228
- // handle response
1229
- }
1230
- }
1231
-
1232
- run();
1233
- ```
1234
-
1235
- ### Parameters
1236
-
1237
- | Parameter | Type | Required | Description |
1238
- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
1239
- | `request` | [operations.ListAccountingTransactionsRequest](../../sdk/models/operations/listaccountingtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1240
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1241
-
1242
-
1243
- ### Response
1244
-
1245
- **Promise<[operations.ListAccountingTransactionsResponse](../../sdk/models/operations/listaccountingtransactionsresponse.md)>**
1246
- ### Errors
1247
-
1248
- | Error Object | Status Code | Content Type |
1249
- | --------------- | --------------- | --------------- |
1250
- | errors.SDKError | 4xx-5xx | */* |
1251
-
1252
- ## patchAccountingAccount
1253
-
1254
- Update an account
1255
-
1256
- ### Example Usage
1257
-
1258
- ```typescript
1259
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1260
- import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1261
-
1262
- async function run() {
1263
- const sdk = new UnifiedTo({
1264
- security: {
1265
- jwt: "<YOUR_API_KEY_HERE>",
1266
- },
1267
- });
1268
-
1269
- const res = await sdk.accounting.patchAccountingAccount({
1270
- accountingAccount: {
1271
- name: "<value>",
1272
- raw: {
1273
- "key": "<value>",
1274
- },
1275
- },
1276
- connectionId: "<value>",
1277
- id: "<id>",
1278
- });
1279
-
1280
- if (res.statusCode == 200) {
1281
- // handle response
1282
- }
1283
- }
1284
-
1285
- run();
1286
- ```
1287
-
1288
- ### Parameters
1289
-
1290
- | Parameter | Type | Required | Description |
1291
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1292
- | `request` | [operations.PatchAccountingAccountRequest](../../sdk/models/operations/patchaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1293
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1294
-
1295
-
1296
- ### Response
1297
-
1298
- **Promise<[operations.PatchAccountingAccountResponse](../../sdk/models/operations/patchaccountingaccountresponse.md)>**
1299
- ### Errors
1300
-
1301
- | Error Object | Status Code | Content Type |
1302
- | --------------- | --------------- | --------------- |
1303
- | errors.SDKError | 4xx-5xx | */* |
1304
-
1305
- ## patchAccountingContact
1306
-
1307
- Update a contact
1308
-
1309
- ### Example Usage
1310
-
1311
- ```typescript
1312
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1313
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1314
-
1315
- async function run() {
1316
- const sdk = new UnifiedTo({
1317
- security: {
1318
- jwt: "<YOUR_API_KEY_HERE>",
1319
- },
1320
- });
1321
-
1322
- const res = await sdk.accounting.patchAccountingContact({
1323
- accountingContact: {
1324
- billingAddress: {},
1325
- emails: [
1326
- {
1327
- email: "Sylvester.Kuhic@yahoo.com",
1328
- },
1329
- ],
1330
- raw: {
1331
- "key": "<value>",
1332
- },
1333
- shippingAddress: {},
1334
- telephones: [
1335
- {
1336
- telephone: "<value>",
1337
- },
1338
- ],
1339
- },
1340
- connectionId: "<value>",
1341
- id: "<id>",
1342
- });
1343
-
1344
- if (res.statusCode == 200) {
1345
- // handle response
1346
- }
1347
- }
1348
-
1349
- run();
1350
- ```
1351
-
1352
- ### Parameters
1353
-
1354
- | Parameter | Type | Required | Description |
1355
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1356
- | `request` | [operations.PatchAccountingContactRequest](../../sdk/models/operations/patchaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1357
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1358
-
1359
-
1360
- ### Response
1361
-
1362
- **Promise<[operations.PatchAccountingContactResponse](../../sdk/models/operations/patchaccountingcontactresponse.md)>**
1363
- ### Errors
1364
-
1365
- | Error Object | Status Code | Content Type |
1366
- | --------------- | --------------- | --------------- |
1367
- | errors.SDKError | 4xx-5xx | */* |
1368
-
1369
- ## patchAccountingInvoice
1370
-
1371
- Update a invoice
1372
-
1373
- ### Example Usage
1374
-
1375
- ```typescript
1376
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1377
- import { AccountingInvoiceStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1378
-
1379
- async function run() {
1380
- const sdk = new UnifiedTo({
1381
- security: {
1382
- jwt: "<YOUR_API_KEY_HERE>",
1383
- },
1384
- });
1385
-
1386
- const res = await sdk.accounting.patchAccountingInvoice({
1387
- accountingInvoice: {
1388
- lineitems: [
1389
- {
1390
- totalAmount: 7374.1,
1391
- },
1392
- ],
1393
- raw: {
1394
- "key": "<value>",
1395
- },
1396
- },
1397
- connectionId: "<value>",
1398
- id: "<id>",
1399
- });
1400
-
1401
- if (res.statusCode == 200) {
1402
- // handle response
1403
- }
1404
- }
1405
-
1406
- run();
1407
- ```
1408
-
1409
- ### Parameters
1410
-
1411
- | Parameter | Type | Required | Description |
1412
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1413
- | `request` | [operations.PatchAccountingInvoiceRequest](../../sdk/models/operations/patchaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1414
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1415
-
1416
-
1417
- ### Response
1418
-
1419
- **Promise<[operations.PatchAccountingInvoiceResponse](../../sdk/models/operations/patchaccountinginvoiceresponse.md)>**
1420
- ### Errors
1421
-
1422
- | Error Object | Status Code | Content Type |
1423
- | --------------- | --------------- | --------------- |
1424
- | errors.SDKError | 4xx-5xx | */* |
1425
-
1426
- ## patchAccountingPayment
1427
-
1428
- Update a payment
1429
-
1430
- ### Example Usage
1431
-
1432
- ```typescript
1433
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1434
-
1435
- async function run() {
1436
- const sdk = new UnifiedTo({
1437
- security: {
1438
- jwt: "<YOUR_API_KEY_HERE>",
1439
- },
1440
- });
1441
-
1442
- const res = await sdk.accounting.patchAccountingPayment({
1443
- accountingPayment: {
1444
- raw: {
1445
- "key": "<value>",
1446
- },
1447
- },
1448
- connectionId: "<value>",
1449
- id: "<id>",
1450
- });
1451
-
1452
- if (res.statusCode == 200) {
1453
- // handle response
1454
- }
1455
- }
1456
-
1457
- run();
1458
- ```
1459
-
1460
- ### Parameters
1461
-
1462
- | Parameter | Type | Required | Description |
1463
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1464
- | `request` | [operations.PatchAccountingPaymentRequest](../../sdk/models/operations/patchaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1465
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1466
-
1467
-
1468
- ### Response
1469
-
1470
- **Promise<[operations.PatchAccountingPaymentResponse](../../sdk/models/operations/patchaccountingpaymentresponse.md)>**
1471
- ### Errors
1472
-
1473
- | Error Object | Status Code | Content Type |
1474
- | --------------- | --------------- | --------------- |
1475
- | errors.SDKError | 4xx-5xx | */* |
1476
-
1477
- ## patchAccountingTaxrate
1478
-
1479
- Update a taxrate
1480
-
1481
- ### Example Usage
1482
-
1483
- ```typescript
1484
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1485
-
1486
- async function run() {
1487
- const sdk = new UnifiedTo({
1488
- security: {
1489
- jwt: "<YOUR_API_KEY_HERE>",
1490
- },
1491
- });
1492
-
1493
- const res = await sdk.accounting.patchAccountingTaxrate({
1494
- accountingTaxrate: {
1495
- name: "<value>",
1496
- rate: 5991.47,
1497
- raw: {
1498
- "key": "<value>",
1499
- },
1500
- },
1501
- connectionId: "<value>",
1502
- id: "<id>",
1503
- });
1504
-
1505
- if (res.statusCode == 200) {
1506
- // handle response
1507
- }
1508
- }
1509
-
1510
- run();
1511
- ```
1512
-
1513
- ### Parameters
1514
-
1515
- | Parameter | Type | Required | Description |
1516
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
1517
- | `request` | [operations.PatchAccountingTaxrateRequest](../../sdk/models/operations/patchaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
1518
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1519
-
1520
-
1521
- ### Response
1522
-
1523
- **Promise<[operations.PatchAccountingTaxrateResponse](../../sdk/models/operations/patchaccountingtaxrateresponse.md)>**
1524
- ### Errors
1525
-
1526
- | Error Object | Status Code | Content Type |
1527
- | --------------- | --------------- | --------------- |
1528
- | errors.SDKError | 4xx-5xx | */* |
1529
-
1530
- ## patchAccountingTransaction
1531
-
1532
- Update a transaction
1533
-
1534
- ### Example Usage
1535
-
1536
- ```typescript
1537
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1538
-
1539
- async function run() {
1540
- const sdk = new UnifiedTo({
1541
- security: {
1542
- jwt: "<YOUR_API_KEY_HERE>",
1543
- },
1544
- });
1545
-
1546
- const res = await sdk.accounting.patchAccountingTransaction({
1547
- accountingTransaction: {
1548
- id: "<id>",
1549
- lineitems: [
1550
- {
1551
- accountId: "<value>",
1552
- totalAmount: 5633.69,
1553
- },
1554
- ],
1555
- raw: {
1556
- "key": "<value>",
1557
- },
1558
- },
1559
- connectionId: "<value>",
1560
- id: "<id>",
1561
- });
1562
-
1563
- if (res.statusCode == 200) {
1564
- // handle response
1565
- }
1566
- }
1567
-
1568
- run();
1569
- ```
1570
-
1571
- ### Parameters
1572
-
1573
- | Parameter | Type | Required | Description |
1574
- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
1575
- | `request` | [operations.PatchAccountingTransactionRequest](../../sdk/models/operations/patchaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1576
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1577
-
1578
-
1579
- ### Response
1580
-
1581
- **Promise<[operations.PatchAccountingTransactionResponse](../../sdk/models/operations/patchaccountingtransactionresponse.md)>**
1582
- ### Errors
1583
-
1584
- | Error Object | Status Code | Content Type |
1585
- | --------------- | --------------- | --------------- |
1586
- | errors.SDKError | 4xx-5xx | */* |
1587
-
1588
- ## removeAccountingAccount
1589
-
1590
- Remove an account
1591
-
1592
- ### Example Usage
1593
-
1594
- ```typescript
1595
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1596
-
1597
- async function run() {
1598
- const sdk = new UnifiedTo({
1599
- security: {
1600
- jwt: "<YOUR_API_KEY_HERE>",
1601
- },
1602
- });
1603
-
1604
- const res = await sdk.accounting.removeAccountingAccount({
1605
- connectionId: "<value>",
1606
- id: "<id>",
1607
- });
1608
-
1609
- if (res.statusCode == 200) {
1610
- // handle response
1611
- }
1612
- }
1613
-
1614
- run();
1615
- ```
1616
-
1617
- ### Parameters
1618
-
1619
- | Parameter | Type | Required | Description |
1620
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1621
- | `request` | [operations.RemoveAccountingAccountRequest](../../sdk/models/operations/removeaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1622
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1623
-
1624
-
1625
- ### Response
1626
-
1627
- **Promise<[operations.RemoveAccountingAccountResponse](../../sdk/models/operations/removeaccountingaccountresponse.md)>**
1628
- ### Errors
1629
-
1630
- | Error Object | Status Code | Content Type |
1631
- | --------------- | --------------- | --------------- |
1632
- | errors.SDKError | 4xx-5xx | */* |
1633
-
1634
- ## removeAccountingContact
1635
-
1636
- Remove a contact
1637
-
1638
- ### Example Usage
1639
-
1640
- ```typescript
1641
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1642
-
1643
- async function run() {
1644
- const sdk = new UnifiedTo({
1645
- security: {
1646
- jwt: "<YOUR_API_KEY_HERE>",
1647
- },
1648
- });
1649
-
1650
- const res = await sdk.accounting.removeAccountingContact({
1651
- connectionId: "<value>",
1652
- id: "<id>",
1653
- });
1654
-
1655
- if (res.statusCode == 200) {
1656
- // handle response
1657
- }
1658
- }
1659
-
1660
- run();
1661
- ```
1662
-
1663
- ### Parameters
1664
-
1665
- | Parameter | Type | Required | Description |
1666
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1667
- | `request` | [operations.RemoveAccountingContactRequest](../../sdk/models/operations/removeaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1668
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1669
-
1670
-
1671
- ### Response
1672
-
1673
- **Promise<[operations.RemoveAccountingContactResponse](../../sdk/models/operations/removeaccountingcontactresponse.md)>**
1674
- ### Errors
1675
-
1676
- | Error Object | Status Code | Content Type |
1677
- | --------------- | --------------- | --------------- |
1678
- | errors.SDKError | 4xx-5xx | */* |
1679
-
1680
- ## removeAccountingInvoice
1681
-
1682
- Remove a invoice
1683
-
1684
- ### Example Usage
1685
-
1686
- ```typescript
1687
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1688
-
1689
- async function run() {
1690
- const sdk = new UnifiedTo({
1691
- security: {
1692
- jwt: "<YOUR_API_KEY_HERE>",
1693
- },
1694
- });
1695
-
1696
- const res = await sdk.accounting.removeAccountingInvoice({
1697
- connectionId: "<value>",
1698
- id: "<id>",
1699
- });
1700
-
1701
- if (res.statusCode == 200) {
1702
- // handle response
1703
- }
1704
- }
1705
-
1706
- run();
1707
- ```
1708
-
1709
- ### Parameters
1710
-
1711
- | Parameter | Type | Required | Description |
1712
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1713
- | `request` | [operations.RemoveAccountingInvoiceRequest](../../sdk/models/operations/removeaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1714
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1715
-
1716
-
1717
- ### Response
1718
-
1719
- **Promise<[operations.RemoveAccountingInvoiceResponse](../../sdk/models/operations/removeaccountinginvoiceresponse.md)>**
1720
- ### Errors
1721
-
1722
- | Error Object | Status Code | Content Type |
1723
- | --------------- | --------------- | --------------- |
1724
- | errors.SDKError | 4xx-5xx | */* |
1725
-
1726
- ## removeAccountingPayment
1727
-
1728
- Remove a payment
1729
-
1730
- ### Example Usage
1731
-
1732
- ```typescript
1733
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1734
-
1735
- async function run() {
1736
- const sdk = new UnifiedTo({
1737
- security: {
1738
- jwt: "<YOUR_API_KEY_HERE>",
1739
- },
1740
- });
1741
-
1742
- const res = await sdk.accounting.removeAccountingPayment({
1743
- connectionId: "<value>",
1744
- id: "<id>",
1745
- });
1746
-
1747
- if (res.statusCode == 200) {
1748
- // handle response
1749
- }
1750
- }
1751
-
1752
- run();
1753
- ```
1754
-
1755
- ### Parameters
1756
-
1757
- | Parameter | Type | Required | Description |
1758
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1759
- | `request` | [operations.RemoveAccountingPaymentRequest](../../sdk/models/operations/removeaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1760
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1761
-
1762
-
1763
- ### Response
1764
-
1765
- **Promise<[operations.RemoveAccountingPaymentResponse](../../sdk/models/operations/removeaccountingpaymentresponse.md)>**
1766
- ### Errors
1767
-
1768
- | Error Object | Status Code | Content Type |
1769
- | --------------- | --------------- | --------------- |
1770
- | errors.SDKError | 4xx-5xx | */* |
1771
-
1772
- ## removeAccountingTaxrate
1773
-
1774
- Remove a taxrate
1775
-
1776
- ### Example Usage
1777
-
1778
- ```typescript
1779
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1780
-
1781
- async function run() {
1782
- const sdk = new UnifiedTo({
1783
- security: {
1784
- jwt: "<YOUR_API_KEY_HERE>",
1785
- },
1786
- });
1787
-
1788
- const res = await sdk.accounting.removeAccountingTaxrate({
1789
- connectionId: "<value>",
1790
- id: "<id>",
1791
- });
1792
-
1793
- if (res.statusCode == 200) {
1794
- // handle response
1795
- }
1796
- }
1797
-
1798
- run();
1799
- ```
1800
-
1801
- ### Parameters
1802
-
1803
- | Parameter | Type | Required | Description |
1804
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1805
- | `request` | [operations.RemoveAccountingTaxrateRequest](../../sdk/models/operations/removeaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
1806
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1807
-
1808
-
1809
- ### Response
1810
-
1811
- **Promise<[operations.RemoveAccountingTaxrateResponse](../../sdk/models/operations/removeaccountingtaxrateresponse.md)>**
1812
- ### Errors
1813
-
1814
- | Error Object | Status Code | Content Type |
1815
- | --------------- | --------------- | --------------- |
1816
- | errors.SDKError | 4xx-5xx | */* |
1817
-
1818
- ## removeAccountingTransaction
1819
-
1820
- Remove a transaction
1821
-
1822
- ### Example Usage
1823
-
1824
- ```typescript
1825
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1826
-
1827
- async function run() {
1828
- const sdk = new UnifiedTo({
1829
- security: {
1830
- jwt: "<YOUR_API_KEY_HERE>",
1831
- },
1832
- });
1833
-
1834
- const res = await sdk.accounting.removeAccountingTransaction({
1835
- connectionId: "<value>",
1836
- id: "<id>",
1837
- });
1838
-
1839
- if (res.statusCode == 200) {
1840
- // handle response
1841
- }
1842
- }
1843
-
1844
- run();
1845
- ```
1846
-
1847
- ### Parameters
1848
-
1849
- | Parameter | Type | Required | Description |
1850
- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
1851
- | `request` | [operations.RemoveAccountingTransactionRequest](../../sdk/models/operations/removeaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1852
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1853
-
1854
-
1855
- ### Response
1856
-
1857
- **Promise<[operations.RemoveAccountingTransactionResponse](../../sdk/models/operations/removeaccountingtransactionresponse.md)>**
1858
- ### Errors
1859
-
1860
- | Error Object | Status Code | Content Type |
1861
- | --------------- | --------------- | --------------- |
1862
- | errors.SDKError | 4xx-5xx | */* |
1863
-
1864
- ## updateAccountingAccount
1865
-
1866
- Update an account
1867
-
1868
- ### Example Usage
1869
-
1870
- ```typescript
1871
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1872
- import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1873
-
1874
- async function run() {
1875
- const sdk = new UnifiedTo({
1876
- security: {
1877
- jwt: "<YOUR_API_KEY_HERE>",
1878
- },
1879
- });
1880
-
1881
- const res = await sdk.accounting.updateAccountingAccount({
1882
- accountingAccount: {
1883
- name: "<value>",
1884
- raw: {
1885
- "key": "<value>",
1886
- },
1887
- },
1888
- connectionId: "<value>",
1889
- id: "<id>",
1890
- });
1891
-
1892
- if (res.statusCode == 200) {
1893
- // handle response
1894
- }
1895
- }
1896
-
1897
- run();
1898
- ```
1899
-
1900
- ### Parameters
1901
-
1902
- | Parameter | Type | Required | Description |
1903
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1904
- | `request` | [operations.UpdateAccountingAccountRequest](../../sdk/models/operations/updateaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1905
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1906
-
1907
-
1908
- ### Response
1909
-
1910
- **Promise<[operations.UpdateAccountingAccountResponse](../../sdk/models/operations/updateaccountingaccountresponse.md)>**
1911
- ### Errors
1912
-
1913
- | Error Object | Status Code | Content Type |
1914
- | --------------- | --------------- | --------------- |
1915
- | errors.SDKError | 4xx-5xx | */* |
1916
-
1917
- ## updateAccountingContact
1918
-
1919
- Update a contact
1920
-
1921
- ### Example Usage
1922
-
1923
- ```typescript
1924
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1925
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1926
-
1927
- async function run() {
1928
- const sdk = new UnifiedTo({
1929
- security: {
1930
- jwt: "<YOUR_API_KEY_HERE>",
1931
- },
1932
- });
1933
-
1934
- const res = await sdk.accounting.updateAccountingContact({
1935
- accountingContact: {
1936
- billingAddress: {},
1937
- emails: [
1938
- {
1939
- email: "Kaci_Hane@hotmail.com",
1940
- },
1941
- ],
1942
- raw: {
1943
- "key": "<value>",
1944
- },
1945
- shippingAddress: {},
1946
- telephones: [
1947
- {
1948
- telephone: "<value>",
1949
- },
1950
- ],
1951
- },
1952
- connectionId: "<value>",
1953
- id: "<id>",
1954
- });
1955
-
1956
- if (res.statusCode == 200) {
1957
- // handle response
1958
- }
1959
- }
1960
-
1961
- run();
1962
- ```
1963
-
1964
- ### Parameters
1965
-
1966
- | Parameter | Type | Required | Description |
1967
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
1968
- | `request` | [operations.UpdateAccountingContactRequest](../../sdk/models/operations/updateaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1969
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1970
-
1971
-
1972
- ### Response
1973
-
1974
- **Promise<[operations.UpdateAccountingContactResponse](../../sdk/models/operations/updateaccountingcontactresponse.md)>**
1975
- ### Errors
1976
-
1977
- | Error Object | Status Code | Content Type |
1978
- | --------------- | --------------- | --------------- |
1979
- | errors.SDKError | 4xx-5xx | */* |
1980
-
1981
- ## updateAccountingInvoice
1982
-
1983
- Update a invoice
1984
-
1985
- ### Example Usage
1986
-
1987
- ```typescript
1988
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1989
- import { AccountingInvoiceStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1990
-
1991
- async function run() {
1992
- const sdk = new UnifiedTo({
1993
- security: {
1994
- jwt: "<YOUR_API_KEY_HERE>",
1995
- },
1996
- });
1997
-
1998
- const res = await sdk.accounting.updateAccountingInvoice({
1999
- accountingInvoice: {
2000
- lineitems: [
2001
- {
2002
- totalAmount: 6974.28,
2003
- },
2004
- ],
2005
- raw: {
2006
- "key": "<value>",
2007
- },
2008
- },
2009
- connectionId: "<value>",
2010
- id: "<id>",
2011
- });
2012
-
2013
- if (res.statusCode == 200) {
2014
- // handle response
2015
- }
2016
- }
2017
-
2018
- run();
2019
- ```
2020
-
2021
- ### Parameters
2022
-
2023
- | Parameter | Type | Required | Description |
2024
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
2025
- | `request` | [operations.UpdateAccountingInvoiceRequest](../../sdk/models/operations/updateaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
2026
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
2027
-
2028
-
2029
- ### Response
2030
-
2031
- **Promise<[operations.UpdateAccountingInvoiceResponse](../../sdk/models/operations/updateaccountinginvoiceresponse.md)>**
2032
- ### Errors
2033
-
2034
- | Error Object | Status Code | Content Type |
2035
- | --------------- | --------------- | --------------- |
2036
- | errors.SDKError | 4xx-5xx | */* |
2037
-
2038
- ## updateAccountingPayment
2039
-
2040
- Update a payment
2041
-
2042
- ### Example Usage
2043
-
2044
- ```typescript
2045
- import { UnifiedTo } from "@unified-api/typescript-sdk";
2046
-
2047
- async function run() {
2048
- const sdk = new UnifiedTo({
2049
- security: {
2050
- jwt: "<YOUR_API_KEY_HERE>",
2051
- },
2052
- });
2053
-
2054
- const res = await sdk.accounting.updateAccountingPayment({
2055
- accountingPayment: {
2056
- raw: {
2057
- "key": "<value>",
2058
- },
2059
- },
2060
- connectionId: "<value>",
2061
- id: "<id>",
2062
- });
2063
-
2064
- if (res.statusCode == 200) {
2065
- // handle response
2066
- }
2067
- }
2068
-
2069
- run();
2070
- ```
2071
-
2072
- ### Parameters
2073
-
2074
- | Parameter | Type | Required | Description |
2075
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
2076
- | `request` | [operations.UpdateAccountingPaymentRequest](../../sdk/models/operations/updateaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2077
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
2078
-
2079
-
2080
- ### Response
2081
-
2082
- **Promise<[operations.UpdateAccountingPaymentResponse](../../sdk/models/operations/updateaccountingpaymentresponse.md)>**
2083
- ### Errors
2084
-
2085
- | Error Object | Status Code | Content Type |
2086
- | --------------- | --------------- | --------------- |
2087
- | errors.SDKError | 4xx-5xx | */* |
2088
-
2089
- ## updateAccountingTaxrate
2090
-
2091
- Update a taxrate
2092
-
2093
- ### Example Usage
2094
-
2095
- ```typescript
2096
- import { UnifiedTo } from "@unified-api/typescript-sdk";
2097
-
2098
- async function run() {
2099
- const sdk = new UnifiedTo({
2100
- security: {
2101
- jwt: "<YOUR_API_KEY_HERE>",
2102
- },
2103
- });
2104
-
2105
- const res = await sdk.accounting.updateAccountingTaxrate({
2106
- accountingTaxrate: {
2107
- name: "<value>",
2108
- rate: 3382.78,
2109
- raw: {
2110
- "key": "<value>",
2111
- },
2112
- },
2113
- connectionId: "<value>",
2114
- id: "<id>",
2115
- });
2116
-
2117
- if (res.statusCode == 200) {
2118
- // handle response
2119
- }
2120
- }
2121
-
2122
- run();
2123
- ```
2124
-
2125
- ### Parameters
2126
-
2127
- | Parameter | Type | Required | Description |
2128
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
2129
- | `request` | [operations.UpdateAccountingTaxrateRequest](../../sdk/models/operations/updateaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
2130
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
2131
-
2132
-
2133
- ### Response
2134
-
2135
- **Promise<[operations.UpdateAccountingTaxrateResponse](../../sdk/models/operations/updateaccountingtaxrateresponse.md)>**
2136
- ### Errors
2137
-
2138
- | Error Object | Status Code | Content Type |
2139
- | --------------- | --------------- | --------------- |
2140
- | errors.SDKError | 4xx-5xx | */* |
2141
-
2142
- ## updateAccountingTransaction
2143
-
2144
- Update a transaction
2145
-
2146
- ### Example Usage
2147
-
2148
- ```typescript
2149
- import { UnifiedTo } from "@unified-api/typescript-sdk";
2150
-
2151
- async function run() {
2152
- const sdk = new UnifiedTo({
2153
- security: {
2154
- jwt: "<YOUR_API_KEY_HERE>",
2155
- },
2156
- });
2157
-
2158
- const res = await sdk.accounting.updateAccountingTransaction({
2159
- accountingTransaction: {
2160
- id: "<id>",
2161
- lineitems: [
2162
- {
2163
- accountId: "<value>",
2164
- totalAmount: 6498.37,
2165
- },
2166
- ],
2167
- raw: {
2168
- "key": "<value>",
2169
- },
2170
- },
2171
- connectionId: "<value>",
2172
- id: "<id>",
2173
- });
2174
-
2175
- if (res.statusCode == 200) {
2176
- // handle response
2177
- }
2178
- }
2179
-
2180
- run();
2181
- ```
2182
-
2183
- ### Parameters
2184
-
2185
- | Parameter | Type | Required | Description |
2186
- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
2187
- | `request` | [operations.UpdateAccountingTransactionRequest](../../sdk/models/operations/updateaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2188
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
2189
-
2190
-
2191
- ### Response
2192
-
2193
- **Promise<[operations.UpdateAccountingTransactionResponse](../../sdk/models/operations/updateaccountingtransactionresponse.md)>**
2194
- ### Errors
2195
-
2196
- | Error Object | Status Code | Content Type |
2197
- | --------------- | --------------- | --------------- |
2198
- | errors.SDKError | 4xx-5xx | */* |