@unified-api/typescript-sdk 2.73.10 → 2.73.11
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/README.md +12 -0
- package/bin/mcp-server.js +4418 -3450
- package/bin/mcp-server.js.map +28 -9
- package/docs/sdks/account/README.md +6 -0
- package/docs/sdks/accounting/README.md +558 -0
- package/docs/sdks/activity/README.md +6 -0
- package/docs/sdks/apicall/README.md +2 -0
- package/docs/sdks/application/README.md +6 -0
- package/docs/sdks/applicationstatus/README.md +1 -0
- package/docs/sdks/ats/README.md +49 -0
- package/docs/sdks/auth/README.md +2 -0
- package/docs/sdks/balancesheet/README.md +2 -0
- package/docs/sdks/bill/README.md +6 -0
- package/docs/sdks/branch/README.md +6 -0
- package/docs/sdks/busy/README.md +1 -0
- package/docs/sdks/calendar/README.md +21 -0
- package/docs/sdks/call/README.md +1 -0
- package/docs/sdks/candidate/README.md +6 -0
- package/docs/sdks/category/README.md +489 -0
- package/docs/sdks/channel/README.md +2 -0
- package/docs/sdks/class/README.md +6 -0
- package/docs/sdks/collection/README.md +6 -0
- package/docs/sdks/comment/README.md +18 -0
- package/docs/sdks/commerce/README.md +30 -0
- package/docs/sdks/commit/README.md +6 -0
- package/docs/sdks/company/README.md +19 -0
- package/docs/sdks/connection/README.md +6 -0
- package/docs/sdks/contact/README.md +18 -0
- package/docs/sdks/course/README.md +6 -0
- package/docs/sdks/creditmemo/README.md +6 -0
- package/docs/sdks/crm/README.md +36 -0
- package/docs/sdks/customer/README.md +6 -0
- package/docs/sdks/deal/README.md +6 -0
- package/docs/sdks/device/README.md +6 -0
- package/docs/sdks/document/README.md +6 -0
- package/docs/sdks/employee/README.md +6 -0
- package/docs/sdks/enrich/README.md +2 -0
- package/docs/sdks/event/README.md +12 -0
- package/docs/sdks/file/README.md +6 -0
- package/docs/sdks/genai/README.md +2 -0
- package/docs/sdks/group/README.md +12 -0
- package/docs/sdks/hris/README.md +40 -0
- package/docs/sdks/instructor/README.md +6 -0
- package/docs/sdks/integration/README.md +3 -0
- package/docs/sdks/interview/README.md +6 -0
- package/docs/sdks/inventory/README.md +6 -0
- package/docs/sdks/invoice/README.md +6 -0
- package/docs/sdks/issue/README.md +1 -0
- package/docs/sdks/item/README.md +6 -0
- package/docs/sdks/job/README.md +6 -0
- package/docs/sdks/journal/README.md +6 -0
- package/docs/sdks/kms/README.md +18 -0
- package/docs/sdks/lead/README.md +6 -0
- package/docs/sdks/link/README.md +12 -0
- package/docs/sdks/list/README.md +6 -0
- package/docs/sdks/lms/README.md +24 -0
- package/docs/sdks/location/README.md +12 -0
- package/docs/sdks/login/README.md +1 -0
- package/docs/sdks/martech/README.md +12 -0
- package/docs/sdks/member/README.md +6 -0
- package/docs/sdks/message/README.md +6 -0
- package/docs/sdks/messaging/README.md +8 -0
- package/docs/sdks/metadata/README.md +6 -0
- package/docs/sdks/model/README.md +1 -0
- package/docs/sdks/note/README.md +6 -0
- package/docs/sdks/order/README.md +6 -0
- package/docs/sdks/organization/README.md +8 -0
- package/docs/sdks/page/README.md +6 -0
- package/docs/sdks/passthrough/README.md +8 -0
- package/docs/sdks/payment/README.md +22 -0
- package/docs/sdks/payout/README.md +2 -0
- package/docs/sdks/payslip/README.md +2 -0
- package/docs/sdks/person/README.md +1 -0
- package/docs/sdks/pipeline/README.md +6 -0
- package/docs/sdks/profitloss/README.md +2 -0
- package/docs/sdks/project/README.md +6 -0
- package/docs/sdks/prompt/README.md +1 -0
- package/docs/sdks/pullrequest/README.md +6 -0
- package/docs/sdks/purchaseorder/README.md +6 -0
- package/docs/sdks/recording/README.md +8 -0
- package/docs/sdks/refund/README.md +2 -0
- package/docs/sdks/repo/README.md +30 -0
- package/docs/sdks/report/README.md +2 -0
- package/docs/sdks/repository/README.md +6 -0
- package/docs/sdks/review/README.md +6 -0
- package/docs/sdks/salesorder/README.md +6 -0
- package/docs/sdks/scim/README.md +12 -0
- package/docs/sdks/scorecard/README.md +6 -0
- package/docs/sdks/space/README.md +6 -0
- package/docs/sdks/storage/README.md +6 -0
- package/docs/sdks/student/README.md +6 -0
- package/docs/sdks/subscription/README.md +6 -0
- package/docs/sdks/task/README.md +18 -0
- package/docs/sdks/taxrate/README.md +6 -0
- package/docs/sdks/ticket/README.md +6 -0
- package/docs/sdks/ticketing/README.md +18 -0
- package/docs/sdks/timeoff/README.md +2 -0
- package/docs/sdks/timeshift/README.md +6 -0
- package/docs/sdks/transaction/README.md +6 -0
- package/docs/sdks/trialbalance/README.md +2 -0
- package/docs/sdks/uc/README.md +19 -0
- package/docs/sdks/unified/README.md +20 -0
- package/docs/sdks/user/README.md +6 -0
- package/docs/sdks/webhook/README.md +8 -0
- package/examples/README.md +5 -0
- package/examples/accountingCreateAccountingAccount.example.ts +2 -0
- package/examples/package-lock.json +6 -5
- package/funcs/accountingCreateAccountingCategory.d.ts +15 -0
- package/funcs/accountingCreateAccountingCategory.d.ts.map +1 -0
- package/funcs/accountingCreateAccountingCategory.js +114 -0
- package/funcs/accountingCreateAccountingCategory.js.map +1 -0
- package/funcs/accountingGetAccountingCategory.d.ts +15 -0
- package/funcs/accountingGetAccountingCategory.d.ts.map +1 -0
- package/funcs/accountingGetAccountingCategory.js +115 -0
- package/funcs/accountingGetAccountingCategory.js.map +1 -0
- package/funcs/accountingListAccountingCategories.d.ts +15 -0
- package/funcs/accountingListAccountingCategories.d.ts.map +1 -0
- package/funcs/accountingListAccountingCategories.js +119 -0
- package/funcs/accountingListAccountingCategories.js.map +1 -0
- package/funcs/accountingPatchAccountingCategory.d.ts +15 -0
- package/funcs/accountingPatchAccountingCategory.d.ts.map +1 -0
- package/funcs/accountingPatchAccountingCategory.js +118 -0
- package/funcs/accountingPatchAccountingCategory.js.map +1 -0
- package/funcs/accountingRemoveAccountingCategory.d.ts +14 -0
- package/funcs/accountingRemoveAccountingCategory.d.ts.map +1 -0
- package/funcs/accountingRemoveAccountingCategory.js +112 -0
- package/funcs/accountingRemoveAccountingCategory.js.map +1 -0
- package/funcs/accountingUpdateAccountingCategory.d.ts +15 -0
- package/funcs/accountingUpdateAccountingCategory.d.ts.map +1 -0
- package/funcs/accountingUpdateAccountingCategory.js +118 -0
- package/funcs/accountingUpdateAccountingCategory.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +13 -1
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/accountingCreateAccountingCategory.d.ts +8 -0
- package/mcp-server/tools/accountingCreateAccountingCategory.d.ts.map +1 -0
- package/mcp-server/tools/accountingCreateAccountingCategory.js +52 -0
- package/mcp-server/tools/accountingCreateAccountingCategory.js.map +1 -0
- package/mcp-server/tools/accountingGetAccountingCategory.d.ts +8 -0
- package/mcp-server/tools/accountingGetAccountingCategory.d.ts.map +1 -0
- package/mcp-server/tools/accountingGetAccountingCategory.js +52 -0
- package/mcp-server/tools/accountingGetAccountingCategory.js.map +1 -0
- package/mcp-server/tools/accountingListAccountingCategories.d.ts +8 -0
- package/mcp-server/tools/accountingListAccountingCategories.d.ts.map +1 -0
- package/mcp-server/tools/accountingListAccountingCategories.js +52 -0
- package/mcp-server/tools/accountingListAccountingCategories.js.map +1 -0
- package/mcp-server/tools/accountingPatchAccountingCategory.d.ts +8 -0
- package/mcp-server/tools/accountingPatchAccountingCategory.d.ts.map +1 -0
- package/mcp-server/tools/accountingPatchAccountingCategory.js +52 -0
- package/mcp-server/tools/accountingPatchAccountingCategory.js.map +1 -0
- package/mcp-server/tools/accountingRemoveAccountingCategory.d.ts +8 -0
- package/mcp-server/tools/accountingRemoveAccountingCategory.d.ts.map +1 -0
- package/mcp-server/tools/accountingRemoveAccountingCategory.js +51 -0
- package/mcp-server/tools/accountingRemoveAccountingCategory.js.map +1 -0
- package/mcp-server/tools/accountingUpdateAccountingCategory.d.ts +8 -0
- package/mcp-server/tools/accountingUpdateAccountingCategory.d.ts.map +1 -0
- package/mcp-server/tools/accountingUpdateAccountingCategory.js +52 -0
- package/mcp-server/tools/accountingUpdateAccountingCategory.js.map +1 -0
- package/package.json +4 -6
- package/sdk/accounting.d.ts +24 -0
- package/sdk/accounting.d.ts.map +1 -1
- package/sdk/accounting.js +42 -0
- package/sdk/accounting.js.map +1 -1
- package/sdk/category.d.ts +30 -0
- package/sdk/category.d.ts.map +1 -0
- package/sdk/category.js +54 -0
- package/sdk/category.js.map +1 -0
- package/sdk/models/operations/createaccountingcategory.d.ts +45 -0
- package/sdk/models/operations/createaccountingcategory.d.ts.map +1 -0
- package/sdk/models/operations/createaccountingcategory.js +77 -0
- package/sdk/models/operations/createaccountingcategory.js.map +1 -0
- package/sdk/models/operations/getaccountingcategory.d.ts +47 -0
- package/sdk/models/operations/getaccountingcategory.d.ts.map +1 -0
- package/sdk/models/operations/getaccountingcategory.js +74 -0
- package/sdk/models/operations/getaccountingcategory.js.map +1 -0
- package/sdk/models/operations/index.d.ts +6 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +6 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listaccountingcategories.d.ts +65 -0
- package/sdk/models/operations/listaccountingcategories.d.ts.map +1 -0
- package/sdk/models/operations/listaccountingcategories.js +90 -0
- package/sdk/models/operations/listaccountingcategories.js.map +1 -0
- package/sdk/models/operations/patchaccountingcategory.d.ts +50 -0
- package/sdk/models/operations/patchaccountingcategory.d.ts.map +1 -0
- package/sdk/models/operations/patchaccountingcategory.js +79 -0
- package/sdk/models/operations/patchaccountingcategory.js.map +1 -0
- package/sdk/models/operations/removeaccountingcategory.d.ts +66 -0
- package/sdk/models/operations/removeaccountingcategory.d.ts.map +1 -0
- package/sdk/models/operations/removeaccountingcategory.js +105 -0
- package/sdk/models/operations/removeaccountingcategory.js.map +1 -0
- package/sdk/models/operations/updateaccountingcategory.d.ts +50 -0
- package/sdk/models/operations/updateaccountingcategory.d.ts.map +1 -0
- package/sdk/models/operations/updateaccountingcategory.js +79 -0
- package/sdk/models/operations/updateaccountingcategory.js.map +1 -0
- package/sdk/models/shared/accountingcategory.d.ts +47 -0
- package/sdk/models/shared/accountingcategory.d.ts.map +1 -0
- package/sdk/models/shared/accountingcategory.js +90 -0
- package/sdk/models/shared/accountingcategory.js.map +1 -0
- package/sdk/models/shared/accountinglineitem.d.ts +2 -0
- package/sdk/models/shared/accountinglineitem.d.ts.map +1 -1
- package/sdk/models/shared/accountinglineitem.js +4 -0
- package/sdk/models/shared/accountinglineitem.js.map +1 -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/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/accountingCreateAccountingCategory.ts +173 -0
- package/src/funcs/accountingGetAccountingCategory.ts +176 -0
- package/src/funcs/accountingListAccountingCategories.ts +178 -0
- package/src/funcs/accountingPatchAccountingCategory.ts +179 -0
- package/src/funcs/accountingRemoveAccountingCategory.ts +181 -0
- package/src/funcs/accountingUpdateAccountingCategory.ts +179 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +13 -1
- package/src/mcp-server/tools/accountingCreateAccountingCategory.ts +37 -0
- package/src/mcp-server/tools/accountingGetAccountingCategory.ts +36 -0
- package/src/mcp-server/tools/accountingListAccountingCategories.ts +37 -0
- package/src/mcp-server/tools/accountingPatchAccountingCategory.ts +37 -0
- package/src/mcp-server/tools/accountingRemoveAccountingCategory.ts +35 -0
- package/src/mcp-server/tools/accountingUpdateAccountingCategory.ts +37 -0
- package/src/sdk/accounting.ts +90 -0
- package/src/sdk/category.ts +100 -0
- package/src/sdk/models/operations/createaccountingcategory.ts +101 -0
- package/src/sdk/models/operations/getaccountingcategory.ts +101 -0
- package/src/sdk/models/operations/index.ts +6 -0
- package/src/sdk/models/operations/listaccountingcategories.ts +135 -0
- package/src/sdk/models/operations/patchaccountingcategory.ts +108 -0
- package/src/sdk/models/operations/removeaccountingcategory.ts +155 -0
- package/src/sdk/models/operations/updateaccountingcategory.ts +108 -0
- package/src/sdk/models/shared/accountingcategory.ts +111 -0
- package/src/sdk/models/shared/accountinglineitem.ts +6 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/sdk.ts +6 -0
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
* [createAccountingAccount](#createaccountingaccount) - Create an account
|
|
9
9
|
* [createAccountingBill](#createaccountingbill) - Create a bill
|
|
10
|
+
* [createAccountingCategory](#createaccountingcategory) - Create a category
|
|
10
11
|
* [createAccountingContact](#createaccountingcontact) - Create a contact
|
|
11
12
|
* [createAccountingCreditmemo](#createaccountingcreditmemo) - Create a creditmemo
|
|
12
13
|
* [createAccountingInvoice](#createaccountinginvoice) - Create an invoice
|
|
@@ -19,6 +20,7 @@
|
|
|
19
20
|
* [getAccountingAccount](#getaccountingaccount) - Retrieve an account
|
|
20
21
|
* [getAccountingBalancesheet](#getaccountingbalancesheet) - Retrieve a balancesheet
|
|
21
22
|
* [getAccountingBill](#getaccountingbill) - Retrieve a bill
|
|
23
|
+
* [getAccountingCategory](#getaccountingcategory) - Retrieve a category
|
|
22
24
|
* [getAccountingContact](#getaccountingcontact) - Retrieve a contact
|
|
23
25
|
* [getAccountingCreditmemo](#getaccountingcreditmemo) - Retrieve a creditmemo
|
|
24
26
|
* [getAccountingInvoice](#getaccountinginvoice) - Retrieve an invoice
|
|
@@ -35,6 +37,7 @@
|
|
|
35
37
|
* [listAccountingAccounts](#listaccountingaccounts) - List all accounts
|
|
36
38
|
* [listAccountingBalancesheets](#listaccountingbalancesheets) - List all balancesheets
|
|
37
39
|
* [listAccountingBills](#listaccountingbills) - List all bills
|
|
40
|
+
* [listAccountingCategories](#listaccountingcategories) - List all categories
|
|
38
41
|
* [listAccountingContacts](#listaccountingcontacts) - List all contacts
|
|
39
42
|
* [listAccountingCreditmemoes](#listaccountingcreditmemoes) - List all creditmemoes
|
|
40
43
|
* [listAccountingInvoices](#listaccountinginvoices) - List all invoices
|
|
@@ -50,6 +53,7 @@
|
|
|
50
53
|
* [listAccountingTrialbalances](#listaccountingtrialbalances) - List all trialbalances
|
|
51
54
|
* [patchAccountingAccount](#patchaccountingaccount) - Update an account
|
|
52
55
|
* [patchAccountingBill](#patchaccountingbill) - Update a bill
|
|
56
|
+
* [patchAccountingCategory](#patchaccountingcategory) - Update a category
|
|
53
57
|
* [patchAccountingContact](#patchaccountingcontact) - Update a contact
|
|
54
58
|
* [patchAccountingCreditmemo](#patchaccountingcreditmemo) - Update a creditmemo
|
|
55
59
|
* [patchAccountingInvoice](#patchaccountinginvoice) - Update an invoice
|
|
@@ -61,6 +65,7 @@
|
|
|
61
65
|
* [patchAccountingTransaction](#patchaccountingtransaction) - Update a transaction
|
|
62
66
|
* [removeAccountingAccount](#removeaccountingaccount) - Remove an account
|
|
63
67
|
* [removeAccountingBill](#removeaccountingbill) - Remove a bill
|
|
68
|
+
* [removeAccountingCategory](#removeaccountingcategory) - Remove a category
|
|
64
69
|
* [removeAccountingContact](#removeaccountingcontact) - Remove a contact
|
|
65
70
|
* [removeAccountingCreditmemo](#removeaccountingcreditmemo) - Remove a creditmemo
|
|
66
71
|
* [removeAccountingInvoice](#removeaccountinginvoice) - Remove an invoice
|
|
@@ -72,6 +77,7 @@
|
|
|
72
77
|
* [removeAccountingTransaction](#removeaccountingtransaction) - Remove a transaction
|
|
73
78
|
* [updateAccountingAccount](#updateaccountingaccount) - Update an account
|
|
74
79
|
* [updateAccountingBill](#updateaccountingbill) - Update a bill
|
|
80
|
+
* [updateAccountingCategory](#updateaccountingcategory) - Update a category
|
|
75
81
|
* [updateAccountingContact](#updateaccountingcontact) - Update a contact
|
|
76
82
|
* [updateAccountingCreditmemo](#updateaccountingcreditmemo) - Update a creditmemo
|
|
77
83
|
* [updateAccountingInvoice](#updateaccountinginvoice) - Update an invoice
|
|
@@ -88,6 +94,7 @@ Create an account
|
|
|
88
94
|
|
|
89
95
|
### Example Usage
|
|
90
96
|
|
|
97
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingAccount" method="post" path="/accounting/{connection_id}/account" -->
|
|
91
98
|
```typescript
|
|
92
99
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
93
100
|
|
|
@@ -166,6 +173,7 @@ Create a bill
|
|
|
166
173
|
|
|
167
174
|
### Example Usage
|
|
168
175
|
|
|
176
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingBill" method="post" path="/accounting/{connection_id}/bill" -->
|
|
169
177
|
```typescript
|
|
170
178
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
171
179
|
|
|
@@ -238,12 +246,92 @@ run();
|
|
|
238
246
|
| --------------- | --------------- | --------------- |
|
|
239
247
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
240
248
|
|
|
249
|
+
## createAccountingCategory
|
|
250
|
+
|
|
251
|
+
Create a category
|
|
252
|
+
|
|
253
|
+
### Example Usage
|
|
254
|
+
|
|
255
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingCategory" method="post" path="/accounting/{connection_id}/category" -->
|
|
256
|
+
```typescript
|
|
257
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
258
|
+
|
|
259
|
+
const unifiedTo = new UnifiedTo({
|
|
260
|
+
security: {
|
|
261
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
262
|
+
},
|
|
263
|
+
});
|
|
264
|
+
|
|
265
|
+
async function run() {
|
|
266
|
+
const result = await unifiedTo.accounting.createAccountingCategory({
|
|
267
|
+
accountingCategory: {},
|
|
268
|
+
connectionId: "<id>",
|
|
269
|
+
});
|
|
270
|
+
|
|
271
|
+
console.log(result);
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
run();
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Standalone function
|
|
278
|
+
|
|
279
|
+
The standalone function version of this method:
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
283
|
+
import { accountingCreateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingCategory.js";
|
|
284
|
+
|
|
285
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
286
|
+
// You can create one instance of it to use across an application.
|
|
287
|
+
const unifiedTo = new UnifiedToCore({
|
|
288
|
+
security: {
|
|
289
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
290
|
+
},
|
|
291
|
+
});
|
|
292
|
+
|
|
293
|
+
async function run() {
|
|
294
|
+
const res = await accountingCreateAccountingCategory(unifiedTo, {
|
|
295
|
+
accountingCategory: {},
|
|
296
|
+
connectionId: "<id>",
|
|
297
|
+
});
|
|
298
|
+
if (res.ok) {
|
|
299
|
+
const { value: result } = res;
|
|
300
|
+
console.log(result);
|
|
301
|
+
} else {
|
|
302
|
+
console.log("accountingCreateAccountingCategory failed:", res.error);
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
run();
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### Parameters
|
|
310
|
+
|
|
311
|
+
| Parameter | Type | Required | Description |
|
|
312
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
313
|
+
| `request` | [operations.CreateAccountingCategoryRequest](../../sdk/models/operations/createaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
314
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
315
|
+
| `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. |
|
|
316
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
317
|
+
|
|
318
|
+
### Response
|
|
319
|
+
|
|
320
|
+
**Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
|
|
321
|
+
|
|
322
|
+
### Errors
|
|
323
|
+
|
|
324
|
+
| Error Type | Status Code | Content Type |
|
|
325
|
+
| --------------- | --------------- | --------------- |
|
|
326
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
327
|
+
|
|
241
328
|
## createAccountingContact
|
|
242
329
|
|
|
243
330
|
Create a contact
|
|
244
331
|
|
|
245
332
|
### Example Usage
|
|
246
333
|
|
|
334
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingContact" method="post" path="/accounting/{connection_id}/contact" -->
|
|
247
335
|
```typescript
|
|
248
336
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
249
337
|
|
|
@@ -322,6 +410,7 @@ Create a creditmemo
|
|
|
322
410
|
|
|
323
411
|
### Example Usage
|
|
324
412
|
|
|
413
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingCreditmemo" method="post" path="/accounting/{connection_id}/creditmemo" -->
|
|
325
414
|
```typescript
|
|
326
415
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
327
416
|
|
|
@@ -400,6 +489,7 @@ Create an invoice
|
|
|
400
489
|
|
|
401
490
|
### Example Usage
|
|
402
491
|
|
|
492
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingInvoice" method="post" path="/accounting/{connection_id}/invoice" -->
|
|
403
493
|
```typescript
|
|
404
494
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
405
495
|
|
|
@@ -478,6 +568,7 @@ Create a journal
|
|
|
478
568
|
|
|
479
569
|
### Example Usage
|
|
480
570
|
|
|
571
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingJournal" method="post" path="/accounting/{connection_id}/journal" -->
|
|
481
572
|
```typescript
|
|
482
573
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
483
574
|
|
|
@@ -556,6 +647,7 @@ Create an order
|
|
|
556
647
|
|
|
557
648
|
### Example Usage
|
|
558
649
|
|
|
650
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingOrder" method="post" path="/accounting/{connection_id}/order" -->
|
|
559
651
|
```typescript
|
|
560
652
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
561
653
|
|
|
@@ -634,6 +726,7 @@ Create a purchaseorder
|
|
|
634
726
|
|
|
635
727
|
### Example Usage
|
|
636
728
|
|
|
729
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingPurchaseorder" method="post" path="/accounting/{connection_id}/purchaseorder" -->
|
|
637
730
|
```typescript
|
|
638
731
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
639
732
|
|
|
@@ -712,6 +805,7 @@ Create a salesorder
|
|
|
712
805
|
|
|
713
806
|
### Example Usage
|
|
714
807
|
|
|
808
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingSalesorder" method="post" path="/accounting/{connection_id}/salesorder" -->
|
|
715
809
|
```typescript
|
|
716
810
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
717
811
|
|
|
@@ -790,6 +884,7 @@ Create a taxrate
|
|
|
790
884
|
|
|
791
885
|
### Example Usage
|
|
792
886
|
|
|
887
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingTaxrate" method="post" path="/accounting/{connection_id}/taxrate" -->
|
|
793
888
|
```typescript
|
|
794
889
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
795
890
|
|
|
@@ -868,6 +963,7 @@ Create a transaction
|
|
|
868
963
|
|
|
869
964
|
### Example Usage
|
|
870
965
|
|
|
966
|
+
<!-- UsageSnippet language="typescript" operationID="createAccountingTransaction" method="post" path="/accounting/{connection_id}/transaction" -->
|
|
871
967
|
```typescript
|
|
872
968
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
873
969
|
|
|
@@ -946,6 +1042,7 @@ Retrieve an account
|
|
|
946
1042
|
|
|
947
1043
|
### Example Usage
|
|
948
1044
|
|
|
1045
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingAccount" method="get" path="/accounting/{connection_id}/account/{id}" -->
|
|
949
1046
|
```typescript
|
|
950
1047
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
951
1048
|
|
|
@@ -1024,6 +1121,7 @@ Retrieve a balancesheet
|
|
|
1024
1121
|
|
|
1025
1122
|
### Example Usage
|
|
1026
1123
|
|
|
1124
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingBalancesheet" method="get" path="/accounting/{connection_id}/balancesheet/{id}" -->
|
|
1027
1125
|
```typescript
|
|
1028
1126
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1029
1127
|
|
|
@@ -1102,6 +1200,7 @@ Retrieve a bill
|
|
|
1102
1200
|
|
|
1103
1201
|
### Example Usage
|
|
1104
1202
|
|
|
1203
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingBill" method="get" path="/accounting/{connection_id}/bill/{id}" -->
|
|
1105
1204
|
```typescript
|
|
1106
1205
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1107
1206
|
|
|
@@ -1174,12 +1273,92 @@ run();
|
|
|
1174
1273
|
| --------------- | --------------- | --------------- |
|
|
1175
1274
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1176
1275
|
|
|
1276
|
+
## getAccountingCategory
|
|
1277
|
+
|
|
1278
|
+
Retrieve a category
|
|
1279
|
+
|
|
1280
|
+
### Example Usage
|
|
1281
|
+
|
|
1282
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingCategory" method="get" path="/accounting/{connection_id}/category/{id}" -->
|
|
1283
|
+
```typescript
|
|
1284
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1285
|
+
|
|
1286
|
+
const unifiedTo = new UnifiedTo({
|
|
1287
|
+
security: {
|
|
1288
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1289
|
+
},
|
|
1290
|
+
});
|
|
1291
|
+
|
|
1292
|
+
async function run() {
|
|
1293
|
+
const result = await unifiedTo.accounting.getAccountingCategory({
|
|
1294
|
+
connectionId: "<id>",
|
|
1295
|
+
id: "<id>",
|
|
1296
|
+
});
|
|
1297
|
+
|
|
1298
|
+
console.log(result);
|
|
1299
|
+
}
|
|
1300
|
+
|
|
1301
|
+
run();
|
|
1302
|
+
```
|
|
1303
|
+
|
|
1304
|
+
### Standalone function
|
|
1305
|
+
|
|
1306
|
+
The standalone function version of this method:
|
|
1307
|
+
|
|
1308
|
+
```typescript
|
|
1309
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1310
|
+
import { accountingGetAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingCategory.js";
|
|
1311
|
+
|
|
1312
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1313
|
+
// You can create one instance of it to use across an application.
|
|
1314
|
+
const unifiedTo = new UnifiedToCore({
|
|
1315
|
+
security: {
|
|
1316
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1317
|
+
},
|
|
1318
|
+
});
|
|
1319
|
+
|
|
1320
|
+
async function run() {
|
|
1321
|
+
const res = await accountingGetAccountingCategory(unifiedTo, {
|
|
1322
|
+
connectionId: "<id>",
|
|
1323
|
+
id: "<id>",
|
|
1324
|
+
});
|
|
1325
|
+
if (res.ok) {
|
|
1326
|
+
const { value: result } = res;
|
|
1327
|
+
console.log(result);
|
|
1328
|
+
} else {
|
|
1329
|
+
console.log("accountingGetAccountingCategory failed:", res.error);
|
|
1330
|
+
}
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1333
|
+
run();
|
|
1334
|
+
```
|
|
1335
|
+
|
|
1336
|
+
### Parameters
|
|
1337
|
+
|
|
1338
|
+
| Parameter | Type | Required | Description |
|
|
1339
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1340
|
+
| `request` | [operations.GetAccountingCategoryRequest](../../sdk/models/operations/getaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1341
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1342
|
+
| `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. |
|
|
1343
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1344
|
+
|
|
1345
|
+
### Response
|
|
1346
|
+
|
|
1347
|
+
**Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
|
|
1348
|
+
|
|
1349
|
+
### Errors
|
|
1350
|
+
|
|
1351
|
+
| Error Type | Status Code | Content Type |
|
|
1352
|
+
| --------------- | --------------- | --------------- |
|
|
1353
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1354
|
+
|
|
1177
1355
|
## getAccountingContact
|
|
1178
1356
|
|
|
1179
1357
|
Retrieve a contact
|
|
1180
1358
|
|
|
1181
1359
|
### Example Usage
|
|
1182
1360
|
|
|
1361
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingContact" method="get" path="/accounting/{connection_id}/contact/{id}" -->
|
|
1183
1362
|
```typescript
|
|
1184
1363
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1185
1364
|
|
|
@@ -1258,6 +1437,7 @@ Retrieve a creditmemo
|
|
|
1258
1437
|
|
|
1259
1438
|
### Example Usage
|
|
1260
1439
|
|
|
1440
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingCreditmemo" method="get" path="/accounting/{connection_id}/creditmemo/{id}" -->
|
|
1261
1441
|
```typescript
|
|
1262
1442
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1263
1443
|
|
|
@@ -1336,6 +1516,7 @@ Retrieve an invoice
|
|
|
1336
1516
|
|
|
1337
1517
|
### Example Usage
|
|
1338
1518
|
|
|
1519
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingInvoice" method="get" path="/accounting/{connection_id}/invoice/{id}" -->
|
|
1339
1520
|
```typescript
|
|
1340
1521
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1341
1522
|
|
|
@@ -1414,6 +1595,7 @@ Retrieve a journal
|
|
|
1414
1595
|
|
|
1415
1596
|
### Example Usage
|
|
1416
1597
|
|
|
1598
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingJournal" method="get" path="/accounting/{connection_id}/journal/{id}" -->
|
|
1417
1599
|
```typescript
|
|
1418
1600
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1419
1601
|
|
|
@@ -1492,6 +1674,7 @@ Retrieve an order
|
|
|
1492
1674
|
|
|
1493
1675
|
### Example Usage
|
|
1494
1676
|
|
|
1677
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingOrder" method="get" path="/accounting/{connection_id}/order/{id}" -->
|
|
1495
1678
|
```typescript
|
|
1496
1679
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1497
1680
|
|
|
@@ -1570,6 +1753,7 @@ Retrieve an organization
|
|
|
1570
1753
|
|
|
1571
1754
|
### Example Usage
|
|
1572
1755
|
|
|
1756
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingOrganization" method="get" path="/accounting/{connection_id}/organization/{id}" -->
|
|
1573
1757
|
```typescript
|
|
1574
1758
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1575
1759
|
|
|
@@ -1648,6 +1832,7 @@ Retrieve a profitloss
|
|
|
1648
1832
|
|
|
1649
1833
|
### Example Usage
|
|
1650
1834
|
|
|
1835
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingProfitloss" method="get" path="/accounting/{connection_id}/profitloss/{id}" -->
|
|
1651
1836
|
```typescript
|
|
1652
1837
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1653
1838
|
|
|
@@ -1726,6 +1911,7 @@ Retrieve a purchaseorder
|
|
|
1726
1911
|
|
|
1727
1912
|
### Example Usage
|
|
1728
1913
|
|
|
1914
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingPurchaseorder" method="get" path="/accounting/{connection_id}/purchaseorder/{id}" -->
|
|
1729
1915
|
```typescript
|
|
1730
1916
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1731
1917
|
|
|
@@ -1804,6 +1990,7 @@ Retrieve a report
|
|
|
1804
1990
|
|
|
1805
1991
|
### Example Usage
|
|
1806
1992
|
|
|
1993
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingReport" method="get" path="/accounting/{connection_id}/report/{id}" -->
|
|
1807
1994
|
```typescript
|
|
1808
1995
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1809
1996
|
|
|
@@ -1882,6 +2069,7 @@ Retrieve a salesorder
|
|
|
1882
2069
|
|
|
1883
2070
|
### Example Usage
|
|
1884
2071
|
|
|
2072
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingSalesorder" method="get" path="/accounting/{connection_id}/salesorder/{id}" -->
|
|
1885
2073
|
```typescript
|
|
1886
2074
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1887
2075
|
|
|
@@ -1960,6 +2148,7 @@ Retrieve a taxrate
|
|
|
1960
2148
|
|
|
1961
2149
|
### Example Usage
|
|
1962
2150
|
|
|
2151
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingTaxrate" method="get" path="/accounting/{connection_id}/taxrate/{id}" -->
|
|
1963
2152
|
```typescript
|
|
1964
2153
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1965
2154
|
|
|
@@ -2038,6 +2227,7 @@ Retrieve a transaction
|
|
|
2038
2227
|
|
|
2039
2228
|
### Example Usage
|
|
2040
2229
|
|
|
2230
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingTransaction" method="get" path="/accounting/{connection_id}/transaction/{id}" -->
|
|
2041
2231
|
```typescript
|
|
2042
2232
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2043
2233
|
|
|
@@ -2116,6 +2306,7 @@ Retrieve a trialbalance
|
|
|
2116
2306
|
|
|
2117
2307
|
### Example Usage
|
|
2118
2308
|
|
|
2309
|
+
<!-- UsageSnippet language="typescript" operationID="getAccountingTrialbalance" method="get" path="/accounting/{connection_id}/trialbalance/{id}" -->
|
|
2119
2310
|
```typescript
|
|
2120
2311
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2121
2312
|
|
|
@@ -2194,6 +2385,7 @@ List all accounts
|
|
|
2194
2385
|
|
|
2195
2386
|
### Example Usage
|
|
2196
2387
|
|
|
2388
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingAccounts" method="get" path="/accounting/{connection_id}/account" -->
|
|
2197
2389
|
```typescript
|
|
2198
2390
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2199
2391
|
|
|
@@ -2270,6 +2462,7 @@ List all balancesheets
|
|
|
2270
2462
|
|
|
2271
2463
|
### Example Usage
|
|
2272
2464
|
|
|
2465
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingBalancesheets" method="get" path="/accounting/{connection_id}/balancesheet" -->
|
|
2273
2466
|
```typescript
|
|
2274
2467
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2275
2468
|
|
|
@@ -2346,6 +2539,7 @@ List all bills
|
|
|
2346
2539
|
|
|
2347
2540
|
### Example Usage
|
|
2348
2541
|
|
|
2542
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingBills" method="get" path="/accounting/{connection_id}/bill" -->
|
|
2349
2543
|
```typescript
|
|
2350
2544
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2351
2545
|
|
|
@@ -2416,12 +2610,90 @@ run();
|
|
|
2416
2610
|
| --------------- | --------------- | --------------- |
|
|
2417
2611
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2418
2612
|
|
|
2613
|
+
## listAccountingCategories
|
|
2614
|
+
|
|
2615
|
+
List all categories
|
|
2616
|
+
|
|
2617
|
+
### Example Usage
|
|
2618
|
+
|
|
2619
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingCategories" method="get" path="/accounting/{connection_id}/category" -->
|
|
2620
|
+
```typescript
|
|
2621
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2622
|
+
|
|
2623
|
+
const unifiedTo = new UnifiedTo({
|
|
2624
|
+
security: {
|
|
2625
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2626
|
+
},
|
|
2627
|
+
});
|
|
2628
|
+
|
|
2629
|
+
async function run() {
|
|
2630
|
+
const result = await unifiedTo.accounting.listAccountingCategories({
|
|
2631
|
+
connectionId: "<id>",
|
|
2632
|
+
});
|
|
2633
|
+
|
|
2634
|
+
console.log(result);
|
|
2635
|
+
}
|
|
2636
|
+
|
|
2637
|
+
run();
|
|
2638
|
+
```
|
|
2639
|
+
|
|
2640
|
+
### Standalone function
|
|
2641
|
+
|
|
2642
|
+
The standalone function version of this method:
|
|
2643
|
+
|
|
2644
|
+
```typescript
|
|
2645
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2646
|
+
import { accountingListAccountingCategories } from "@unified-api/typescript-sdk/funcs/accountingListAccountingCategories.js";
|
|
2647
|
+
|
|
2648
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2649
|
+
// You can create one instance of it to use across an application.
|
|
2650
|
+
const unifiedTo = new UnifiedToCore({
|
|
2651
|
+
security: {
|
|
2652
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2653
|
+
},
|
|
2654
|
+
});
|
|
2655
|
+
|
|
2656
|
+
async function run() {
|
|
2657
|
+
const res = await accountingListAccountingCategories(unifiedTo, {
|
|
2658
|
+
connectionId: "<id>",
|
|
2659
|
+
});
|
|
2660
|
+
if (res.ok) {
|
|
2661
|
+
const { value: result } = res;
|
|
2662
|
+
console.log(result);
|
|
2663
|
+
} else {
|
|
2664
|
+
console.log("accountingListAccountingCategories failed:", res.error);
|
|
2665
|
+
}
|
|
2666
|
+
}
|
|
2667
|
+
|
|
2668
|
+
run();
|
|
2669
|
+
```
|
|
2670
|
+
|
|
2671
|
+
### Parameters
|
|
2672
|
+
|
|
2673
|
+
| Parameter | Type | Required | Description |
|
|
2674
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2675
|
+
| `request` | [operations.ListAccountingCategoriesRequest](../../sdk/models/operations/listaccountingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2676
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2677
|
+
| `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. |
|
|
2678
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2679
|
+
|
|
2680
|
+
### Response
|
|
2681
|
+
|
|
2682
|
+
**Promise\<[shared.AccountingCategory[]](../../models/.md)\>**
|
|
2683
|
+
|
|
2684
|
+
### Errors
|
|
2685
|
+
|
|
2686
|
+
| Error Type | Status Code | Content Type |
|
|
2687
|
+
| --------------- | --------------- | --------------- |
|
|
2688
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2689
|
+
|
|
2419
2690
|
## listAccountingContacts
|
|
2420
2691
|
|
|
2421
2692
|
List all contacts
|
|
2422
2693
|
|
|
2423
2694
|
### Example Usage
|
|
2424
2695
|
|
|
2696
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingContacts" method="get" path="/accounting/{connection_id}/contact" -->
|
|
2425
2697
|
```typescript
|
|
2426
2698
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2427
2699
|
|
|
@@ -2498,6 +2770,7 @@ List all creditmemoes
|
|
|
2498
2770
|
|
|
2499
2771
|
### Example Usage
|
|
2500
2772
|
|
|
2773
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingCreditmemoes" method="get" path="/accounting/{connection_id}/creditmemo" -->
|
|
2501
2774
|
```typescript
|
|
2502
2775
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2503
2776
|
|
|
@@ -2574,6 +2847,7 @@ List all invoices
|
|
|
2574
2847
|
|
|
2575
2848
|
### Example Usage
|
|
2576
2849
|
|
|
2850
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingInvoices" method="get" path="/accounting/{connection_id}/invoice" -->
|
|
2577
2851
|
```typescript
|
|
2578
2852
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2579
2853
|
|
|
@@ -2650,6 +2924,7 @@ List all journals
|
|
|
2650
2924
|
|
|
2651
2925
|
### Example Usage
|
|
2652
2926
|
|
|
2927
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingJournals" method="get" path="/accounting/{connection_id}/journal" -->
|
|
2653
2928
|
```typescript
|
|
2654
2929
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2655
2930
|
|
|
@@ -2726,6 +3001,7 @@ List all orders
|
|
|
2726
3001
|
|
|
2727
3002
|
### Example Usage
|
|
2728
3003
|
|
|
3004
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingOrders" method="get" path="/accounting/{connection_id}/order" -->
|
|
2729
3005
|
```typescript
|
|
2730
3006
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2731
3007
|
|
|
@@ -2802,6 +3078,7 @@ List all organizations
|
|
|
2802
3078
|
|
|
2803
3079
|
### Example Usage
|
|
2804
3080
|
|
|
3081
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingOrganizations" method="get" path="/accounting/{connection_id}/organization" -->
|
|
2805
3082
|
```typescript
|
|
2806
3083
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2807
3084
|
|
|
@@ -2878,6 +3155,7 @@ List all profitlosses
|
|
|
2878
3155
|
|
|
2879
3156
|
### Example Usage
|
|
2880
3157
|
|
|
3158
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingProfitlosses" method="get" path="/accounting/{connection_id}/profitloss" -->
|
|
2881
3159
|
```typescript
|
|
2882
3160
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2883
3161
|
|
|
@@ -2954,6 +3232,7 @@ List all purchaseorders
|
|
|
2954
3232
|
|
|
2955
3233
|
### Example Usage
|
|
2956
3234
|
|
|
3235
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingPurchaseorders" method="get" path="/accounting/{connection_id}/purchaseorder" -->
|
|
2957
3236
|
```typescript
|
|
2958
3237
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2959
3238
|
|
|
@@ -3030,6 +3309,7 @@ List all reports
|
|
|
3030
3309
|
|
|
3031
3310
|
### Example Usage
|
|
3032
3311
|
|
|
3312
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingReports" method="get" path="/accounting/{connection_id}/report" -->
|
|
3033
3313
|
```typescript
|
|
3034
3314
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3035
3315
|
|
|
@@ -3106,6 +3386,7 @@ List all salesorders
|
|
|
3106
3386
|
|
|
3107
3387
|
### Example Usage
|
|
3108
3388
|
|
|
3389
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingSalesorders" method="get" path="/accounting/{connection_id}/salesorder" -->
|
|
3109
3390
|
```typescript
|
|
3110
3391
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3111
3392
|
|
|
@@ -3182,6 +3463,7 @@ List all taxrates
|
|
|
3182
3463
|
|
|
3183
3464
|
### Example Usage
|
|
3184
3465
|
|
|
3466
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingTaxrates" method="get" path="/accounting/{connection_id}/taxrate" -->
|
|
3185
3467
|
```typescript
|
|
3186
3468
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3187
3469
|
|
|
@@ -3258,6 +3540,7 @@ List all transactions
|
|
|
3258
3540
|
|
|
3259
3541
|
### Example Usage
|
|
3260
3542
|
|
|
3543
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingTransactions" method="get" path="/accounting/{connection_id}/transaction" -->
|
|
3261
3544
|
```typescript
|
|
3262
3545
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3263
3546
|
|
|
@@ -3334,6 +3617,7 @@ List all trialbalances
|
|
|
3334
3617
|
|
|
3335
3618
|
### Example Usage
|
|
3336
3619
|
|
|
3620
|
+
<!-- UsageSnippet language="typescript" operationID="listAccountingTrialbalances" method="get" path="/accounting/{connection_id}/trialbalance" -->
|
|
3337
3621
|
```typescript
|
|
3338
3622
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3339
3623
|
|
|
@@ -3410,6 +3694,7 @@ Update an account
|
|
|
3410
3694
|
|
|
3411
3695
|
### Example Usage
|
|
3412
3696
|
|
|
3697
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingAccount" method="patch" path="/accounting/{connection_id}/account/{id}" -->
|
|
3413
3698
|
```typescript
|
|
3414
3699
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3415
3700
|
|
|
@@ -3490,6 +3775,7 @@ Update a bill
|
|
|
3490
3775
|
|
|
3491
3776
|
### Example Usage
|
|
3492
3777
|
|
|
3778
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingBill" method="patch" path="/accounting/{connection_id}/bill/{id}" -->
|
|
3493
3779
|
```typescript
|
|
3494
3780
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3495
3781
|
|
|
@@ -3564,12 +3850,94 @@ run();
|
|
|
3564
3850
|
| --------------- | --------------- | --------------- |
|
|
3565
3851
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3566
3852
|
|
|
3853
|
+
## patchAccountingCategory
|
|
3854
|
+
|
|
3855
|
+
Update a category
|
|
3856
|
+
|
|
3857
|
+
### Example Usage
|
|
3858
|
+
|
|
3859
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingCategory" method="patch" path="/accounting/{connection_id}/category/{id}" -->
|
|
3860
|
+
```typescript
|
|
3861
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3862
|
+
|
|
3863
|
+
const unifiedTo = new UnifiedTo({
|
|
3864
|
+
security: {
|
|
3865
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3866
|
+
},
|
|
3867
|
+
});
|
|
3868
|
+
|
|
3869
|
+
async function run() {
|
|
3870
|
+
const result = await unifiedTo.accounting.patchAccountingCategory({
|
|
3871
|
+
accountingCategory: {},
|
|
3872
|
+
connectionId: "<id>",
|
|
3873
|
+
id: "<id>",
|
|
3874
|
+
});
|
|
3875
|
+
|
|
3876
|
+
console.log(result);
|
|
3877
|
+
}
|
|
3878
|
+
|
|
3879
|
+
run();
|
|
3880
|
+
```
|
|
3881
|
+
|
|
3882
|
+
### Standalone function
|
|
3883
|
+
|
|
3884
|
+
The standalone function version of this method:
|
|
3885
|
+
|
|
3886
|
+
```typescript
|
|
3887
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
3888
|
+
import { accountingPatchAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingCategory.js";
|
|
3889
|
+
|
|
3890
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
3891
|
+
// You can create one instance of it to use across an application.
|
|
3892
|
+
const unifiedTo = new UnifiedToCore({
|
|
3893
|
+
security: {
|
|
3894
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
3895
|
+
},
|
|
3896
|
+
});
|
|
3897
|
+
|
|
3898
|
+
async function run() {
|
|
3899
|
+
const res = await accountingPatchAccountingCategory(unifiedTo, {
|
|
3900
|
+
accountingCategory: {},
|
|
3901
|
+
connectionId: "<id>",
|
|
3902
|
+
id: "<id>",
|
|
3903
|
+
});
|
|
3904
|
+
if (res.ok) {
|
|
3905
|
+
const { value: result } = res;
|
|
3906
|
+
console.log(result);
|
|
3907
|
+
} else {
|
|
3908
|
+
console.log("accountingPatchAccountingCategory failed:", res.error);
|
|
3909
|
+
}
|
|
3910
|
+
}
|
|
3911
|
+
|
|
3912
|
+
run();
|
|
3913
|
+
```
|
|
3914
|
+
|
|
3915
|
+
### Parameters
|
|
3916
|
+
|
|
3917
|
+
| Parameter | Type | Required | Description |
|
|
3918
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3919
|
+
| `request` | [operations.PatchAccountingCategoryRequest](../../sdk/models/operations/patchaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
3920
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
3921
|
+
| `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. |
|
|
3922
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
3923
|
+
|
|
3924
|
+
### Response
|
|
3925
|
+
|
|
3926
|
+
**Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
|
|
3927
|
+
|
|
3928
|
+
### Errors
|
|
3929
|
+
|
|
3930
|
+
| Error Type | Status Code | Content Type |
|
|
3931
|
+
| --------------- | --------------- | --------------- |
|
|
3932
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
3933
|
+
|
|
3567
3934
|
## patchAccountingContact
|
|
3568
3935
|
|
|
3569
3936
|
Update a contact
|
|
3570
3937
|
|
|
3571
3938
|
### Example Usage
|
|
3572
3939
|
|
|
3940
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingContact" method="patch" path="/accounting/{connection_id}/contact/{id}" -->
|
|
3573
3941
|
```typescript
|
|
3574
3942
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3575
3943
|
|
|
@@ -3650,6 +4018,7 @@ Update a creditmemo
|
|
|
3650
4018
|
|
|
3651
4019
|
### Example Usage
|
|
3652
4020
|
|
|
4021
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingCreditmemo" method="patch" path="/accounting/{connection_id}/creditmemo/{id}" -->
|
|
3653
4022
|
```typescript
|
|
3654
4023
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3655
4024
|
|
|
@@ -3730,6 +4099,7 @@ Update an invoice
|
|
|
3730
4099
|
|
|
3731
4100
|
### Example Usage
|
|
3732
4101
|
|
|
4102
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingInvoice" method="patch" path="/accounting/{connection_id}/invoice/{id}" -->
|
|
3733
4103
|
```typescript
|
|
3734
4104
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3735
4105
|
|
|
@@ -3810,6 +4180,7 @@ Update a journal
|
|
|
3810
4180
|
|
|
3811
4181
|
### Example Usage
|
|
3812
4182
|
|
|
4183
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingJournal" method="patch" path="/accounting/{connection_id}/journal/{id}" -->
|
|
3813
4184
|
```typescript
|
|
3814
4185
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3815
4186
|
|
|
@@ -3890,6 +4261,7 @@ Update an order
|
|
|
3890
4261
|
|
|
3891
4262
|
### Example Usage
|
|
3892
4263
|
|
|
4264
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingOrder" method="patch" path="/accounting/{connection_id}/order/{id}" -->
|
|
3893
4265
|
```typescript
|
|
3894
4266
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3895
4267
|
|
|
@@ -3970,6 +4342,7 @@ Update a purchaseorder
|
|
|
3970
4342
|
|
|
3971
4343
|
### Example Usage
|
|
3972
4344
|
|
|
4345
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingPurchaseorder" method="patch" path="/accounting/{connection_id}/purchaseorder/{id}" -->
|
|
3973
4346
|
```typescript
|
|
3974
4347
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
3975
4348
|
|
|
@@ -4050,6 +4423,7 @@ Update a salesorder
|
|
|
4050
4423
|
|
|
4051
4424
|
### Example Usage
|
|
4052
4425
|
|
|
4426
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingSalesorder" method="patch" path="/accounting/{connection_id}/salesorder/{id}" -->
|
|
4053
4427
|
```typescript
|
|
4054
4428
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4055
4429
|
|
|
@@ -4130,6 +4504,7 @@ Update a taxrate
|
|
|
4130
4504
|
|
|
4131
4505
|
### Example Usage
|
|
4132
4506
|
|
|
4507
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingTaxrate" method="patch" path="/accounting/{connection_id}/taxrate/{id}" -->
|
|
4133
4508
|
```typescript
|
|
4134
4509
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4135
4510
|
|
|
@@ -4210,6 +4585,7 @@ Update a transaction
|
|
|
4210
4585
|
|
|
4211
4586
|
### Example Usage
|
|
4212
4587
|
|
|
4588
|
+
<!-- UsageSnippet language="typescript" operationID="patchAccountingTransaction" method="patch" path="/accounting/{connection_id}/transaction/{id}" -->
|
|
4213
4589
|
```typescript
|
|
4214
4590
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4215
4591
|
|
|
@@ -4290,6 +4666,7 @@ Remove an account
|
|
|
4290
4666
|
|
|
4291
4667
|
### Example Usage
|
|
4292
4668
|
|
|
4669
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingAccount" method="delete" path="/accounting/{connection_id}/account/{id}" -->
|
|
4293
4670
|
```typescript
|
|
4294
4671
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4295
4672
|
|
|
@@ -4368,6 +4745,7 @@ Remove a bill
|
|
|
4368
4745
|
|
|
4369
4746
|
### Example Usage
|
|
4370
4747
|
|
|
4748
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingBill" method="delete" path="/accounting/{connection_id}/bill/{id}" -->
|
|
4371
4749
|
```typescript
|
|
4372
4750
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4373
4751
|
|
|
@@ -4440,12 +4818,92 @@ run();
|
|
|
4440
4818
|
| --------------- | --------------- | --------------- |
|
|
4441
4819
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
4442
4820
|
|
|
4821
|
+
## removeAccountingCategory
|
|
4822
|
+
|
|
4823
|
+
Remove a category
|
|
4824
|
+
|
|
4825
|
+
### Example Usage
|
|
4826
|
+
|
|
4827
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingCategory" method="delete" path="/accounting/{connection_id}/category/{id}" -->
|
|
4828
|
+
```typescript
|
|
4829
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4830
|
+
|
|
4831
|
+
const unifiedTo = new UnifiedTo({
|
|
4832
|
+
security: {
|
|
4833
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
4834
|
+
},
|
|
4835
|
+
});
|
|
4836
|
+
|
|
4837
|
+
async function run() {
|
|
4838
|
+
const result = await unifiedTo.accounting.removeAccountingCategory({
|
|
4839
|
+
connectionId: "<id>",
|
|
4840
|
+
id: "<id>",
|
|
4841
|
+
});
|
|
4842
|
+
|
|
4843
|
+
console.log(result);
|
|
4844
|
+
}
|
|
4845
|
+
|
|
4846
|
+
run();
|
|
4847
|
+
```
|
|
4848
|
+
|
|
4849
|
+
### Standalone function
|
|
4850
|
+
|
|
4851
|
+
The standalone function version of this method:
|
|
4852
|
+
|
|
4853
|
+
```typescript
|
|
4854
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
4855
|
+
import { accountingRemoveAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingCategory.js";
|
|
4856
|
+
|
|
4857
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
4858
|
+
// You can create one instance of it to use across an application.
|
|
4859
|
+
const unifiedTo = new UnifiedToCore({
|
|
4860
|
+
security: {
|
|
4861
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
4862
|
+
},
|
|
4863
|
+
});
|
|
4864
|
+
|
|
4865
|
+
async function run() {
|
|
4866
|
+
const res = await accountingRemoveAccountingCategory(unifiedTo, {
|
|
4867
|
+
connectionId: "<id>",
|
|
4868
|
+
id: "<id>",
|
|
4869
|
+
});
|
|
4870
|
+
if (res.ok) {
|
|
4871
|
+
const { value: result } = res;
|
|
4872
|
+
console.log(result);
|
|
4873
|
+
} else {
|
|
4874
|
+
console.log("accountingRemoveAccountingCategory failed:", res.error);
|
|
4875
|
+
}
|
|
4876
|
+
}
|
|
4877
|
+
|
|
4878
|
+
run();
|
|
4879
|
+
```
|
|
4880
|
+
|
|
4881
|
+
### Parameters
|
|
4882
|
+
|
|
4883
|
+
| Parameter | Type | Required | Description |
|
|
4884
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
4885
|
+
| `request` | [operations.RemoveAccountingCategoryRequest](../../sdk/models/operations/removeaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
4886
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
4887
|
+
| `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. |
|
|
4888
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
4889
|
+
|
|
4890
|
+
### Response
|
|
4891
|
+
|
|
4892
|
+
**Promise\<[operations.RemoveAccountingCategoryResponse](../../sdk/models/operations/removeaccountingcategoryresponse.md)\>**
|
|
4893
|
+
|
|
4894
|
+
### Errors
|
|
4895
|
+
|
|
4896
|
+
| Error Type | Status Code | Content Type |
|
|
4897
|
+
| --------------- | --------------- | --------------- |
|
|
4898
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
4899
|
+
|
|
4443
4900
|
## removeAccountingContact
|
|
4444
4901
|
|
|
4445
4902
|
Remove a contact
|
|
4446
4903
|
|
|
4447
4904
|
### Example Usage
|
|
4448
4905
|
|
|
4906
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingContact" method="delete" path="/accounting/{connection_id}/contact/{id}" -->
|
|
4449
4907
|
```typescript
|
|
4450
4908
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4451
4909
|
|
|
@@ -4524,6 +4982,7 @@ Remove a creditmemo
|
|
|
4524
4982
|
|
|
4525
4983
|
### Example Usage
|
|
4526
4984
|
|
|
4985
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingCreditmemo" method="delete" path="/accounting/{connection_id}/creditmemo/{id}" -->
|
|
4527
4986
|
```typescript
|
|
4528
4987
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4529
4988
|
|
|
@@ -4602,6 +5061,7 @@ Remove an invoice
|
|
|
4602
5061
|
|
|
4603
5062
|
### Example Usage
|
|
4604
5063
|
|
|
5064
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingInvoice" method="delete" path="/accounting/{connection_id}/invoice/{id}" -->
|
|
4605
5065
|
```typescript
|
|
4606
5066
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4607
5067
|
|
|
@@ -4680,6 +5140,7 @@ Remove a journal
|
|
|
4680
5140
|
|
|
4681
5141
|
### Example Usage
|
|
4682
5142
|
|
|
5143
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingJournal" method="delete" path="/accounting/{connection_id}/journal/{id}" -->
|
|
4683
5144
|
```typescript
|
|
4684
5145
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4685
5146
|
|
|
@@ -4758,6 +5219,7 @@ Remove an order
|
|
|
4758
5219
|
|
|
4759
5220
|
### Example Usage
|
|
4760
5221
|
|
|
5222
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingOrder" method="delete" path="/accounting/{connection_id}/order/{id}" -->
|
|
4761
5223
|
```typescript
|
|
4762
5224
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4763
5225
|
|
|
@@ -4836,6 +5298,7 @@ Remove a purchaseorder
|
|
|
4836
5298
|
|
|
4837
5299
|
### Example Usage
|
|
4838
5300
|
|
|
5301
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingPurchaseorder" method="delete" path="/accounting/{connection_id}/purchaseorder/{id}" -->
|
|
4839
5302
|
```typescript
|
|
4840
5303
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4841
5304
|
|
|
@@ -4914,6 +5377,7 @@ Remove a salesorder
|
|
|
4914
5377
|
|
|
4915
5378
|
### Example Usage
|
|
4916
5379
|
|
|
5380
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingSalesorder" method="delete" path="/accounting/{connection_id}/salesorder/{id}" -->
|
|
4917
5381
|
```typescript
|
|
4918
5382
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4919
5383
|
|
|
@@ -4992,6 +5456,7 @@ Remove a taxrate
|
|
|
4992
5456
|
|
|
4993
5457
|
### Example Usage
|
|
4994
5458
|
|
|
5459
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingTaxrate" method="delete" path="/accounting/{connection_id}/taxrate/{id}" -->
|
|
4995
5460
|
```typescript
|
|
4996
5461
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
4997
5462
|
|
|
@@ -5070,6 +5535,7 @@ Remove a transaction
|
|
|
5070
5535
|
|
|
5071
5536
|
### Example Usage
|
|
5072
5537
|
|
|
5538
|
+
<!-- UsageSnippet language="typescript" operationID="removeAccountingTransaction" method="delete" path="/accounting/{connection_id}/transaction/{id}" -->
|
|
5073
5539
|
```typescript
|
|
5074
5540
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5075
5541
|
|
|
@@ -5148,6 +5614,7 @@ Update an account
|
|
|
5148
5614
|
|
|
5149
5615
|
### Example Usage
|
|
5150
5616
|
|
|
5617
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingAccount" method="put" path="/accounting/{connection_id}/account/{id}" -->
|
|
5151
5618
|
```typescript
|
|
5152
5619
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5153
5620
|
|
|
@@ -5228,6 +5695,7 @@ Update a bill
|
|
|
5228
5695
|
|
|
5229
5696
|
### Example Usage
|
|
5230
5697
|
|
|
5698
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingBill" method="put" path="/accounting/{connection_id}/bill/{id}" -->
|
|
5231
5699
|
```typescript
|
|
5232
5700
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5233
5701
|
|
|
@@ -5302,12 +5770,94 @@ run();
|
|
|
5302
5770
|
| --------------- | --------------- | --------------- |
|
|
5303
5771
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
5304
5772
|
|
|
5773
|
+
## updateAccountingCategory
|
|
5774
|
+
|
|
5775
|
+
Update a category
|
|
5776
|
+
|
|
5777
|
+
### Example Usage
|
|
5778
|
+
|
|
5779
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingCategory" method="put" path="/accounting/{connection_id}/category/{id}" -->
|
|
5780
|
+
```typescript
|
|
5781
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5782
|
+
|
|
5783
|
+
const unifiedTo = new UnifiedTo({
|
|
5784
|
+
security: {
|
|
5785
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
5786
|
+
},
|
|
5787
|
+
});
|
|
5788
|
+
|
|
5789
|
+
async function run() {
|
|
5790
|
+
const result = await unifiedTo.accounting.updateAccountingCategory({
|
|
5791
|
+
accountingCategory: {},
|
|
5792
|
+
connectionId: "<id>",
|
|
5793
|
+
id: "<id>",
|
|
5794
|
+
});
|
|
5795
|
+
|
|
5796
|
+
console.log(result);
|
|
5797
|
+
}
|
|
5798
|
+
|
|
5799
|
+
run();
|
|
5800
|
+
```
|
|
5801
|
+
|
|
5802
|
+
### Standalone function
|
|
5803
|
+
|
|
5804
|
+
The standalone function version of this method:
|
|
5805
|
+
|
|
5806
|
+
```typescript
|
|
5807
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
5808
|
+
import { accountingUpdateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingCategory.js";
|
|
5809
|
+
|
|
5810
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
5811
|
+
// You can create one instance of it to use across an application.
|
|
5812
|
+
const unifiedTo = new UnifiedToCore({
|
|
5813
|
+
security: {
|
|
5814
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
5815
|
+
},
|
|
5816
|
+
});
|
|
5817
|
+
|
|
5818
|
+
async function run() {
|
|
5819
|
+
const res = await accountingUpdateAccountingCategory(unifiedTo, {
|
|
5820
|
+
accountingCategory: {},
|
|
5821
|
+
connectionId: "<id>",
|
|
5822
|
+
id: "<id>",
|
|
5823
|
+
});
|
|
5824
|
+
if (res.ok) {
|
|
5825
|
+
const { value: result } = res;
|
|
5826
|
+
console.log(result);
|
|
5827
|
+
} else {
|
|
5828
|
+
console.log("accountingUpdateAccountingCategory failed:", res.error);
|
|
5829
|
+
}
|
|
5830
|
+
}
|
|
5831
|
+
|
|
5832
|
+
run();
|
|
5833
|
+
```
|
|
5834
|
+
|
|
5835
|
+
### Parameters
|
|
5836
|
+
|
|
5837
|
+
| Parameter | Type | Required | Description |
|
|
5838
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5839
|
+
| `request` | [operations.UpdateAccountingCategoryRequest](../../sdk/models/operations/updateaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
5840
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
5841
|
+
| `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. |
|
|
5842
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
5843
|
+
|
|
5844
|
+
### Response
|
|
5845
|
+
|
|
5846
|
+
**Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
|
|
5847
|
+
|
|
5848
|
+
### Errors
|
|
5849
|
+
|
|
5850
|
+
| Error Type | Status Code | Content Type |
|
|
5851
|
+
| --------------- | --------------- | --------------- |
|
|
5852
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
5853
|
+
|
|
5305
5854
|
## updateAccountingContact
|
|
5306
5855
|
|
|
5307
5856
|
Update a contact
|
|
5308
5857
|
|
|
5309
5858
|
### Example Usage
|
|
5310
5859
|
|
|
5860
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingContact" method="put" path="/accounting/{connection_id}/contact/{id}" -->
|
|
5311
5861
|
```typescript
|
|
5312
5862
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5313
5863
|
|
|
@@ -5388,6 +5938,7 @@ Update a creditmemo
|
|
|
5388
5938
|
|
|
5389
5939
|
### Example Usage
|
|
5390
5940
|
|
|
5941
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingCreditmemo" method="put" path="/accounting/{connection_id}/creditmemo/{id}" -->
|
|
5391
5942
|
```typescript
|
|
5392
5943
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5393
5944
|
|
|
@@ -5468,6 +6019,7 @@ Update an invoice
|
|
|
5468
6019
|
|
|
5469
6020
|
### Example Usage
|
|
5470
6021
|
|
|
6022
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingInvoice" method="put" path="/accounting/{connection_id}/invoice/{id}" -->
|
|
5471
6023
|
```typescript
|
|
5472
6024
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5473
6025
|
|
|
@@ -5548,6 +6100,7 @@ Update a journal
|
|
|
5548
6100
|
|
|
5549
6101
|
### Example Usage
|
|
5550
6102
|
|
|
6103
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingJournal" method="put" path="/accounting/{connection_id}/journal/{id}" -->
|
|
5551
6104
|
```typescript
|
|
5552
6105
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5553
6106
|
|
|
@@ -5628,6 +6181,7 @@ Update an order
|
|
|
5628
6181
|
|
|
5629
6182
|
### Example Usage
|
|
5630
6183
|
|
|
6184
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingOrder" method="put" path="/accounting/{connection_id}/order/{id}" -->
|
|
5631
6185
|
```typescript
|
|
5632
6186
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5633
6187
|
|
|
@@ -5708,6 +6262,7 @@ Update a purchaseorder
|
|
|
5708
6262
|
|
|
5709
6263
|
### Example Usage
|
|
5710
6264
|
|
|
6265
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingPurchaseorder" method="put" path="/accounting/{connection_id}/purchaseorder/{id}" -->
|
|
5711
6266
|
```typescript
|
|
5712
6267
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5713
6268
|
|
|
@@ -5788,6 +6343,7 @@ Update a salesorder
|
|
|
5788
6343
|
|
|
5789
6344
|
### Example Usage
|
|
5790
6345
|
|
|
6346
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingSalesorder" method="put" path="/accounting/{connection_id}/salesorder/{id}" -->
|
|
5791
6347
|
```typescript
|
|
5792
6348
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5793
6349
|
|
|
@@ -5868,6 +6424,7 @@ Update a taxrate
|
|
|
5868
6424
|
|
|
5869
6425
|
### Example Usage
|
|
5870
6426
|
|
|
6427
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingTaxrate" method="put" path="/accounting/{connection_id}/taxrate/{id}" -->
|
|
5871
6428
|
```typescript
|
|
5872
6429
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5873
6430
|
|
|
@@ -5948,6 +6505,7 @@ Update a transaction
|
|
|
5948
6505
|
|
|
5949
6506
|
### Example Usage
|
|
5950
6507
|
|
|
6508
|
+
<!-- UsageSnippet language="typescript" operationID="updateAccountingTransaction" method="put" path="/accounting/{connection_id}/transaction/{id}" -->
|
|
5951
6509
|
```typescript
|
|
5952
6510
|
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
5953
6511
|
|