From 92089d8771361a11a2f1f20baf1f0feb5512064b Mon Sep 17 00:00:00 2001
From: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Date: Thu, 8 May 2025 16:21:28 +0000
Subject: [PATCH] SDK regeneration
---
package.json | 2 +-
reference.md | 3519 -----------------
.../resources/accessTokens/client/Client.ts | 8 +-
.../resources/connections/client/Client.ts | 20 +-
.../resources/ledgerAccounts/client/Client.ts | 8 +-
.../resources/payables/client/Client.ts | 8 +-
.../resources/receivables/client/Client.ts | 8 +-
.../resources/syncedRecords/client/Client.ts | 12 +-
.../resources/taxRates/client/Client.ts | 8 +-
src/api/resources/analytics/client/Client.ts | 12 +-
.../approvalPolicies/client/Client.ts | 20 +-
.../resources/processes/client/Client.ts | 16 +-
.../approvalRequests/client/Client.ts | 24 +-
src/api/resources/comments/client/Client.ts | 20 +-
.../client/Client.ts | 20 +-
.../resources/counterparts/client/Client.ts | 28 +-
.../resources/addresses/client/Client.ts | 20 +-
.../resources/bankAccounts/client/Client.ts | 24 +-
.../resources/contacts/client/Client.ts | 24 +-
.../resources/vatIds/client/Client.ts | 20 +-
.../resources/creditNotes/client/Client.ts | 84 +-
.../resources/dataExports/client/Client.ts | 16 +-
.../resources/extraData/client/Client.ts | 20 +-
.../resources/deliveryNotes/client/Client.ts | 28 +-
.../eInvoicingConnections/client/Client.ts | 20 +-
src/api/resources/entities/client/Client.ts | 64 +-
.../resources/bankAccounts/client/Client.ts | 24 +-
.../resources/onboardingData/client/Client.ts | 8 +-
.../resources/paymentMethods/client/Client.ts | 8 +-
.../resources/persons/client/Client.ts | 24 +-
.../resources/vatIds/client/Client.ts | 20 +-
.../resources/entityUsers/client/Client.ts | 40 +-
src/api/resources/events/client/Client.ts | 8 +-
src/api/resources/files/client/Client.ts | 16 +-
src/api/resources/financing/client/Client.ts | 16 +-
.../resources/mailTemplates/client/Client.ts | 32 +-
.../resources/mailboxDomains/client/Client.ts | 16 +-
src/api/resources/mailboxes/client/Client.ts | 16 +-
.../resources/measureUnits/client/Client.ts | 20 +-
src/api/resources/ocr/client/Client.ts | 16 +-
.../overdueReminders/client/Client.ts | 20 +-
.../partnerSettings/client/Client.ts | 8 +-
src/api/resources/payables/client/Client.ts | 84 +-
.../resources/lineItems/client/Client.ts | 24 +-
.../resources/paymentIntents/client/Client.ts | 16 +-
.../resources/paymentLinks/client/Client.ts | 12 +-
.../resources/paymentRecords/client/Client.ts | 28 +-
.../paymentReminders/client/Client.ts | 20 +-
.../resources/paymentTerms/client/Client.ts | 20 +-
.../resources/pdfTemplates/client/Client.ts | 20 +-
src/api/resources/products/client/Client.ts | 20 +-
src/api/resources/projects/client/Client.ts | 20 +-
.../resources/purchaseOrders/client/Client.ts | 32 +-
.../resources/receivables/client/Client.ts | 100 +-
.../resources/recurrences/client/Client.ts | 20 +-
src/api/resources/roles/client/Client.ts | 20 +-
src/api/resources/tags/client/Client.ts | 20 +-
.../resources/textTemplates/client/Client.ts | 24 +-
src/api/resources/vatRates/client/Client.ts | 4 +-
.../webhookDeliveries/client/Client.ts | 4 +-
.../webhookSubscriptions/client/Client.ts | 32 +-
src/version.ts | 2 +-
62 files changed, 674 insertions(+), 4193 deletions(-)
diff --git a/package.json b/package.json
index b39fcca..2e5b0e5 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@monite/node-client",
- "version": "0.3.3",
+ "version": "0.3.4",
"private": false,
"repository": "https://github.com/team-monite/monite-node-client",
"license": "MIT",
diff --git a/reference.md b/reference.md
index da5fe71..3164b73 100644
--- a/reference.md
+++ b/reference.md
@@ -16226,3522 +16226,3 @@ await client.accounting.ledgerAccounts.getById("ledger_account_id");
## ApprovalPolicies Processes
-
-client.approvalPolicies.processes.get(approvalPolicyId) -> Monite.ApprovalProcessResourceList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve a list of all approval policy processes.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.approvalPolicies.processes.get("approval_policy_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**approvalPolicyId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Processes.RequestOptions`
-
-
-
-
-
-
-
-
-client.approvalPolicies.processes.getById(approvalPolicyId, processId) -> Monite.ProcessResource
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve a specific approval policy process.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.approvalPolicies.processes.getById("approval_policy_id", "process_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**approvalPolicyId:** `string`
-
-
-
-
-
--
-
-**processId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Processes.RequestOptions`
-
-
-
-
-
-
-
-
-client.approvalPolicies.processes.cancelById(approvalPolicyId, processId) -> Monite.ProcessResource
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Cancel an ongoing approval process for a specific approval policy.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.approvalPolicies.processes.cancelById("approval_policy_id", "process_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**approvalPolicyId:** `string`
-
-
-
-
-
--
-
-**processId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Processes.RequestOptions`
-
-
-
-
-
-
-
-
-client.approvalPolicies.processes.getSteps(approvalPolicyId, processId) -> Monite.ApprovalProcessStepResourceList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve a list of approval policy process steps.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.approvalPolicies.processes.getSteps("approval_policy_id", "process_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**approvalPolicyId:** `string`
-
-
-
-
-
--
-
-**processId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Processes.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.addresses.get(counterpartId) -> Monite.CounterpartAddressResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.addresses.get("counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Addresses.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.addresses.create(counterpartId, { ...params }) -> Monite.CounterpartAddressResponseWithCounterpartId
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.addresses.create("counterpart_id", {
- city: "Berlin",
- country: "AF",
- line1: "Flughafenstrasse 52",
- postal_code: "10115",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.CounterpartAddress`
-
-
-
-
-
--
-
-**requestOptions:** `Addresses.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.addresses.getById(addressId, counterpartId) -> Monite.CounterpartAddressResponseWithCounterpartId
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.addresses.getById("address_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**addressId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Addresses.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.addresses.deleteById(addressId, counterpartId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.addresses.deleteById("address_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**addressId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Addresses.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.addresses.updateById(addressId, counterpartId, { ...params }) -> Monite.CounterpartAddressResponseWithCounterpartId
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.addresses.updateById("address_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**addressId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.CounterpartUpdateAddress`
-
-
-
-
-
--
-
-**requestOptions:** `Addresses.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.get(counterpartId) -> Monite.CounterpartBankAccountResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.get("counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.create(counterpartId, { ...params }) -> Monite.CounterpartBankAccountResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.create("counterpart_id", {
- country: "AF",
- currency: "AED",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.CreateCounterpartBankAccount`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.getById(bankAccountId, counterpartId) -> Monite.CounterpartBankAccountResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.getById("bank_account_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.deleteById(bankAccountId, counterpartId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.deleteById("bank_account_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.updateById(bankAccountId, counterpartId, { ...params }) -> Monite.CounterpartBankAccountResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.updateById("bank_account_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.UpdateCounterpartBankAccount`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.bankAccounts.makeDefaultById(bankAccountId, counterpartId) -> unknown
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.bankAccounts.makeDefaultById("bank_account_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.get(counterpartId) -> Monite.CounterpartContactsResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.get("counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.create(counterpartId, { ...params }) -> Monite.CounterpartContactResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.create("counterpart_id", {
- address: {
- city: "Berlin",
- country: "AF",
- line1: "Flughafenstrasse 52",
- postal_code: "10115",
- },
- first_name: "Mary",
- last_name: "O'Brien",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.CreateCounterpartContactPayload`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.getById(contactId, counterpartId) -> Monite.CounterpartContactResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.getById("contact_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**contactId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.deleteById(contactId, counterpartId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.deleteById("contact_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**contactId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.updateById(contactId, counterpartId, { ...params }) -> Monite.CounterpartContactResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.updateById("contact_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**contactId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.UpdateCounterpartContactPayload`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.contacts.makeDefaultById(contactId, counterpartId) -> Monite.CounterpartContactResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.contacts.makeDefaultById("contact_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**contactId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.vatIds.get(counterpartId) -> Monite.CounterpartVatIdResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.vatIds.get("counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.vatIds.create(counterpartId, { ...params }) -> Monite.CounterpartVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.vatIds.create("counterpart_id", {
- value: "123456789",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.CounterpartVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.vatIds.getById(vatId, counterpartId) -> Monite.CounterpartVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.vatIds.getById("vat_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**vatId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.vatIds.deleteById(vatId, counterpartId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.vatIds.deleteById("vat_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**vatId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.counterparts.vatIds.updateById(vatId, counterpartId, { ...params }) -> Monite.CounterpartVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.counterparts.vatIds.updateById("vat_id", "counterpart_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**vatId:** `string`
-
-
-
-
-
--
-
-**counterpartId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.counterparts.CounterpartUpdateVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.dataExports.extraData.get({ ...params }) -> Monite.ExtraDataResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.dataExports.extraData.get();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.dataExports.ExtraDataGetRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ExtraData.RequestOptions`
-
-
-
-
-
-
-
-
-client.dataExports.extraData.create({ ...params }) -> Monite.ExtraDataResource
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.dataExports.extraData.create({
- field_name: "default_account_code",
- field_value: "field_value",
- object_id: "object_id",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.dataExports.ExtraDataCreateRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ExtraData.RequestOptions`
-
-
-
-
-
-
-
-
-client.dataExports.extraData.getById(extraDataId) -> Monite.ExtraDataResource
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.dataExports.extraData.getById("extra_data_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**extraDataId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `ExtraData.RequestOptions`
-
-
-
-
-
-
-
-
-client.dataExports.extraData.deleteById(extraDataId) -> Monite.ExtraDataResource
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.dataExports.extraData.deleteById("extra_data_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**extraDataId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `ExtraData.RequestOptions`
-
-
-
-
-
-
-
-
-client.dataExports.extraData.updateById(extraDataId, { ...params }) -> Monite.ExtraDataResource
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.dataExports.extraData.updateById("extra_data_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**extraDataId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.dataExports.ExtraDataUpdateRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ExtraData.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.get() -> Monite.EntityBankAccountPaginationResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all bank accounts of this entity.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.get();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.create({ ...params }) -> Monite.EntityBankAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Adds a new bank account for the specified entity.
-
-The minimum required fields are `currency` and `country`. Other required fields depend on the currency and country.
-
-Bank accounts in African countries can use any fields or combinations of fields.
-
-For other countries:
-
-- EUR accounts require `iban`.
-- GBP accounts require `account_holder_name`, `account_number`, and `sort_code`.
-- USD accounts require `account_holder_name`, `account_number`, and `routing_number`.
-- Accounts in other currencies require one of:
- - `iban`
- - `account_number` and `sort_code`
- - `account_number` and `routing_number`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.create({
- country: "AF",
- currency: "AED",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.entities.CreateEntityBankAccountRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.getById(bankAccountId) -> Monite.EntityBankAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve a bank account by its ID.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.getById("bank_account_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.deleteById(bankAccountId) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete the bank account specified by its ID.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.deleteById("bank_account_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.updateById(bankAccountId, { ...params }) -> Monite.EntityBankAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Change the specified fields with the provided values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.updateById("bank_account_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.UpdateEntityBankAccountRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.makeDefaultById(bankAccountId) -> Monite.EntityBankAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Set a bank account as the default for this entity per currency.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.makeDefaultById("bank_account_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.onboardingData.get(entityId) -> Monite.EntityOnboardingDataResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.onboardingData.get("entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `OnboardingData.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.onboardingData.update(entityId, { ...params }) -> Monite.EntityOnboardingDataResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.onboardingData.update("entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityOnboardingDataRequest`
-
-
-
-
-
--
-
-**requestOptions:** `OnboardingData.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.paymentMethods.get(entityId) -> Monite.OnboardingPaymentMethodsResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all enabled payment methods.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.paymentMethods.get("entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentMethods.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.paymentMethods.set(entityId, { ...params }) -> Monite.OnboardingPaymentMethodsResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Set which payment methods should be enabled.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.paymentMethods.set("entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EnabledPaymentMethods`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentMethods.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.get(entityId) -> Monite.EntityVatIdResourceList
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.get("entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.create(entityId, { ...params }) -> Monite.EntityVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.create("entity_id", {
- country: "AF",
- value: "123456789",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.getById(id, entityId) -> Monite.EntityVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.getById("id", "entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.deleteById(id, entityId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.deleteById("id", "entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.updateById(id, entityId, { ...params }) -> Monite.EntityVatIdResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.updateById("id", "entity_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityUpdateVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.get() -> Monite.PersonsResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.get();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.create({ ...params }) -> Monite.PersonResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.create({
- email: "email",
- first_name: "first_name",
- last_name: "last_name",
- relationship: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.entities.PersonRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.getById(personId) -> Monite.PersonResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.getById("person_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.deleteById(personId) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.deleteById("person_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.updateById(personId, { ...params }) -> Monite.PersonResponse
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.updateById("person_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.OptionalPersonRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.uploadOnboardingDocuments(personId, { ...params }) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Provide files for person onboarding verification
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.uploadOnboardingDocuments("person_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.PersonOnboardingDocumentsPayload`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.get(payableId, { ...params }) -> Monite.LineItemPaginationResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a list of all line items related to a specific payable.
-Related guide: [List all payable line items](https://docs.monite.com/accounts-payable/payables/line-items#list-all-line-items-of-a-payable)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.get("payable_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.payables.LineItemsGetRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.create(payableId, { ...params }) -> Monite.LineItemResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Add a new line item to a specific payable.
-
-The `subtotal` and `total` fields of line items are automatically calculated based on the `unit_price`,
-`quantity`, and `tax` fields, therefore, are read-only and appear only in the response schema. The field
-`ledger_account_id` is required **only** for account integration, otherwise, it is optional.
-
-Related guide: [Add line items to a payable](https://docs.monite.com/accounts-payable/payables/line-items#add-line-items-to-a-payable)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.create("payable_id", {});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.LineItemRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.replace(payableId, { ...params }) -> Monite.LineItemsReplaceResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Replaces the information of all line items of a specific payable.
-
-Related guide: [Replace all line items](https://docs.monite.com/accounts-payable/payables/line-items#replace-all-line-items)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.replace("payable_id", {
- data: [{}],
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.payables.LineItemsReplaceRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.getById(lineItemId, payableId) -> Monite.LineItemResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get information about a specific line item with a given ID.
-
-Related guide: [Retrieve a line item](https://docs.monite.com/accounts-payable/payables/line-items#retrieve-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.getById("line_item_id", "payable_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.deleteById(lineItemId, payableId) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete the line item with the given ID.
-
-Related guide: [Remove a line item](https://docs.monite.com/accounts-payable/payables/line-items#remove-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.deleteById("line_item_id", "payable_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.updateById(lineItemId, payableId, { ...params }) -> Monite.LineItemResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Edits the information of a specific line item.
-
-Related guide: [Update a line item](https://docs.monite.com/accounts-payable/payables/line-items#update-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.updateById("line_item_id", "payable_id", {});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.LineItemRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-