From 5d5a131cb15c7ef2660296d93c1cf497d733faa8 Mon Sep 17 00:00:00 2001
From: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Date: Fri, 9 May 2025 18:01:38 +0000
Subject: [PATCH] SDK regeneration
---
package.json | 2 +-
reference.md | 11668 +---------------
.../resources/accessTokens/client/Client.ts | 8 +-
.../resources/connections/client/Client.ts | 20 +-
.../resources/ledgerAccounts/client/Client.ts | 8 +-
.../requests/LedgerAccountsGetRequest.ts | 6 +-
.../resources/payables/client/Client.ts | 8 +-
.../resources/receivables/client/Client.ts | 8 +-
.../resources/syncedRecords/client/Client.ts | 12 +-
.../requests/SyncedRecordsGetRequest.ts | 6 +-
.../resources/taxRates/client/Client.ts | 8 +-
.../client/requests/TaxRatesGetRequest.ts | 6 +-
src/api/resources/analytics/client/Client.ts | 12 +-
.../approvalPolicies/client/Client.ts | 20 +-
.../resources/processes/client/Client.ts | 16 +-
.../approvalRequests/client/Client.ts | 24 +-
src/api/resources/comments/client/Client.ts | 20 +-
.../client/Client.ts | 20 +-
.../resources/counterparts/client/Client.ts | 28 +-
.../resources/addresses/client/Client.ts | 20 +-
.../resources/bankAccounts/client/Client.ts | 24 +-
.../resources/contacts/client/Client.ts | 24 +-
.../resources/vatIds/client/Client.ts | 20 +-
.../resources/creditNotes/client/Client.ts | 84 +-
.../resources/dataExports/client/Client.ts | 16 +-
.../resources/extraData/client/Client.ts | 20 +-
.../resources/deliveryNotes/client/Client.ts | 28 +-
.../eInvoicingConnections/client/Client.ts | 129 +-
.../EinvoicingConnectionCreateRequest.ts | 4 +
.../EinvoicingConnectionUpdateRequest.ts | 18 +
.../client/requests/index.ts | 1 +
src/api/resources/entities/client/Client.ts | 64 +-
.../resources/bankAccounts/client/Client.ts | 24 +-
.../resources/onboardingData/client/Client.ts | 8 +-
.../resources/paymentMethods/client/Client.ts | 8 +-
.../resources/persons/client/Client.ts | 24 +-
.../resources/vatIds/client/Client.ts | 20 +-
.../resources/entityUsers/client/Client.ts | 40 +-
src/api/resources/events/client/Client.ts | 8 +-
src/api/resources/files/client/Client.ts | 16 +-
src/api/resources/financing/client/Client.ts | 16 +-
.../resources/mailTemplates/client/Client.ts | 32 +-
.../resources/mailboxDomains/client/Client.ts | 16 +-
src/api/resources/mailboxes/client/Client.ts | 16 +-
.../resources/measureUnits/client/Client.ts | 20 +-
src/api/resources/ocr/client/Client.ts | 16 +-
.../overdueReminders/client/Client.ts | 20 +-
.../partnerSettings/client/Client.ts | 8 +-
src/api/resources/payables/client/Client.ts | 84 +-
.../resources/lineItems/client/Client.ts | 24 +-
.../resources/paymentIntents/client/Client.ts | 16 +-
.../resources/paymentLinks/client/Client.ts | 12 +-
.../resources/paymentRecords/client/Client.ts | 28 +-
.../paymentReminders/client/Client.ts | 20 +-
.../resources/paymentTerms/client/Client.ts | 20 +-
.../resources/pdfTemplates/client/Client.ts | 20 +-
src/api/resources/products/client/Client.ts | 20 +-
src/api/resources/projects/client/Client.ts | 20 +-
.../resources/purchaseOrders/client/Client.ts | 32 +-
.../resources/receivables/client/Client.ts | 100 +-
.../resources/recurrences/client/Client.ts | 20 +-
src/api/resources/roles/client/Client.ts | 20 +-
src/api/resources/tags/client/Client.ts | 20 +-
.../resources/textTemplates/client/Client.ts | 24 +-
src/api/resources/vatRates/client/Client.ts | 4 +-
.../webhookDeliveries/client/Client.ts | 4 +-
.../webhookSubscriptions/client/Client.ts | 32 +-
src/api/types/EinvoicingConnectionResponse.ts | 4 +
src/api/types/UpdateEinvoicingAddress.ts | 16 +
src/api/types/index.ts | 1 +
src/version.ts | 2 +-
71 files changed, 895 insertions(+), 12292 deletions(-)
create mode 100644 src/api/resources/eInvoicingConnections/client/requests/EinvoicingConnectionUpdateRequest.ts
create mode 100644 src/api/types/UpdateEinvoicingAddress.ts
diff --git a/package.json b/package.json
index b39fcca..2e5b0e5 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@monite/node-client",
- "version": "0.3.3",
+ "version": "0.3.4",
"private": false,
"repository": "https://github.com/team-monite/monite-node-client",
"license": "MIT",
diff --git a/reference.md b/reference.md
index da5fe71..55bb6c2 100644
--- a/reference.md
+++ b/reference.md
@@ -2956,6 +2956,62 @@ await client.eInvoicingConnections.deleteEinvoicingConnectionsId("einvoicing_con
+client.eInvoicingConnections.patchEinvoicingConnectionsId(einvoicingConnectionId, { ...params }) -> Monite.EinvoicingConnectionResponse
+
+-
+
+#### π Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.eInvoicingConnections.patchEinvoicingConnectionsId("einvoicing_connection_id");
+```
+
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**einvoicingConnectionId:** `string`
+
+
+
+
+
+-
+
+**request:** `Monite.EinvoicingConnectionUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EInvoicingConnections.RequestOptions`
+
+
+
+
+
+
+
+
+client.eInvoicingConnections.postEinvoicingConnectionsIdNetworkCredentials(einvoicingConnectionId, { ...params }) -> Monite.EinvoicingNetworkCredentialsResponse
-
@@ -8133,11615 +8189,3 @@ await client.creditNotes.getPayableCreditNotesIdValidate("credit_note_id");
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/references/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/api/payables/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/accounts-payable/approvals/manual-transition), for example. essential data
-fields to move from `draft` to `new`
-
-Related guide: [Create a payable from data](https://docs.monite.com/accounts-payable/payables/collect#create-a-payable-from-data)
-
-See also:
-
-[Automatic calculation of due date](https://docs.monite.com/accounts-payable/payables/collect#automatic-calculation-of-due-date)
-
-[Suggested payment date](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date)
-
-[Attach file](https://docs.monite.com/accounts-payable/payables/collect#attach-file)
-
-[Collect payables by email](https://docs.monite.com/accounts-payable/payables/collect#send-payables-by-email)
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/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/accounts-payable/payables/index).
-
-
-
-
-
-
-#### π 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.
-
-For more flexible configuration and retrieval of other data types, use `GET /analytics/payables`.
-
-
-
-
-
-
-#### π 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.postPayablesIdCancelOcr(payableId) -> Monite.PayableResponseSchema
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Request to cancel the OCR processing of the specified payable.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.postPayablesIdCancelOcr("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/accounts-payable/approvals/manual-transition#mark-as-paid)
-
-See also:
-
-[Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index)
-
-[Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#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/accounts-payable/approvals/manual-transition#mark-as-partially-paid)
-
-See also:
-
-[Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index)
-
-[Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date)
-
-[Mark a payable as paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#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",
- },
- 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.paymentRecords.patchPaymentRecordsId(paymentRecordId, { ...params }) -> Monite.PaymentRecordResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.paymentRecords.patchPaymentRecordsId("payment_record_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**paymentRecordId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.PaymentRecordUpdateRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentRecords.RequestOptions`
-
-
-
-
-
-
-
-
-client.paymentRecords.postPaymentRecordsIdCancel(paymentRecordId, { ...params }) -> Monite.PaymentRecordResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.paymentRecords.postPaymentRecordsIdCancel("payment_record_id", {});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**paymentRecordId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.PaymentRecordStatusUpdateRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentRecords.RequestOptions`
-
-
-
-
-
-
-
-
-client.paymentRecords.postPaymentRecordsIdMarkAsSucceeded(paymentRecordId, { ...params }) -> Monite.PaymentRecordResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.paymentRecords.postPaymentRecordsIdMarkAsSucceeded("payment_record_id", {
- paid_at: "2024-01-15T09:30:00Z",
-});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**paymentRecordId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.PaymentRecordMarkAsSucceededRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentRecords.RequestOptions`
-
-
-
-
-
-
-
-
-client.paymentRecords.postPaymentRecordsIdStartProcessing(paymentRecordId, { ...params }) -> Monite.PaymentRecordResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.paymentRecords.postPaymentRecordsIdStartProcessing("payment_record_id", {});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**paymentRecordId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.PaymentRecordStatusUpdateRequest`
-
-
-
-
-
--
-
-**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.getReceivablesRequiredFields({ ...params }) -> Monite.ReceivableRequiredFields
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Get field requirements for invoice creation given the entity and counterpart details.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.receivables.getReceivablesRequiredFields();
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.GetReceivablesRequiredFieldsRequest`
-
-
-
-
-
--
-
-**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
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document's lifecycle. For more information, see [Document history](https://docs.monite.com/accounts-receivable/document-history).
-
-You can filter the history by the date range and event type. Events are sorted from oldest to newest by default.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.receivables.getHistory("receivable_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**receivableId:** `string` β ID of the accounts receivable document whose history you want to get.
-
-
-
-
-
--
-
-**request:** `Monite.ReceivablesGetHistoryRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Receivables.RequestOptions`
-
-
-
-
-
-
-
-
-client.receivables.getHistoryById(receivableHistoryId, receivableId) -> Monite.ReceivableHistoryResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns a single record from the change history of the specified accounts receivable document.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.receivables.getHistoryById("receivable_history_id", "receivable_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**receivableHistoryId:** `string` β ID of the history record to return. You can get these IDs from `GET /receivables/{receivable_id}/history`.
-
-
-
-
-
--
-
-**receivableId:** `string` β ID of the accounts receivable document whose history you want to get.
-
-
-
-
-
--
-
-**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.deleteRolesId(roleId) -> void
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Delete a role with the specified ID. The role being deleted must not be in use by any entity users, otherwise a 409 error is returned. To check if there are entity users that have this role, call `GET /entity_users?role_id=ROLE_ID`.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.roles.deleteRolesId("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.PartnerProjectSettingsPayloadOutput
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Retrieve all settings for this partner.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.partnerSettings.get();
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `PartnerSettings.RequestOptions`
-
-
-
-
-
-
-
-
-client.partnerSettings.update({ ...params }) -> Monite.PartnerProjectSettingsPayloadOutput
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Change the specified fields with the provided values.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.partnerSettings.update();
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.PartnerProjectSettingsPayloadInput`
-
-
-
-
-
--
-
-**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
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns an aggregated log of webhook delivery attempts. The data contains a list of triggered webhook events, how many times Monite tried to send each event to your server, the last HTTP status code returned by your webhook listener endpoint, and whether the final attempt to deliver that event was successful.
-
-We guarantee access to webhook delivery data only from the last three months. Earlier data may be unavailable.
-
-Note that if the same event type is included in multiple webhook subscriptions, the results will include several entries for each occurrence of this event - one entry per subscription.
-
-
-
-
-
-
-#### π 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() -> Monite.AccountingConnectionResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Create new connection
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.accounting.connections.create();
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**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
-
-
--
-
-
--
-
-Adds a new bank account for the specified entity.
-
-The minimum required fields are `currency` and `country`. Other required fields depend on the currency and country.
-
-Bank accounts in African countries can use any fields or combinations of fields.
-
-For other countries:
-
-- EUR accounts require `iban`.
-- GBP accounts require `account_holder_name`, `account_number`, and `sort_code`.
-- USD accounts require `account_holder_name`, `account_number`, and `routing_number`.
-- Accounts in other currencies require one of:
- - `iban`
- - `account_number` and `sort_code`
- - `account_number` and `routing_number`
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.create({
- country: "AF",
- currency: "AED",
-});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.entities.CreateEntityBankAccountRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.getById(bankAccountId) -> Monite.EntityBankAccountResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Retrieve a bank account by its ID.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.getById("bank_account_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.deleteById(bankAccountId) -> void
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Delete the bank account specified by its ID.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.deleteById("bank_account_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.updateById(bankAccountId, { ...params }) -> Monite.EntityBankAccountResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Change the specified fields with the provided values.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.updateById("bank_account_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.UpdateEntityBankAccountRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.bankAccounts.makeDefaultById(bankAccountId) -> Monite.EntityBankAccountResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Set a bank account as the default for this entity per currency.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.bankAccounts.makeDefaultById("bank_account_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**bankAccountId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `BankAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.onboardingData.get(entityId) -> Monite.EntityOnboardingDataResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.onboardingData.get("entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `OnboardingData.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.onboardingData.update(entityId, { ...params }) -> Monite.EntityOnboardingDataResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.onboardingData.update("entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityOnboardingDataRequest`
-
-
-
-
-
--
-
-**requestOptions:** `OnboardingData.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.paymentMethods.get(entityId) -> Monite.OnboardingPaymentMethodsResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Get all enabled payment methods.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.paymentMethods.get("entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentMethods.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.paymentMethods.set(entityId, { ...params }) -> Monite.OnboardingPaymentMethodsResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Set which payment methods should be enabled.
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.paymentMethods.set("entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EnabledPaymentMethods`
-
-
-
-
-
--
-
-**requestOptions:** `PaymentMethods.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.get(entityId) -> Monite.EntityVatIdResourceList
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.get("entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.create(entityId, { ...params }) -> Monite.EntityVatIdResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.create("entity_id", {
- country: "AF",
- value: "123456789",
-});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.getById(id, entityId) -> Monite.EntityVatIdResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.getById("id", "entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.deleteById(id, entityId) -> void
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.deleteById("id", "entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.vatIds.updateById(id, entityId, { ...params }) -> Monite.EntityVatIdResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.vatIds.updateById("id", "entity_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**entityId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.EntityUpdateVatId`
-
-
-
-
-
--
-
-**requestOptions:** `VatIds.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.get() -> Monite.PersonsResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.get();
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.create({ ...params }) -> Monite.PersonResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.create({
- email: "email",
- first_name: "first_name",
- last_name: "last_name",
- relationship: {},
-});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**request:** `Monite.entities.PersonRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.getById(personId) -> Monite.PersonResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.getById("person_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.deleteById(personId) -> void
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.deleteById("person_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.updateById(personId, { ...params }) -> Monite.PersonResponse
-
--
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.updateById("person_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.OptionalPersonRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.entities.persons.uploadOnboardingDocuments(personId, { ...params }) -> void
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Provide files for person onboarding verification
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.entities.persons.uploadOnboardingDocuments("person_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**personId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.entities.PersonOnboardingDocumentsPayload`
-
-
-
-
-
--
-
-**requestOptions:** `Persons.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.get(payableId, { ...params }) -> Monite.LineItemPaginationResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Get a list of all line items related to a specific payable.
-Related guide: [List all payable line items](https://docs.monite.com/accounts-payable/payables/line-items#list-all-line-items-of-a-payable)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.get("payable_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.payables.LineItemsGetRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.create(payableId, { ...params }) -> Monite.LineItemResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Add a new line item to a specific payable.
-
-The `subtotal` and `total` fields of line items are automatically calculated based on the `unit_price`,
-`quantity`, and `tax` fields, therefore, are read-only and appear only in the response schema. The field
-`ledger_account_id` is required **only** for account integration, otherwise, it is optional.
-
-Related guide: [Add line items to a payable](https://docs.monite.com/accounts-payable/payables/line-items#add-line-items-to-a-payable)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.create("payable_id", {});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.LineItemRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.replace(payableId, { ...params }) -> Monite.LineItemsReplaceResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Replaces the information of all line items of a specific payable.
-
-Related guide: [Replace all line items](https://docs.monite.com/accounts-payable/payables/line-items#replace-all-line-items)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.replace("payable_id", {
- data: [{}],
-});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.payables.LineItemsReplaceRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.getById(lineItemId, payableId) -> Monite.LineItemResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Get information about a specific line item with a given ID.
-
-Related guide: [Retrieve a line item](https://docs.monite.com/accounts-payable/payables/line-items#retrieve-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.getById("line_item_id", "payable_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.deleteById(lineItemId, payableId) -> void
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Delete the line item with the given ID.
-
-Related guide: [Remove a line item](https://docs.monite.com/accounts-payable/payables/line-items#remove-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.deleteById("line_item_id", "payable_id");
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-client.payables.lineItems.updateById(lineItemId, payableId, { ...params }) -> Monite.LineItemResponse
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Edits the information of a specific line item.
-
-Related guide: [Update a line item](https://docs.monite.com/accounts-payable/payables/line-items#update-a-line-item)
-
-See also:
-
-[Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)
-
-[Collect payables](https://docs.monite.com/accounts-payable/payables/collect)
-
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```typescript
-await client.payables.lineItems.updateById("line_item_id", "payable_id", {});
-```
-
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**lineItemId:** `string`
-
-
-
-
-
--
-
-**payableId:** `string`
-
-
-
-
-
--
-
-**request:** `Monite.LineItemRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LineItems.RequestOptions`
-
-
-
-
-
-
-
-
-