@unified-api/typescript-sdk 2.9.3 → 2.9.5
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.
- package/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,3629 @@
|
|
|
1
|
+
# Accounting
|
|
2
|
+
(*accounting*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createAccountingAccount](#createaccountingaccount) - Create an account
|
|
9
|
+
* [createAccountingContact](#createaccountingcontact) - Create a contact
|
|
10
|
+
* [createAccountingInvoice](#createaccountinginvoice) - Create an invoice
|
|
11
|
+
* [createAccountingJournal](#createaccountingjournal) - Create a journal
|
|
12
|
+
* [createAccountingOrder](#createaccountingorder) - Create an order
|
|
13
|
+
* [createAccountingTaxrate](#createaccountingtaxrate) - Create a taxrate
|
|
14
|
+
* [createAccountingTransaction](#createaccountingtransaction) - Create a transaction
|
|
15
|
+
* [getAccountingAccount](#getaccountingaccount) - Retrieve an account
|
|
16
|
+
* [getAccountingContact](#getaccountingcontact) - Retrieve a contact
|
|
17
|
+
* [getAccountingInvoice](#getaccountinginvoice) - Retrieve an invoice
|
|
18
|
+
* [getAccountingJournal](#getaccountingjournal) - Retrieve a journal
|
|
19
|
+
* [getAccountingOrder](#getaccountingorder) - Retrieve an order
|
|
20
|
+
* [getAccountingOrganization](#getaccountingorganization) - Retrieve an organization
|
|
21
|
+
* [getAccountingTaxrate](#getaccountingtaxrate) - Retrieve a taxrate
|
|
22
|
+
* [getAccountingTransaction](#getaccountingtransaction) - Retrieve a transaction
|
|
23
|
+
* [listAccountingAccounts](#listaccountingaccounts) - List all accounts
|
|
24
|
+
* [listAccountingContacts](#listaccountingcontacts) - List all contacts
|
|
25
|
+
* [listAccountingInvoices](#listaccountinginvoices) - List all invoices
|
|
26
|
+
* [listAccountingJournals](#listaccountingjournals) - List all journals
|
|
27
|
+
* [listAccountingOrders](#listaccountingorders) - List all orders
|
|
28
|
+
* [listAccountingOrganizations](#listaccountingorganizations) - List all organizations
|
|
29
|
+
* [listAccountingTaxrates](#listaccountingtaxrates) - List all taxrates
|
|
30
|
+
* [listAccountingTransactions](#listaccountingtransactions) - List all transactions
|
|
31
|
+
* [patchAccountingAccount](#patchaccountingaccount) - Update an account
|
|
32
|
+
* [patchAccountingContact](#patchaccountingcontact) - Update a contact
|
|
33
|
+
* [patchAccountingInvoice](#patchaccountinginvoice) - Update an invoice
|
|
34
|
+
* [patchAccountingJournal](#patchaccountingjournal) - Update a journal
|
|
35
|
+
* [patchAccountingOrder](#patchaccountingorder) - Update an order
|
|
36
|
+
* [patchAccountingTaxrate](#patchaccountingtaxrate) - Update a taxrate
|
|
37
|
+
* [patchAccountingTransaction](#patchaccountingtransaction) - Update a transaction
|
|
38
|
+
* [removeAccountingAccount](#removeaccountingaccount) - Remove an account
|
|
39
|
+
* [removeAccountingContact](#removeaccountingcontact) - Remove a contact
|
|
40
|
+
* [removeAccountingInvoice](#removeaccountinginvoice) - Remove an invoice
|
|
41
|
+
* [removeAccountingJournal](#removeaccountingjournal) - Remove a journal
|
|
42
|
+
* [removeAccountingOrder](#removeaccountingorder) - Remove an order
|
|
43
|
+
* [removeAccountingTaxrate](#removeaccountingtaxrate) - Remove a taxrate
|
|
44
|
+
* [removeAccountingTransaction](#removeaccountingtransaction) - Remove a transaction
|
|
45
|
+
* [updateAccountingAccount](#updateaccountingaccount) - Update an account
|
|
46
|
+
* [updateAccountingContact](#updateaccountingcontact) - Update a contact
|
|
47
|
+
* [updateAccountingInvoice](#updateaccountinginvoice) - Update an invoice
|
|
48
|
+
* [updateAccountingJournal](#updateaccountingjournal) - Update a journal
|
|
49
|
+
* [updateAccountingOrder](#updateaccountingorder) - Update an order
|
|
50
|
+
* [updateAccountingTaxrate](#updateaccountingtaxrate) - Update a taxrate
|
|
51
|
+
* [updateAccountingTransaction](#updateaccountingtransaction) - Update a transaction
|
|
52
|
+
|
|
53
|
+
## createAccountingAccount
|
|
54
|
+
|
|
55
|
+
Create an account
|
|
56
|
+
|
|
57
|
+
### Example Usage
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
61
|
+
|
|
62
|
+
const unifiedTo = new UnifiedTo({
|
|
63
|
+
security: {
|
|
64
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
async function run() {
|
|
69
|
+
const result = await unifiedTo.accounting.createAccountingAccount({
|
|
70
|
+
connectionId: "<value>",
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
// Handle the result
|
|
74
|
+
console.log(result);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
run();
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Standalone function
|
|
81
|
+
|
|
82
|
+
The standalone function version of this method:
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
86
|
+
import { accountingCreateAccountingAccount } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingAccount.js";
|
|
87
|
+
|
|
88
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
89
|
+
// You can create one instance of it to use across an application.
|
|
90
|
+
const unifiedTo = new UnifiedToCore({
|
|
91
|
+
security: {
|
|
92
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
93
|
+
},
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
async function run() {
|
|
97
|
+
const res = await accountingCreateAccountingAccount(unifiedTo, {
|
|
98
|
+
connectionId: "<value>",
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
if (!res.ok) {
|
|
102
|
+
throw res.error;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
const { value: result } = res;
|
|
106
|
+
|
|
107
|
+
// Handle the result
|
|
108
|
+
console.log(result);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
run();
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Parameters
|
|
115
|
+
|
|
116
|
+
| Parameter | Type | Required | Description |
|
|
117
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
118
|
+
| `request` | [operations.CreateAccountingAccountRequest](../../sdk/models/operations/createaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
119
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
120
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
121
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
122
|
+
|
|
123
|
+
### Response
|
|
124
|
+
|
|
125
|
+
**Promise\<[shared.AccountingAccount](../../sdk/models/shared/accountingaccount.md)\>**
|
|
126
|
+
|
|
127
|
+
### Errors
|
|
128
|
+
|
|
129
|
+
| Error Type | Status Code | Content Type |
|
|
130
|
+
| --------------- | --------------- | --------------- |
|
|
131
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
132
|
+
|
|
133
|
+
## createAccountingContact
|
|
134
|
+
|
|
135
|
+
Create a contact
|
|
136
|
+
|
|
137
|
+
### Example Usage
|
|
138
|
+
|
|
139
|
+
```typescript
|
|
140
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
141
|
+
|
|
142
|
+
const unifiedTo = new UnifiedTo({
|
|
143
|
+
security: {
|
|
144
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
145
|
+
},
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
async function run() {
|
|
149
|
+
const result = await unifiedTo.accounting.createAccountingContact({
|
|
150
|
+
connectionId: "<value>",
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
// Handle the result
|
|
154
|
+
console.log(result);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
run();
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Standalone function
|
|
161
|
+
|
|
162
|
+
The standalone function version of this method:
|
|
163
|
+
|
|
164
|
+
```typescript
|
|
165
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
166
|
+
import { accountingCreateAccountingContact } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingContact.js";
|
|
167
|
+
|
|
168
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
169
|
+
// You can create one instance of it to use across an application.
|
|
170
|
+
const unifiedTo = new UnifiedToCore({
|
|
171
|
+
security: {
|
|
172
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
173
|
+
},
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
async function run() {
|
|
177
|
+
const res = await accountingCreateAccountingContact(unifiedTo, {
|
|
178
|
+
connectionId: "<value>",
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
if (!res.ok) {
|
|
182
|
+
throw res.error;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
const { value: result } = res;
|
|
186
|
+
|
|
187
|
+
// Handle the result
|
|
188
|
+
console.log(result);
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
run();
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
| Parameter | Type | Required | Description |
|
|
197
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
198
|
+
| `request` | [operations.CreateAccountingContactRequest](../../sdk/models/operations/createaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
199
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
200
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
201
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
202
|
+
|
|
203
|
+
### Response
|
|
204
|
+
|
|
205
|
+
**Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
|
|
206
|
+
|
|
207
|
+
### Errors
|
|
208
|
+
|
|
209
|
+
| Error Type | Status Code | Content Type |
|
|
210
|
+
| --------------- | --------------- | --------------- |
|
|
211
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
212
|
+
|
|
213
|
+
## createAccountingInvoice
|
|
214
|
+
|
|
215
|
+
Create an invoice
|
|
216
|
+
|
|
217
|
+
### Example Usage
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
221
|
+
|
|
222
|
+
const unifiedTo = new UnifiedTo({
|
|
223
|
+
security: {
|
|
224
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
225
|
+
},
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
async function run() {
|
|
229
|
+
const result = await unifiedTo.accounting.createAccountingInvoice({
|
|
230
|
+
connectionId: "<value>",
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
// Handle the result
|
|
234
|
+
console.log(result);
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
run();
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Standalone function
|
|
241
|
+
|
|
242
|
+
The standalone function version of this method:
|
|
243
|
+
|
|
244
|
+
```typescript
|
|
245
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
246
|
+
import { accountingCreateAccountingInvoice } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingInvoice.js";
|
|
247
|
+
|
|
248
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
249
|
+
// You can create one instance of it to use across an application.
|
|
250
|
+
const unifiedTo = new UnifiedToCore({
|
|
251
|
+
security: {
|
|
252
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
253
|
+
},
|
|
254
|
+
});
|
|
255
|
+
|
|
256
|
+
async function run() {
|
|
257
|
+
const res = await accountingCreateAccountingInvoice(unifiedTo, {
|
|
258
|
+
connectionId: "<value>",
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
if (!res.ok) {
|
|
262
|
+
throw res.error;
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
const { value: result } = res;
|
|
266
|
+
|
|
267
|
+
// Handle the result
|
|
268
|
+
console.log(result);
|
|
269
|
+
}
|
|
270
|
+
|
|
271
|
+
run();
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
|
|
276
|
+
| Parameter | Type | Required | Description |
|
|
277
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
278
|
+
| `request` | [operations.CreateAccountingInvoiceRequest](../../sdk/models/operations/createaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
279
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
280
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
281
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
282
|
+
|
|
283
|
+
### Response
|
|
284
|
+
|
|
285
|
+
**Promise\<[shared.AccountingInvoice](../../sdk/models/shared/accountinginvoice.md)\>**
|
|
286
|
+
|
|
287
|
+
### Errors
|
|
288
|
+
|
|
289
|
+
| Error Type | Status Code | Content Type |
|
|
290
|
+
| --------------- | --------------- | --------------- |
|
|
291
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
292
|
+
|
|
293
|
+
## createAccountingJournal
|
|
294
|
+
|
|
295
|
+
Create a journal
|
|
296
|
+
|
|
297
|
+
### Example Usage
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
301
|
+
|
|
302
|
+
const unifiedTo = new UnifiedTo({
|
|
303
|
+
security: {
|
|
304
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
305
|
+
},
|
|
306
|
+
});
|
|
307
|
+
|
|
308
|
+
async function run() {
|
|
309
|
+
const result = await unifiedTo.accounting.createAccountingJournal({
|
|
310
|
+
connectionId: "<value>",
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
// Handle the result
|
|
314
|
+
console.log(result);
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
run();
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Standalone function
|
|
321
|
+
|
|
322
|
+
The standalone function version of this method:
|
|
323
|
+
|
|
324
|
+
```typescript
|
|
325
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
326
|
+
import { accountingCreateAccountingJournal } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingJournal.js";
|
|
327
|
+
|
|
328
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
329
|
+
// You can create one instance of it to use across an application.
|
|
330
|
+
const unifiedTo = new UnifiedToCore({
|
|
331
|
+
security: {
|
|
332
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
333
|
+
},
|
|
334
|
+
});
|
|
335
|
+
|
|
336
|
+
async function run() {
|
|
337
|
+
const res = await accountingCreateAccountingJournal(unifiedTo, {
|
|
338
|
+
connectionId: "<value>",
|
|
339
|
+
});
|
|
340
|
+
|
|
341
|
+
if (!res.ok) {
|
|
342
|
+
throw res.error;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
const { value: result } = res;
|
|
346
|
+
|
|
347
|
+
// Handle the result
|
|
348
|
+
console.log(result);
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
run();
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
### Parameters
|
|
355
|
+
|
|
356
|
+
| Parameter | Type | Required | Description |
|
|
357
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
358
|
+
| `request` | [operations.CreateAccountingJournalRequest](../../sdk/models/operations/createaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
359
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
360
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
361
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
362
|
+
|
|
363
|
+
### Response
|
|
364
|
+
|
|
365
|
+
**Promise\<[shared.AccountingJournal](../../sdk/models/shared/accountingjournal.md)\>**
|
|
366
|
+
|
|
367
|
+
### Errors
|
|
368
|
+
|
|
369
|
+
| Error Type | Status Code | Content Type |
|
|
370
|
+
| --------------- | --------------- | --------------- |
|
|
371
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
372
|
+
|
|
373
|
+
## createAccountingOrder
|
|
374
|
+
|
|
375
|
+
Create an order
|
|
376
|
+
|
|
377
|
+
### Example Usage
|
|
378
|
+
|
|
379
|
+
```typescript
|
|
380
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
381
|
+
|
|
382
|
+
const unifiedTo = new UnifiedTo({
|
|
383
|
+
security: {
|
|
384
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
385
|
+
},
|
|
386
|
+
});
|
|
387
|
+
|
|
388
|
+
async function run() {
|
|
389
|
+
const result = await unifiedTo.accounting.createAccountingOrder({
|
|
390
|
+
connectionId: "<id>",
|
|
391
|
+
});
|
|
392
|
+
|
|
393
|
+
// Handle the result
|
|
394
|
+
console.log(result);
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
run();
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### Standalone function
|
|
401
|
+
|
|
402
|
+
The standalone function version of this method:
|
|
403
|
+
|
|
404
|
+
```typescript
|
|
405
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
406
|
+
import { accountingCreateAccountingOrder } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingOrder.js";
|
|
407
|
+
|
|
408
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
409
|
+
// You can create one instance of it to use across an application.
|
|
410
|
+
const unifiedTo = new UnifiedToCore({
|
|
411
|
+
security: {
|
|
412
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
413
|
+
},
|
|
414
|
+
});
|
|
415
|
+
|
|
416
|
+
async function run() {
|
|
417
|
+
const res = await accountingCreateAccountingOrder(unifiedTo, {
|
|
418
|
+
connectionId: "<id>",
|
|
419
|
+
});
|
|
420
|
+
|
|
421
|
+
if (!res.ok) {
|
|
422
|
+
throw res.error;
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
const { value: result } = res;
|
|
426
|
+
|
|
427
|
+
// Handle the result
|
|
428
|
+
console.log(result);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
run();
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### Parameters
|
|
435
|
+
|
|
436
|
+
| Parameter | Type | Required | Description |
|
|
437
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
438
|
+
| `request` | [operations.CreateAccountingOrderRequest](../../sdk/models/operations/createaccountingorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
439
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
440
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
441
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
442
|
+
|
|
443
|
+
### Response
|
|
444
|
+
|
|
445
|
+
**Promise\<[shared.AccountingOrder](../../sdk/models/shared/accountingorder.md)\>**
|
|
446
|
+
|
|
447
|
+
### Errors
|
|
448
|
+
|
|
449
|
+
| Error Type | Status Code | Content Type |
|
|
450
|
+
| --------------- | --------------- | --------------- |
|
|
451
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
452
|
+
|
|
453
|
+
## createAccountingTaxrate
|
|
454
|
+
|
|
455
|
+
Create a taxrate
|
|
456
|
+
|
|
457
|
+
### Example Usage
|
|
458
|
+
|
|
459
|
+
```typescript
|
|
460
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
461
|
+
|
|
462
|
+
const unifiedTo = new UnifiedTo({
|
|
463
|
+
security: {
|
|
464
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
465
|
+
},
|
|
466
|
+
});
|
|
467
|
+
|
|
468
|
+
async function run() {
|
|
469
|
+
const result = await unifiedTo.accounting.createAccountingTaxrate({
|
|
470
|
+
connectionId: "<value>",
|
|
471
|
+
});
|
|
472
|
+
|
|
473
|
+
// Handle the result
|
|
474
|
+
console.log(result);
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
run();
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
### Standalone function
|
|
481
|
+
|
|
482
|
+
The standalone function version of this method:
|
|
483
|
+
|
|
484
|
+
```typescript
|
|
485
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
486
|
+
import { accountingCreateAccountingTaxrate } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingTaxrate.js";
|
|
487
|
+
|
|
488
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
489
|
+
// You can create one instance of it to use across an application.
|
|
490
|
+
const unifiedTo = new UnifiedToCore({
|
|
491
|
+
security: {
|
|
492
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
493
|
+
},
|
|
494
|
+
});
|
|
495
|
+
|
|
496
|
+
async function run() {
|
|
497
|
+
const res = await accountingCreateAccountingTaxrate(unifiedTo, {
|
|
498
|
+
connectionId: "<value>",
|
|
499
|
+
});
|
|
500
|
+
|
|
501
|
+
if (!res.ok) {
|
|
502
|
+
throw res.error;
|
|
503
|
+
}
|
|
504
|
+
|
|
505
|
+
const { value: result } = res;
|
|
506
|
+
|
|
507
|
+
// Handle the result
|
|
508
|
+
console.log(result);
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
run();
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
| Parameter | Type | Required | Description |
|
|
517
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
518
|
+
| `request` | [operations.CreateAccountingTaxrateRequest](../../sdk/models/operations/createaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
519
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
520
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
521
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
522
|
+
|
|
523
|
+
### Response
|
|
524
|
+
|
|
525
|
+
**Promise\<[shared.AccountingTaxrate](../../sdk/models/shared/accountingtaxrate.md)\>**
|
|
526
|
+
|
|
527
|
+
### Errors
|
|
528
|
+
|
|
529
|
+
| Error Type | Status Code | Content Type |
|
|
530
|
+
| --------------- | --------------- | --------------- |
|
|
531
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
532
|
+
|
|
533
|
+
## createAccountingTransaction
|
|
534
|
+
|
|
535
|
+
Create a transaction
|
|
536
|
+
|
|
537
|
+
### Example Usage
|
|
538
|
+
|
|
539
|
+
```typescript
|
|
540
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
541
|
+
|
|
542
|
+
const unifiedTo = new UnifiedTo({
|
|
543
|
+
security: {
|
|
544
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
545
|
+
},
|
|
546
|
+
});
|
|
547
|
+
|
|
548
|
+
async function run() {
|
|
549
|
+
const result = await unifiedTo.accounting.createAccountingTransaction({
|
|
550
|
+
connectionId: "<value>",
|
|
551
|
+
});
|
|
552
|
+
|
|
553
|
+
// Handle the result
|
|
554
|
+
console.log(result);
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
run();
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
### Standalone function
|
|
561
|
+
|
|
562
|
+
The standalone function version of this method:
|
|
563
|
+
|
|
564
|
+
```typescript
|
|
565
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
566
|
+
import { accountingCreateAccountingTransaction } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingTransaction.js";
|
|
567
|
+
|
|
568
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
569
|
+
// You can create one instance of it to use across an application.
|
|
570
|
+
const unifiedTo = new UnifiedToCore({
|
|
571
|
+
security: {
|
|
572
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
573
|
+
},
|
|
574
|
+
});
|
|
575
|
+
|
|
576
|
+
async function run() {
|
|
577
|
+
const res = await accountingCreateAccountingTransaction(unifiedTo, {
|
|
578
|
+
connectionId: "<value>",
|
|
579
|
+
});
|
|
580
|
+
|
|
581
|
+
if (!res.ok) {
|
|
582
|
+
throw res.error;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
const { value: result } = res;
|
|
586
|
+
|
|
587
|
+
// Handle the result
|
|
588
|
+
console.log(result);
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
run();
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### Parameters
|
|
595
|
+
|
|
596
|
+
| Parameter | Type | Required | Description |
|
|
597
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
598
|
+
| `request` | [operations.CreateAccountingTransactionRequest](../../sdk/models/operations/createaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
599
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
600
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
601
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
602
|
+
|
|
603
|
+
### Response
|
|
604
|
+
|
|
605
|
+
**Promise\<[shared.AccountingTransaction](../../sdk/models/shared/accountingtransaction.md)\>**
|
|
606
|
+
|
|
607
|
+
### Errors
|
|
608
|
+
|
|
609
|
+
| Error Type | Status Code | Content Type |
|
|
610
|
+
| --------------- | --------------- | --------------- |
|
|
611
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
612
|
+
|
|
613
|
+
## getAccountingAccount
|
|
614
|
+
|
|
615
|
+
Retrieve an account
|
|
616
|
+
|
|
617
|
+
### Example Usage
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
621
|
+
|
|
622
|
+
const unifiedTo = new UnifiedTo({
|
|
623
|
+
security: {
|
|
624
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
625
|
+
},
|
|
626
|
+
});
|
|
627
|
+
|
|
628
|
+
async function run() {
|
|
629
|
+
const result = await unifiedTo.accounting.getAccountingAccount({
|
|
630
|
+
connectionId: "<value>",
|
|
631
|
+
id: "<id>",
|
|
632
|
+
});
|
|
633
|
+
|
|
634
|
+
// Handle the result
|
|
635
|
+
console.log(result);
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
run();
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Standalone function
|
|
642
|
+
|
|
643
|
+
The standalone function version of this method:
|
|
644
|
+
|
|
645
|
+
```typescript
|
|
646
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
647
|
+
import { accountingGetAccountingAccount } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingAccount.js";
|
|
648
|
+
|
|
649
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
650
|
+
// You can create one instance of it to use across an application.
|
|
651
|
+
const unifiedTo = new UnifiedToCore({
|
|
652
|
+
security: {
|
|
653
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
654
|
+
},
|
|
655
|
+
});
|
|
656
|
+
|
|
657
|
+
async function run() {
|
|
658
|
+
const res = await accountingGetAccountingAccount(unifiedTo, {
|
|
659
|
+
connectionId: "<value>",
|
|
660
|
+
id: "<id>",
|
|
661
|
+
});
|
|
662
|
+
|
|
663
|
+
if (!res.ok) {
|
|
664
|
+
throw res.error;
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
const { value: result } = res;
|
|
668
|
+
|
|
669
|
+
// Handle the result
|
|
670
|
+
console.log(result);
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
run();
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
| Parameter | Type | Required | Description |
|
|
679
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
680
|
+
| `request` | [operations.GetAccountingAccountRequest](../../sdk/models/operations/getaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
681
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
682
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
683
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
684
|
+
|
|
685
|
+
### Response
|
|
686
|
+
|
|
687
|
+
**Promise\<[shared.AccountingAccount](../../sdk/models/shared/accountingaccount.md)\>**
|
|
688
|
+
|
|
689
|
+
### Errors
|
|
690
|
+
|
|
691
|
+
| Error Type | Status Code | Content Type |
|
|
692
|
+
| --------------- | --------------- | --------------- |
|
|
693
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
694
|
+
|
|
695
|
+
## getAccountingContact
|
|
696
|
+
|
|
697
|
+
Retrieve a contact
|
|
698
|
+
|
|
699
|
+
### Example Usage
|
|
700
|
+
|
|
701
|
+
```typescript
|
|
702
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
703
|
+
|
|
704
|
+
const unifiedTo = new UnifiedTo({
|
|
705
|
+
security: {
|
|
706
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
707
|
+
},
|
|
708
|
+
});
|
|
709
|
+
|
|
710
|
+
async function run() {
|
|
711
|
+
const result = await unifiedTo.accounting.getAccountingContact({
|
|
712
|
+
connectionId: "<value>",
|
|
713
|
+
id: "<id>",
|
|
714
|
+
});
|
|
715
|
+
|
|
716
|
+
// Handle the result
|
|
717
|
+
console.log(result);
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
run();
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
### Standalone function
|
|
724
|
+
|
|
725
|
+
The standalone function version of this method:
|
|
726
|
+
|
|
727
|
+
```typescript
|
|
728
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
729
|
+
import { accountingGetAccountingContact } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingContact.js";
|
|
730
|
+
|
|
731
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
732
|
+
// You can create one instance of it to use across an application.
|
|
733
|
+
const unifiedTo = new UnifiedToCore({
|
|
734
|
+
security: {
|
|
735
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
736
|
+
},
|
|
737
|
+
});
|
|
738
|
+
|
|
739
|
+
async function run() {
|
|
740
|
+
const res = await accountingGetAccountingContact(unifiedTo, {
|
|
741
|
+
connectionId: "<value>",
|
|
742
|
+
id: "<id>",
|
|
743
|
+
});
|
|
744
|
+
|
|
745
|
+
if (!res.ok) {
|
|
746
|
+
throw res.error;
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
const { value: result } = res;
|
|
750
|
+
|
|
751
|
+
// Handle the result
|
|
752
|
+
console.log(result);
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
run();
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
### Parameters
|
|
759
|
+
|
|
760
|
+
| Parameter | Type | Required | Description |
|
|
761
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
762
|
+
| `request` | [operations.GetAccountingContactRequest](../../sdk/models/operations/getaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
763
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
764
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
765
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
766
|
+
|
|
767
|
+
### Response
|
|
768
|
+
|
|
769
|
+
**Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
|
|
770
|
+
|
|
771
|
+
### Errors
|
|
772
|
+
|
|
773
|
+
| Error Type | Status Code | Content Type |
|
|
774
|
+
| --------------- | --------------- | --------------- |
|
|
775
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
776
|
+
|
|
777
|
+
## getAccountingInvoice
|
|
778
|
+
|
|
779
|
+
Retrieve an invoice
|
|
780
|
+
|
|
781
|
+
### Example Usage
|
|
782
|
+
|
|
783
|
+
```typescript
|
|
784
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
785
|
+
|
|
786
|
+
const unifiedTo = new UnifiedTo({
|
|
787
|
+
security: {
|
|
788
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
789
|
+
},
|
|
790
|
+
});
|
|
791
|
+
|
|
792
|
+
async function run() {
|
|
793
|
+
const result = await unifiedTo.accounting.getAccountingInvoice({
|
|
794
|
+
connectionId: "<value>",
|
|
795
|
+
id: "<id>",
|
|
796
|
+
});
|
|
797
|
+
|
|
798
|
+
// Handle the result
|
|
799
|
+
console.log(result);
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
run();
|
|
803
|
+
```
|
|
804
|
+
|
|
805
|
+
### Standalone function
|
|
806
|
+
|
|
807
|
+
The standalone function version of this method:
|
|
808
|
+
|
|
809
|
+
```typescript
|
|
810
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
811
|
+
import { accountingGetAccountingInvoice } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingInvoice.js";
|
|
812
|
+
|
|
813
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
814
|
+
// You can create one instance of it to use across an application.
|
|
815
|
+
const unifiedTo = new UnifiedToCore({
|
|
816
|
+
security: {
|
|
817
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
818
|
+
},
|
|
819
|
+
});
|
|
820
|
+
|
|
821
|
+
async function run() {
|
|
822
|
+
const res = await accountingGetAccountingInvoice(unifiedTo, {
|
|
823
|
+
connectionId: "<value>",
|
|
824
|
+
id: "<id>",
|
|
825
|
+
});
|
|
826
|
+
|
|
827
|
+
if (!res.ok) {
|
|
828
|
+
throw res.error;
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
const { value: result } = res;
|
|
832
|
+
|
|
833
|
+
// Handle the result
|
|
834
|
+
console.log(result);
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
run();
|
|
838
|
+
```
|
|
839
|
+
|
|
840
|
+
### Parameters
|
|
841
|
+
|
|
842
|
+
| Parameter | Type | Required | Description |
|
|
843
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
844
|
+
| `request` | [operations.GetAccountingInvoiceRequest](../../sdk/models/operations/getaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
845
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
846
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
847
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
848
|
+
|
|
849
|
+
### Response
|
|
850
|
+
|
|
851
|
+
**Promise\<[shared.AccountingInvoice](../../sdk/models/shared/accountinginvoice.md)\>**
|
|
852
|
+
|
|
853
|
+
### Errors
|
|
854
|
+
|
|
855
|
+
| Error Type | Status Code | Content Type |
|
|
856
|
+
| --------------- | --------------- | --------------- |
|
|
857
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
858
|
+
|
|
859
|
+
## getAccountingJournal
|
|
860
|
+
|
|
861
|
+
Retrieve a journal
|
|
862
|
+
|
|
863
|
+
### Example Usage
|
|
864
|
+
|
|
865
|
+
```typescript
|
|
866
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
867
|
+
|
|
868
|
+
const unifiedTo = new UnifiedTo({
|
|
869
|
+
security: {
|
|
870
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
871
|
+
},
|
|
872
|
+
});
|
|
873
|
+
|
|
874
|
+
async function run() {
|
|
875
|
+
const result = await unifiedTo.accounting.getAccountingJournal({
|
|
876
|
+
connectionId: "<value>",
|
|
877
|
+
id: "<id>",
|
|
878
|
+
});
|
|
879
|
+
|
|
880
|
+
// Handle the result
|
|
881
|
+
console.log(result);
|
|
882
|
+
}
|
|
883
|
+
|
|
884
|
+
run();
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
### Standalone function
|
|
888
|
+
|
|
889
|
+
The standalone function version of this method:
|
|
890
|
+
|
|
891
|
+
```typescript
|
|
892
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
893
|
+
import { accountingGetAccountingJournal } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingJournal.js";
|
|
894
|
+
|
|
895
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
896
|
+
// You can create one instance of it to use across an application.
|
|
897
|
+
const unifiedTo = new UnifiedToCore({
|
|
898
|
+
security: {
|
|
899
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
900
|
+
},
|
|
901
|
+
});
|
|
902
|
+
|
|
903
|
+
async function run() {
|
|
904
|
+
const res = await accountingGetAccountingJournal(unifiedTo, {
|
|
905
|
+
connectionId: "<value>",
|
|
906
|
+
id: "<id>",
|
|
907
|
+
});
|
|
908
|
+
|
|
909
|
+
if (!res.ok) {
|
|
910
|
+
throw res.error;
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
const { value: result } = res;
|
|
914
|
+
|
|
915
|
+
// Handle the result
|
|
916
|
+
console.log(result);
|
|
917
|
+
}
|
|
918
|
+
|
|
919
|
+
run();
|
|
920
|
+
```
|
|
921
|
+
|
|
922
|
+
### Parameters
|
|
923
|
+
|
|
924
|
+
| Parameter | Type | Required | Description |
|
|
925
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
926
|
+
| `request` | [operations.GetAccountingJournalRequest](../../sdk/models/operations/getaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
927
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
928
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
929
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
930
|
+
|
|
931
|
+
### Response
|
|
932
|
+
|
|
933
|
+
**Promise\<[shared.AccountingJournal](../../sdk/models/shared/accountingjournal.md)\>**
|
|
934
|
+
|
|
935
|
+
### Errors
|
|
936
|
+
|
|
937
|
+
| Error Type | Status Code | Content Type |
|
|
938
|
+
| --------------- | --------------- | --------------- |
|
|
939
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
940
|
+
|
|
941
|
+
## getAccountingOrder
|
|
942
|
+
|
|
943
|
+
Retrieve an order
|
|
944
|
+
|
|
945
|
+
### Example Usage
|
|
946
|
+
|
|
947
|
+
```typescript
|
|
948
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
949
|
+
|
|
950
|
+
const unifiedTo = new UnifiedTo({
|
|
951
|
+
security: {
|
|
952
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
953
|
+
},
|
|
954
|
+
});
|
|
955
|
+
|
|
956
|
+
async function run() {
|
|
957
|
+
const result = await unifiedTo.accounting.getAccountingOrder({
|
|
958
|
+
connectionId: "<id>",
|
|
959
|
+
id: "<id>",
|
|
960
|
+
});
|
|
961
|
+
|
|
962
|
+
// Handle the result
|
|
963
|
+
console.log(result);
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
run();
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
### Standalone function
|
|
970
|
+
|
|
971
|
+
The standalone function version of this method:
|
|
972
|
+
|
|
973
|
+
```typescript
|
|
974
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
975
|
+
import { accountingGetAccountingOrder } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingOrder.js";
|
|
976
|
+
|
|
977
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
978
|
+
// You can create one instance of it to use across an application.
|
|
979
|
+
const unifiedTo = new UnifiedToCore({
|
|
980
|
+
security: {
|
|
981
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
982
|
+
},
|
|
983
|
+
});
|
|
984
|
+
|
|
985
|
+
async function run() {
|
|
986
|
+
const res = await accountingGetAccountingOrder(unifiedTo, {
|
|
987
|
+
connectionId: "<id>",
|
|
988
|
+
id: "<id>",
|
|
989
|
+
});
|
|
990
|
+
|
|
991
|
+
if (!res.ok) {
|
|
992
|
+
throw res.error;
|
|
993
|
+
}
|
|
994
|
+
|
|
995
|
+
const { value: result } = res;
|
|
996
|
+
|
|
997
|
+
// Handle the result
|
|
998
|
+
console.log(result);
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
run();
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
### Parameters
|
|
1005
|
+
|
|
1006
|
+
| Parameter | Type | Required | Description |
|
|
1007
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1008
|
+
| `request` | [operations.GetAccountingOrderRequest](../../sdk/models/operations/getaccountingorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1009
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1010
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1011
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1012
|
+
|
|
1013
|
+
### Response
|
|
1014
|
+
|
|
1015
|
+
**Promise\<[shared.AccountingOrder](../../sdk/models/shared/accountingorder.md)\>**
|
|
1016
|
+
|
|
1017
|
+
### Errors
|
|
1018
|
+
|
|
1019
|
+
| Error Type | Status Code | Content Type |
|
|
1020
|
+
| --------------- | --------------- | --------------- |
|
|
1021
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1022
|
+
|
|
1023
|
+
## getAccountingOrganization
|
|
1024
|
+
|
|
1025
|
+
Retrieve an organization
|
|
1026
|
+
|
|
1027
|
+
### Example Usage
|
|
1028
|
+
|
|
1029
|
+
```typescript
|
|
1030
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1031
|
+
|
|
1032
|
+
const unifiedTo = new UnifiedTo({
|
|
1033
|
+
security: {
|
|
1034
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1035
|
+
},
|
|
1036
|
+
});
|
|
1037
|
+
|
|
1038
|
+
async function run() {
|
|
1039
|
+
const result = await unifiedTo.accounting.getAccountingOrganization({
|
|
1040
|
+
connectionId: "<value>",
|
|
1041
|
+
id: "<id>",
|
|
1042
|
+
});
|
|
1043
|
+
|
|
1044
|
+
// Handle the result
|
|
1045
|
+
console.log(result);
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
run();
|
|
1049
|
+
```
|
|
1050
|
+
|
|
1051
|
+
### Standalone function
|
|
1052
|
+
|
|
1053
|
+
The standalone function version of this method:
|
|
1054
|
+
|
|
1055
|
+
```typescript
|
|
1056
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1057
|
+
import { accountingGetAccountingOrganization } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingOrganization.js";
|
|
1058
|
+
|
|
1059
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1060
|
+
// You can create one instance of it to use across an application.
|
|
1061
|
+
const unifiedTo = new UnifiedToCore({
|
|
1062
|
+
security: {
|
|
1063
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1064
|
+
},
|
|
1065
|
+
});
|
|
1066
|
+
|
|
1067
|
+
async function run() {
|
|
1068
|
+
const res = await accountingGetAccountingOrganization(unifiedTo, {
|
|
1069
|
+
connectionId: "<value>",
|
|
1070
|
+
id: "<id>",
|
|
1071
|
+
});
|
|
1072
|
+
|
|
1073
|
+
if (!res.ok) {
|
|
1074
|
+
throw res.error;
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
const { value: result } = res;
|
|
1078
|
+
|
|
1079
|
+
// Handle the result
|
|
1080
|
+
console.log(result);
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
run();
|
|
1084
|
+
```
|
|
1085
|
+
|
|
1086
|
+
### Parameters
|
|
1087
|
+
|
|
1088
|
+
| Parameter | Type | Required | Description |
|
|
1089
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1090
|
+
| `request` | [operations.GetAccountingOrganizationRequest](../../sdk/models/operations/getaccountingorganizationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1091
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1092
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1093
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1094
|
+
|
|
1095
|
+
### Response
|
|
1096
|
+
|
|
1097
|
+
**Promise\<[shared.AccountingOrganization](../../sdk/models/shared/accountingorganization.md)\>**
|
|
1098
|
+
|
|
1099
|
+
### Errors
|
|
1100
|
+
|
|
1101
|
+
| Error Type | Status Code | Content Type |
|
|
1102
|
+
| --------------- | --------------- | --------------- |
|
|
1103
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1104
|
+
|
|
1105
|
+
## getAccountingTaxrate
|
|
1106
|
+
|
|
1107
|
+
Retrieve a taxrate
|
|
1108
|
+
|
|
1109
|
+
### Example Usage
|
|
1110
|
+
|
|
1111
|
+
```typescript
|
|
1112
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1113
|
+
|
|
1114
|
+
const unifiedTo = new UnifiedTo({
|
|
1115
|
+
security: {
|
|
1116
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1117
|
+
},
|
|
1118
|
+
});
|
|
1119
|
+
|
|
1120
|
+
async function run() {
|
|
1121
|
+
const result = await unifiedTo.accounting.getAccountingTaxrate({
|
|
1122
|
+
connectionId: "<value>",
|
|
1123
|
+
id: "<id>",
|
|
1124
|
+
});
|
|
1125
|
+
|
|
1126
|
+
// Handle the result
|
|
1127
|
+
console.log(result);
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
run();
|
|
1131
|
+
```
|
|
1132
|
+
|
|
1133
|
+
### Standalone function
|
|
1134
|
+
|
|
1135
|
+
The standalone function version of this method:
|
|
1136
|
+
|
|
1137
|
+
```typescript
|
|
1138
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1139
|
+
import { accountingGetAccountingTaxrate } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingTaxrate.js";
|
|
1140
|
+
|
|
1141
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1142
|
+
// You can create one instance of it to use across an application.
|
|
1143
|
+
const unifiedTo = new UnifiedToCore({
|
|
1144
|
+
security: {
|
|
1145
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1146
|
+
},
|
|
1147
|
+
});
|
|
1148
|
+
|
|
1149
|
+
async function run() {
|
|
1150
|
+
const res = await accountingGetAccountingTaxrate(unifiedTo, {
|
|
1151
|
+
connectionId: "<value>",
|
|
1152
|
+
id: "<id>",
|
|
1153
|
+
});
|
|
1154
|
+
|
|
1155
|
+
if (!res.ok) {
|
|
1156
|
+
throw res.error;
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
const { value: result } = res;
|
|
1160
|
+
|
|
1161
|
+
// Handle the result
|
|
1162
|
+
console.log(result);
|
|
1163
|
+
}
|
|
1164
|
+
|
|
1165
|
+
run();
|
|
1166
|
+
```
|
|
1167
|
+
|
|
1168
|
+
### Parameters
|
|
1169
|
+
|
|
1170
|
+
| Parameter | Type | Required | Description |
|
|
1171
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1172
|
+
| `request` | [operations.GetAccountingTaxrateRequest](../../sdk/models/operations/getaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1173
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1174
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1175
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1176
|
+
|
|
1177
|
+
### Response
|
|
1178
|
+
|
|
1179
|
+
**Promise\<[shared.AccountingTaxrate](../../sdk/models/shared/accountingtaxrate.md)\>**
|
|
1180
|
+
|
|
1181
|
+
### Errors
|
|
1182
|
+
|
|
1183
|
+
| Error Type | Status Code | Content Type |
|
|
1184
|
+
| --------------- | --------------- | --------------- |
|
|
1185
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1186
|
+
|
|
1187
|
+
## getAccountingTransaction
|
|
1188
|
+
|
|
1189
|
+
Retrieve a transaction
|
|
1190
|
+
|
|
1191
|
+
### Example Usage
|
|
1192
|
+
|
|
1193
|
+
```typescript
|
|
1194
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1195
|
+
|
|
1196
|
+
const unifiedTo = new UnifiedTo({
|
|
1197
|
+
security: {
|
|
1198
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1199
|
+
},
|
|
1200
|
+
});
|
|
1201
|
+
|
|
1202
|
+
async function run() {
|
|
1203
|
+
const result = await unifiedTo.accounting.getAccountingTransaction({
|
|
1204
|
+
connectionId: "<value>",
|
|
1205
|
+
id: "<id>",
|
|
1206
|
+
});
|
|
1207
|
+
|
|
1208
|
+
// Handle the result
|
|
1209
|
+
console.log(result);
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1212
|
+
run();
|
|
1213
|
+
```
|
|
1214
|
+
|
|
1215
|
+
### Standalone function
|
|
1216
|
+
|
|
1217
|
+
The standalone function version of this method:
|
|
1218
|
+
|
|
1219
|
+
```typescript
|
|
1220
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1221
|
+
import { accountingGetAccountingTransaction } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingTransaction.js";
|
|
1222
|
+
|
|
1223
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1224
|
+
// You can create one instance of it to use across an application.
|
|
1225
|
+
const unifiedTo = new UnifiedToCore({
|
|
1226
|
+
security: {
|
|
1227
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1228
|
+
},
|
|
1229
|
+
});
|
|
1230
|
+
|
|
1231
|
+
async function run() {
|
|
1232
|
+
const res = await accountingGetAccountingTransaction(unifiedTo, {
|
|
1233
|
+
connectionId: "<value>",
|
|
1234
|
+
id: "<id>",
|
|
1235
|
+
});
|
|
1236
|
+
|
|
1237
|
+
if (!res.ok) {
|
|
1238
|
+
throw res.error;
|
|
1239
|
+
}
|
|
1240
|
+
|
|
1241
|
+
const { value: result } = res;
|
|
1242
|
+
|
|
1243
|
+
// Handle the result
|
|
1244
|
+
console.log(result);
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
run();
|
|
1248
|
+
```
|
|
1249
|
+
|
|
1250
|
+
### Parameters
|
|
1251
|
+
|
|
1252
|
+
| Parameter | Type | Required | Description |
|
|
1253
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1254
|
+
| `request` | [operations.GetAccountingTransactionRequest](../../sdk/models/operations/getaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1255
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1256
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1257
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1258
|
+
|
|
1259
|
+
### Response
|
|
1260
|
+
|
|
1261
|
+
**Promise\<[shared.AccountingTransaction](../../sdk/models/shared/accountingtransaction.md)\>**
|
|
1262
|
+
|
|
1263
|
+
### Errors
|
|
1264
|
+
|
|
1265
|
+
| Error Type | Status Code | Content Type |
|
|
1266
|
+
| --------------- | --------------- | --------------- |
|
|
1267
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1268
|
+
|
|
1269
|
+
## listAccountingAccounts
|
|
1270
|
+
|
|
1271
|
+
List all accounts
|
|
1272
|
+
|
|
1273
|
+
### Example Usage
|
|
1274
|
+
|
|
1275
|
+
```typescript
|
|
1276
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1277
|
+
|
|
1278
|
+
const unifiedTo = new UnifiedTo({
|
|
1279
|
+
security: {
|
|
1280
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1281
|
+
},
|
|
1282
|
+
});
|
|
1283
|
+
|
|
1284
|
+
async function run() {
|
|
1285
|
+
const result = await unifiedTo.accounting.listAccountingAccounts({
|
|
1286
|
+
connectionId: "<value>",
|
|
1287
|
+
});
|
|
1288
|
+
|
|
1289
|
+
// Handle the result
|
|
1290
|
+
console.log(result);
|
|
1291
|
+
}
|
|
1292
|
+
|
|
1293
|
+
run();
|
|
1294
|
+
```
|
|
1295
|
+
|
|
1296
|
+
### Standalone function
|
|
1297
|
+
|
|
1298
|
+
The standalone function version of this method:
|
|
1299
|
+
|
|
1300
|
+
```typescript
|
|
1301
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1302
|
+
import { accountingListAccountingAccounts } from "@unified-api/typescript-sdk/funcs/accountingListAccountingAccounts.js";
|
|
1303
|
+
|
|
1304
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1305
|
+
// You can create one instance of it to use across an application.
|
|
1306
|
+
const unifiedTo = new UnifiedToCore({
|
|
1307
|
+
security: {
|
|
1308
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1309
|
+
},
|
|
1310
|
+
});
|
|
1311
|
+
|
|
1312
|
+
async function run() {
|
|
1313
|
+
const res = await accountingListAccountingAccounts(unifiedTo, {
|
|
1314
|
+
connectionId: "<value>",
|
|
1315
|
+
});
|
|
1316
|
+
|
|
1317
|
+
if (!res.ok) {
|
|
1318
|
+
throw res.error;
|
|
1319
|
+
}
|
|
1320
|
+
|
|
1321
|
+
const { value: result } = res;
|
|
1322
|
+
|
|
1323
|
+
// Handle the result
|
|
1324
|
+
console.log(result);
|
|
1325
|
+
}
|
|
1326
|
+
|
|
1327
|
+
run();
|
|
1328
|
+
```
|
|
1329
|
+
|
|
1330
|
+
### Parameters
|
|
1331
|
+
|
|
1332
|
+
| Parameter | Type | Required | Description |
|
|
1333
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1334
|
+
| `request` | [operations.ListAccountingAccountsRequest](../../sdk/models/operations/listaccountingaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1335
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1336
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1337
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1338
|
+
|
|
1339
|
+
### Response
|
|
1340
|
+
|
|
1341
|
+
**Promise\<[shared.AccountingAccount[]](../../models/.md)\>**
|
|
1342
|
+
|
|
1343
|
+
### Errors
|
|
1344
|
+
|
|
1345
|
+
| Error Type | Status Code | Content Type |
|
|
1346
|
+
| --------------- | --------------- | --------------- |
|
|
1347
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1348
|
+
|
|
1349
|
+
## listAccountingContacts
|
|
1350
|
+
|
|
1351
|
+
List all contacts
|
|
1352
|
+
|
|
1353
|
+
### Example Usage
|
|
1354
|
+
|
|
1355
|
+
```typescript
|
|
1356
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1357
|
+
|
|
1358
|
+
const unifiedTo = new UnifiedTo({
|
|
1359
|
+
security: {
|
|
1360
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1361
|
+
},
|
|
1362
|
+
});
|
|
1363
|
+
|
|
1364
|
+
async function run() {
|
|
1365
|
+
const result = await unifiedTo.accounting.listAccountingContacts({
|
|
1366
|
+
connectionId: "<value>",
|
|
1367
|
+
});
|
|
1368
|
+
|
|
1369
|
+
// Handle the result
|
|
1370
|
+
console.log(result);
|
|
1371
|
+
}
|
|
1372
|
+
|
|
1373
|
+
run();
|
|
1374
|
+
```
|
|
1375
|
+
|
|
1376
|
+
### Standalone function
|
|
1377
|
+
|
|
1378
|
+
The standalone function version of this method:
|
|
1379
|
+
|
|
1380
|
+
```typescript
|
|
1381
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1382
|
+
import { accountingListAccountingContacts } from "@unified-api/typescript-sdk/funcs/accountingListAccountingContacts.js";
|
|
1383
|
+
|
|
1384
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1385
|
+
// You can create one instance of it to use across an application.
|
|
1386
|
+
const unifiedTo = new UnifiedToCore({
|
|
1387
|
+
security: {
|
|
1388
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1389
|
+
},
|
|
1390
|
+
});
|
|
1391
|
+
|
|
1392
|
+
async function run() {
|
|
1393
|
+
const res = await accountingListAccountingContacts(unifiedTo, {
|
|
1394
|
+
connectionId: "<value>",
|
|
1395
|
+
});
|
|
1396
|
+
|
|
1397
|
+
if (!res.ok) {
|
|
1398
|
+
throw res.error;
|
|
1399
|
+
}
|
|
1400
|
+
|
|
1401
|
+
const { value: result } = res;
|
|
1402
|
+
|
|
1403
|
+
// Handle the result
|
|
1404
|
+
console.log(result);
|
|
1405
|
+
}
|
|
1406
|
+
|
|
1407
|
+
run();
|
|
1408
|
+
```
|
|
1409
|
+
|
|
1410
|
+
### Parameters
|
|
1411
|
+
|
|
1412
|
+
| Parameter | Type | Required | Description |
|
|
1413
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1414
|
+
| `request` | [operations.ListAccountingContactsRequest](../../sdk/models/operations/listaccountingcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1415
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1416
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1417
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1418
|
+
|
|
1419
|
+
### Response
|
|
1420
|
+
|
|
1421
|
+
**Promise\<[shared.AccountingContact[]](../../models/.md)\>**
|
|
1422
|
+
|
|
1423
|
+
### Errors
|
|
1424
|
+
|
|
1425
|
+
| Error Type | Status Code | Content Type |
|
|
1426
|
+
| --------------- | --------------- | --------------- |
|
|
1427
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1428
|
+
|
|
1429
|
+
## listAccountingInvoices
|
|
1430
|
+
|
|
1431
|
+
List all invoices
|
|
1432
|
+
|
|
1433
|
+
### Example Usage
|
|
1434
|
+
|
|
1435
|
+
```typescript
|
|
1436
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1437
|
+
|
|
1438
|
+
const unifiedTo = new UnifiedTo({
|
|
1439
|
+
security: {
|
|
1440
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1441
|
+
},
|
|
1442
|
+
});
|
|
1443
|
+
|
|
1444
|
+
async function run() {
|
|
1445
|
+
const result = await unifiedTo.accounting.listAccountingInvoices({
|
|
1446
|
+
connectionId: "<value>",
|
|
1447
|
+
});
|
|
1448
|
+
|
|
1449
|
+
// Handle the result
|
|
1450
|
+
console.log(result);
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1453
|
+
run();
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
### Standalone function
|
|
1457
|
+
|
|
1458
|
+
The standalone function version of this method:
|
|
1459
|
+
|
|
1460
|
+
```typescript
|
|
1461
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1462
|
+
import { accountingListAccountingInvoices } from "@unified-api/typescript-sdk/funcs/accountingListAccountingInvoices.js";
|
|
1463
|
+
|
|
1464
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1465
|
+
// You can create one instance of it to use across an application.
|
|
1466
|
+
const unifiedTo = new UnifiedToCore({
|
|
1467
|
+
security: {
|
|
1468
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1469
|
+
},
|
|
1470
|
+
});
|
|
1471
|
+
|
|
1472
|
+
async function run() {
|
|
1473
|
+
const res = await accountingListAccountingInvoices(unifiedTo, {
|
|
1474
|
+
connectionId: "<value>",
|
|
1475
|
+
});
|
|
1476
|
+
|
|
1477
|
+
if (!res.ok) {
|
|
1478
|
+
throw res.error;
|
|
1479
|
+
}
|
|
1480
|
+
|
|
1481
|
+
const { value: result } = res;
|
|
1482
|
+
|
|
1483
|
+
// Handle the result
|
|
1484
|
+
console.log(result);
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
run();
|
|
1488
|
+
```
|
|
1489
|
+
|
|
1490
|
+
### Parameters
|
|
1491
|
+
|
|
1492
|
+
| Parameter | Type | Required | Description |
|
|
1493
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1494
|
+
| `request` | [operations.ListAccountingInvoicesRequest](../../sdk/models/operations/listaccountinginvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1495
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1496
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1497
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1498
|
+
|
|
1499
|
+
### Response
|
|
1500
|
+
|
|
1501
|
+
**Promise\<[shared.AccountingInvoice[]](../../models/.md)\>**
|
|
1502
|
+
|
|
1503
|
+
### Errors
|
|
1504
|
+
|
|
1505
|
+
| Error Type | Status Code | Content Type |
|
|
1506
|
+
| --------------- | --------------- | --------------- |
|
|
1507
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1508
|
+
|
|
1509
|
+
## listAccountingJournals
|
|
1510
|
+
|
|
1511
|
+
List all journals
|
|
1512
|
+
|
|
1513
|
+
### Example Usage
|
|
1514
|
+
|
|
1515
|
+
```typescript
|
|
1516
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1517
|
+
|
|
1518
|
+
const unifiedTo = new UnifiedTo({
|
|
1519
|
+
security: {
|
|
1520
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1521
|
+
},
|
|
1522
|
+
});
|
|
1523
|
+
|
|
1524
|
+
async function run() {
|
|
1525
|
+
const result = await unifiedTo.accounting.listAccountingJournals({
|
|
1526
|
+
connectionId: "<value>",
|
|
1527
|
+
});
|
|
1528
|
+
|
|
1529
|
+
// Handle the result
|
|
1530
|
+
console.log(result);
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
run();
|
|
1534
|
+
```
|
|
1535
|
+
|
|
1536
|
+
### Standalone function
|
|
1537
|
+
|
|
1538
|
+
The standalone function version of this method:
|
|
1539
|
+
|
|
1540
|
+
```typescript
|
|
1541
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1542
|
+
import { accountingListAccountingJournals } from "@unified-api/typescript-sdk/funcs/accountingListAccountingJournals.js";
|
|
1543
|
+
|
|
1544
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1545
|
+
// You can create one instance of it to use across an application.
|
|
1546
|
+
const unifiedTo = new UnifiedToCore({
|
|
1547
|
+
security: {
|
|
1548
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1549
|
+
},
|
|
1550
|
+
});
|
|
1551
|
+
|
|
1552
|
+
async function run() {
|
|
1553
|
+
const res = await accountingListAccountingJournals(unifiedTo, {
|
|
1554
|
+
connectionId: "<value>",
|
|
1555
|
+
});
|
|
1556
|
+
|
|
1557
|
+
if (!res.ok) {
|
|
1558
|
+
throw res.error;
|
|
1559
|
+
}
|
|
1560
|
+
|
|
1561
|
+
const { value: result } = res;
|
|
1562
|
+
|
|
1563
|
+
// Handle the result
|
|
1564
|
+
console.log(result);
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
run();
|
|
1568
|
+
```
|
|
1569
|
+
|
|
1570
|
+
### Parameters
|
|
1571
|
+
|
|
1572
|
+
| Parameter | Type | Required | Description |
|
|
1573
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1574
|
+
| `request` | [operations.ListAccountingJournalsRequest](../../sdk/models/operations/listaccountingjournalsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1575
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1576
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1577
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1578
|
+
|
|
1579
|
+
### Response
|
|
1580
|
+
|
|
1581
|
+
**Promise\<[shared.AccountingJournal[]](../../models/.md)\>**
|
|
1582
|
+
|
|
1583
|
+
### Errors
|
|
1584
|
+
|
|
1585
|
+
| Error Type | Status Code | Content Type |
|
|
1586
|
+
| --------------- | --------------- | --------------- |
|
|
1587
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1588
|
+
|
|
1589
|
+
## listAccountingOrders
|
|
1590
|
+
|
|
1591
|
+
List all orders
|
|
1592
|
+
|
|
1593
|
+
### Example Usage
|
|
1594
|
+
|
|
1595
|
+
```typescript
|
|
1596
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1597
|
+
|
|
1598
|
+
const unifiedTo = new UnifiedTo({
|
|
1599
|
+
security: {
|
|
1600
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1601
|
+
},
|
|
1602
|
+
});
|
|
1603
|
+
|
|
1604
|
+
async function run() {
|
|
1605
|
+
const result = await unifiedTo.accounting.listAccountingOrders({
|
|
1606
|
+
connectionId: "<id>",
|
|
1607
|
+
});
|
|
1608
|
+
|
|
1609
|
+
// Handle the result
|
|
1610
|
+
console.log(result);
|
|
1611
|
+
}
|
|
1612
|
+
|
|
1613
|
+
run();
|
|
1614
|
+
```
|
|
1615
|
+
|
|
1616
|
+
### Standalone function
|
|
1617
|
+
|
|
1618
|
+
The standalone function version of this method:
|
|
1619
|
+
|
|
1620
|
+
```typescript
|
|
1621
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1622
|
+
import { accountingListAccountingOrders } from "@unified-api/typescript-sdk/funcs/accountingListAccountingOrders.js";
|
|
1623
|
+
|
|
1624
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1625
|
+
// You can create one instance of it to use across an application.
|
|
1626
|
+
const unifiedTo = new UnifiedToCore({
|
|
1627
|
+
security: {
|
|
1628
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1629
|
+
},
|
|
1630
|
+
});
|
|
1631
|
+
|
|
1632
|
+
async function run() {
|
|
1633
|
+
const res = await accountingListAccountingOrders(unifiedTo, {
|
|
1634
|
+
connectionId: "<id>",
|
|
1635
|
+
});
|
|
1636
|
+
|
|
1637
|
+
if (!res.ok) {
|
|
1638
|
+
throw res.error;
|
|
1639
|
+
}
|
|
1640
|
+
|
|
1641
|
+
const { value: result } = res;
|
|
1642
|
+
|
|
1643
|
+
// Handle the result
|
|
1644
|
+
console.log(result);
|
|
1645
|
+
}
|
|
1646
|
+
|
|
1647
|
+
run();
|
|
1648
|
+
```
|
|
1649
|
+
|
|
1650
|
+
### Parameters
|
|
1651
|
+
|
|
1652
|
+
| Parameter | Type | Required | Description |
|
|
1653
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1654
|
+
| `request` | [operations.ListAccountingOrdersRequest](../../sdk/models/operations/listaccountingordersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1655
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1656
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1657
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1658
|
+
|
|
1659
|
+
### Response
|
|
1660
|
+
|
|
1661
|
+
**Promise\<[shared.AccountingOrder[]](../../models/.md)\>**
|
|
1662
|
+
|
|
1663
|
+
### Errors
|
|
1664
|
+
|
|
1665
|
+
| Error Type | Status Code | Content Type |
|
|
1666
|
+
| --------------- | --------------- | --------------- |
|
|
1667
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1668
|
+
|
|
1669
|
+
## listAccountingOrganizations
|
|
1670
|
+
|
|
1671
|
+
List all organizations
|
|
1672
|
+
|
|
1673
|
+
### Example Usage
|
|
1674
|
+
|
|
1675
|
+
```typescript
|
|
1676
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1677
|
+
|
|
1678
|
+
const unifiedTo = new UnifiedTo({
|
|
1679
|
+
security: {
|
|
1680
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1681
|
+
},
|
|
1682
|
+
});
|
|
1683
|
+
|
|
1684
|
+
async function run() {
|
|
1685
|
+
const result = await unifiedTo.accounting.listAccountingOrganizations({
|
|
1686
|
+
connectionId: "<value>",
|
|
1687
|
+
});
|
|
1688
|
+
|
|
1689
|
+
// Handle the result
|
|
1690
|
+
console.log(result);
|
|
1691
|
+
}
|
|
1692
|
+
|
|
1693
|
+
run();
|
|
1694
|
+
```
|
|
1695
|
+
|
|
1696
|
+
### Standalone function
|
|
1697
|
+
|
|
1698
|
+
The standalone function version of this method:
|
|
1699
|
+
|
|
1700
|
+
```typescript
|
|
1701
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1702
|
+
import { accountingListAccountingOrganizations } from "@unified-api/typescript-sdk/funcs/accountingListAccountingOrganizations.js";
|
|
1703
|
+
|
|
1704
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1705
|
+
// You can create one instance of it to use across an application.
|
|
1706
|
+
const unifiedTo = new UnifiedToCore({
|
|
1707
|
+
security: {
|
|
1708
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1709
|
+
},
|
|
1710
|
+
});
|
|
1711
|
+
|
|
1712
|
+
async function run() {
|
|
1713
|
+
const res = await accountingListAccountingOrganizations(unifiedTo, {
|
|
1714
|
+
connectionId: "<value>",
|
|
1715
|
+
});
|
|
1716
|
+
|
|
1717
|
+
if (!res.ok) {
|
|
1718
|
+
throw res.error;
|
|
1719
|
+
}
|
|
1720
|
+
|
|
1721
|
+
const { value: result } = res;
|
|
1722
|
+
|
|
1723
|
+
// Handle the result
|
|
1724
|
+
console.log(result);
|
|
1725
|
+
}
|
|
1726
|
+
|
|
1727
|
+
run();
|
|
1728
|
+
```
|
|
1729
|
+
|
|
1730
|
+
### Parameters
|
|
1731
|
+
|
|
1732
|
+
| Parameter | Type | Required | Description |
|
|
1733
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1734
|
+
| `request` | [operations.ListAccountingOrganizationsRequest](../../sdk/models/operations/listaccountingorganizationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1735
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1736
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1737
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1738
|
+
|
|
1739
|
+
### Response
|
|
1740
|
+
|
|
1741
|
+
**Promise\<[shared.AccountingOrganization[]](../../models/.md)\>**
|
|
1742
|
+
|
|
1743
|
+
### Errors
|
|
1744
|
+
|
|
1745
|
+
| Error Type | Status Code | Content Type |
|
|
1746
|
+
| --------------- | --------------- | --------------- |
|
|
1747
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1748
|
+
|
|
1749
|
+
## listAccountingTaxrates
|
|
1750
|
+
|
|
1751
|
+
List all taxrates
|
|
1752
|
+
|
|
1753
|
+
### Example Usage
|
|
1754
|
+
|
|
1755
|
+
```typescript
|
|
1756
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1757
|
+
|
|
1758
|
+
const unifiedTo = new UnifiedTo({
|
|
1759
|
+
security: {
|
|
1760
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1761
|
+
},
|
|
1762
|
+
});
|
|
1763
|
+
|
|
1764
|
+
async function run() {
|
|
1765
|
+
const result = await unifiedTo.accounting.listAccountingTaxrates({
|
|
1766
|
+
connectionId: "<value>",
|
|
1767
|
+
});
|
|
1768
|
+
|
|
1769
|
+
// Handle the result
|
|
1770
|
+
console.log(result);
|
|
1771
|
+
}
|
|
1772
|
+
|
|
1773
|
+
run();
|
|
1774
|
+
```
|
|
1775
|
+
|
|
1776
|
+
### Standalone function
|
|
1777
|
+
|
|
1778
|
+
The standalone function version of this method:
|
|
1779
|
+
|
|
1780
|
+
```typescript
|
|
1781
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1782
|
+
import { accountingListAccountingTaxrates } from "@unified-api/typescript-sdk/funcs/accountingListAccountingTaxrates.js";
|
|
1783
|
+
|
|
1784
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1785
|
+
// You can create one instance of it to use across an application.
|
|
1786
|
+
const unifiedTo = new UnifiedToCore({
|
|
1787
|
+
security: {
|
|
1788
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1789
|
+
},
|
|
1790
|
+
});
|
|
1791
|
+
|
|
1792
|
+
async function run() {
|
|
1793
|
+
const res = await accountingListAccountingTaxrates(unifiedTo, {
|
|
1794
|
+
connectionId: "<value>",
|
|
1795
|
+
});
|
|
1796
|
+
|
|
1797
|
+
if (!res.ok) {
|
|
1798
|
+
throw res.error;
|
|
1799
|
+
}
|
|
1800
|
+
|
|
1801
|
+
const { value: result } = res;
|
|
1802
|
+
|
|
1803
|
+
// Handle the result
|
|
1804
|
+
console.log(result);
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
run();
|
|
1808
|
+
```
|
|
1809
|
+
|
|
1810
|
+
### Parameters
|
|
1811
|
+
|
|
1812
|
+
| Parameter | Type | Required | Description |
|
|
1813
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1814
|
+
| `request` | [operations.ListAccountingTaxratesRequest](../../sdk/models/operations/listaccountingtaxratesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1815
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1816
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1817
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1818
|
+
|
|
1819
|
+
### Response
|
|
1820
|
+
|
|
1821
|
+
**Promise\<[shared.AccountingTaxrate[]](../../models/.md)\>**
|
|
1822
|
+
|
|
1823
|
+
### Errors
|
|
1824
|
+
|
|
1825
|
+
| Error Type | Status Code | Content Type |
|
|
1826
|
+
| --------------- | --------------- | --------------- |
|
|
1827
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1828
|
+
|
|
1829
|
+
## listAccountingTransactions
|
|
1830
|
+
|
|
1831
|
+
List all transactions
|
|
1832
|
+
|
|
1833
|
+
### Example Usage
|
|
1834
|
+
|
|
1835
|
+
```typescript
|
|
1836
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1837
|
+
|
|
1838
|
+
const unifiedTo = new UnifiedTo({
|
|
1839
|
+
security: {
|
|
1840
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1841
|
+
},
|
|
1842
|
+
});
|
|
1843
|
+
|
|
1844
|
+
async function run() {
|
|
1845
|
+
const result = await unifiedTo.accounting.listAccountingTransactions({
|
|
1846
|
+
connectionId: "<value>",
|
|
1847
|
+
});
|
|
1848
|
+
|
|
1849
|
+
// Handle the result
|
|
1850
|
+
console.log(result);
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
run();
|
|
1854
|
+
```
|
|
1855
|
+
|
|
1856
|
+
### Standalone function
|
|
1857
|
+
|
|
1858
|
+
The standalone function version of this method:
|
|
1859
|
+
|
|
1860
|
+
```typescript
|
|
1861
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1862
|
+
import { accountingListAccountingTransactions } from "@unified-api/typescript-sdk/funcs/accountingListAccountingTransactions.js";
|
|
1863
|
+
|
|
1864
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1865
|
+
// You can create one instance of it to use across an application.
|
|
1866
|
+
const unifiedTo = new UnifiedToCore({
|
|
1867
|
+
security: {
|
|
1868
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1869
|
+
},
|
|
1870
|
+
});
|
|
1871
|
+
|
|
1872
|
+
async function run() {
|
|
1873
|
+
const res = await accountingListAccountingTransactions(unifiedTo, {
|
|
1874
|
+
connectionId: "<value>",
|
|
1875
|
+
});
|
|
1876
|
+
|
|
1877
|
+
if (!res.ok) {
|
|
1878
|
+
throw res.error;
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
const { value: result } = res;
|
|
1882
|
+
|
|
1883
|
+
// Handle the result
|
|
1884
|
+
console.log(result);
|
|
1885
|
+
}
|
|
1886
|
+
|
|
1887
|
+
run();
|
|
1888
|
+
```
|
|
1889
|
+
|
|
1890
|
+
### Parameters
|
|
1891
|
+
|
|
1892
|
+
| Parameter | Type | Required | Description |
|
|
1893
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1894
|
+
| `request` | [operations.ListAccountingTransactionsRequest](../../sdk/models/operations/listaccountingtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1895
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1896
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1897
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1898
|
+
|
|
1899
|
+
### Response
|
|
1900
|
+
|
|
1901
|
+
**Promise\<[shared.AccountingTransaction[]](../../models/.md)\>**
|
|
1902
|
+
|
|
1903
|
+
### Errors
|
|
1904
|
+
|
|
1905
|
+
| Error Type | Status Code | Content Type |
|
|
1906
|
+
| --------------- | --------------- | --------------- |
|
|
1907
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1908
|
+
|
|
1909
|
+
## patchAccountingAccount
|
|
1910
|
+
|
|
1911
|
+
Update an account
|
|
1912
|
+
|
|
1913
|
+
### Example Usage
|
|
1914
|
+
|
|
1915
|
+
```typescript
|
|
1916
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1917
|
+
|
|
1918
|
+
const unifiedTo = new UnifiedTo({
|
|
1919
|
+
security: {
|
|
1920
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1921
|
+
},
|
|
1922
|
+
});
|
|
1923
|
+
|
|
1924
|
+
async function run() {
|
|
1925
|
+
const result = await unifiedTo.accounting.patchAccountingAccount({
|
|
1926
|
+
connectionId: "<value>",
|
|
1927
|
+
id: "<id>",
|
|
1928
|
+
});
|
|
1929
|
+
|
|
1930
|
+
// Handle the result
|
|
1931
|
+
console.log(result);
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
run();
|
|
1935
|
+
```
|
|
1936
|
+
|
|
1937
|
+
### Standalone function
|
|
1938
|
+
|
|
1939
|
+
The standalone function version of this method:
|
|
1940
|
+
|
|
1941
|
+
```typescript
|
|
1942
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1943
|
+
import { accountingPatchAccountingAccount } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingAccount.js";
|
|
1944
|
+
|
|
1945
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1946
|
+
// You can create one instance of it to use across an application.
|
|
1947
|
+
const unifiedTo = new UnifiedToCore({
|
|
1948
|
+
security: {
|
|
1949
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1950
|
+
},
|
|
1951
|
+
});
|
|
1952
|
+
|
|
1953
|
+
async function run() {
|
|
1954
|
+
const res = await accountingPatchAccountingAccount(unifiedTo, {
|
|
1955
|
+
connectionId: "<value>",
|
|
1956
|
+
id: "<id>",
|
|
1957
|
+
});
|
|
1958
|
+
|
|
1959
|
+
if (!res.ok) {
|
|
1960
|
+
throw res.error;
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
const { value: result } = res;
|
|
1964
|
+
|
|
1965
|
+
// Handle the result
|
|
1966
|
+
console.log(result);
|
|
1967
|
+
}
|
|
1968
|
+
|
|
1969
|
+
run();
|
|
1970
|
+
```
|
|
1971
|
+
|
|
1972
|
+
### Parameters
|
|
1973
|
+
|
|
1974
|
+
| Parameter | Type | Required | Description |
|
|
1975
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1976
|
+
| `request` | [operations.PatchAccountingAccountRequest](../../sdk/models/operations/patchaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1977
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1978
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1979
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1980
|
+
|
|
1981
|
+
### Response
|
|
1982
|
+
|
|
1983
|
+
**Promise\<[shared.AccountingAccount](../../sdk/models/shared/accountingaccount.md)\>**
|
|
1984
|
+
|
|
1985
|
+
### Errors
|
|
1986
|
+
|
|
1987
|
+
| Error Type | Status Code | Content Type |
|
|
1988
|
+
| --------------- | --------------- | --------------- |
|
|
1989
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1990
|
+
|
|
1991
|
+
## patchAccountingContact
|
|
1992
|
+
|
|
1993
|
+
Update a contact
|
|
1994
|
+
|
|
1995
|
+
### Example Usage
|
|
1996
|
+
|
|
1997
|
+
```typescript
|
|
1998
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1999
|
+
|
|
2000
|
+
const unifiedTo = new UnifiedTo({
|
|
2001
|
+
security: {
|
|
2002
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2003
|
+
},
|
|
2004
|
+
});
|
|
2005
|
+
|
|
2006
|
+
async function run() {
|
|
2007
|
+
const result = await unifiedTo.accounting.patchAccountingContact({
|
|
2008
|
+
connectionId: "<value>",
|
|
2009
|
+
id: "<id>",
|
|
2010
|
+
});
|
|
2011
|
+
|
|
2012
|
+
// Handle the result
|
|
2013
|
+
console.log(result);
|
|
2014
|
+
}
|
|
2015
|
+
|
|
2016
|
+
run();
|
|
2017
|
+
```
|
|
2018
|
+
|
|
2019
|
+
### Standalone function
|
|
2020
|
+
|
|
2021
|
+
The standalone function version of this method:
|
|
2022
|
+
|
|
2023
|
+
```typescript
|
|
2024
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2025
|
+
import { accountingPatchAccountingContact } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingContact.js";
|
|
2026
|
+
|
|
2027
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2028
|
+
// You can create one instance of it to use across an application.
|
|
2029
|
+
const unifiedTo = new UnifiedToCore({
|
|
2030
|
+
security: {
|
|
2031
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2032
|
+
},
|
|
2033
|
+
});
|
|
2034
|
+
|
|
2035
|
+
async function run() {
|
|
2036
|
+
const res = await accountingPatchAccountingContact(unifiedTo, {
|
|
2037
|
+
connectionId: "<value>",
|
|
2038
|
+
id: "<id>",
|
|
2039
|
+
});
|
|
2040
|
+
|
|
2041
|
+
if (!res.ok) {
|
|
2042
|
+
throw res.error;
|
|
2043
|
+
}
|
|
2044
|
+
|
|
2045
|
+
const { value: result } = res;
|
|
2046
|
+
|
|
2047
|
+
// Handle the result
|
|
2048
|
+
console.log(result);
|
|
2049
|
+
}
|
|
2050
|
+
|
|
2051
|
+
run();
|
|
2052
|
+
```
|
|
2053
|
+
|
|
2054
|
+
### Parameters
|
|
2055
|
+
|
|
2056
|
+
| Parameter | Type | Required | Description |
|
|
2057
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2058
|
+
| `request` | [operations.PatchAccountingContactRequest](../../sdk/models/operations/patchaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2059
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2060
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2061
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2062
|
+
|
|
2063
|
+
### Response
|
|
2064
|
+
|
|
2065
|
+
**Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
|
|
2066
|
+
|
|
2067
|
+
### Errors
|
|
2068
|
+
|
|
2069
|
+
| Error Type | Status Code | Content Type |
|
|
2070
|
+
| --------------- | --------------- | --------------- |
|
|
2071
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2072
|
+
|
|
2073
|
+
## patchAccountingInvoice
|
|
2074
|
+
|
|
2075
|
+
Update an invoice
|
|
2076
|
+
|
|
2077
|
+
### Example Usage
|
|
2078
|
+
|
|
2079
|
+
```typescript
|
|
2080
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2081
|
+
|
|
2082
|
+
const unifiedTo = new UnifiedTo({
|
|
2083
|
+
security: {
|
|
2084
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2085
|
+
},
|
|
2086
|
+
});
|
|
2087
|
+
|
|
2088
|
+
async function run() {
|
|
2089
|
+
const result = await unifiedTo.accounting.patchAccountingInvoice({
|
|
2090
|
+
connectionId: "<value>",
|
|
2091
|
+
id: "<id>",
|
|
2092
|
+
});
|
|
2093
|
+
|
|
2094
|
+
// Handle the result
|
|
2095
|
+
console.log(result);
|
|
2096
|
+
}
|
|
2097
|
+
|
|
2098
|
+
run();
|
|
2099
|
+
```
|
|
2100
|
+
|
|
2101
|
+
### Standalone function
|
|
2102
|
+
|
|
2103
|
+
The standalone function version of this method:
|
|
2104
|
+
|
|
2105
|
+
```typescript
|
|
2106
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2107
|
+
import { accountingPatchAccountingInvoice } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingInvoice.js";
|
|
2108
|
+
|
|
2109
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2110
|
+
// You can create one instance of it to use across an application.
|
|
2111
|
+
const unifiedTo = new UnifiedToCore({
|
|
2112
|
+
security: {
|
|
2113
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2114
|
+
},
|
|
2115
|
+
});
|
|
2116
|
+
|
|
2117
|
+
async function run() {
|
|
2118
|
+
const res = await accountingPatchAccountingInvoice(unifiedTo, {
|
|
2119
|
+
connectionId: "<value>",
|
|
2120
|
+
id: "<id>",
|
|
2121
|
+
});
|
|
2122
|
+
|
|
2123
|
+
if (!res.ok) {
|
|
2124
|
+
throw res.error;
|
|
2125
|
+
}
|
|
2126
|
+
|
|
2127
|
+
const { value: result } = res;
|
|
2128
|
+
|
|
2129
|
+
// Handle the result
|
|
2130
|
+
console.log(result);
|
|
2131
|
+
}
|
|
2132
|
+
|
|
2133
|
+
run();
|
|
2134
|
+
```
|
|
2135
|
+
|
|
2136
|
+
### Parameters
|
|
2137
|
+
|
|
2138
|
+
| Parameter | Type | Required | Description |
|
|
2139
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2140
|
+
| `request` | [operations.PatchAccountingInvoiceRequest](../../sdk/models/operations/patchaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2141
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2142
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2143
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2144
|
+
|
|
2145
|
+
### Response
|
|
2146
|
+
|
|
2147
|
+
**Promise\<[shared.AccountingInvoice](../../sdk/models/shared/accountinginvoice.md)\>**
|
|
2148
|
+
|
|
2149
|
+
### Errors
|
|
2150
|
+
|
|
2151
|
+
| Error Type | Status Code | Content Type |
|
|
2152
|
+
| --------------- | --------------- | --------------- |
|
|
2153
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2154
|
+
|
|
2155
|
+
## patchAccountingJournal
|
|
2156
|
+
|
|
2157
|
+
Update a journal
|
|
2158
|
+
|
|
2159
|
+
### Example Usage
|
|
2160
|
+
|
|
2161
|
+
```typescript
|
|
2162
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2163
|
+
|
|
2164
|
+
const unifiedTo = new UnifiedTo({
|
|
2165
|
+
security: {
|
|
2166
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2167
|
+
},
|
|
2168
|
+
});
|
|
2169
|
+
|
|
2170
|
+
async function run() {
|
|
2171
|
+
const result = await unifiedTo.accounting.patchAccountingJournal({
|
|
2172
|
+
connectionId: "<value>",
|
|
2173
|
+
id: "<id>",
|
|
2174
|
+
});
|
|
2175
|
+
|
|
2176
|
+
// Handle the result
|
|
2177
|
+
console.log(result);
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2180
|
+
run();
|
|
2181
|
+
```
|
|
2182
|
+
|
|
2183
|
+
### Standalone function
|
|
2184
|
+
|
|
2185
|
+
The standalone function version of this method:
|
|
2186
|
+
|
|
2187
|
+
```typescript
|
|
2188
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2189
|
+
import { accountingPatchAccountingJournal } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingJournal.js";
|
|
2190
|
+
|
|
2191
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2192
|
+
// You can create one instance of it to use across an application.
|
|
2193
|
+
const unifiedTo = new UnifiedToCore({
|
|
2194
|
+
security: {
|
|
2195
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2196
|
+
},
|
|
2197
|
+
});
|
|
2198
|
+
|
|
2199
|
+
async function run() {
|
|
2200
|
+
const res = await accountingPatchAccountingJournal(unifiedTo, {
|
|
2201
|
+
connectionId: "<value>",
|
|
2202
|
+
id: "<id>",
|
|
2203
|
+
});
|
|
2204
|
+
|
|
2205
|
+
if (!res.ok) {
|
|
2206
|
+
throw res.error;
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
const { value: result } = res;
|
|
2210
|
+
|
|
2211
|
+
// Handle the result
|
|
2212
|
+
console.log(result);
|
|
2213
|
+
}
|
|
2214
|
+
|
|
2215
|
+
run();
|
|
2216
|
+
```
|
|
2217
|
+
|
|
2218
|
+
### Parameters
|
|
2219
|
+
|
|
2220
|
+
| Parameter | Type | Required | Description |
|
|
2221
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2222
|
+
| `request` | [operations.PatchAccountingJournalRequest](../../sdk/models/operations/patchaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2223
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2224
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2225
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2226
|
+
|
|
2227
|
+
### Response
|
|
2228
|
+
|
|
2229
|
+
**Promise\<[shared.AccountingJournal](../../sdk/models/shared/accountingjournal.md)\>**
|
|
2230
|
+
|
|
2231
|
+
### Errors
|
|
2232
|
+
|
|
2233
|
+
| Error Type | Status Code | Content Type |
|
|
2234
|
+
| --------------- | --------------- | --------------- |
|
|
2235
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2236
|
+
|
|
2237
|
+
## patchAccountingOrder
|
|
2238
|
+
|
|
2239
|
+
Update an order
|
|
2240
|
+
|
|
2241
|
+
### Example Usage
|
|
2242
|
+
|
|
2243
|
+
```typescript
|
|
2244
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2245
|
+
|
|
2246
|
+
const unifiedTo = new UnifiedTo({
|
|
2247
|
+
security: {
|
|
2248
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2249
|
+
},
|
|
2250
|
+
});
|
|
2251
|
+
|
|
2252
|
+
async function run() {
|
|
2253
|
+
const result = await unifiedTo.accounting.patchAccountingOrder({
|
|
2254
|
+
connectionId: "<id>",
|
|
2255
|
+
id: "<id>",
|
|
2256
|
+
});
|
|
2257
|
+
|
|
2258
|
+
// Handle the result
|
|
2259
|
+
console.log(result);
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2262
|
+
run();
|
|
2263
|
+
```
|
|
2264
|
+
|
|
2265
|
+
### Standalone function
|
|
2266
|
+
|
|
2267
|
+
The standalone function version of this method:
|
|
2268
|
+
|
|
2269
|
+
```typescript
|
|
2270
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2271
|
+
import { accountingPatchAccountingOrder } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingOrder.js";
|
|
2272
|
+
|
|
2273
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2274
|
+
// You can create one instance of it to use across an application.
|
|
2275
|
+
const unifiedTo = new UnifiedToCore({
|
|
2276
|
+
security: {
|
|
2277
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2278
|
+
},
|
|
2279
|
+
});
|
|
2280
|
+
|
|
2281
|
+
async function run() {
|
|
2282
|
+
const res = await accountingPatchAccountingOrder(unifiedTo, {
|
|
2283
|
+
connectionId: "<id>",
|
|
2284
|
+
id: "<id>",
|
|
2285
|
+
});
|
|
2286
|
+
|
|
2287
|
+
if (!res.ok) {
|
|
2288
|
+
throw res.error;
|
|
2289
|
+
}
|
|
2290
|
+
|
|
2291
|
+
const { value: result } = res;
|
|
2292
|
+
|
|
2293
|
+
// Handle the result
|
|
2294
|
+
console.log(result);
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2297
|
+
run();
|
|
2298
|
+
```
|
|
2299
|
+
|
|
2300
|
+
### Parameters
|
|
2301
|
+
|
|
2302
|
+
| Parameter | Type | Required | Description |
|
|
2303
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2304
|
+
| `request` | [operations.PatchAccountingOrderRequest](../../sdk/models/operations/patchaccountingorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2305
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2306
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2307
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2308
|
+
|
|
2309
|
+
### Response
|
|
2310
|
+
|
|
2311
|
+
**Promise\<[shared.AccountingOrder](../../sdk/models/shared/accountingorder.md)\>**
|
|
2312
|
+
|
|
2313
|
+
### Errors
|
|
2314
|
+
|
|
2315
|
+
| Error Type | Status Code | Content Type |
|
|
2316
|
+
| --------------- | --------------- | --------------- |
|
|
2317
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2318
|
+
|
|
2319
|
+
## patchAccountingTaxrate
|
|
2320
|
+
|
|
2321
|
+
Update a taxrate
|
|
2322
|
+
|
|
2323
|
+
### Example Usage
|
|
2324
|
+
|
|
2325
|
+
```typescript
|
|
2326
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2327
|
+
|
|
2328
|
+
const unifiedTo = new UnifiedTo({
|
|
2329
|
+
security: {
|
|
2330
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2331
|
+
},
|
|
2332
|
+
});
|
|
2333
|
+
|
|
2334
|
+
async function run() {
|
|
2335
|
+
const result = await unifiedTo.accounting.patchAccountingTaxrate({
|
|
2336
|
+
connectionId: "<value>",
|
|
2337
|
+
id: "<id>",
|
|
2338
|
+
});
|
|
2339
|
+
|
|
2340
|
+
// Handle the result
|
|
2341
|
+
console.log(result);
|
|
2342
|
+
}
|
|
2343
|
+
|
|
2344
|
+
run();
|
|
2345
|
+
```
|
|
2346
|
+
|
|
2347
|
+
### Standalone function
|
|
2348
|
+
|
|
2349
|
+
The standalone function version of this method:
|
|
2350
|
+
|
|
2351
|
+
```typescript
|
|
2352
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2353
|
+
import { accountingPatchAccountingTaxrate } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingTaxrate.js";
|
|
2354
|
+
|
|
2355
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2356
|
+
// You can create one instance of it to use across an application.
|
|
2357
|
+
const unifiedTo = new UnifiedToCore({
|
|
2358
|
+
security: {
|
|
2359
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2360
|
+
},
|
|
2361
|
+
});
|
|
2362
|
+
|
|
2363
|
+
async function run() {
|
|
2364
|
+
const res = await accountingPatchAccountingTaxrate(unifiedTo, {
|
|
2365
|
+
connectionId: "<value>",
|
|
2366
|
+
id: "<id>",
|
|
2367
|
+
});
|
|
2368
|
+
|
|
2369
|
+
if (!res.ok) {
|
|
2370
|
+
throw res.error;
|
|
2371
|
+
}
|
|
2372
|
+
|
|
2373
|
+
const { value: result } = res;
|
|
2374
|
+
|
|
2375
|
+
// Handle the result
|
|
2376
|
+
console.log(result);
|
|
2377
|
+
}
|
|
2378
|
+
|
|
2379
|
+
run();
|
|
2380
|
+
```
|
|
2381
|
+
|
|
2382
|
+
### Parameters
|
|
2383
|
+
|
|
2384
|
+
| Parameter | Type | Required | Description |
|
|
2385
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2386
|
+
| `request` | [operations.PatchAccountingTaxrateRequest](../../sdk/models/operations/patchaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2387
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2388
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2389
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2390
|
+
|
|
2391
|
+
### Response
|
|
2392
|
+
|
|
2393
|
+
**Promise\<[shared.AccountingTaxrate](../../sdk/models/shared/accountingtaxrate.md)\>**
|
|
2394
|
+
|
|
2395
|
+
### Errors
|
|
2396
|
+
|
|
2397
|
+
| Error Type | Status Code | Content Type |
|
|
2398
|
+
| --------------- | --------------- | --------------- |
|
|
2399
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2400
|
+
|
|
2401
|
+
## patchAccountingTransaction
|
|
2402
|
+
|
|
2403
|
+
Update a transaction
|
|
2404
|
+
|
|
2405
|
+
### Example Usage
|
|
2406
|
+
|
|
2407
|
+
```typescript
|
|
2408
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2409
|
+
|
|
2410
|
+
const unifiedTo = new UnifiedTo({
|
|
2411
|
+
security: {
|
|
2412
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2413
|
+
},
|
|
2414
|
+
});
|
|
2415
|
+
|
|
2416
|
+
async function run() {
|
|
2417
|
+
const result = await unifiedTo.accounting.patchAccountingTransaction({
|
|
2418
|
+
connectionId: "<value>",
|
|
2419
|
+
id: "<id>",
|
|
2420
|
+
});
|
|
2421
|
+
|
|
2422
|
+
// Handle the result
|
|
2423
|
+
console.log(result);
|
|
2424
|
+
}
|
|
2425
|
+
|
|
2426
|
+
run();
|
|
2427
|
+
```
|
|
2428
|
+
|
|
2429
|
+
### Standalone function
|
|
2430
|
+
|
|
2431
|
+
The standalone function version of this method:
|
|
2432
|
+
|
|
2433
|
+
```typescript
|
|
2434
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2435
|
+
import { accountingPatchAccountingTransaction } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingTransaction.js";
|
|
2436
|
+
|
|
2437
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2438
|
+
// You can create one instance of it to use across an application.
|
|
2439
|
+
const unifiedTo = new UnifiedToCore({
|
|
2440
|
+
security: {
|
|
2441
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2442
|
+
},
|
|
2443
|
+
});
|
|
2444
|
+
|
|
2445
|
+
async function run() {
|
|
2446
|
+
const res = await accountingPatchAccountingTransaction(unifiedTo, {
|
|
2447
|
+
connectionId: "<value>",
|
|
2448
|
+
id: "<id>",
|
|
2449
|
+
});
|
|
2450
|
+
|
|
2451
|
+
if (!res.ok) {
|
|
2452
|
+
throw res.error;
|
|
2453
|
+
}
|
|
2454
|
+
|
|
2455
|
+
const { value: result } = res;
|
|
2456
|
+
|
|
2457
|
+
// Handle the result
|
|
2458
|
+
console.log(result);
|
|
2459
|
+
}
|
|
2460
|
+
|
|
2461
|
+
run();
|
|
2462
|
+
```
|
|
2463
|
+
|
|
2464
|
+
### Parameters
|
|
2465
|
+
|
|
2466
|
+
| Parameter | Type | Required | Description |
|
|
2467
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2468
|
+
| `request` | [operations.PatchAccountingTransactionRequest](../../sdk/models/operations/patchaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2469
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2470
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2471
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2472
|
+
|
|
2473
|
+
### Response
|
|
2474
|
+
|
|
2475
|
+
**Promise\<[shared.AccountingTransaction](../../sdk/models/shared/accountingtransaction.md)\>**
|
|
2476
|
+
|
|
2477
|
+
### Errors
|
|
2478
|
+
|
|
2479
|
+
| Error Type | Status Code | Content Type |
|
|
2480
|
+
| --------------- | --------------- | --------------- |
|
|
2481
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2482
|
+
|
|
2483
|
+
## removeAccountingAccount
|
|
2484
|
+
|
|
2485
|
+
Remove an account
|
|
2486
|
+
|
|
2487
|
+
### Example Usage
|
|
2488
|
+
|
|
2489
|
+
```typescript
|
|
2490
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2491
|
+
|
|
2492
|
+
const unifiedTo = new UnifiedTo({
|
|
2493
|
+
security: {
|
|
2494
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2495
|
+
},
|
|
2496
|
+
});
|
|
2497
|
+
|
|
2498
|
+
async function run() {
|
|
2499
|
+
const result = await unifiedTo.accounting.removeAccountingAccount({
|
|
2500
|
+
connectionId: "<value>",
|
|
2501
|
+
id: "<id>",
|
|
2502
|
+
});
|
|
2503
|
+
|
|
2504
|
+
// Handle the result
|
|
2505
|
+
console.log(result);
|
|
2506
|
+
}
|
|
2507
|
+
|
|
2508
|
+
run();
|
|
2509
|
+
```
|
|
2510
|
+
|
|
2511
|
+
### Standalone function
|
|
2512
|
+
|
|
2513
|
+
The standalone function version of this method:
|
|
2514
|
+
|
|
2515
|
+
```typescript
|
|
2516
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2517
|
+
import { accountingRemoveAccountingAccount } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingAccount.js";
|
|
2518
|
+
|
|
2519
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2520
|
+
// You can create one instance of it to use across an application.
|
|
2521
|
+
const unifiedTo = new UnifiedToCore({
|
|
2522
|
+
security: {
|
|
2523
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2524
|
+
},
|
|
2525
|
+
});
|
|
2526
|
+
|
|
2527
|
+
async function run() {
|
|
2528
|
+
const res = await accountingRemoveAccountingAccount(unifiedTo, {
|
|
2529
|
+
connectionId: "<value>",
|
|
2530
|
+
id: "<id>",
|
|
2531
|
+
});
|
|
2532
|
+
|
|
2533
|
+
if (!res.ok) {
|
|
2534
|
+
throw res.error;
|
|
2535
|
+
}
|
|
2536
|
+
|
|
2537
|
+
const { value: result } = res;
|
|
2538
|
+
|
|
2539
|
+
// Handle the result
|
|
2540
|
+
console.log(result);
|
|
2541
|
+
}
|
|
2542
|
+
|
|
2543
|
+
run();
|
|
2544
|
+
```
|
|
2545
|
+
|
|
2546
|
+
### Parameters
|
|
2547
|
+
|
|
2548
|
+
| Parameter | Type | Required | Description |
|
|
2549
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2550
|
+
| `request` | [operations.RemoveAccountingAccountRequest](../../sdk/models/operations/removeaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2551
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2552
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2553
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2554
|
+
|
|
2555
|
+
### Response
|
|
2556
|
+
|
|
2557
|
+
**Promise\<[operations.RemoveAccountingAccountResponse](../../sdk/models/operations/removeaccountingaccountresponse.md)\>**
|
|
2558
|
+
|
|
2559
|
+
### Errors
|
|
2560
|
+
|
|
2561
|
+
| Error Type | Status Code | Content Type |
|
|
2562
|
+
| --------------- | --------------- | --------------- |
|
|
2563
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2564
|
+
|
|
2565
|
+
## removeAccountingContact
|
|
2566
|
+
|
|
2567
|
+
Remove a contact
|
|
2568
|
+
|
|
2569
|
+
### Example Usage
|
|
2570
|
+
|
|
2571
|
+
```typescript
|
|
2572
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2573
|
+
|
|
2574
|
+
const unifiedTo = new UnifiedTo({
|
|
2575
|
+
security: {
|
|
2576
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2577
|
+
},
|
|
2578
|
+
});
|
|
2579
|
+
|
|
2580
|
+
async function run() {
|
|
2581
|
+
const result = await unifiedTo.accounting.removeAccountingContact({
|
|
2582
|
+
connectionId: "<value>",
|
|
2583
|
+
id: "<id>",
|
|
2584
|
+
});
|
|
2585
|
+
|
|
2586
|
+
// Handle the result
|
|
2587
|
+
console.log(result);
|
|
2588
|
+
}
|
|
2589
|
+
|
|
2590
|
+
run();
|
|
2591
|
+
```
|
|
2592
|
+
|
|
2593
|
+
### Standalone function
|
|
2594
|
+
|
|
2595
|
+
The standalone function version of this method:
|
|
2596
|
+
|
|
2597
|
+
```typescript
|
|
2598
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2599
|
+
import { accountingRemoveAccountingContact } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingContact.js";
|
|
2600
|
+
|
|
2601
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2602
|
+
// You can create one instance of it to use across an application.
|
|
2603
|
+
const unifiedTo = new UnifiedToCore({
|
|
2604
|
+
security: {
|
|
2605
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2606
|
+
},
|
|
2607
|
+
});
|
|
2608
|
+
|
|
2609
|
+
async function run() {
|
|
2610
|
+
const res = await accountingRemoveAccountingContact(unifiedTo, {
|
|
2611
|
+
connectionId: "<value>",
|
|
2612
|
+
id: "<id>",
|
|
2613
|
+
});
|
|
2614
|
+
|
|
2615
|
+
if (!res.ok) {
|
|
2616
|
+
throw res.error;
|
|
2617
|
+
}
|
|
2618
|
+
|
|
2619
|
+
const { value: result } = res;
|
|
2620
|
+
|
|
2621
|
+
// Handle the result
|
|
2622
|
+
console.log(result);
|
|
2623
|
+
}
|
|
2624
|
+
|
|
2625
|
+
run();
|
|
2626
|
+
```
|
|
2627
|
+
|
|
2628
|
+
### Parameters
|
|
2629
|
+
|
|
2630
|
+
| Parameter | Type | Required | Description |
|
|
2631
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2632
|
+
| `request` | [operations.RemoveAccountingContactRequest](../../sdk/models/operations/removeaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2633
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2634
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2635
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2636
|
+
|
|
2637
|
+
### Response
|
|
2638
|
+
|
|
2639
|
+
**Promise\<[operations.RemoveAccountingContactResponse](../../sdk/models/operations/removeaccountingcontactresponse.md)\>**
|
|
2640
|
+
|
|
2641
|
+
### Errors
|
|
2642
|
+
|
|
2643
|
+
| Error Type | Status Code | Content Type |
|
|
2644
|
+
| --------------- | --------------- | --------------- |
|
|
2645
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2646
|
+
|
|
2647
|
+
## removeAccountingInvoice
|
|
2648
|
+
|
|
2649
|
+
Remove an invoice
|
|
2650
|
+
|
|
2651
|
+
### Example Usage
|
|
2652
|
+
|
|
2653
|
+
```typescript
|
|
2654
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2655
|
+
|
|
2656
|
+
const unifiedTo = new UnifiedTo({
|
|
2657
|
+
security: {
|
|
2658
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2659
|
+
},
|
|
2660
|
+
});
|
|
2661
|
+
|
|
2662
|
+
async function run() {
|
|
2663
|
+
const result = await unifiedTo.accounting.removeAccountingInvoice({
|
|
2664
|
+
connectionId: "<value>",
|
|
2665
|
+
id: "<id>",
|
|
2666
|
+
});
|
|
2667
|
+
|
|
2668
|
+
// Handle the result
|
|
2669
|
+
console.log(result);
|
|
2670
|
+
}
|
|
2671
|
+
|
|
2672
|
+
run();
|
|
2673
|
+
```
|
|
2674
|
+
|
|
2675
|
+
### Standalone function
|
|
2676
|
+
|
|
2677
|
+
The standalone function version of this method:
|
|
2678
|
+
|
|
2679
|
+
```typescript
|
|
2680
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2681
|
+
import { accountingRemoveAccountingInvoice } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingInvoice.js";
|
|
2682
|
+
|
|
2683
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2684
|
+
// You can create one instance of it to use across an application.
|
|
2685
|
+
const unifiedTo = new UnifiedToCore({
|
|
2686
|
+
security: {
|
|
2687
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2688
|
+
},
|
|
2689
|
+
});
|
|
2690
|
+
|
|
2691
|
+
async function run() {
|
|
2692
|
+
const res = await accountingRemoveAccountingInvoice(unifiedTo, {
|
|
2693
|
+
connectionId: "<value>",
|
|
2694
|
+
id: "<id>",
|
|
2695
|
+
});
|
|
2696
|
+
|
|
2697
|
+
if (!res.ok) {
|
|
2698
|
+
throw res.error;
|
|
2699
|
+
}
|
|
2700
|
+
|
|
2701
|
+
const { value: result } = res;
|
|
2702
|
+
|
|
2703
|
+
// Handle the result
|
|
2704
|
+
console.log(result);
|
|
2705
|
+
}
|
|
2706
|
+
|
|
2707
|
+
run();
|
|
2708
|
+
```
|
|
2709
|
+
|
|
2710
|
+
### Parameters
|
|
2711
|
+
|
|
2712
|
+
| Parameter | Type | Required | Description |
|
|
2713
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2714
|
+
| `request` | [operations.RemoveAccountingInvoiceRequest](../../sdk/models/operations/removeaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2715
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2716
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2717
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2718
|
+
|
|
2719
|
+
### Response
|
|
2720
|
+
|
|
2721
|
+
**Promise\<[operations.RemoveAccountingInvoiceResponse](../../sdk/models/operations/removeaccountinginvoiceresponse.md)\>**
|
|
2722
|
+
|
|
2723
|
+
### Errors
|
|
2724
|
+
|
|
2725
|
+
| Error Type | Status Code | Content Type |
|
|
2726
|
+
| --------------- | --------------- | --------------- |
|
|
2727
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2728
|
+
|
|
2729
|
+
## removeAccountingJournal
|
|
2730
|
+
|
|
2731
|
+
Remove a journal
|
|
2732
|
+
|
|
2733
|
+
### Example Usage
|
|
2734
|
+
|
|
2735
|
+
```typescript
|
|
2736
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2737
|
+
|
|
2738
|
+
const unifiedTo = new UnifiedTo({
|
|
2739
|
+
security: {
|
|
2740
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2741
|
+
},
|
|
2742
|
+
});
|
|
2743
|
+
|
|
2744
|
+
async function run() {
|
|
2745
|
+
const result = await unifiedTo.accounting.removeAccountingJournal({
|
|
2746
|
+
connectionId: "<value>",
|
|
2747
|
+
id: "<id>",
|
|
2748
|
+
});
|
|
2749
|
+
|
|
2750
|
+
// Handle the result
|
|
2751
|
+
console.log(result);
|
|
2752
|
+
}
|
|
2753
|
+
|
|
2754
|
+
run();
|
|
2755
|
+
```
|
|
2756
|
+
|
|
2757
|
+
### Standalone function
|
|
2758
|
+
|
|
2759
|
+
The standalone function version of this method:
|
|
2760
|
+
|
|
2761
|
+
```typescript
|
|
2762
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2763
|
+
import { accountingRemoveAccountingJournal } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingJournal.js";
|
|
2764
|
+
|
|
2765
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2766
|
+
// You can create one instance of it to use across an application.
|
|
2767
|
+
const unifiedTo = new UnifiedToCore({
|
|
2768
|
+
security: {
|
|
2769
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2770
|
+
},
|
|
2771
|
+
});
|
|
2772
|
+
|
|
2773
|
+
async function run() {
|
|
2774
|
+
const res = await accountingRemoveAccountingJournal(unifiedTo, {
|
|
2775
|
+
connectionId: "<value>",
|
|
2776
|
+
id: "<id>",
|
|
2777
|
+
});
|
|
2778
|
+
|
|
2779
|
+
if (!res.ok) {
|
|
2780
|
+
throw res.error;
|
|
2781
|
+
}
|
|
2782
|
+
|
|
2783
|
+
const { value: result } = res;
|
|
2784
|
+
|
|
2785
|
+
// Handle the result
|
|
2786
|
+
console.log(result);
|
|
2787
|
+
}
|
|
2788
|
+
|
|
2789
|
+
run();
|
|
2790
|
+
```
|
|
2791
|
+
|
|
2792
|
+
### Parameters
|
|
2793
|
+
|
|
2794
|
+
| Parameter | Type | Required | Description |
|
|
2795
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2796
|
+
| `request` | [operations.RemoveAccountingJournalRequest](../../sdk/models/operations/removeaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2797
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2798
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2799
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2800
|
+
|
|
2801
|
+
### Response
|
|
2802
|
+
|
|
2803
|
+
**Promise\<[operations.RemoveAccountingJournalResponse](../../sdk/models/operations/removeaccountingjournalresponse.md)\>**
|
|
2804
|
+
|
|
2805
|
+
### Errors
|
|
2806
|
+
|
|
2807
|
+
| Error Type | Status Code | Content Type |
|
|
2808
|
+
| --------------- | --------------- | --------------- |
|
|
2809
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2810
|
+
|
|
2811
|
+
## removeAccountingOrder
|
|
2812
|
+
|
|
2813
|
+
Remove an order
|
|
2814
|
+
|
|
2815
|
+
### Example Usage
|
|
2816
|
+
|
|
2817
|
+
```typescript
|
|
2818
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2819
|
+
|
|
2820
|
+
const unifiedTo = new UnifiedTo({
|
|
2821
|
+
security: {
|
|
2822
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2823
|
+
},
|
|
2824
|
+
});
|
|
2825
|
+
|
|
2826
|
+
async function run() {
|
|
2827
|
+
const result = await unifiedTo.accounting.removeAccountingOrder({
|
|
2828
|
+
connectionId: "<id>",
|
|
2829
|
+
id: "<id>",
|
|
2830
|
+
});
|
|
2831
|
+
|
|
2832
|
+
// Handle the result
|
|
2833
|
+
console.log(result);
|
|
2834
|
+
}
|
|
2835
|
+
|
|
2836
|
+
run();
|
|
2837
|
+
```
|
|
2838
|
+
|
|
2839
|
+
### Standalone function
|
|
2840
|
+
|
|
2841
|
+
The standalone function version of this method:
|
|
2842
|
+
|
|
2843
|
+
```typescript
|
|
2844
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2845
|
+
import { accountingRemoveAccountingOrder } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingOrder.js";
|
|
2846
|
+
|
|
2847
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2848
|
+
// You can create one instance of it to use across an application.
|
|
2849
|
+
const unifiedTo = new UnifiedToCore({
|
|
2850
|
+
security: {
|
|
2851
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2852
|
+
},
|
|
2853
|
+
});
|
|
2854
|
+
|
|
2855
|
+
async function run() {
|
|
2856
|
+
const res = await accountingRemoveAccountingOrder(unifiedTo, {
|
|
2857
|
+
connectionId: "<id>",
|
|
2858
|
+
id: "<id>",
|
|
2859
|
+
});
|
|
2860
|
+
|
|
2861
|
+
if (!res.ok) {
|
|
2862
|
+
throw res.error;
|
|
2863
|
+
}
|
|
2864
|
+
|
|
2865
|
+
const { value: result } = res;
|
|
2866
|
+
|
|
2867
|
+
// Handle the result
|
|
2868
|
+
console.log(result);
|
|
2869
|
+
}
|
|
2870
|
+
|
|
2871
|
+
run();
|
|
2872
|
+
```
|
|
2873
|
+
|
|
2874
|
+
### Parameters
|
|
2875
|
+
|
|
2876
|
+
| Parameter | Type | Required | Description |
|
|
2877
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2878
|
+
| `request` | [operations.RemoveAccountingOrderRequest](../../sdk/models/operations/removeaccountingorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2879
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2880
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2881
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2882
|
+
|
|
2883
|
+
### Response
|
|
2884
|
+
|
|
2885
|
+
**Promise\<[operations.RemoveAccountingOrderResponse](../../sdk/models/operations/removeaccountingorderresponse.md)\>**
|
|
2886
|
+
|
|
2887
|
+
### Errors
|
|
2888
|
+
|
|
2889
|
+
| Error Type | Status Code | Content Type |
|
|
2890
|
+
| --------------- | --------------- | --------------- |
|
|
2891
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2892
|
+
|
|
2893
|
+
## removeAccountingTaxrate
|
|
2894
|
+
|
|
2895
|
+
Remove a taxrate
|
|
2896
|
+
|
|
2897
|
+
### Example Usage
|
|
2898
|
+
|
|
2899
|
+
```typescript
|
|
2900
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2901
|
+
|
|
2902
|
+
const unifiedTo = new UnifiedTo({
|
|
2903
|
+
security: {
|
|
2904
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2905
|
+
},
|
|
2906
|
+
});
|
|
2907
|
+
|
|
2908
|
+
async function run() {
|
|
2909
|
+
const result = await unifiedTo.accounting.removeAccountingTaxrate({
|
|
2910
|
+
connectionId: "<value>",
|
|
2911
|
+
id: "<id>",
|
|
2912
|
+
});
|
|
2913
|
+
|
|
2914
|
+
// Handle the result
|
|
2915
|
+
console.log(result);
|
|
2916
|
+
}
|
|
2917
|
+
|
|
2918
|
+
run();
|
|
2919
|
+
```
|
|
2920
|
+
|
|
2921
|
+
### Standalone function
|
|
2922
|
+
|
|
2923
|
+
The standalone function version of this method:
|
|
2924
|
+
|
|
2925
|
+
```typescript
|
|
2926
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2927
|
+
import { accountingRemoveAccountingTaxrate } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingTaxrate.js";
|
|
2928
|
+
|
|
2929
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2930
|
+
// You can create one instance of it to use across an application.
|
|
2931
|
+
const unifiedTo = new UnifiedToCore({
|
|
2932
|
+
security: {
|
|
2933
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2934
|
+
},
|
|
2935
|
+
});
|
|
2936
|
+
|
|
2937
|
+
async function run() {
|
|
2938
|
+
const res = await accountingRemoveAccountingTaxrate(unifiedTo, {
|
|
2939
|
+
connectionId: "<value>",
|
|
2940
|
+
id: "<id>",
|
|
2941
|
+
});
|
|
2942
|
+
|
|
2943
|
+
if (!res.ok) {
|
|
2944
|
+
throw res.error;
|
|
2945
|
+
}
|
|
2946
|
+
|
|
2947
|
+
const { value: result } = res;
|
|
2948
|
+
|
|
2949
|
+
// Handle the result
|
|
2950
|
+
console.log(result);
|
|
2951
|
+
}
|
|
2952
|
+
|
|
2953
|
+
run();
|
|
2954
|
+
```
|
|
2955
|
+
|
|
2956
|
+
### Parameters
|
|
2957
|
+
|
|
2958
|
+
| Parameter | Type | Required | Description |
|
|
2959
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2960
|
+
| `request` | [operations.RemoveAccountingTaxrateRequest](../../sdk/models/operations/removeaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2961
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2962
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2963
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2964
|
+
|
|
2965
|
+
### Response
|
|
2966
|
+
|
|
2967
|
+
**Promise\<[operations.RemoveAccountingTaxrateResponse](../../sdk/models/operations/removeaccountingtaxrateresponse.md)\>**
|
|
2968
|
+
|
|
2969
|
+
### Errors
|
|
2970
|
+
|
|
2971
|
+
| Error Type | Status Code | Content Type |
|
|
2972
|
+
| --------------- | --------------- | --------------- |
|
|
2973
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2974
|
+
|
|
2975
|
+
## removeAccountingTransaction
|
|
2976
|
+
|
|
2977
|
+
Remove a transaction
|
|
2978
|
+
|
|
2979
|
+
### Example Usage
|
|
2980
|
+
|
|
2981
|
+
```typescript
|
|
2982
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2983
|
+
|
|
2984
|
+
const unifiedTo = new UnifiedTo({
|
|
2985
|
+
security: {
|
|
2986
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2987
|
+
},
|
|
2988
|
+
});
|
|
2989
|
+
|
|
2990
|
+
async function run() {
|
|
2991
|
+
const result = await unifiedTo.accounting.removeAccountingTransaction({
|
|
2992
|
+
connectionId: "<value>",
|
|
2993
|
+
id: "<id>",
|
|
2994
|
+
});
|
|
2995
|
+
|
|
2996
|
+
// Handle the result
|
|
2997
|
+
console.log(result);
|
|
2998
|
+
}
|
|
2999
|
+
|
|
3000
|
+
run();
|
|
3001
|
+
```
|
|
3002
|
+
|
|
3003
|
+
### Standalone function
|
|
3004
|
+
|
|
3005
|
+
The standalone function version of this method:
|
|
3006
|
+
|
|
3007
|
+
```typescript
|
|
3008
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3009
|
+
import { accountingRemoveAccountingTransaction } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingTransaction.js";
|
|
3010
|
+
|
|
3011
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3012
|
+
// You can create one instance of it to use across an application.
|
|
3013
|
+
const unifiedTo = new UnifiedToCore({
|
|
3014
|
+
security: {
|
|
3015
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3016
|
+
},
|
|
3017
|
+
});
|
|
3018
|
+
|
|
3019
|
+
async function run() {
|
|
3020
|
+
const res = await accountingRemoveAccountingTransaction(unifiedTo, {
|
|
3021
|
+
connectionId: "<value>",
|
|
3022
|
+
id: "<id>",
|
|
3023
|
+
});
|
|
3024
|
+
|
|
3025
|
+
if (!res.ok) {
|
|
3026
|
+
throw res.error;
|
|
3027
|
+
}
|
|
3028
|
+
|
|
3029
|
+
const { value: result } = res;
|
|
3030
|
+
|
|
3031
|
+
// Handle the result
|
|
3032
|
+
console.log(result);
|
|
3033
|
+
}
|
|
3034
|
+
|
|
3035
|
+
run();
|
|
3036
|
+
```
|
|
3037
|
+
|
|
3038
|
+
### Parameters
|
|
3039
|
+
|
|
3040
|
+
| Parameter | Type | Required | Description |
|
|
3041
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3042
|
+
| `request` | [operations.RemoveAccountingTransactionRequest](../../sdk/models/operations/removeaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3043
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3044
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3045
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3046
|
+
|
|
3047
|
+
### Response
|
|
3048
|
+
|
|
3049
|
+
**Promise\<[operations.RemoveAccountingTransactionResponse](../../sdk/models/operations/removeaccountingtransactionresponse.md)\>**
|
|
3050
|
+
|
|
3051
|
+
### Errors
|
|
3052
|
+
|
|
3053
|
+
| Error Type | Status Code | Content Type |
|
|
3054
|
+
| --------------- | --------------- | --------------- |
|
|
3055
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3056
|
+
|
|
3057
|
+
## updateAccountingAccount
|
|
3058
|
+
|
|
3059
|
+
Update an account
|
|
3060
|
+
|
|
3061
|
+
### Example Usage
|
|
3062
|
+
|
|
3063
|
+
```typescript
|
|
3064
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3065
|
+
|
|
3066
|
+
const unifiedTo = new UnifiedTo({
|
|
3067
|
+
security: {
|
|
3068
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3069
|
+
},
|
|
3070
|
+
});
|
|
3071
|
+
|
|
3072
|
+
async function run() {
|
|
3073
|
+
const result = await unifiedTo.accounting.updateAccountingAccount({
|
|
3074
|
+
connectionId: "<value>",
|
|
3075
|
+
id: "<id>",
|
|
3076
|
+
});
|
|
3077
|
+
|
|
3078
|
+
// Handle the result
|
|
3079
|
+
console.log(result);
|
|
3080
|
+
}
|
|
3081
|
+
|
|
3082
|
+
run();
|
|
3083
|
+
```
|
|
3084
|
+
|
|
3085
|
+
### Standalone function
|
|
3086
|
+
|
|
3087
|
+
The standalone function version of this method:
|
|
3088
|
+
|
|
3089
|
+
```typescript
|
|
3090
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3091
|
+
import { accountingUpdateAccountingAccount } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingAccount.js";
|
|
3092
|
+
|
|
3093
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3094
|
+
// You can create one instance of it to use across an application.
|
|
3095
|
+
const unifiedTo = new UnifiedToCore({
|
|
3096
|
+
security: {
|
|
3097
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3098
|
+
},
|
|
3099
|
+
});
|
|
3100
|
+
|
|
3101
|
+
async function run() {
|
|
3102
|
+
const res = await accountingUpdateAccountingAccount(unifiedTo, {
|
|
3103
|
+
connectionId: "<value>",
|
|
3104
|
+
id: "<id>",
|
|
3105
|
+
});
|
|
3106
|
+
|
|
3107
|
+
if (!res.ok) {
|
|
3108
|
+
throw res.error;
|
|
3109
|
+
}
|
|
3110
|
+
|
|
3111
|
+
const { value: result } = res;
|
|
3112
|
+
|
|
3113
|
+
// Handle the result
|
|
3114
|
+
console.log(result);
|
|
3115
|
+
}
|
|
3116
|
+
|
|
3117
|
+
run();
|
|
3118
|
+
```
|
|
3119
|
+
|
|
3120
|
+
### Parameters
|
|
3121
|
+
|
|
3122
|
+
| Parameter | Type | Required | Description |
|
|
3123
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3124
|
+
| `request` | [operations.UpdateAccountingAccountRequest](../../sdk/models/operations/updateaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3125
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3126
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3127
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3128
|
+
|
|
3129
|
+
### Response
|
|
3130
|
+
|
|
3131
|
+
**Promise\<[shared.AccountingAccount](../../sdk/models/shared/accountingaccount.md)\>**
|
|
3132
|
+
|
|
3133
|
+
### Errors
|
|
3134
|
+
|
|
3135
|
+
| Error Type | Status Code | Content Type |
|
|
3136
|
+
| --------------- | --------------- | --------------- |
|
|
3137
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3138
|
+
|
|
3139
|
+
## updateAccountingContact
|
|
3140
|
+
|
|
3141
|
+
Update a contact
|
|
3142
|
+
|
|
3143
|
+
### Example Usage
|
|
3144
|
+
|
|
3145
|
+
```typescript
|
|
3146
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3147
|
+
|
|
3148
|
+
const unifiedTo = new UnifiedTo({
|
|
3149
|
+
security: {
|
|
3150
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3151
|
+
},
|
|
3152
|
+
});
|
|
3153
|
+
|
|
3154
|
+
async function run() {
|
|
3155
|
+
const result = await unifiedTo.accounting.updateAccountingContact({
|
|
3156
|
+
connectionId: "<value>",
|
|
3157
|
+
id: "<id>",
|
|
3158
|
+
});
|
|
3159
|
+
|
|
3160
|
+
// Handle the result
|
|
3161
|
+
console.log(result);
|
|
3162
|
+
}
|
|
3163
|
+
|
|
3164
|
+
run();
|
|
3165
|
+
```
|
|
3166
|
+
|
|
3167
|
+
### Standalone function
|
|
3168
|
+
|
|
3169
|
+
The standalone function version of this method:
|
|
3170
|
+
|
|
3171
|
+
```typescript
|
|
3172
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3173
|
+
import { accountingUpdateAccountingContact } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingContact.js";
|
|
3174
|
+
|
|
3175
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3176
|
+
// You can create one instance of it to use across an application.
|
|
3177
|
+
const unifiedTo = new UnifiedToCore({
|
|
3178
|
+
security: {
|
|
3179
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3180
|
+
},
|
|
3181
|
+
});
|
|
3182
|
+
|
|
3183
|
+
async function run() {
|
|
3184
|
+
const res = await accountingUpdateAccountingContact(unifiedTo, {
|
|
3185
|
+
connectionId: "<value>",
|
|
3186
|
+
id: "<id>",
|
|
3187
|
+
});
|
|
3188
|
+
|
|
3189
|
+
if (!res.ok) {
|
|
3190
|
+
throw res.error;
|
|
3191
|
+
}
|
|
3192
|
+
|
|
3193
|
+
const { value: result } = res;
|
|
3194
|
+
|
|
3195
|
+
// Handle the result
|
|
3196
|
+
console.log(result);
|
|
3197
|
+
}
|
|
3198
|
+
|
|
3199
|
+
run();
|
|
3200
|
+
```
|
|
3201
|
+
|
|
3202
|
+
### Parameters
|
|
3203
|
+
|
|
3204
|
+
| Parameter | Type | Required | Description |
|
|
3205
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3206
|
+
| `request` | [operations.UpdateAccountingContactRequest](../../sdk/models/operations/updateaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3207
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3208
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3209
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3210
|
+
|
|
3211
|
+
### Response
|
|
3212
|
+
|
|
3213
|
+
**Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
|
|
3214
|
+
|
|
3215
|
+
### Errors
|
|
3216
|
+
|
|
3217
|
+
| Error Type | Status Code | Content Type |
|
|
3218
|
+
| --------------- | --------------- | --------------- |
|
|
3219
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3220
|
+
|
|
3221
|
+
## updateAccountingInvoice
|
|
3222
|
+
|
|
3223
|
+
Update an invoice
|
|
3224
|
+
|
|
3225
|
+
### Example Usage
|
|
3226
|
+
|
|
3227
|
+
```typescript
|
|
3228
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3229
|
+
|
|
3230
|
+
const unifiedTo = new UnifiedTo({
|
|
3231
|
+
security: {
|
|
3232
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3233
|
+
},
|
|
3234
|
+
});
|
|
3235
|
+
|
|
3236
|
+
async function run() {
|
|
3237
|
+
const result = await unifiedTo.accounting.updateAccountingInvoice({
|
|
3238
|
+
connectionId: "<value>",
|
|
3239
|
+
id: "<id>",
|
|
3240
|
+
});
|
|
3241
|
+
|
|
3242
|
+
// Handle the result
|
|
3243
|
+
console.log(result);
|
|
3244
|
+
}
|
|
3245
|
+
|
|
3246
|
+
run();
|
|
3247
|
+
```
|
|
3248
|
+
|
|
3249
|
+
### Standalone function
|
|
3250
|
+
|
|
3251
|
+
The standalone function version of this method:
|
|
3252
|
+
|
|
3253
|
+
```typescript
|
|
3254
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3255
|
+
import { accountingUpdateAccountingInvoice } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingInvoice.js";
|
|
3256
|
+
|
|
3257
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3258
|
+
// You can create one instance of it to use across an application.
|
|
3259
|
+
const unifiedTo = new UnifiedToCore({
|
|
3260
|
+
security: {
|
|
3261
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3262
|
+
},
|
|
3263
|
+
});
|
|
3264
|
+
|
|
3265
|
+
async function run() {
|
|
3266
|
+
const res = await accountingUpdateAccountingInvoice(unifiedTo, {
|
|
3267
|
+
connectionId: "<value>",
|
|
3268
|
+
id: "<id>",
|
|
3269
|
+
});
|
|
3270
|
+
|
|
3271
|
+
if (!res.ok) {
|
|
3272
|
+
throw res.error;
|
|
3273
|
+
}
|
|
3274
|
+
|
|
3275
|
+
const { value: result } = res;
|
|
3276
|
+
|
|
3277
|
+
// Handle the result
|
|
3278
|
+
console.log(result);
|
|
3279
|
+
}
|
|
3280
|
+
|
|
3281
|
+
run();
|
|
3282
|
+
```
|
|
3283
|
+
|
|
3284
|
+
### Parameters
|
|
3285
|
+
|
|
3286
|
+
| Parameter | Type | Required | Description |
|
|
3287
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3288
|
+
| `request` | [operations.UpdateAccountingInvoiceRequest](../../sdk/models/operations/updateaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3289
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3290
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3291
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3292
|
+
|
|
3293
|
+
### Response
|
|
3294
|
+
|
|
3295
|
+
**Promise\<[shared.AccountingInvoice](../../sdk/models/shared/accountinginvoice.md)\>**
|
|
3296
|
+
|
|
3297
|
+
### Errors
|
|
3298
|
+
|
|
3299
|
+
| Error Type | Status Code | Content Type |
|
|
3300
|
+
| --------------- | --------------- | --------------- |
|
|
3301
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3302
|
+
|
|
3303
|
+
## updateAccountingJournal
|
|
3304
|
+
|
|
3305
|
+
Update a journal
|
|
3306
|
+
|
|
3307
|
+
### Example Usage
|
|
3308
|
+
|
|
3309
|
+
```typescript
|
|
3310
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3311
|
+
|
|
3312
|
+
const unifiedTo = new UnifiedTo({
|
|
3313
|
+
security: {
|
|
3314
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3315
|
+
},
|
|
3316
|
+
});
|
|
3317
|
+
|
|
3318
|
+
async function run() {
|
|
3319
|
+
const result = await unifiedTo.accounting.updateAccountingJournal({
|
|
3320
|
+
connectionId: "<value>",
|
|
3321
|
+
id: "<id>",
|
|
3322
|
+
});
|
|
3323
|
+
|
|
3324
|
+
// Handle the result
|
|
3325
|
+
console.log(result);
|
|
3326
|
+
}
|
|
3327
|
+
|
|
3328
|
+
run();
|
|
3329
|
+
```
|
|
3330
|
+
|
|
3331
|
+
### Standalone function
|
|
3332
|
+
|
|
3333
|
+
The standalone function version of this method:
|
|
3334
|
+
|
|
3335
|
+
```typescript
|
|
3336
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3337
|
+
import { accountingUpdateAccountingJournal } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingJournal.js";
|
|
3338
|
+
|
|
3339
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3340
|
+
// You can create one instance of it to use across an application.
|
|
3341
|
+
const unifiedTo = new UnifiedToCore({
|
|
3342
|
+
security: {
|
|
3343
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3344
|
+
},
|
|
3345
|
+
});
|
|
3346
|
+
|
|
3347
|
+
async function run() {
|
|
3348
|
+
const res = await accountingUpdateAccountingJournal(unifiedTo, {
|
|
3349
|
+
connectionId: "<value>",
|
|
3350
|
+
id: "<id>",
|
|
3351
|
+
});
|
|
3352
|
+
|
|
3353
|
+
if (!res.ok) {
|
|
3354
|
+
throw res.error;
|
|
3355
|
+
}
|
|
3356
|
+
|
|
3357
|
+
const { value: result } = res;
|
|
3358
|
+
|
|
3359
|
+
// Handle the result
|
|
3360
|
+
console.log(result);
|
|
3361
|
+
}
|
|
3362
|
+
|
|
3363
|
+
run();
|
|
3364
|
+
```
|
|
3365
|
+
|
|
3366
|
+
### Parameters
|
|
3367
|
+
|
|
3368
|
+
| Parameter | Type | Required | Description |
|
|
3369
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3370
|
+
| `request` | [operations.UpdateAccountingJournalRequest](../../sdk/models/operations/updateaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3371
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3372
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3373
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3374
|
+
|
|
3375
|
+
### Response
|
|
3376
|
+
|
|
3377
|
+
**Promise\<[shared.AccountingJournal](../../sdk/models/shared/accountingjournal.md)\>**
|
|
3378
|
+
|
|
3379
|
+
### Errors
|
|
3380
|
+
|
|
3381
|
+
| Error Type | Status Code | Content Type |
|
|
3382
|
+
| --------------- | --------------- | --------------- |
|
|
3383
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3384
|
+
|
|
3385
|
+
## updateAccountingOrder
|
|
3386
|
+
|
|
3387
|
+
Update an order
|
|
3388
|
+
|
|
3389
|
+
### Example Usage
|
|
3390
|
+
|
|
3391
|
+
```typescript
|
|
3392
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3393
|
+
|
|
3394
|
+
const unifiedTo = new UnifiedTo({
|
|
3395
|
+
security: {
|
|
3396
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3397
|
+
},
|
|
3398
|
+
});
|
|
3399
|
+
|
|
3400
|
+
async function run() {
|
|
3401
|
+
const result = await unifiedTo.accounting.updateAccountingOrder({
|
|
3402
|
+
connectionId: "<id>",
|
|
3403
|
+
id: "<id>",
|
|
3404
|
+
});
|
|
3405
|
+
|
|
3406
|
+
// Handle the result
|
|
3407
|
+
console.log(result);
|
|
3408
|
+
}
|
|
3409
|
+
|
|
3410
|
+
run();
|
|
3411
|
+
```
|
|
3412
|
+
|
|
3413
|
+
### Standalone function
|
|
3414
|
+
|
|
3415
|
+
The standalone function version of this method:
|
|
3416
|
+
|
|
3417
|
+
```typescript
|
|
3418
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3419
|
+
import { accountingUpdateAccountingOrder } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingOrder.js";
|
|
3420
|
+
|
|
3421
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3422
|
+
// You can create one instance of it to use across an application.
|
|
3423
|
+
const unifiedTo = new UnifiedToCore({
|
|
3424
|
+
security: {
|
|
3425
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3426
|
+
},
|
|
3427
|
+
});
|
|
3428
|
+
|
|
3429
|
+
async function run() {
|
|
3430
|
+
const res = await accountingUpdateAccountingOrder(unifiedTo, {
|
|
3431
|
+
connectionId: "<id>",
|
|
3432
|
+
id: "<id>",
|
|
3433
|
+
});
|
|
3434
|
+
|
|
3435
|
+
if (!res.ok) {
|
|
3436
|
+
throw res.error;
|
|
3437
|
+
}
|
|
3438
|
+
|
|
3439
|
+
const { value: result } = res;
|
|
3440
|
+
|
|
3441
|
+
// Handle the result
|
|
3442
|
+
console.log(result);
|
|
3443
|
+
}
|
|
3444
|
+
|
|
3445
|
+
run();
|
|
3446
|
+
```
|
|
3447
|
+
|
|
3448
|
+
### Parameters
|
|
3449
|
+
|
|
3450
|
+
| Parameter | Type | Required | Description |
|
|
3451
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3452
|
+
| `request` | [operations.UpdateAccountingOrderRequest](../../sdk/models/operations/updateaccountingorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3453
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3454
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3455
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3456
|
+
|
|
3457
|
+
### Response
|
|
3458
|
+
|
|
3459
|
+
**Promise\<[shared.AccountingOrder](../../sdk/models/shared/accountingorder.md)\>**
|
|
3460
|
+
|
|
3461
|
+
### Errors
|
|
3462
|
+
|
|
3463
|
+
| Error Type | Status Code | Content Type |
|
|
3464
|
+
| --------------- | --------------- | --------------- |
|
|
3465
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3466
|
+
|
|
3467
|
+
## updateAccountingTaxrate
|
|
3468
|
+
|
|
3469
|
+
Update a taxrate
|
|
3470
|
+
|
|
3471
|
+
### Example Usage
|
|
3472
|
+
|
|
3473
|
+
```typescript
|
|
3474
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3475
|
+
|
|
3476
|
+
const unifiedTo = new UnifiedTo({
|
|
3477
|
+
security: {
|
|
3478
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3479
|
+
},
|
|
3480
|
+
});
|
|
3481
|
+
|
|
3482
|
+
async function run() {
|
|
3483
|
+
const result = await unifiedTo.accounting.updateAccountingTaxrate({
|
|
3484
|
+
connectionId: "<value>",
|
|
3485
|
+
id: "<id>",
|
|
3486
|
+
});
|
|
3487
|
+
|
|
3488
|
+
// Handle the result
|
|
3489
|
+
console.log(result);
|
|
3490
|
+
}
|
|
3491
|
+
|
|
3492
|
+
run();
|
|
3493
|
+
```
|
|
3494
|
+
|
|
3495
|
+
### Standalone function
|
|
3496
|
+
|
|
3497
|
+
The standalone function version of this method:
|
|
3498
|
+
|
|
3499
|
+
```typescript
|
|
3500
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3501
|
+
import { accountingUpdateAccountingTaxrate } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingTaxrate.js";
|
|
3502
|
+
|
|
3503
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3504
|
+
// You can create one instance of it to use across an application.
|
|
3505
|
+
const unifiedTo = new UnifiedToCore({
|
|
3506
|
+
security: {
|
|
3507
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3508
|
+
},
|
|
3509
|
+
});
|
|
3510
|
+
|
|
3511
|
+
async function run() {
|
|
3512
|
+
const res = await accountingUpdateAccountingTaxrate(unifiedTo, {
|
|
3513
|
+
connectionId: "<value>",
|
|
3514
|
+
id: "<id>",
|
|
3515
|
+
});
|
|
3516
|
+
|
|
3517
|
+
if (!res.ok) {
|
|
3518
|
+
throw res.error;
|
|
3519
|
+
}
|
|
3520
|
+
|
|
3521
|
+
const { value: result } = res;
|
|
3522
|
+
|
|
3523
|
+
// Handle the result
|
|
3524
|
+
console.log(result);
|
|
3525
|
+
}
|
|
3526
|
+
|
|
3527
|
+
run();
|
|
3528
|
+
```
|
|
3529
|
+
|
|
3530
|
+
### Parameters
|
|
3531
|
+
|
|
3532
|
+
| Parameter | Type | Required | Description |
|
|
3533
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3534
|
+
| `request` | [operations.UpdateAccountingTaxrateRequest](../../sdk/models/operations/updateaccountingtaxraterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3535
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3536
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3537
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3538
|
+
|
|
3539
|
+
### Response
|
|
3540
|
+
|
|
3541
|
+
**Promise\<[shared.AccountingTaxrate](../../sdk/models/shared/accountingtaxrate.md)\>**
|
|
3542
|
+
|
|
3543
|
+
### Errors
|
|
3544
|
+
|
|
3545
|
+
| Error Type | Status Code | Content Type |
|
|
3546
|
+
| --------------- | --------------- | --------------- |
|
|
3547
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3548
|
+
|
|
3549
|
+
## updateAccountingTransaction
|
|
3550
|
+
|
|
3551
|
+
Update a transaction
|
|
3552
|
+
|
|
3553
|
+
### Example Usage
|
|
3554
|
+
|
|
3555
|
+
```typescript
|
|
3556
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3557
|
+
|
|
3558
|
+
const unifiedTo = new UnifiedTo({
|
|
3559
|
+
security: {
|
|
3560
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3561
|
+
},
|
|
3562
|
+
});
|
|
3563
|
+
|
|
3564
|
+
async function run() {
|
|
3565
|
+
const result = await unifiedTo.accounting.updateAccountingTransaction({
|
|
3566
|
+
connectionId: "<value>",
|
|
3567
|
+
id: "<id>",
|
|
3568
|
+
});
|
|
3569
|
+
|
|
3570
|
+
// Handle the result
|
|
3571
|
+
console.log(result);
|
|
3572
|
+
}
|
|
3573
|
+
|
|
3574
|
+
run();
|
|
3575
|
+
```
|
|
3576
|
+
|
|
3577
|
+
### Standalone function
|
|
3578
|
+
|
|
3579
|
+
The standalone function version of this method:
|
|
3580
|
+
|
|
3581
|
+
```typescript
|
|
3582
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3583
|
+
import { accountingUpdateAccountingTransaction } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingTransaction.js";
|
|
3584
|
+
|
|
3585
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3586
|
+
// You can create one instance of it to use across an application.
|
|
3587
|
+
const unifiedTo = new UnifiedToCore({
|
|
3588
|
+
security: {
|
|
3589
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3590
|
+
},
|
|
3591
|
+
});
|
|
3592
|
+
|
|
3593
|
+
async function run() {
|
|
3594
|
+
const res = await accountingUpdateAccountingTransaction(unifiedTo, {
|
|
3595
|
+
connectionId: "<value>",
|
|
3596
|
+
id: "<id>",
|
|
3597
|
+
});
|
|
3598
|
+
|
|
3599
|
+
if (!res.ok) {
|
|
3600
|
+
throw res.error;
|
|
3601
|
+
}
|
|
3602
|
+
|
|
3603
|
+
const { value: result } = res;
|
|
3604
|
+
|
|
3605
|
+
// Handle the result
|
|
3606
|
+
console.log(result);
|
|
3607
|
+
}
|
|
3608
|
+
|
|
3609
|
+
run();
|
|
3610
|
+
```
|
|
3611
|
+
|
|
3612
|
+
### Parameters
|
|
3613
|
+
|
|
3614
|
+
| Parameter | Type | Required | Description |
|
|
3615
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3616
|
+
| `request` | [operations.UpdateAccountingTransactionRequest](../../sdk/models/operations/updateaccountingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3617
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3618
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
3619
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3620
|
+
|
|
3621
|
+
### Response
|
|
3622
|
+
|
|
3623
|
+
**Promise\<[shared.AccountingTransaction](../../sdk/models/shared/accountingtransaction.md)\>**
|
|
3624
|
+
|
|
3625
|
+
### Errors
|
|
3626
|
+
|
|
3627
|
+
| Error Type | Status Code | Content Type |
|
|
3628
|
+
| --------------- | --------------- | --------------- |
|
|
3629
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|