diff --git a/.fernignore b/.fernignore
new file mode 100644
index 0000000..084a8eb
--- /dev/null
+++ b/.fernignore
@@ -0,0 +1 @@
+# Specify files that shouldn't be modified by Fern
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..cf13c1c
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,30 @@
+name: ci
+
+on: [push]
+
+jobs:
+ compile:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v3
+
+ - name: Set up node
+ uses: actions/setup-node@v3
+
+ - name: Compile
+ run: yarn && yarn build
+
+ test:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v3
+
+ - name: Set up node
+ uses: actions/setup-node@v3
+
+ - name: Compile
+ run: yarn && yarn test
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..72271e0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+.DS_Store
+/dist
\ No newline at end of file
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..6db0876
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,9 @@
+node_modules
+src
+tests
+.gitignore
+.github
+.fernignore
+.prettierrc.yml
+tsconfig.json
+yarn.lock
\ No newline at end of file
diff --git a/.prettierrc.yml b/.prettierrc.yml
new file mode 100644
index 0000000..0c06786
--- /dev/null
+++ b/.prettierrc.yml
@@ -0,0 +1,2 @@
+tabWidth: 4
+printWidth: 120
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 76d0774..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Monite
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/README.md b/README.md
index 91e4447..05e720d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,149 @@
-# monite-node-client
\ No newline at end of file
+# Monite TypeScript Library
+
+[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fteam-monite%2Fmonite-node-client)
+[](https://www.npmjs.com/package/)
+
+The Monite TypeScript library provides convenient access to the Monite API from TypeScript.
+
+## Documentation
+
+API reference documentation is available [here](https://docs.monite.com/api).
+
+## Installation
+
+```sh
+npm i -s
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { MoniteClient } from "";
+
+const client = new MoniteClient({
+ token: "YOUR_TOKEN",
+ moniteVersion: "YOUR_MONITE_VERSION",
+ moniteEntityId: "YOUR_MONITE_ENTITY_ID",
+});
+await client.products.create({
+ name: "name",
+});
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Monite } from "Monite";
+
+const request: Monite.ApprovalPoliciesGetRequest = {
+ ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { MoniteError } from "Monite";
+
+try {
+ await client.products.create(...);
+} catch (err) {
+ if (err instanceof MoniteError) {
+ console.log(err.statusCode);
+ console.log(err.message);
+ console.log(err.body);
+ }
+}
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.products.create(..., {
+ maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.products.create(..., {
+ timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.products.create(..., {
+ abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { MoniteClient } from "Monite";
+
+const client = new MoniteClient({
+ ...
+ fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
diff --git a/jest.config.js b/jest.config.js
new file mode 100644
index 0000000..35d6e65
--- /dev/null
+++ b/jest.config.js
@@ -0,0 +1,5 @@
+/** @type {import('jest').Config} */
+module.exports = {
+ preset: "ts-jest",
+ testEnvironment: "node",
+};
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..ae0acf9
--- /dev/null
+++ b/package.json
@@ -0,0 +1,45 @@
+{
+ "name": "",
+ "version": "0.1.0",
+ "private": false,
+ "repository": "https://github.com/team-monite/monite-node-client",
+ "main": "./index.js",
+ "types": "./index.d.ts",
+ "scripts": {
+ "format": "prettier . --write --ignore-unknown",
+ "build": "tsc",
+ "prepack": "cp -rv dist/. .",
+ "test": "jest"
+ },
+ "dependencies": {
+ "url-join": "4.0.1",
+ "form-data": "^4.0.0",
+ "formdata-node": "^6.0.3",
+ "node-fetch": "2.7.0",
+ "qs": "6.11.2",
+ "readable-stream": "^4.5.2",
+ "js-base64": "3.7.2",
+ "form-data-encoder": "^4.0.2"
+ },
+ "devDependencies": {
+ "@types/url-join": "4.0.1",
+ "@types/qs": "6.9.8",
+ "@types/node-fetch": "2.6.9",
+ "@types/readable-stream": "^4.0.15",
+ "fetch-mock-jest": "^1.5.1",
+ "webpack": "^5.94.0",
+ "ts-loader": "^9.3.1",
+ "jest": "29.7.0",
+ "@types/jest": "29.5.5",
+ "ts-jest": "29.1.1",
+ "jest-environment-jsdom": "29.7.0",
+ "@types/node": "17.0.33",
+ "prettier": "2.7.1",
+ "typescript": "4.6.4"
+ },
+ "browser": {
+ "fs": false,
+ "os": false,
+ "path": false
+ }
+}
diff --git a/reference.md b/reference.md
new file mode 100644
index 0000000..9b3515f
--- /dev/null
+++ b/reference.md
@@ -0,0 +1,16997 @@
+# Reference
+
+## Approval policies
+
+client.approvalPolicies.get({ ...params }) -> Monite.ApprovalPolicyResourceList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve a list of all approval policies with pagination.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalPolicies.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ApprovalPoliciesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalPolicies.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalPolicies.create({ ...params }) -> Monite.ApprovalPolicyResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new approval policy.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalPolicies.create({
+ name: "name",
+ description: "description",
+ script: [true],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ApprovalPolicyCreate`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalPolicies.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalPolicies.getById(approvalPolicyId) -> Monite.ApprovalPolicyResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve a specific approval policy.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalPolicies.getById("approval_policy_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalPolicyId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalPolicies.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalPolicies.deleteById(approvalPolicyId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete an existing approval policy.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalPolicies.deleteById("approval_policy_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalPolicyId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalPolicies.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalPolicies.updateById(approvalPolicyId, { ...params }) -> Monite.ApprovalPolicyResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update an existing approval policy.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalPolicies.updateById("approval_policy_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalPolicyId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ApprovalPolicyUpdate`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalPolicies.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.get({ ...params }) -> Monite.ApprovalRequestResourceList
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ApprovalRequestsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.create({ ...params }) -> Monite.ApprovalRequestResourceWithMetadata
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.create({
+ object_id: "object_id",
+ object_type: "account",
+ required_approval_count: 1,
+ role_ids: ["role_ids"],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ApprovalRequestCreateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.getById(approvalRequestId) -> Monite.ApprovalRequestResourceWithMetadata
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.getById("approval_request_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalRequestId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.approveById(approvalRequestId) -> Monite.ApprovalRequestResourceWithMetadata
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.approveById("approval_request_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalRequestId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.cancelById(approvalRequestId) -> Monite.ApprovalRequestResourceWithMetadata
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.cancelById("approval_request_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalRequestId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.approvalRequests.rejectById(approvalRequestId) -> Monite.ApprovalRequestResourceWithMetadata
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.approvalRequests.rejectById("approval_request_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approvalRequestId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ApprovalRequests.RequestOptions`
+
+
+
+
+
+
+
+
+client.auditLogs.get({ ...params }) -> Monite.LogsResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.auditLogs.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.AuditLogsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditLogs.RequestOptions`
+
+
+
+
+
+
+
+
+client.auditLogs.getById(logId) -> Monite.LogResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.auditLogs.getById("log_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**logId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditLogs.RequestOptions`
+
+
+
+
+
+
+
+
+client.accessTokens.revoke({ ...params }) -> Monite.MessageResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Revoke an existing token immediately.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accessTokens.revoke({
+ client_id: "client_id",
+ client_secret: "client_secret",
+ token: "token",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.RevokeTokenPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `AccessTokens.RequestOptions`
+
+
+
+
+
+
+
+
+client.accessTokens.create({ ...params }) -> Monite.AccessTokenResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new access token based on client ID and client secret.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accessTokens.create({
+ client_id: "client_id",
+ client_secret: "client_secret",
+ grant_type: "client_credentials",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ObtainTokenPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `AccessTokens.RequestOptions`
+
+
+
+
+
+
+
+
+client.batchPayments.create({ ...params }) -> Monite.PaymentsBatchPaymentResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.batchPayments.create({
+ payer_bank_account_id: "payer_bank_account_id",
+ payment_intents: [
+ {
+ object: {
+ id: "id",
+ type: "payable",
+ },
+ recipient: {
+ id: "id",
+ type: "counterpart",
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentsBatchPaymentRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BatchPayments.RequestOptions`
+
+
+
+
+
+
+
+
+client.batchPayments.getById(batchPaymentId) -> Monite.PaymentsBatchPaymentResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.batchPayments.getById("batch_payment_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**batchPaymentId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `BatchPayments.RequestOptions`
+
+
+
+
+
+
+
+
+client.comments.get({ ...params }) -> Monite.CommentResourceList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get comments
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.comments.get({
+ object_type: "payable",
+ object_id: "object_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CommentsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+client.comments.create({ ...params }) -> Monite.CommentResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new comment
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.comments.create({
+ object_id: "object_id",
+ object_type: "object_type",
+ text: "text",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CommentCreateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+client.comments.getById(commentId) -> Monite.CommentResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get comment
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.comments.getById("comment_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**commentId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+client.comments.deleteById(commentId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete comment
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.comments.deleteById("comment_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**commentId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+client.comments.updateById(commentId, { ...params }) -> Monite.CommentResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update comment
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.comments.updateById("comment_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**commentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.CommentUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.get({ ...params }) -> Monite.CounterpartPaginationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.get({
+ sort_code: "123456",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CounterpartsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.create({ ...params }) -> Monite.CounterpartResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.create({
+ type: "individual",
+ individual: {
+ address: {
+ city: "Berlin",
+ country: "AF",
+ line1: "Flughafenstrasse 52",
+ postal_code: "10115",
+ },
+ first_name: "Adnan",
+ is_customer: true,
+ is_vendor: true,
+ last_name: "Singh",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CounterpartCreatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.getById(counterpartId) -> Monite.CounterpartResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.getById("counterpart_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**counterpartId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.deleteById(counterpartId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.deleteById("counterpart_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**counterpartId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.updateById(counterpartId, { ...params }) -> Monite.CounterpartResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.updateById("counterpart_id", {
+ individual: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**counterpartId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.CounterpartUpdatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.getPartnerMetadataById(counterpartId) -> Monite.PartnerMetadataResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.getPartnerMetadataById("counterpart_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**counterpartId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.counterparts.updatePartnerMetadataById(counterpartId, { ...params }) -> Monite.PartnerMetadataResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.counterparts.updatePartnerMetadataById("counterpart_id", {
+ metadata: {
+ key: "value",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**counterpartId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PartnerMetadata`
+
+
+
+
+
+-
+
+**requestOptions:** `Counterparts.RequestOptions`
+
+
+
+
+
+
+
+
+client.dataExports.get({ ...params }) -> Monite.AllDocumentExportResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.dataExports.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.DataExportsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `DataExports.RequestOptions`
+
+
+
+
+
+
+
+
+client.dataExports.create({ ...params }) -> Monite.CreateExportTaskResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.dataExports.create({
+ date_from: "date_from",
+ date_to: "date_to",
+ format: "csv",
+ objects: [
+ {
+ name: "receivable",
+ statuses: ["draft"],
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ExportPayloadSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `DataExports.RequestOptions`
+
+
+
+
+
+
+
+
+client.dataExports.getSupportedFormats() -> Monite.SupportedFormatSchema[]
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.dataExports.getSupportedFormats();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DataExports.RequestOptions`
+
+
+
+
+
+
+
+
+client.dataExports.getById(documentExportId) -> Monite.DocumentExportResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.dataExports.getById("document_export_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**documentExportId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `DataExports.RequestOptions`
+
+
+
+
+
+
+
+
+client.pdfTemplates.get() -> Monite.TemplateListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+This API call returns all supported templates with language codes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.pdfTemplates.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PdfTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.pdfTemplates.getSystem() -> Monite.TemplateListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+This API call returns all supported system templates with language codes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.pdfTemplates.getSystem();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PdfTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.pdfTemplates.getById(documentTemplateId) -> Monite.TemplateReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.pdfTemplates.getById("document_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**documentTemplateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PdfTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.pdfTemplates.makeDefaultById(documentTemplateId) -> Monite.TemplateReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.pdfTemplates.makeDefaultById("document_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**documentTemplateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PdfTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.pdfTemplates.previewById(documentTemplateId) -> stream.Readable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a sample PDF invoice generated using the specified template.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.pdfTemplates.previewById("string");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**documentTemplateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PdfTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.get({ ...params }) -> Monite.EntityPaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve a list of all entities.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.EntitiesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.create({ ...params }) -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new entity from the specified values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.create({
+ address: {
+ city: "city",
+ country: "AF",
+ line1: "line1",
+ postal_code: "postal_code",
+ },
+ email: "email",
+ type: "individual",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateEntityRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.getEntitiesMe() -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deprecated. Use `GET /entity_users/my_entity` instead.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.getEntitiesMe();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.patchEntitiesMe({ ...params }) -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deprecated. Use `PATCH /entity_users/my_entity` instead.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.patchEntitiesMe({});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.UpdateEntityRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.getById(entityId) -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve an entity by its ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.getById("ea837e28-509b-4b6a-a600-d54b6aa0b1f5");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string` — A unique ID to specify the entity.
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.updateById(entityId, { ...params }) -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with the provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.updateById("ea837e28-509b-4b6a-a600-d54b6aa0b1f5", {});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string` — A unique ID to specify the entity.
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateEntityRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.uploadLogoById(file, entityId) -> Monite.FileSchema3
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Entity logo can be PNG, JPG, or GIF, up to 10 MB in size. The logo is used, for example, in PDF documents created by this entity.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.uploadLogoById(fs.createReadStream("/path/to/your/file"), "ea837e28-509b-4b6a-a600-d54b6aa0b1f5");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**file:** `File | fs.ReadStream | Blob`
+
+
+
+
+
+-
+
+**entityId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.deleteLogoById(entityId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.deleteLogoById("ea837e28-509b-4b6a-a600-d54b6aa0b1f5");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string` — A unique ID to specify the entity.
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.getPartnerMetadataById(entityId) -> Monite.PartnerMetadataResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve a metadata object associated with this entity, usually in a JSON format.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.getPartnerMetadataById("entity_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.updatePartnerMetadataById(entityId, { ...params }) -> Monite.PartnerMetadataResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Fully replace the current metadata object with the specified instance.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.updatePartnerMetadataById("entity_id", {
+ metadata: {
+ key: "value",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PartnerMetadata`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.getSettingsById(entityId) -> Monite.MergedSettingsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve all settings for this entity.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.getSettingsById("ea837e28-509b-4b6a-a600-d54b6aa0b1f5");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string` — A unique ID to specify the entity.
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.updateSettingsById(entityId, { ...params }) -> Monite.MergedSettingsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with the provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.updateSettingsById("ea837e28-509b-4b6a-a600-d54b6aa0b1f5");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `string` — A unique ID to specify the entity.
+
+
+
+
+
+-
+
+**request:** `Monite.PatchSettingsPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.uploadOnboardingDocuments({ ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Provide files for entity onboarding verification
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.uploadOnboardingDocuments();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.EntityOnboardingDocumentsPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.getOnboardingRequirements() -> Monite.GetOnboardingRequirementsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get onboarding requirements for the entity
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.getOnboardingRequirements();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Entities.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.get({ ...params }) -> Monite.EntityUserPaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve a list of all entity users.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.EntityUsersGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.create({ ...params }) -> Monite.EntityUserResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new entity user from the specified values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.create({
+ first_name: "Andrey",
+ login: "login",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateEntityUserRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.getCurrent() -> Monite.EntityUserResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve an entity user by its ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.getCurrent();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.updateCurrent({ ...params }) -> Monite.EntityUserResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.updateCurrent();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.UpdateMeEntityUserRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.getCurrentEntity() -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves information of an entity, which this entity user belongs to.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.getCurrentEntity();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.updateCurrentEntity({ ...params }) -> Monite.EntityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update information of an entity, which this entity user belongs to.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.updateCurrentEntity({});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.UpdateEntityRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.getCurrentRole() -> Monite.RoleResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves information of a role assigned to this entity user.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.getCurrentRole();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.getById(entityUserId) -> Monite.EntityUserResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve an entity user by its ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.getById("entity_user_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityUserId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.deleteById(entityUserId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.deleteById("entity_user_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityUserId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.entityUsers.updateById(entityUserId, { ...params }) -> Monite.EntityUserResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entityUsers.updateById("entity_user_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityUserId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateEntityUserRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EntityUsers.RequestOptions`
+
+
+
+
+
+
+
+
+client.events.get({ ...params }) -> Monite.EventPaginationResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get events for a given entity.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.events.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.EventsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Events.RequestOptions`
+
+
+
+
+
+
+
+
+client.events.getById(eventId) -> Monite.EventResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get event by ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.events.getById("event_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**eventId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Events.RequestOptions`
+
+
+
+
+
+
+
+
+client.files.get({ ...params }) -> Monite.FilesResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.files.get({
+ id__in: "string",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.FilesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+client.files.upload(file, { ...params }) -> Monite.FileResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.files.upload(fs.createReadStream("/path/to/your/file"), {
+ file_type: "ocr_results",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**file:** `File | fs.ReadStream | Blob`
+
+
+
+
+
+-
+
+**request:** `Monite.UploadFile`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+client.files.getById(fileId) -> Monite.FileResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.files.getById("file_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fileId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+client.files.delete(fileId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.files.delete("file_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fileId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.get({ ...params }) -> Monite.CustomTemplatesPaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all custom templates
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.MailTemplatesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.create({ ...params }) -> Monite.CustomTemplateDataSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create custom template
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.create({
+ body_template: "body_template",
+ name: "name",
+ subject_template: "subject_template",
+ type: "receivables_quote",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.AddCustomTemplateSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.preview({ ...params }) -> Monite.PreviewTemplateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Preview rendered template
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.preview({
+ body: "body",
+ document_type: "receivables_quote",
+ language_code: "ab",
+ subject: "subject",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PreviewTemplateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.getSystem() -> Monite.SystemTemplates
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all system templates
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.getSystem();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.getById(templateId) -> Monite.CustomTemplateDataSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get custom template by ID
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.getById("template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**templateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.deleteById(templateId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete custom template bt ID
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.deleteById("template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**templateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.updateById(templateId, { ...params }) -> Monite.CustomTemplateDataSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update custom template by ID
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.updateById("template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**templateId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateCustomTemplateSchemaRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailTemplates.makeDefaultById(templateId) -> Monite.CustomTemplateDataSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Make template default
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailTemplates.makeDefaultById("template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**templateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MailTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxDomains.get() -> Monite.DomainListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all domains owned by partner_id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxDomains.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `MailboxDomains.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxDomains.create({ ...params }) -> Monite.DomainResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create domain for the partner_id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxDomains.create({
+ domain: "domain",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.DomainRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `MailboxDomains.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxDomains.deleteById(domainId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete domain for the partner_id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxDomains.deleteById("domain_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**domainId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MailboxDomains.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxDomains.verifyById(domainId) -> Monite.VerifyResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Verify domain for the partner_id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxDomains.verifyById("domain_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**domainId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MailboxDomains.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxes.get() -> Monite.MailboxDataResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all mailboxes owned by Entity
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxes.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Mailboxes.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxes.create({ ...params }) -> Monite.MailboxResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new mailbox
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxes.create({
+ mailbox_domain_id: "mailbox_domain_id",
+ mailbox_name: "mailbox_name",
+ related_object_type: "payable",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.MailboxDomainRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Mailboxes.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxes.search({ ...params }) -> Monite.MailboxDataResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all mailboxes owned by Entity
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxes.search({
+ entity_ids: ["entity_ids"],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.MailboxMultipleEntitiesRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Mailboxes.RequestOptions`
+
+
+
+
+
+
+
+
+client.mailboxes.deleteById(mailboxId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete mailbox
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.mailboxes.deleteById("mailbox_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**mailboxId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Mailboxes.RequestOptions`
+
+
+
+
+
+
+
+
+client.measureUnits.get() -> Monite.UnitListResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.measureUnits.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `MeasureUnits.RequestOptions`
+
+
+
+
+
+
+
+
+client.measureUnits.create({ ...params }) -> Monite.UnitResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.measureUnits.create({
+ name: "name",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.UnitRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `MeasureUnits.RequestOptions`
+
+
+
+
+
+
+
+
+client.measureUnits.getById(unitId) -> Monite.UnitResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.measureUnits.getById("unit_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**unitId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MeasureUnits.RequestOptions`
+
+
+
+
+
+
+
+
+client.measureUnits.deleteById(unitId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.measureUnits.deleteById("unit_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**unitId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `MeasureUnits.RequestOptions`
+
+
+
+
+
+
+
+
+client.measureUnits.updateById(unitId, { ...params }) -> Monite.UnitResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.measureUnits.updateById("unit_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**unitId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UnitUpdate`
+
+
+
+
+
+-
+
+**requestOptions:** `MeasureUnits.RequestOptions`
+
+
+
+
+
+
+
+
+client.onboardingLinks.create({ ...params }) -> Monite.OnboardingLinkPublicResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.onboardingLinks.create({
+ expires_at: "2024-01-15T09:30:00Z",
+ refresh_url: "refresh_url",
+ return_url: "return_url",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.OnboardingLinkRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `OnboardingLinks.RequestOptions`
+
+
+
+
+
+
+
+
+client.overdueReminders.get() -> Monite.AllOverdueRemindersResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.overdueReminders.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `OverdueReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.overdueReminders.create({ ...params }) -> Monite.OverdueReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.overdueReminders.create({
+ name: "name",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.OverdueReminderRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `OverdueReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.overdueReminders.getById(overdueReminderId) -> Monite.OverdueReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.overdueReminders.getById("overdue_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**overdueReminderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `OverdueReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.overdueReminders.deleteById(overdueReminderId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.overdueReminders.deleteById("overdue_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**overdueReminderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `OverdueReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.overdueReminders.updateById(overdueReminderId, { ...params }) -> Monite.OverdueReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.overdueReminders.updateById("overdue_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**overdueReminderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.OverdueReminderUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `OverdueReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.get({ ...params }) -> Monite.PurchaseOrderPaginationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PurchaseOrdersGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.create({ ...params }) -> Monite.PurchaseOrderResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.create({
+ counterpart_id: "counterpart_id",
+ currency: "AED",
+ items: [
+ {
+ currency: "AED",
+ name: "name",
+ price: 1,
+ quantity: 1,
+ unit: "unit",
+ vat_rate: 1,
+ },
+ ],
+ message: "message",
+ valid_for_days: 1,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PurchaseOrderPayloadSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.getVariables() -> Monite.VariablesObjectList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a list of placeholders allowed to insert into an email template for customization
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.getVariables();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.getById(purchaseOrderId) -> Monite.PurchaseOrderResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.getById("purchase_order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**purchaseOrderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.deleteById(purchaseOrderId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.deleteById("purchase_order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**purchaseOrderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.updateById(purchaseOrderId, { ...params }) -> Monite.PurchaseOrderResponseSchema
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.updateById("purchase_order_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**purchaseOrderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdatePurchaseOrderPayloadSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.previewById(purchaseOrderId, { ...params }) -> Monite.PurchaseOrderEmailPreviewResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.previewById("purchase_order_id", {
+ body_text: "body_text",
+ subject_text: "subject_text",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**purchaseOrderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PurchaseOrderEmailPreviewRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.purchaseOrders.sendById(purchaseOrderId, { ...params }) -> Monite.PurchaseOrderEmailSentResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.purchaseOrders.sendById("purchase_order_id", {
+ body_text: "body_text",
+ subject_text: "subject_text",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**purchaseOrderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.SendPurchaseOrderViaEmailRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.get({ ...params }) -> Monite.PayablePaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists all payables from the connected entity.
+
+If you already have the data of the payable (amount in [minor units](https://docs.monite.com/docs/currencies#minor-units), currency, vendor information, and other details)
+stored somewhere as individual attributes, you can create a payable with these attributes by calling [POST
+/payables](https://docs.monite.com/reference/post_payables) and providing the [base64-encoded](https://en.wikipedia.org/wiki/Base64) contents of the original invoice file in the field `base64_encoded_file`.
+
+A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and
+demanding payment.
+
+The `file_name` field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured
+to automatically set `suggested_payment_term`, this object can be omitted from the request body.
+
+The `id` generated for this payable can be used in other API calls to update the data of this payable or trigger [
+status transitions](https://docs.monite.com/docs/payable-status-transitions), for example. essential data
+fields to move from `draft` to `new`
+
+Related guide: [Create a payable from data](https://docs.monite.com/docs/collect-payables#create-a-payable-from-data)
+
+See also:
+
+[Automatic calculation of due date](https://docs.monite.com/docs/collect-payables#automatic-calculation-of-due-date)
+
+[Suggested payment date](https://docs.monite.com/docs/collect-payables#suggested-payment-date)
+
+[Attach file](https://docs.monite.com/docs/collect-payables#attach-file)
+
+[Collect payables by email](https://docs.monite.com/docs/collect-payables#send-payables-by-email)
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PayablesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.create({ ...params }) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Add a new payable by providing the amount, currency, vendor name, and other details.
+You can provide the base64_encoded contents of the original invoice file in the field `base64_encoded_file`.
+
+You can use this endpoint to bypass the Monite OCR service and provide the data directly
+(for example, if you already have the data in place).
+
+A newly created payable has the the `draft` [status](https://docs.monite.com/docs/payables-lifecycle).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.create();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PayableUploadWithDataSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.getAnalytics({ ...params }) -> Monite.PayableAggregatedDataResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve aggregated statistics for payables, including total amount and count, both overall and by status.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.getAnalytics();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PayablesGetAnalyticsRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.uploadFromFile(file) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Upload an incoming invoice (payable) in PDF, PNG, JPEG, or TIFF format and scan its contents. The maximum file size is 10MB.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.uploadFromFile(fs.createReadStream("/path/to/your/file"));
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**file:** `File | fs.ReadStream | Blob`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.getValidations() -> Monite.PayableValidationsResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get payable validations.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.getValidations();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.updateValidations({ ...params }) -> Monite.PayableValidationsResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update payable validations.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.updateValidations({
+ required_fields: ["currency"],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PayableValidationsUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.resetValidations() -> Monite.PayableValidationsResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Reset payable validations to default ones.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.resetValidations();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.getVariables() -> Monite.PayableTemplatesVariablesObjectList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a list of placeholders allowed to insert into an email template for customization
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.getVariables();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.getById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves information about a specific payable with the given ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.getById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.deleteById(payableId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes a specific payable.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.deleteById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.updateById(payableId, { ...params }) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the information about a specific payable.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.updateById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PayableUpdateSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.approvePaymentById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Confirms that the payable is ready to be paid.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.approvePaymentById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.attachFileById(file, payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Attach file to payable without existing attachment.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.attachFileById(fs.createReadStream("/path/to/your/file"), "payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**file:** `File | fs.ReadStream | Blob`
+
+
+
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.cancelById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Cancels the payable that was not confirmed during the review.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.cancelById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.markAsPaidById(payableId, { ...params }) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Mark a payable as paid.
+
+Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter
+case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status
+manually.
+
+Optionally, it is possible to pass the `comment` field in the request body, to describe how and when the invoice was
+paid.
+
+Notes:
+
+- To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` permission
+ for payables.
+- The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described
+ in the `payment_terms.discount` value.
+
+Related guide: [Mark a payable as paid](https://docs.monite.com/docs/payable-status-transitions#mark-as-paid)
+
+See also:
+
+[Payables lifecycle](https://docs.monite.com/docs/payables-lifecycle)
+
+[Payables status transitions](https://docs.monite.com/docs/collect-payables#suggested-payment-date)
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.markAsPaidById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.CommentPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.markAsPartiallyPaidById(payableId, { ...params }) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Mark a payable as partially paid.
+
+If the payable is partially paid, its status is moved to `partially_paid`. The value of the `amount_paid` field must be
+the sum of all payments made, not only the last one.
+
+Notes:
+
+- This endpoint can be used for payables in the `waiting_to_be_paid` status.
+- The `amount_paid` must be greater than 0 and less than the total payable amount specified by the `amount` field.
+- You can use this endpoint multiple times for the same payable to reflect multiple partial payments, always setting the
+ sum of all payments made.
+- To use this endpoint with an entity user token, this entity user must have a role that includes the `pay`
+ permission for payables.
+- The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described
+ in the `payment_terms.discount` value.
+
+Related guide: [Mark a payable as partially paid](https://docs.monite.com/docs/payable-status-transitions#mark-as-partially-paid)
+
+See also:
+
+[Payables lifecycle](https://docs.monite.com/docs/payables-lifecycle)
+
+[Payables status transitions](https://docs.monite.com/docs/collect-payables#suggested-payment-date)
+
+[Mark a payable as paid](https://docs.monite.com/docs/payable-status-transitions#mark-as-paid)
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.markAsPartiallyPaidById("payable_id", {
+ amount_paid: 1,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PartiallyPaidPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.rejectById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Declines the payable when an approver finds any mismatch or discrepancies.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.rejectById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.reopenById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Reset payable state from rejected to new.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.reopenById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.submitForApprovalById(payableId) -> Monite.PayableResponseSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Starts the approval process once the uploaded payable is validated.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.submitForApprovalById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.payables.validateById(payableId) -> Monite.PayableValidationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Check the invoice for compliance with the requirements for movement from draft to new status.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.validateById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentIntents.get({ ...params }) -> Monite.PaymentIntentsListResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentIntents.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentIntentsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentIntents.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentIntents.getById(paymentIntentId) -> Monite.PaymentIntentResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentIntents.getById("payment_intent_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentIntentId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentIntents.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentIntents.updateById(paymentIntentId, { ...params }) -> Monite.PaymentIntentResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentIntents.updateById("payment_intent_id", {
+ amount: 1,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentIntentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdatePaymentIntentPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentIntents.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentIntents.getHistoryById(paymentIntentId) -> Monite.PaymentIntentHistoryResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentIntents.getHistoryById("payment_intent_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentIntentId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentIntents.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentLinks.create({ ...params }) -> Monite.PublicPaymentLinkResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentLinks.create({
+ payment_methods: ["sepa_credit"],
+ recipient: {
+ id: "id",
+ type: "entity",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreatePaymentLinkRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentLinks.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentLinks.getById(paymentLinkId) -> Monite.PublicPaymentLinkResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentLinks.getById("payment_link_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentLinkId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentLinks.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentLinks.expireById(paymentLinkId) -> Monite.PublicPaymentLinkResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentLinks.expireById("payment_link_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentLinkId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentLinks.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentRecords.get({ ...params }) -> Monite.PaymentRecordResponseList
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentRecords.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentRecordsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentRecords.create({ ...params }) -> Monite.PaymentRecordResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentRecords.create({
+ amount: 1,
+ currency: "AED",
+ object: {
+ id: "id",
+ type: "receivable",
+ },
+ paid_at: "2024-01-15T09:30:00Z",
+ payment_intent_id: "payment_intent_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentRecordRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentRecords.getById(paymentRecordId) -> Monite.PaymentRecordResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentRecords.getById("payment_record_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentRecordId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentReminders.get() -> Monite.GetAllPaymentReminders
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentReminders.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PaymentReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentReminders.create({ ...params }) -> Monite.PaymentReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentReminders.create({
+ name: "name",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentReminder`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentReminders.getById(paymentReminderId) -> Monite.PaymentReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentReminders.getById("payment_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentReminderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentReminders.deleteById(paymentReminderId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentReminders.deleteById("payment_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentReminderId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentReminders.updateById(paymentReminderId, { ...params }) -> Monite.PaymentReminderResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentReminders.updateById("payment_reminder_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentReminderId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PaymentReminderUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentReminders.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentTerms.get() -> Monite.PaymentTermsListResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentTerms.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PaymentTerms.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentTerms.create({ ...params }) -> Monite.PaymentTermsResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentTerms.create({
+ name: "name",
+ term_final: {
+ number_of_days: 1,
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PaymentTermsCreatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentTerms.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentTerms.getById(paymentTermsId) -> Monite.PaymentTermsResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentTerms.getById("payment_terms_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentTermsId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentTerms.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentTerms.deleteById(paymentTermsId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentTerms.deleteById("payment_terms_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentTermsId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentTerms.RequestOptions`
+
+
+
+
+
+
+
+
+client.paymentTerms.updateById(paymentTermsId, { ...params }) -> Monite.PaymentTermsResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.paymentTerms.updateById("payment_terms_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**paymentTermsId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.PaymentTermsUpdatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentTerms.RequestOptions`
+
+
+
+
+
+
+
+
+client.products.get({ ...params }) -> Monite.ProductServicePaginationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.products.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ProductsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Products.RequestOptions`
+
+
+
+
+
+
+
+
+client.products.create({ ...params }) -> Monite.ProductServiceResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.products.create({
+ name: "name",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ProductServiceRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Products.RequestOptions`
+
+
+
+
+
+
+
+
+client.products.getById(productId) -> Monite.ProductServiceResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.products.getById("product_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**productId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Products.RequestOptions`
+
+
+
+
+
+
+
+
+client.products.deleteById(productId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.products.deleteById("product_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**productId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Products.RequestOptions`
+
+
+
+
+
+
+
+
+client.products.updateById(productId, { ...params }) -> Monite.ProductServiceResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.products.updateById("product_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**productId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ProductServiceUpdate`
+
+
+
+
+
+-
+
+**requestOptions:** `Products.RequestOptions`
+
+
+
+
+
+
+
+
+client.projects.get({ ...params }) -> Monite.ProjectPaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all projects for an entity
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.projects.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ProjectsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+client.projects.create({ ...params }) -> Monite.ProjectResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new project.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.projects.create({
+ name: "Marketing",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ProjectCreateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+client.projects.getById(projectId) -> Monite.ProjectResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a project with the given ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.projects.getById("project_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**projectId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+client.projects.deleteById(projectId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a project.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.projects.deleteById("project_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**projectId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+client.projects.updateById(projectId, { ...params }) -> Monite.ProjectResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update a project.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.projects.updateById("project_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**projectId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ProjectUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.get({ ...params }) -> Monite.ReceivablePaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of [accounts receivable](https://docs.monite.com/accounts-receivable/index) documents - invoices, quotes, and credit notes - of the specified entity.
+
+Results can be filtered by amount, counterpart, due date, and other criteria. Multiple filters are combined using logical AND unless specified otherwise. If no documents matching the search criteria are found, the endpoint returns a successful response with an empty `data` array.
+
+This endpoint supports [pagination](https://docs.monite.com/api/concepts/pagination-sorting-filtering) and sorting. By default, results are sorted by the creation date in ascending order (from oldest to newest).
+
+#### Examples
+
+##### Invoices
+
+- Get all overdue invoices:
+
+ ```
+ GET /receivables?type=invoice&status=overdue
+ ```
+
+- Get all invoices created for the counterpart named "Solarwind" (case-insensitive):
+
+ ```
+ GET /receivables?type=invoice?counterpart_name__icontains=Solarwind
+ ```
+
+- Get invoices whose total amount starts from 500 EUR:
+
+ ```
+ GET /receivables?type=invoice&total_amount__gte=50000
+ ```
+
+- Get invoices that are due for payment in September 2024:
+
+ ```
+ GET /receivables?type=invoice&due_date__gte=2024-09-01T00:00:00Z&due_date__lt=2024-10-01T00:00:00Z
+ ```
+
+- Get invoices created on or after September 1, 2024:
+
+ ```
+ GET /receivables?type=invoice&created_at__gte=2024-09-01T00:00:00Z
+ ```
+
+- Find an invoice created from a specific quote:
+
+ ```
+ GET /receivables?type=invoice?based_on=QUOTE_ID
+ ```
+
+##### Quotes
+
+- Get the latest created quote:
+
+ ```
+ GET /receivables?type=quote&sort=created_at&order=desc&limit=1
+ ```
+
+- Get the latest issued quote:
+
+ ```
+ GET /receivables?type=quote&sort=issue_date&order=desc&limit=1
+ ```
+
+##### Credit notes
+
+- Find all credit notes created for a specific invoice:
+
+ ```
+ GET /receivables?type=credit_note?based_on=INVOICE_ID
+ ```
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ReceivablesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.create({ ...params }) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.create({
+ counterpart_billing_address_id: "counterpart_billing_address_id",
+ counterpart_id: "counterpart_id",
+ currency: "AED",
+ line_items: [
+ {
+ quantity: 1.1,
+ },
+ ],
+ type: "quote",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.ReceivableFacadeCreatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getVariables() -> Monite.ReceivableTemplatesVariablesObjectList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a list of placeholders that can be used in email templates for customization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getVariables();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getById(receivableId) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.deleteById(receivableId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.deleteById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.updateById(receivableId, { ...params }) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.updateById("receivable_id", {
+ quote: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivableUpdatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.acceptById(receivableId, { ...params }) -> Monite.SuccessResult
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.acceptById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.QuoteAcceptRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.cancelById(receivableId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.cancelById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.cloneById(receivableId) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.cloneById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.declineById(receivableId, { ...params }) -> Monite.SuccessResult
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.declineById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivableDeclinePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getHistory(receivableId, { ...params }) -> Monite.ReceivableHistoryPaginationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getHistory("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivablesGetHistoryRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getHistoryById(receivableHistoryId, receivableId) -> Monite.ReceivableHistoryResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getHistoryById("receivable_history_id", "receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableHistoryId:** `string`
+
+
+
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.issueById(receivableId) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.issueById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.updateLineItemsById(receivableId, { ...params }) -> Monite.LineItemsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Replace all line items of an existing invoice or quote with a new list of line items.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.updateLineItemsById("receivable_id", {
+ data: [
+ {
+ quantity: 1.1,
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateLineItems`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getMails(receivableId, { ...params }) -> Monite.ReceivableMailPaginationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getMails("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivablesGetMailsRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getMailById(receivableId, mailId) -> Monite.ReceivableMailResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getMailById("receivable_id", "mail_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**mailId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.markAsPaidById(receivableId, { ...params }) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.markAsPaidById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivablePaidPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.markAsPartiallyPaidById(receivableId, { ...params }) -> Monite.ReceivableResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deprecated. Use `POST /payment_records` to record an invoice payment.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.markAsPartiallyPaidById("receivable_id", {
+ amount_paid: 1,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivablePartiallyPaidPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.markAsUncollectibleById(receivableId, { ...params }) -> Monite.ReceivableResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.markAsUncollectibleById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivableUncollectiblePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.getPdfLinkById(receivableId) -> Monite.ReceivableFileUrl
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.getPdfLinkById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.previewById(receivableId, { ...params }) -> Monite.ReceivablePreviewResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.previewById("receivable_id", {
+ body_text: "body_text",
+ subject_text: "subject_text",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivablePreviewRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.sendById(receivableId, { ...params }) -> Monite.ReceivableSendResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.sendById("receivable_id", {
+ body_text: "body_text",
+ subject_text: "subject_text",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivableSendRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.sendTestReminderById(receivableId, { ...params }) -> Monite.ReceivablesSendResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.sendTestReminderById("receivable_id", {
+ reminder_type: "term_1",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.ReceivableSendTestReminderPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.receivables.verifyById(receivableId) -> Monite.ReceivablesVerifyResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.receivables.verifyById("receivable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**receivableId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.recurrences.get() -> Monite.GetAllRecurrences
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.recurrences.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Recurrences.RequestOptions`
+
+
+
+
+
+
+
+
+client.recurrences.create({ ...params }) -> Monite.Recurrence
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.recurrences.create({
+ day_of_month: "first_day",
+ end_month: 1,
+ end_year: 1,
+ invoice_id: "invoice_id",
+ start_month: 1,
+ start_year: 1,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateRecurrencePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Recurrences.RequestOptions`
+
+
+
+
+
+
+
+
+client.recurrences.getById(recurrenceId) -> Monite.Recurrence
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.recurrences.getById("recurrence_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**recurrenceId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Recurrences.RequestOptions`
+
+
+
+
+
+
+
+
+client.recurrences.updateById(recurrenceId, { ...params }) -> Monite.Recurrence
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.recurrences.updateById("recurrence_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**recurrenceId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateRecurrencePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `Recurrences.RequestOptions`
+
+
+
+
+
+
+
+
+client.recurrences.cancelById(recurrenceId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.recurrences.cancelById("recurrence_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**recurrenceId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Recurrences.RequestOptions`
+
+
+
+
+
+
+
+
+client.roles.get({ ...params }) -> Monite.RolePaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Find all roles that match the search criteria.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.roles.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.RolesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+client.roles.create({ ...params }) -> Monite.RoleResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new role from the specified values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.roles.create({
+ name: "name",
+ permissions: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateRoleRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+client.roles.getById(roleId) -> Monite.RoleResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.roles.getById("role_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**roleId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+client.roles.updateById(roleId, { ...params }) -> Monite.RoleResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with the provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.roles.updateById("role_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**roleId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateRoleRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+client.partnerSettings.get() -> Monite.PartnerProjectSettingsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve all settings for this partner.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.partnerSettings.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PartnerSettings.RequestOptions`
+
+
+
+
+
+
+
+
+client.partnerSettings.update({ ...params }) -> Monite.PartnerProjectSettingsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the specified fields with the provided values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.partnerSettings.update();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.PartnerProjectSettingsPayload`
+
+
+
+
+
+-
+
+**requestOptions:** `PartnerSettings.RequestOptions`
+
+
+
+
+
+
+
+
+client.tags.get({ ...params }) -> Monite.TagsPaginationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a list of all tags. Tags can be assigned to resources to assist with searching and filtering.
+Tags can also be used as trigger conditions in payable approval policies.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.tags.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.TagsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+client.tags.create({ ...params }) -> Monite.TagReadSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new tag. The tag name must be unique.
+Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags.
+
+The response returns an auto-generated ID assigned to this tag.
+To assign this tag to a resource, send the tag ID in the `tag_ids` list when creating or updating a resource.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.tags.create({
+ name: "Marketing",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.TagCreateSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+client.tags.getById(tagId) -> Monite.TagReadSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get information about a tag with the given ID.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.tags.getById("tag_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**tagId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+client.tags.deleteById(tagId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a tag with the given ID. This tag will be automatically deleted from all resources where it was used.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.tags.deleteById("tag_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**tagId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+client.tags.updateById(tagId, { ...params }) -> Monite.TagReadSchema
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Change the tag name. The new name must be unique among existing tags.
+Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.tags.updateById("tag_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**tagId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.TagUpdateSchema`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.get({ ...params }) -> Monite.TextTemplateResponseList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get text templates
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.TextTemplatesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.create({ ...params }) -> Monite.TextTemplateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a text template
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.create({
+ document_type: "quote",
+ name: "name",
+ template: "template",
+ type: "email_header",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateTextTemplatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.getById(textTemplateId) -> Monite.TextTemplateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all custom contents
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.getById("text_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**textTemplateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.deleteById(textTemplateId) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete custom content by ID
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.deleteById("text_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**textTemplateId:** `string` — UUID text_template ID
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.updateById(textTemplateId, { ...params }) -> Monite.TextTemplateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update custom content by ID
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.updateById("text_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**textTemplateId:** `string` — UUID text_template ID
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateTextTemplatePayload`
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.textTemplates.makeDefaultById(textTemplateId) -> Monite.TextTemplateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Make text template default
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.textTemplates.makeDefaultById("text_template_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**textTemplateId:** `string` — UUID text_template ID
+
+
+
+
+
+-
+
+**requestOptions:** `TextTemplates.RequestOptions`
+
+
+
+
+
+
+
+
+client.vatRates.get({ ...params }) -> Monite.VatRateListResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.vatRates.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.VatRatesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `VatRates.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookDeliveries.get({ ...params }) -> Monite.WebhookDeliveryPaginationResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookDeliveries.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.WebhookDeliveriesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookDeliveries.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.get({ ...params }) -> Monite.WebhookSubscriptionPaginationResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.WebhookSubscriptionsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.create({ ...params }) -> Monite.WebhookSubscriptionResourceWithSecret
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.create({
+ object_type: "account",
+ url: "url",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.CreateWebhookSubscriptionRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.getById(webhookSubscriptionId) -> Monite.WebhookSubscriptionResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.getById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.deleteById(webhookSubscriptionId) -> void
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.deleteById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.updateById(webhookSubscriptionId, { ...params }) -> Monite.WebhookSubscriptionResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.updateById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.UpdateWebhookSubscriptionRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.disableById(webhookSubscriptionId) -> Monite.WebhookSubscriptionResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.disableById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.enableById(webhookSubscriptionId) -> Monite.WebhookSubscriptionResource
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.enableById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.webhookSubscriptions.regenerateSecretById(webhookSubscriptionId) -> Monite.WebhookSubscriptionResourceWithSecret
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.webhookSubscriptions.regenerateSecretById("webhook_subscription_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**webhookSubscriptionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookSubscriptions.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.payables.get({ ...params }) -> Monite.AccountingPayableList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of accounts payable invoices (bills) that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details.
+
+This endpoint only provides read-only access to the accounting system's data but does not pull those payables into Monite. You can use it to review the data in the accounting system and find out which of those payables already exist or do not exist in Monite.
+
+Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting_connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting_connections/{connection_id}/sync` to trigger on-demand synchronization before getting the list of payables.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payables.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.PayablesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.payables.getById(payableId) -> Monite.AccountingPayable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns information about an individual payable invoice (bill) that exists in the entity's accounting system. This payable may or may not also exist in Monite.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payables.getById("payable_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payableId:** `string` — An internal ID of the payable invoice (bill) in the accounting system. You can get these IDs from `GET /accounting/payables`.
+
+
+
+
+
+-
+
+**requestOptions:** `Payables.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.receivables.get({ ...params }) -> Monite.AccountingReceivableList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of invoices that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details.
+
+This endpoint only provides read-only access to the accounting system's data but does not pull those invoices into Monite. You can use it to review the data in the accounting system and find out which of those invoices already exist or do not exist in Monite.
+
+Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting_connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting_connections/{connection_id}/sync` to trigger on-demand synchronization before getting the invoice list.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.receivables.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.ReceivablesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.receivables.getById(invoiceId) -> Monite.AccountingReceivable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns information about an individual invoice that exists in the entity's accounting system. This invoice may or may not also exist in Monite.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.receivables.getById("invoice_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**invoiceId:** `string` — An internal ID of the invoice in the accounting system. You can get these IDs from `GET /accounting/receivables`.
+
+
+
+
+
+-
+
+**requestOptions:** `Receivables.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.connections.get() -> Monite.AccountingConnectionList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all connections
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.connections.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Connections.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.connections.create({ ...params }) -> Monite.AccountingConnectionResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new connection
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.connections.create();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.AccountingConnectionRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Connections.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.connections.getById(connectionId) -> Monite.AccountingConnectionResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get connection by id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.connections.getById("connection_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**connectionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Connections.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.connections.disconnectById(connectionId) -> Monite.AccountingConnectionResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Disconnect
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.connections.disconnectById("connection_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**connectionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Connections.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.connections.syncById(connectionId) -> Monite.AccountingMessageResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.connections.syncById("connection_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**connectionId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Connections.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.syncedRecords.get({ ...params }) -> Monite.SyncRecordResourceList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get synchronized records
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.syncedRecords.get({
+ object_type: "product",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.SyncedRecordsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncedRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.syncedRecords.getById(syncedRecordId) -> Monite.SyncRecordResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get synchronized record by id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.syncedRecords.getById("synced_record_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**syncedRecordId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncedRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.syncedRecords.pushById(syncedRecordId) -> Monite.SyncRecordResource
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Push object to the accounting system manually
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.syncedRecords.pushById("synced_record_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**syncedRecordId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncedRecords.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.taxRates.get({ ...params }) -> Monite.AccountingTaxRateListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all tax rate accounts
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.taxRates.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.TaxRatesGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TaxRates.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.taxRates.getById(taxRateId) -> Monite.AccountingTaxRateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get tax rate account by id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.taxRates.getById("tax_rate_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**taxRateId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `TaxRates.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.ledgerAccounts.get({ ...params }) -> Monite.LedgerAccountListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all ledger accounts
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.ledgerAccounts.get();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.accounting.LedgerAccountsGetRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LedgerAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+client.accounting.ledgerAccounts.getById(ledgerAccountId) -> Monite.LedgerAccountResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get ledger account by id
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.ledgerAccounts.getById("ledger_account_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**ledgerAccountId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `LedgerAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+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
+
+
+-
+
+
+-
+
+Add a new bank account for the specified entity.
+
+The minimum required fields are `currency` and `country`. Other required fields depend on the currency:
+
+- 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.completeVerification({ ...params }) -> Monite.CompleteVerificationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.bankAccounts.completeVerification({
+ airwallex_plaid: {
+ account: {
+ id: "id",
+ mask: "mask",
+ name: "name",
+ },
+ institution: {
+ id: "id",
+ name: "name",
+ },
+ mandate: {
+ email: "email",
+ signatory: "signatory",
+ type: "us_ach_debit",
+ version: "1.0",
+ },
+ public_token: "public_token",
+ },
+ type: "airwallex_plaid",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.entities.CompleteVerificationRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.bankAccounts.startVerification({ ...params }) -> Monite.VerificationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Start entity bank account verification. The flow depends on verification type.
+For airwallex_plaid it generates Plaid Link token to init the Plaid SDK.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.bankAccounts.startVerification({
+ airwallex_plaid: {
+ client_name: "client_name",
+ redirect_url: "redirect_url",
+ },
+ type: "airwallex_plaid",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Monite.VerificationRequest`
+
+
+
+
+
+-
+
+**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.completeVerificationById(bankAccountId, { ...params }) -> Monite.CompleteRefreshVerificationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.bankAccounts.completeVerificationById("bank_account_id", {
+ type: "airwallex_plaid",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**bankAccountId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.entities.CompleteRefreshVerificationRequest`
+
+
+
+
+
+-
+
+**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.bankAccounts.refreshVerificationById(bankAccountId, { ...params }) -> Monite.VerificationResponse
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.bankAccounts.refreshVerificationById("bank_account_id", {
+ airwallex_plaid: {
+ client_name: "client_name",
+ redirect_url: "redirect_url",
+ },
+ type: "airwallex_plaid",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**bankAccountId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.VerificationRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+client.entities.bankAccounts.getVerificationsById(bankAccountId) -> Monite.BankAccountVerifications
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.entities.bankAccounts.getVerificationsById("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({
+ first_name: "first_name",
+ last_name: "last_name",
+ email: "email",
+ 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/docs/manage-line-items#list-all-line-items-of-a-payable)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 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/docs/manage-line-items#add-line-items-to-a-payable)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 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/docs/manage-line-items#replace-all-line-items)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 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/docs/manage-line-items#retrieve-a-line-item)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 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/docs/manage-line-items#remove-a-line-item)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 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/docs/manage-line-items#update-a-line-item)
+
+See also:
+
+[Manage line items](https://docs.monite.com/docs/manage-line-items)
+
+[Collect payables](https://docs.monite.com/docs/collect-payables)
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.payables.lineItems.updateById("line_item_id", "payable_id", {});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**lineItemId:** `string`
+
+
+
+
+
+-
+
+**payableId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.LineItemRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LineItems.RequestOptions`
+
+
+
+
+
+
+
+
+