diff --git a/README.md b/README.md index fada801..3581edd 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,8 @@ import asyncio client = AsyncMonite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) async def main() -> None: await client.products.create(name='name', ) -asyncio.run(main())``` +asyncio.run(main()) +``` ## Exception Handling diff --git a/pyproject.toml b/pyproject.toml index 6a8973a..7e8d533 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "monite" [tool.poetry] name = "monite" -version = "0.5.2" +version = "0.5.3" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 96719df..d78365c 100644 --- a/reference.md +++ b/reference.md @@ -5159,6 +5159,22 @@ client.e_invoicing_connections.post_einvoicing_connections(address=EinvoicingAdd
+**is_receiver:** `typing.Optional[bool]` — Set to `true` if the entity needs to receive e-invoices. + +
+
+ +
+
+ +**is_sender:** `typing.Optional[bool]` — Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -5269,6 +5285,81 @@ client.e_invoicing_connections.delete_einvoicing_connections_id(einvoicing_conne
+ + + + +
client.e_invoicing_connections.patch_einvoicing_connections_id(...) +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from monite import Monite +client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) +client.e_invoicing_connections.patch_einvoicing_connections_id(einvoicing_connection_id='einvoicing_connection_id', ) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**einvoicing_connection_id:** `str` + +
+
+ +
+
+ +**address:** `typing.Optional[UpdateEinvoicingAddress]` — Integration Address + +
+
+ +
+
+ +**is_receiver:** `typing.Optional[bool]` — Set to `true` if the entity needs to receive e-invoices. + +
+
+ +
+
+ +**is_sender:** `typing.Optional[bool]` — Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ +
@@ -16426,13649 +16517,3 @@ client.payables.validate_by_id(payable_id='payable_id', ) ## Payment intents
client.payment_intents.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_intents.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Order by - -
-
- -
-
- -**limit:** `typing.Optional[int]` — Max is 100 - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` — A token, obtained from previous page. Prior over other filters - -
-
- -
-
- -**sort:** `typing.Optional[PaymentIntentCursorFields]` — Allowed sort fields - -
-
- -
-
- -**object_id:** `typing.Optional[str]` — ID of a payable or receivable invoice. If provided, returns only payment intents associated with the specified invoice. - -
-
- -
-
- -**object_id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — A list of payable IDs and/or receivable IDs. If provided, returns only payment intents associated with the specified payable and receivable invoices. Valid but nonexistent IDs do not raise errors but produce no results. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_intents.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_intents.get_by_id(payment_intent_id='payment_intent_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_intent_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_intents.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_intents.update_by_id(payment_intent_id='payment_intent_id', amount=1, ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_intent_id:** `str` - -
-
- -
-
- -**amount:** `int` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_intents.get_history_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_intents.get_history_by_id(payment_intent_id='payment_intent_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_intent_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Payment links -
client.payment_links.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import PaymentAccountObject -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_links.create(payment_methods=["sepa_credit"], recipient=PaymentAccountObject(id='id', type="entity", ), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_methods:** `typing.Sequence[MoniteAllPaymentMethodsTypes]` - -
-
- -
-
- -**recipient:** `PaymentAccountObject` - -
-
- -
-
- -**amount:** `typing.Optional[int]` — The payment amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Required if `object` is not specified. - -
-
- -
-
- -**currency:** `typing.Optional[CurrencyEnum]` — The payment currency. Required if `object` is not specified. - -
-
- -
-
- -**expires_at:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**invoice:** `typing.Optional[Invoice]` — An object containing information about the invoice being paid. Used only if `object` is not specified. - -
-
- -
-
- -**object:** `typing.Optional[PaymentObject]` — If the invoice being paid is a payable or receivable stored in Monite, provide the `object` object containing the invoice type and ID. Otherwise, use the `amount`, `currency`, `payment_reference`, and (optionally) `invoice` fields to specify the invoice-related data. - -
-
- -
-
- -**payment_reference:** `typing.Optional[str]` — A payment reference number that the recipient can use to identify the payer or purpose of the transaction. Required if `object` is not specified. - -
-
- -
-
- -**return_url:** `typing.Optional[str]` — The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_links.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_links.get_by_id(payment_link_id='payment_link_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_link_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_links.expire_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_links.expire_by_id(payment_link_id='payment_link_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_link_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Payment records -
client.payment_records.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Order by - -
-
- -
-
- -**limit:** `typing.Optional[int]` — Max is 100 - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` — A token, obtained from previous page. Prior over other filters - -
-
- -
-
- -**sort:** `typing.Optional[PaymentRecordCursorFields]` — Allowed sort fields - -
-
- -
-
- -**is_external:** `typing.Optional[bool]` — Identifies whether payment is from our rails or external system - -
-
- -
-
- -**object_id:** `typing.Optional[str]` — ID of the object, that is connected to payment - -
-
- -
-
- -**object_type:** `typing.Optional[ObjectTypeEnum]` — Type of an object, which is connected with payment - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` — Created after this datetime (exclusive) - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` — Created before this datetime (exclusive) - -
-
- -
-
- -**updated_at_gt:** `typing.Optional[dt.datetime]` — Updated after this datetime (exclusive) - -
-
- -
-
- -**updated_at_lt:** `typing.Optional[dt.datetime]` — Updated before this datetime (exclusive) - -
-
- -
-
- -**paid_at_gt:** `typing.Optional[dt.datetime]` — Paid after this datetime (exclusive) - -
-
- -
-
- -**paid_at_lt:** `typing.Optional[dt.datetime]` — Paid before this datetime (exclusive) - -
-
- -
-
- -**planned_payment_date:** `typing.Optional[str]` — Optional date of the upcoming payment (equality) - -
-
- -
-
- -**planned_payment_date_gt:** `typing.Optional[str]` — Planned after this date (exclusive) - -
-
- -
-
- -**planned_payment_date_lt:** `typing.Optional[str]` — Planned before this date (exclusive) - -
-
- -
-
- -**planned_payment_date_gte:** `typing.Optional[str]` — Planned at or after this date (inclusive) - -
-
- -
-
- -**planned_payment_date_lte:** `typing.Optional[str]` — Planned at or before this date (inclusive) - -
-
- -
-
- -**status:** `typing.Optional[PaymentRecordStatusEnum]` — One of the payment record statuses - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Payment intent status as a raw string - -
-
- -
-
- -**payment_method:** `typing.Optional[str]` — Payment method used for the transaction - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import PaymentRecordObjectRequest -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.create(amount=1, currency="AED", object=PaymentRecordObjectRequest(id='id', type="receivable", ), payment_intent_id='payment_intent_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**amount:** `int` — Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents). - -
-
- -
-
- -**currency:** `CurrencyEnum` — Currency code (ISO 4217) indicating the currency in which the payment was made. - -
-
- -
-
- -**object:** `PaymentRecordObjectRequest` — Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier. - -
-
- -
-
- -**payment_intent_id:** `str` — Identifier for an payment intent. - -
-
- -
-
- -**entity_user_id:** `typing.Optional[str]` — ID of the user associated with the payment, if applicable. - -
-
- -
-
- -**paid_at:** `typing.Optional[dt.datetime]` — Timestamp marking when the payment was executed. Null if payment hasn't occurred yet. - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Raw status string of the external payment intent. - -
-
- -
-
- -**payment_method:** `typing.Optional[str]` — Payment method used or planned for the transaction. - -
-
- -
-
- -**planned_payment_date:** `typing.Optional[str]` — Scheduled date for future payments, required when the payment is planned but not yet executed. - -
-
- -
-
- -**status:** `typing.Optional[PaymentRecordRequestStatus]` — Status of the payment record indicating its current stage (e.g., created, processing, succeeded). - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.get_by_id(payment_record_id='payment_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_record_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.patch_payment_records_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.patch_payment_records_id(payment_record_id='payment_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_record_id:** `str` - -
-
- -
-
- -**amount:** `typing.Optional[int]` — Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents). - -
-
- -
-
- -**currency:** `typing.Optional[CurrencyEnum]` — Currency code (ISO 4217) indicating the currency in which the payment was made. - -
-
- -
-
- -**entity_user_id:** `typing.Optional[str]` — ID of the user associated with the payment, if applicable. - -
-
- -
-
- -**object:** `typing.Optional[PaymentRecordObjectRequest]` — Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier. - -
-
- -
-
- -**paid_at:** `typing.Optional[dt.datetime]` — Timestamp marking when the payment was executed. Null if payment hasn't occurred yet. - -
-
- -
-
- -**payment_intent_id:** `typing.Optional[str]` — Identifier for an payment intent. - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Raw status string of the external payment intent. - -
-
- -
-
- -**payment_method:** `typing.Optional[str]` — Payment method used or planned for the transaction. - -
-
- -
-
- -**planned_payment_date:** `typing.Optional[str]` — Scheduled date for future payments, required when the payment is planned but not yet executed. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.post_payment_records_id_cancel(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.post_payment_records_id_cancel(payment_record_id='payment_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_record_id:** `str` - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Raw status string of the external payment intent. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.post_payment_records_id_mark_as_succeeded(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -import datetime -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.post_payment_records_id_mark_as_succeeded(payment_record_id='payment_record_id', paid_at=datetime.datetime.fromisoformat("2024-01-15 09:30:00+00:00", ), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_record_id:** `str` - -
-
- -
-
- -**paid_at:** `dt.datetime` — Timestamp marking when the payment was executed. - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Raw status string of the external payment intent. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_records.post_payment_records_id_start_processing(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_records.post_payment_records_id_start_processing(payment_record_id='payment_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_record_id:** `str` - -
-
- -
-
- -**payment_intent_status:** `typing.Optional[str]` — Raw status string of the external payment intent. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Payment reminders -
client.payment_reminders.get() -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_reminders.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_reminders.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_reminders.create(name='name', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**term1reminder:** `typing.Optional[Reminder]` — Reminder to send for first payment term - -
-
- -
-
- -**term2reminder:** `typing.Optional[Reminder]` — Reminder to send for second payment term - -
-
- -
-
- -**term_final_reminder:** `typing.Optional[Reminder]` — Reminder to send for final payment term - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_reminders.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_reminders.get_by_id(payment_reminder_id='payment_reminder_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_reminder_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_reminders.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_reminders.delete_by_id(payment_reminder_id='payment_reminder_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_reminder_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_reminders.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_reminders.update_by_id(payment_reminder_id='payment_reminder_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_reminder_id:** `str` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**term1reminder:** `typing.Optional[Reminder]` — Reminder to send for first payment term - -
-
- -
-
- -**term2reminder:** `typing.Optional[Reminder]` — Reminder to send for second payment term - -
-
- -
-
- -**term_final_reminder:** `typing.Optional[Reminder]` — Reminder to send for final payment term - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Payment terms -
client.payment_terms.get() -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_terms.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_terms.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import PaymentTerm -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_terms.create(name='name', term_final=PaymentTerm(number_of_days=1, ), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` - -
-
- -
-
- -**term_final:** `PaymentTerm` — The final tier of the payment term. Defines the invoice due date. - -
-
- -
-
- -**description:** `typing.Optional[str]` - -
-
- -
-
- -**term1:** `typing.Optional[PaymentTermDiscount]` — The first tier of the payment term. Represents the terms of the first early discount. - -
-
- -
-
- -**term2:** `typing.Optional[PaymentTermDiscount]` — The second tier of the payment term. Defines the terms of the second early discount. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_terms.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_terms.get_by_id(payment_terms_id='payment_terms_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_terms_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_terms.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_terms.delete_by_id(payment_terms_id='payment_terms_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_terms_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payment_terms.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payment_terms.update_by_id(payment_terms_id='payment_terms_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payment_terms_id:** `str` - -
-
- -
-
- -**description:** `typing.Optional[str]` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**term1:** `typing.Optional[PaymentTermDiscount]` — The first tier of the payment term. Represents the terms of the first early discount. - -
-
- -
-
- -**term2:** `typing.Optional[PaymentTermDiscount]` — The second tier of the payment term. Defines the terms of the second early discount. - -
-
- -
-
- -**term_final:** `typing.Optional[PaymentTerm]` — The final tier of the payment term. Defines the invoice due date. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Products -
client.products.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.products.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[ProductCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**name_contains:** `typing.Optional[str]` - -
-
- -
-
- -**name_icontains:** `typing.Optional[str]` - -
-
- -
-
- -**type:** `typing.Optional[ProductServiceTypeEnum]` - -
-
- -
-
- -**price:** `typing.Optional[int]` - -
-
- -
-
- -**price_gt:** `typing.Optional[int]` - -
-
- -
-
- -**price_lt:** `typing.Optional[int]` - -
-
- -
-
- -**price_gte:** `typing.Optional[int]` - -
-
- -
-
- -**price_lte:** `typing.Optional[int]` - -
-
- -
-
- -**currency:** `typing.Optional[CurrencyEnum]` - -
-
- -
-
- -**currency_in:** `typing.Optional[typing.Union[CurrencyEnum, typing.Sequence[CurrencyEnum]]]` - -
-
- -
-
- -**measure_unit_id:** `typing.Optional[str]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.products.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.products.create(name='name', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` — Name of the product. - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of the product. - -
-
- -
-
- -**ledger_account_id:** `typing.Optional[str]` - -
-
- -
-
- -**measure_unit_id:** `typing.Optional[str]` — The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). - -
-
- -
-
- -**price:** `typing.Optional[Price]` - -
-
- -
-
- -**smallest_amount:** `typing.Optional[float]` — The smallest amount allowed for this product. - -
-
- -
-
- -**type:** `typing.Optional[ProductServiceTypeEnum]` — Specifies whether this offering is a product or service. This may affect the applicable tax rates. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.products.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.products.get_by_id(product_id='product_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**product_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.products.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.products.delete_by_id(product_id='product_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**product_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.products.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.products.update_by_id(product_id='product_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**product_id:** `str` - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of the product. - -
-
- -
-
- -**ledger_account_id:** `typing.Optional[str]` - -
-
- -
-
- -**measure_unit_id:** `typing.Optional[str]` — The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). - -
-
- -
-
- -**name:** `typing.Optional[str]` — Name of the product. - -
-
- -
-
- -**price:** `typing.Optional[Price]` - -
-
- -
-
- -**smallest_amount:** `typing.Optional[float]` — The smallest amount allowed for this product. - -
-
- -
-
- -**type:** `typing.Optional[ProductServiceTypeEnum]` — Specifies whether this offering is a product or service. This may affect the applicable tax rates. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Projects -
client.projects.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all projects for an entity -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.projects.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[ProjectCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**start_date:** `typing.Optional[str]` - -
-
- -
-
- -**start_date_gt:** `typing.Optional[str]` - -
-
- -
-
- -**start_date_lt:** `typing.Optional[str]` - -
-
- -
-
- -**start_date_gte:** `typing.Optional[str]` - -
-
- -
-
- -**start_date_lte:** `typing.Optional[str]` - -
-
- -
-
- -**end_date:** `typing.Optional[str]` - -
-
- -
-
- -**end_date_gt:** `typing.Optional[str]` - -
-
- -
-
- -**end_date_lt:** `typing.Optional[str]` - -
-
- -
-
- -**end_date_gte:** `typing.Optional[str]` - -
-
- -
-
- -**end_date_lte:** `typing.Optional[str]` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**name_iexact:** `typing.Optional[str]` - -
-
- -
-
- -**name_contains:** `typing.Optional[str]` - -
-
- -
-
- -**name_icontains:** `typing.Optional[str]` - -
-
- -
-
- -**code:** `typing.Optional[str]` - -
-
- -
-
- -**created_by_entity_user_id:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.projects.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Create a new project. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.projects.create(name='Marketing', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` — The project name. - -
-
- -
-
- -**code:** `typing.Optional[str]` — Project code - -
-
- -
-
- -**color:** `typing.Optional[str]` — Project color - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of project - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — Project end date - -
-
- -
-
- -**parent_id:** `typing.Optional[str]` — Parent project ID - -
-
- -
-
- -**partner_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Project metadata - -
-
- -
-
- -**start_date:** `typing.Optional[str]` — Project start date - -
-
- -
-
- -**tag_ids:** `typing.Optional[typing.Sequence[str]]` — A list of IDs of user-defined tags (labels) assigned to this project. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.projects.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get a project with the given ID. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.projects.get_by_id(project_id='project_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**project_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.projects.delete_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Delete a project. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.projects.delete_by_id(project_id='project_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**project_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.projects.update_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Update a project. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.projects.update_by_id(project_id='project_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**project_id:** `str` - -
-
- -
-
- -**code:** `typing.Optional[str]` — Project code - -
-
- -
-
- -**color:** `typing.Optional[str]` — Project color - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of project - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — Project end date - -
-
- -
-
- -**name:** `typing.Optional[str]` — The project name. - -
-
- -
-
- -**parent_id:** `typing.Optional[str]` — Parent project ID - -
-
- -
-
- -**partner_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Project metadata - -
-
- -
-
- -**start_date:** `typing.Optional[str]` — Project start date - -
-
- -
-
- -**tag_ids:** `typing.Optional[typing.Sequence[str]]` — A list of IDs of user-defined tags (labels) assigned to this project. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Receivables -
client.receivables.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` - -The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. - -When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. - -To specify multiple IDs, repeat this parameter for each value: -`id__in=&id__in=` - -
-
- -
-
- -**status_in:** `typing.Optional[typing.Union[ReceivablesGetRequestStatusInItem, typing.Sequence[ReceivablesGetRequestStatusInItem]]]` - -Return only receivables that have the specified statuses. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). - -To specify multiple statuses, repeat this parameter for each value: -`status__in=draft&status__in=issued` - -
-
- -
-
- -**entity_user_id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables created by the entity users with the specified IDs.To specify multiple user IDs, repeat this parameter for each ID: -`entity_user_id__in=&entity_user_id__in=` - -If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. - -IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results. - -
-
- -
-
- -**sort:** `typing.Optional[ReceivableCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**tag_ids_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables whose [tags](https://docs.monite.com/common/tags) include at least one of the tags with the specified IDs. - -For example, given receivables with the following tags: -1. tagA -2. tagB -3. tagA, tagB -4. tagC -5. tagB, tagC - - -`tag_ids__in=&tag_ids__in=` will return receivables 1, 2, 3, and 5. - -Valid but nonexistent tag IDs do not raise errors but produce no results. - -
-
- -
-
- -**tag_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables whose [tags](https://docs.monite.com/common/tags) include all of the tags with the specified IDs and optionally other tags that are not specified. - -For example, given receivables with the following tags: -1. tagA -2. tagB -3. tagA, tagB -4. tagC -5. tagA, tagB, tagC - - -`tag_ids=&tag_ids=` will return receivables 3 and 5. - -
-
- -
-
- -**product_ids_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables whose line items include at least one of the product IDs with the specified IDs. - -To specify multiple product IDs, repeat this parameter for each ID: -`product_ids__in=&product_ids__in=` - -For example, given receivables with the following product IDs: -1. productA -2. productB -3. productA, productB -4. productC -5. productB, productC - - -`product_ids__in=&product_ids__in=` will return receivables 1, 2, 3, and 5.Valid but nonexistent product IDs do not raise errors but produce no results. - -
-
- -
-
- -**product_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only receivables whose line items include all of the product IDs with the specified IDs and optionally other products that are not specified. - -To specify multiple product IDs, repeat this parameter for each ID: -`product_ids=&product_ids=` - -For example, given receivables with the following product IDs: -1. productA -2. productB -3. productA, productB -4. productC -5. productA, productB, productC - - -`product_ids=&product_ids=` will return receivables 3 and 5. - -
-
- -
-
- -**project_id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Return only receivables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. - -
-
- -
-
- -**type:** `typing.Optional[ReceivableType]` - -
-
- -
-
- -**document_id:** `typing.Optional[str]` - -
-
- -
-
- -**document_id_contains:** `typing.Optional[str]` - -
-
- -
-
- -**document_id_icontains:** `typing.Optional[str]` - -
-
- -
-
- -**issue_date_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**issue_date_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**issue_date_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**issue_date_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**counterpart_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_name:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_name_contains:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_name_icontains:** `typing.Optional[str]` - -
-
- -
-
- -**total_amount:** `typing.Optional[int]` - -
-
- -
-
- -**total_amount_gt:** `typing.Optional[int]` - -
-
- -
-
- -**total_amount_lt:** `typing.Optional[int]` - -
-
- -
-
- -**total_amount_gte:** `typing.Optional[int]` - -
-
- -
-
- -**total_amount_lte:** `typing.Optional[int]` - -
-
- -
-
- -**status:** `typing.Optional[ReceivablesGetRequestStatus]` - -
-
- -
-
- -**entity_user_id:** `typing.Optional[str]` - -
-
- -
-
- -**based_on:** `typing.Optional[str]` - -
-
- -
-
- -**due_date_gt:** `typing.Optional[str]` - -
-
- -
-
- -**due_date_lt:** `typing.Optional[str]` - -
-
- -
-
- -**due_date_gte:** `typing.Optional[str]` - -
-
- -
-
- -**due_date_lte:** `typing.Optional[str]` - -
-
- -
-
- -**project_id:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import ReceivableFacadeCreateQuotePayload -from monite import LineItem -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.create(request=ReceivableFacadeCreateQuotePayload(counterpart_billing_address_id='counterpart_billing_address_id', counterpart_id='counterpart_id', currency="AED", line_items=[LineItem(quantity=1.1, )], ), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request:** `ReceivableFacadeCreatePayload` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_receivables_required_fields(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get field requirements for invoice creation given the entity and counterpart details. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_receivables_required_fields() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_billing_address_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_country:** `typing.Optional[AllowedCountries]` - -
-
- -
-
- -**counterpart_type:** `typing.Optional[CounterpartType]` - -
-
- -
-
- -**entity_vat_id_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_vat_id_id:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_variables() -
-
- -#### 📝 Description - -
-
- -
-
- -Get a list of placeholders that can be used in email templates for customization. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_variables() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.delete_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import UpdateQuotePayload -from monite import UpdateQuote -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.update_by_id(receivable_id='receivable_id', request=UpdateQuotePayload(quote=UpdateQuote(), ), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request:** `ReceivableUpdatePayload` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.accept_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.accept_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**signature:** `typing.Optional[Signature]` — A digital signature, if required for quote acceptance - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.cancel_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.cancel_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.clone_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.clone_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.decline_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.decline_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**comment:** `typing.Optional[str]` — Field with a comment on why the client declined this Quote - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_history(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_history(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` — ID of the accounts receivable document whose history you want to get. - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[ReceivableHistoryCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**event_type_in:** `typing.Optional[typing.Union[ReceivableHistoryEventTypeEnum, typing.Sequence[ReceivableHistoryEventTypeEnum]]]` - -Return only the specified [event types](https://docs.monite.com/accounts-receivable/document-history#event-types). To include multiple types, repeat this parameter for each value: -`event_type__in=receivable_updated&event_type__in=status_changed` - -
-
- -
-
- -**entity_user_id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -Return only events caused by the entity users with the specified IDs. To specify multiple user IDs, repeat this parameter for each ID: -`entity_user_id__in=&entity_user_id__in=` - -
-
- -
-
- -**timestamp_gt:** `typing.Optional[dt.datetime]` — Return only events that occurred after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]`. - -
-
- -
-
- -**timestamp_lt:** `typing.Optional[dt.datetime]` — Return only events that occurred before the specified date and time. - -
-
- -
-
- -**timestamp_gte:** `typing.Optional[dt.datetime]` — Return only events that occurred on or after the specified date and time. - -
-
- -
-
- -**timestamp_lte:** `typing.Optional[dt.datetime]` — Return only events that occurred before or on the specified date and time. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_history_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a single record from the change history of the specified accounts receivable document. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_history_by_id(receivable_history_id='receivable_history_id', receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_history_id:** `str` — ID of the history record to return. You can get these IDs from `GET /receivables/{receivable_id}/history`. - -
-
- -
-
- -**receivable_id:** `str` — ID of the accounts receivable document whose history you want to get. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.issue_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.issue_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.update_line_items_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Replace all line items of an existing invoice or quote with a new list of line items. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import LineItem -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.update_line_items_by_id(receivable_id='receivable_id', data=[LineItem(quantity=1.1, )], ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**data:** `typing.Sequence[LineItem]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_mails(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_mails(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[ReceivableMailCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**status:** `typing.Optional[ReceivableMailStatusEnum]` - -
-
- -
-
- -**status_in:** `typing.Optional[typing.Union[ReceivableMailStatusEnum, typing.Sequence[ReceivableMailStatusEnum]]]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_mail_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_mail_by_id(receivable_id='receivable_id', mail_id='mail_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**mail_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.mark_as_paid_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.mark_as_paid_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**comment:** `typing.Optional[str]` — Optional comment explaining how the payment was made. - -
-
- -
-
- -**paid_at:** `typing.Optional[dt.datetime]` — Date and time when the invoice was paid. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.mark_as_partially_paid_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Deprecated. Use `POST /payment_records` to record an invoice payment. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.mark_as_partially_paid_by_id(receivable_id='receivable_id', amount_paid=1, ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**amount_paid:** `int` — How much has been paid on the invoice (in minor units). - -
-
- -
-
- -**comment:** `typing.Optional[str]` — Optional comment explaining how the payment was made. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.mark_as_uncollectible_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.mark_as_uncollectible_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**comment:** `typing.Optional[str]` — Optional comment explains why the Invoice goes uncollectible. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.get_pdf_link_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.get_pdf_link_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.preview_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.preview_by_id(receivable_id='receivable_id', body_text='body_text', subject_text='subject_text', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**body_text:** `str` — Body text of the content - -
-
- -
-
- -**subject_text:** `str` — Subject text of the content - -
-
- -
-
- -**language:** `typing.Optional[LanguageCodeEnum]` — Language code for localization purposes - -
-
- -
-
- -**type:** `typing.Optional[ReceivablesPreviewTypeEnum]` — The type of the preview document. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.send_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.send_by_id(receivable_id='receivable_id', body_text='body_text', subject_text='subject_text', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**body_text:** `str` — Body text of the content - -
-
- -
-
- -**subject_text:** `str` — Subject text of the content - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.send_test_reminder_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.send_test_reminder_by_id(receivable_id='receivable_id', reminder_type="term_1", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**reminder_type:** `ReminderTypeEnum` — The type of the reminder to be sent. - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.receivables.verify_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.receivables.verify_by_id(receivable_id='receivable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**receivable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Recurrences -
client.recurrences.get() -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.recurrences.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.recurrences.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -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 - -
-
- -
-
- -**day_of_month:** `DayOfMonth` - -
-
- -
-
- -**end_month:** `int` - -
-
- -
-
- -**end_year:** `int` - -
-
- -
-
- -**invoice_id:** `str` - -
-
- -
-
- -**start_month:** `int` - -
-
- -
-
- -**start_year:** `int` - -
-
- -
-
- -**automation_level:** `typing.Optional[AutomationLevel]` - -Controls how invoices are processed when generated: -- "draft": Creates invoices in draft status, requiring manual review, issuing, and sending -- "issue": Automatically issues invoices but requires manual sending -- "issue_and_send": Fully automates the process (creates, issues, and sends invoices) - -Default: "issue" (or "issue_and_send" if subject_text and body_text are provided) - -Note: When using "issue_and_send", both subject_text and body_text must be provided. - -
-
- -
-
- -**body_text:** `typing.Optional[str]` - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**subject_text:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.recurrences.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.recurrences.get_by_id(recurrence_id='recurrence_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**recurrence_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.recurrences.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.recurrences.update_by_id(recurrence_id='recurrence_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**recurrence_id:** `str` - -
-
- -
-
- -**automation_level:** `typing.Optional[AutomationLevel]` - -Controls how invoices are processed when generated: -- "draft": Creates invoices in draft status, requiring manual review, issuing, and sending -- "issue": Automatically issues invoices but requires manual sending -- "issue_and_send": Fully automates the process (creates, issues, and sends invoices) - -Default: "issue" (or "issue_and_send" if subject_text and body_text are provided) - -Note: When using "issue_and_send", both subject_text and body_text must be provided. - -
-
- -
-
- -**body_text:** `typing.Optional[str]` - -
-
- -
-
- -**day_of_month:** `typing.Optional[DayOfMonth]` - -
-
- -
-
- -**end_month:** `typing.Optional[int]` - -
-
- -
-
- -**end_year:** `typing.Optional[int]` - -
-
- -
-
- -**recipients:** `typing.Optional[Recipients]` - -
-
- -
-
- -**subject_text:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.recurrences.cancel_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.recurrences.cancel_by_id(recurrence_id='recurrence_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**recurrence_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Roles -
client.roles.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Find all roles that match the search criteria. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.roles.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[RoleCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**created_at:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.roles.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Create a new role from the specified values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import BizObjectsSchemaInput -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.roles.create(name='name', permissions=BizObjectsSchemaInput(), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` — Role name - -
-
- -
-
- -**permissions:** `BizObjectsSchemaInput` — Access permissions - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.roles.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.roles.get_by_id(role_id='role_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**role_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.roles.delete_roles_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.roles.delete_roles_id(role_id='role_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**role_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.roles.update_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Change the specified fields with the provided values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.roles.update_by_id(role_id='role_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**role_id:** `str` - -
-
- -
-
- -**name:** `typing.Optional[str]` — Role name - -
-
- -
-
- -**permissions:** `typing.Optional[BizObjectsSchemaInput]` — Access permissions - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Partner settings -
client.partner_settings.get() -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve all settings for this partner. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.partner_settings.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.partner_settings.update(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Change the specified fields with the provided values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.partner_settings.update() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**currency:** `typing.Optional[CurrencySettingsInput]` — Custom currency exchange rates. - -
-
- -
-
- -**payable:** `typing.Optional[PayableSettings]` — Settings for the payables module. - -
-
- -
-
- -**receivable:** `typing.Optional[ReceivableSettings]` — Settings for the receivables module. - -
-
- -
-
- -**mail:** `typing.Optional[MailSettings]` — Settings for email and mailboxes. - -
-
- -
-
- -**commercial_conditions:** `typing.Optional[typing.Sequence[str]]` — Commercial conditions for receivables. - -
-
- -
-
- -**units:** `typing.Optional[typing.Sequence[Unit]]` — Measurement units. - -
-
- -
-
- -**website:** `typing.Optional[str]` - -
-
- -
-
- -**default_role:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A default role to provision upon new entity creation. - -
-
- -
-
- -**payments:** `typing.Optional[PaymentsSettingsInput]` — Settings for the payments module. - -
-
- -
-
- -**api_version:** `typing.Optional[ApiVersion]` — Default API version for partner. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Tags -
client.tags.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.tags.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[TagCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**created_by_entity_user_id:** `typing.Optional[str]` - -
-
- -
-
- -**name_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -
-
- -
-
- -**id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.tags.create(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.tags.create(name='Marketing', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**name:** `str` — The tag name. Must be unique. - -
-
- -
-
- -**category:** `typing.Optional[TagCategory]` — The tag category. - -
-
- -
-
- -**description:** `typing.Optional[str]` — The tag description. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.tags.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get information about a tag with the given ID. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.tags.get_by_id(tag_id='tag_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**tag_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.tags.delete_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Delete a tag with the given ID. This tag will be automatically deleted from all resources where it was used. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.tags.delete_by_id(tag_id='tag_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**tag_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.tags.update_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.tags.update_by_id(tag_id='tag_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**tag_id:** `str` - -
-
- -
-
- -**category:** `typing.Optional[TagCategory]` — The tag category. - -
-
- -
-
- -**description:** `typing.Optional[str]` — The tag description. - -
-
- -
-
- -**name:** `typing.Optional[str]` — The tag name. Must be unique. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Text templates -
client.text_templates.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get text templates -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**type:** `typing.Optional[TextTemplateType]` - -
-
- -
-
- -**document_type:** `typing.Optional[TextTemplateDocumentTypeEnum]` - -
-
- -
-
- -**is_default:** `typing.Optional[bool]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.text_templates.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Create a text template -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.create(document_type="quote", name='name', template='template', type="email_header", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**document_type:** `TextTemplateDocumentTypeEnum` - -
-
- -
-
- -**name:** `str` - -
-
- -
-
- -**template:** `str` - -
-
- -
-
- -**type:** `TextTemplateType` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.text_templates.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all custom contents -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.get_by_id(text_template_id='text_template_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**text_template_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.text_templates.delete_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Delete custom content by ID -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.delete_by_id(text_template_id='text_template_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**text_template_id:** `str` — UUID text_template ID - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.text_templates.update_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Update custom content by ID -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.update_by_id(text_template_id='text_template_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**text_template_id:** `str` — UUID text_template ID - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**template:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.text_templates.make_default_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Make text template default -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.text_templates.make_default_by_id(text_template_id='text_template_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**text_template_id:** `str` — UUID text_template ID - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## VAT rates -
client.vat_rates.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.vat_rates.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_address_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_id:** `typing.Optional[str]` - -
-
- -
-
- -**counterpart_vat_id_id:** `typing.Optional[str]` - -
-
- -
-
- -**entity_vat_id_id:** `typing.Optional[str]` - -
-
- -
-
- -**product_type:** `typing.Optional[ProductServiceTypeEnum]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Webhook deliveries -
client.webhook_deliveries.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_deliveries.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[WebhookDeliveryCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**event_id:** `typing.Optional[str]` - -
-
- -
-
- -**object_type:** `typing.Optional[WebhookObjectType]` - -
-
- -
-
- -**event_action:** `typing.Optional[str]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Webhook subscriptions -
client.webhook_subscriptions.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[WebhookSubscriptionCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**object_type:** `typing.Optional[WebhookObjectType]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.create(object_type="account", url='url', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**object_type:** `WebhookObjectType` - -
-
- -
-
- -**url:** `str` - -
-
- -
-
- -**event_types:** `typing.Optional[typing.Sequence[str]]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.get_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.delete_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.update_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**event_types:** `typing.Optional[typing.Sequence[str]]` - -
-
- -
-
- -**object_type:** `typing.Optional[WebhookObjectType]` - -
-
- -
-
- -**url:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.disable_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.disable_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.enable_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.enable_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.webhook_subscriptions.regenerate_secret_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.webhook_subscriptions.regenerate_secret_by_id(webhook_subscription_id='webhook_subscription_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**webhook_subscription_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting Payables -
client.accounting.payables.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.payables.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**limit:** `typing.Optional[int]` — Number of results per page. - -
-
- -
-
- -**offset:** `typing.Optional[int]` — Number of results to skip before selecting items to return. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.payables.get_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.payables.get_by_id(payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payable_id:** `str` — An internal ID of the payable invoice (bill) in the accounting system. You can get these IDs from `GET /accounting/payables`. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting Receivables -
client.accounting.receivables.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.receivables.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**limit:** `typing.Optional[int]` — Number of results per page. - -
-
- -
-
- -**offset:** `typing.Optional[int]` — Number of results to skip before selecting items to return. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.receivables.get_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.receivables.get_by_id(invoice_id='invoice_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**invoice_id:** `str` — An internal ID of the invoice in the accounting system. You can get these IDs from `GET /accounting/receivables`. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting Connections -
client.accounting.connections.get() -
-
- -#### 📝 Description - -
-
- -
-
- -Get all connections -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.connections.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.connections.create() -
-
- -#### 📝 Description - -
-
- -
-
- -Create new connection -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.connections.create() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.connections.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get connection by id -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.connections.get_by_id(connection_id='connection_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**connection_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.connections.disconnect_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Disconnect -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.connections.disconnect_by_id(connection_id='connection_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**connection_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.connections.sync_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.connections.sync_by_id(connection_id='connection_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**connection_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting SyncedRecords -
client.accounting.synced_records.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get synchronized records -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.synced_records.get(object_type="product", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**object_type:** `ObjectMatchTypes` - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[SyncRecordCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**object_id:** `typing.Optional[str]` - -
-
- -
-
- -**object_id_in:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.synced_records.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get synchronized record by id -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.synced_records.get_by_id(synced_record_id='synced_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**synced_record_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.synced_records.push_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Push object to the accounting system manually -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.synced_records.push_by_id(synced_record_id='synced_record_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**synced_record_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting TaxRates -
client.accounting.tax_rates.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all tax rate accounts -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.tax_rates.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[TaxRateAccountCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.tax_rates.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get tax rate account by id -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.tax_rates.get_by_id(tax_rate_id='tax_rate_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**tax_rate_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Accounting LedgerAccounts -
client.accounting.ledger_accounts.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all ledger accounts -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.ledger_accounts.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[LedgerAccountCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.accounting.ledger_accounts.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get ledger account by id -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.accounting.ledger_accounts.get_by_id(ledger_account_id='ledger_account_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**ledger_account_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## ApprovalPolicies Processes -
client.approval_policies.processes.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve a list of all approval policy processes. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.approval_policies.processes.get(approval_policy_id='approval_policy_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**approval_policy_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.approval_policies.processes.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve a specific approval policy process. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.approval_policies.processes.get_by_id(approval_policy_id='approval_policy_id', process_id='process_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**approval_policy_id:** `str` - -
-
- -
-
- -**process_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.approval_policies.processes.cancel_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Cancel an ongoing approval process for a specific approval policy. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.approval_policies.processes.cancel_by_id(approval_policy_id='approval_policy_id', process_id='process_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**approval_policy_id:** `str` - -
-
- -
-
- -**process_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.approval_policies.processes.get_steps(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve a list of approval policy process steps. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.approval_policies.processes.get_steps(approval_policy_id='approval_policy_id', process_id='process_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**approval_policy_id:** `str` - -
-
- -
-
- -**process_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Counterparts Addresses -
client.counterparts.addresses.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.addresses.get(counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.addresses.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.addresses.create(counterpart_id='counterpart_id', city='Berlin', country="AF", line1='Flughafenstrasse 52', postal_code='10115', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**city:** `str` — City name. - -
-
- -
-
- -**country:** `AllowedCountries` — Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - -
-
- -
-
- -**line1:** `str` — Street address. - -
-
- -
-
- -**postal_code:** `str` — ZIP or postal code. - -
-
- -
-
- -**line2:** `typing.Optional[str]` — Additional address information (if any). - -
-
- -
-
- -**state:** `typing.Optional[str]` — State, region, province, or county. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.addresses.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.addresses.get_by_id(address_id='address_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**address_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.addresses.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.addresses.delete_by_id(address_id='address_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**address_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.addresses.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.addresses.update_by_id(address_id='address_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**address_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**city:** `typing.Optional[str]` — City name. - -
-
- -
-
- -**country:** `typing.Optional[AllowedCountries]` — Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - -
-
- -
-
- -**line1:** `typing.Optional[str]` — Street address. - -
-
- -
-
- -**line2:** `typing.Optional[str]` — Additional address information (if any). - -
-
- -
-
- -**postal_code:** `typing.Optional[str]` — ZIP or postal code. - -
-
- -
-
- -**state:** `typing.Optional[str]` — State, region, province, or county. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Counterparts BankAccounts -
client.counterparts.bank_accounts.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.get(counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.bank_accounts.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.create(counterpart_id='counterpart_id', country="AF", currency="AED", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**country:** `AllowedCountries` - -
-
- -
-
- -**currency:** `CurrencyEnum` - -
-
- -
-
- -**account_holder_name:** `typing.Optional[str]` — The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. - -
-
- -
-
- -**account_number:** `typing.Optional[str]` — The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. - -
-
- -
-
- -**bic:** `typing.Optional[str]` — The BIC/SWIFT code of the bank. - -
-
- -
-
- -**iban:** `typing.Optional[str]` — The IBAN of the bank account. - -
-
- -
-
- -**is_default_for_currency:** `typing.Optional[bool]` - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**partner_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Metadata for partner needs. - -
-
- -
-
- -**routing_number:** `typing.Optional[str]` — The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. - -
-
- -
-
- -**sort_code:** `typing.Optional[str]` — The bank's sort code. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.bank_accounts.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.get_by_id(bank_account_id='bank_account_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.bank_accounts.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.delete_by_id(bank_account_id='bank_account_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.bank_accounts.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.update_by_id(bank_account_id='bank_account_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**account_holder_name:** `typing.Optional[str]` — The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. - -
-
- -
-
- -**account_number:** `typing.Optional[str]` — The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. - -
-
- -
-
- -**bic:** `typing.Optional[str]` — The BIC/SWIFT code of the bank. - -
-
- -
-
- -**country:** `typing.Optional[AllowedCountries]` - -
-
- -
-
- -**currency:** `typing.Optional[CurrencyEnum]` - -
-
- -
-
- -**iban:** `typing.Optional[str]` — The IBAN of the bank account. - -
-
- -
-
- -**name:** `typing.Optional[str]` - -
-
- -
-
- -**partner_metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Metadata for partner needs. - -
-
- -
-
- -**routing_number:** `typing.Optional[str]` — The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. - -
-
- -
-
- -**sort_code:** `typing.Optional[str]` — The bank's sort code. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.bank_accounts.make_default_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.bank_accounts.make_default_by_id(bank_account_id='bank_account_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Counterparts Contacts -
client.counterparts.contacts.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.get(counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.contacts.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import CounterpartAddress -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.create(counterpart_id='counterpart_id', address=CounterpartAddress(city='Berlin', country="AF", line1='Flughafenstrasse 52', postal_code='10115', ), first_name='Mary', last_name="O'Brien", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**address:** `CounterpartAddress` — The address of a contact person. - -
-
- -
-
- -**first_name:** `str` — The first name of a contact person. - -
-
- -
-
- -**last_name:** `str` — The last name of a contact person. - -
-
- -
-
- -**email:** `typing.Optional[str]` — The email address of a contact person. - -
-
- -
-
- -**phone:** `typing.Optional[str]` — The phone number of a contact person - -
-
- -
-
- -**title:** `typing.Optional[str]` — The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.contacts.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.get_by_id(contact_id='contact_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**contact_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.contacts.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.delete_by_id(contact_id='contact_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**contact_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.contacts.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.update_by_id(contact_id='contact_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**contact_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**address:** `typing.Optional[CounterpartAddress]` — The address of a contact person. - -
-
- -
-
- -**email:** `typing.Optional[str]` — The email address of a contact person. - -
-
- -
-
- -**first_name:** `typing.Optional[str]` — The first name of a contact person. - -
-
- -
-
- -**last_name:** `typing.Optional[str]` — The last name of a contact person. - -
-
- -
-
- -**phone:** `typing.Optional[str]` — The phone number of a contact person - -
-
- -
-
- -**title:** `typing.Optional[str]` — The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.contacts.make_default_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.contacts.make_default_by_id(contact_id='contact_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**contact_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Counterparts VatIds -
client.counterparts.vat_ids.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.vat_ids.get(counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.vat_ids.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.vat_ids.create(counterpart_id='counterpart_id', value='123456789', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**value:** `str` - -
-
- -
-
- -**country:** `typing.Optional[AllowedCountries]` - -
-
- -
-
- -**type:** `typing.Optional[VatIdTypeEnum]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.vat_ids.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.vat_ids.get_by_id(vat_id='vat_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**vat_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.vat_ids.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.vat_ids.delete_by_id(vat_id='vat_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**vat_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.counterparts.vat_ids.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.counterparts.vat_ids.update_by_id(vat_id='vat_id', counterpart_id='counterpart_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**vat_id:** `str` - -
-
- -
-
- -**counterpart_id:** `str` - -
-
- -
-
- -**country:** `typing.Optional[AllowedCountries]` - -
-
- -
-
- -**type:** `typing.Optional[VatIdTypeEnum]` - -
-
- -
-
- -**value:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## DataExports ExtraData -
client.data_exports.extra_data.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.data_exports.extra_data.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Order by - -
-
- -
-
- -**limit:** `typing.Optional[int]` — Max is 100 - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` — A token, obtained from previous page. Prior over other filters - -
-
- -
-
- -**sort:** `typing.Optional[ExportSettingCursorFields]` — Allowed sort fields - -
-
- -
-
- -**created_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**created_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_gt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_lt:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_gte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**updated_at_lte:** `typing.Optional[dt.datetime]` - -
-
- -
-
- -**object_id:** `typing.Optional[str]` - -
-
- -
-
- -**field_name:** `typing.Optional[str]` - -
-
- -
-
- -**field_value:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.data_exports.extra_data.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.data_exports.extra_data.create(field_name="default_account_code", field_value='field_value', object_id='object_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**field_name:** `SupportedFieldNames` - -
-
- -
-
- -**field_value:** `str` - -
-
- -
-
- -**object_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.data_exports.extra_data.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.data_exports.extra_data.get_by_id(extra_data_id='extra_data_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**extra_data_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.data_exports.extra_data.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.data_exports.extra_data.delete_by_id(extra_data_id='extra_data_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**extra_data_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.data_exports.extra_data.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.data_exports.extra_data.update_by_id(extra_data_id='extra_data_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**extra_data_id:** `str` - -
-
- -
-
- -**field_name:** `typing.Optional[SupportedFieldNames]` - -
-
- -
-
- -**field_value:** `typing.Optional[str]` - -
-
- -
-
- -**object_id:** `typing.Optional[str]` - -
-
- -
-
- -**object_type:** `typing.Optional[typing.Literal["counterpart"]]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Entities BankAccounts -
client.entities.bank_accounts.get() -
-
- -#### 📝 Description - -
-
- -
-
- -Get all bank accounts of this entity. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.bank_accounts.create(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.create(country="AF", currency="AED", ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**country:** `AllowedCountries` — The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - -
-
- -
-
- -**currency:** `CurrencyEnum` — The currency of the bank account, represented as a three-letter ISO [currency code](https://docs.monite.com/references/currencies). - -
-
- -
-
- -**account_holder_name:** `typing.Optional[str]` - -The name of the person or business that owns this bank account. Required in the following cases: -* the account currency is GBP or USD, -* the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account. - -
-
- -
-
- -**account_number:** `typing.Optional[str]` — The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits. - -
-
- -
-
- -**bank_name:** `typing.Optional[str]` — The bank name. - -
-
- -
-
- -**bic:** `typing.Optional[str]` - -The SWIFT/BIC code of the bank. Can be either 8 or 11 characters long. Monite verifies the BIC length, country code, and whether the structure conforms to ISO 9362. - -If `bic` is specified, `iban` must also be specified. - -
-
- -
-
- -**display_name:** `typing.Optional[str]` — User-defined name of this bank account, such as 'Primary account' or 'Savings account'. - -
-
- -
-
- -**iban:** `typing.Optional[str]` — The IBAN of the bank account, up to 34 characters. Required if the account currency is EUR. Monite verifies the IBAN length, checksum digits, and country-specific format according to ISO 13616. - -
-
- -
-
- -**is_default_for_currency:** `typing.Optional[bool]` — If set to `true` or if this is the first bank account added for the given currency, this account becomes the default one for its currency. - -
-
- -
-
- -**routing_number:** `typing.Optional[str]` — The bank's routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits. - -
-
- -
-
- -**sort_code:** `typing.Optional[str]` — The bank's sort code. Required if the account currency is GBP. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.bank_accounts.get_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Retrieve a bank account by its ID. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.get_by_id(bank_account_id='bank_account_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.bank_accounts.delete_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Delete the bank account specified by its ID. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.delete_by_id(bank_account_id='bank_account_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.bank_accounts.update_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Change the specified fields with the provided values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.update_by_id(bank_account_id='bank_account_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**account_holder_name:** `typing.Optional[str]` — The name of the person or business that owns this bank account. If the account currency is GBP or USD, the holder name cannot be changed to an empty string. - -
-
- -
-
- -**display_name:** `typing.Optional[str]` — User-defined name of this bank account, such as 'Primary account' or 'Savings account'. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.bank_accounts.make_default_by_id(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Set a bank account as the default for this entity per currency. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.bank_accounts.make_default_by_id(bank_account_id='bank_account_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**bank_account_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Entities OnboardingData -
client.entities.onboarding_data.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.onboarding_data.get(entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.onboarding_data.update(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.onboarding_data.update(entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**business_profile:** `typing.Optional[BusinessProfileInput]` — Business information about the entity. - -
-
- -
-
- -**ownership_declaration:** `typing.Optional[OwnershipDeclarationInput]` — Used to attest that the beneficial owner information provided is both current and correct. - -
-
- -
-
- -**tos_acceptance:** `typing.Optional[TermsOfServiceAcceptanceInput]` — Details on the entity's acceptance of the service agreement. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Entities PaymentMethods -
client.entities.payment_methods.get(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all enabled payment methods. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.payment_methods.get(entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.payment_methods.set(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Set which payment methods should be enabled. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.payment_methods.set(entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**payment_methods:** `typing.Optional[typing.Sequence[MoniteAllPaymentMethodsTypes]]` — Deprecated. Use payment_methods_receive instead. - -
-
- -
-
- -**payment_methods_receive:** `typing.Optional[typing.Sequence[MoniteAllPaymentMethodsTypes]]` — Enable payment methods to receive money. - -
-
- -
-
- -**payment_methods_send:** `typing.Optional[typing.Sequence[MoniteAllPaymentMethodsTypes]]` — Enable payment methods to send money. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Entities VatIds -
client.entities.vat_ids.get(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.vat_ids.get(entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.vat_ids.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.vat_ids.create(entity_id='entity_id', country="AF", value='123456789', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**country:** `AllowedCountries` - -
-
- -
-
- -**value:** `str` - -
-
- -
-
- -**type:** `typing.Optional[VatIdTypeEnum]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.vat_ids.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.vat_ids.get_by_id(id='id', entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.vat_ids.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.vat_ids.delete_by_id(id='id', entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.vat_ids.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.vat_ids.update_by_id(id='id', entity_id='entity_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**entity_id:** `str` - -
-
- -
-
- -**country:** `typing.Optional[AllowedCountries]` - -
-
- -
-
- -**type:** `typing.Optional[VatIdTypeEnum]` - -
-
- -
-
- -**value:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Entities Persons -
client.entities.persons.get() -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.get() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.persons.create(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -from monite import PersonRelationshipRequest -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.create(email='email', first_name='first_name', last_name='last_name', relationship=PersonRelationshipRequest(), ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**email:** `str` — The person's email address - -
-
- -
-
- -**first_name:** `str` — The person's first name - -
-
- -
-
- -**last_name:** `str` — The person's last name - -
-
- -
-
- -**relationship:** `PersonRelationshipRequest` — Describes the person's relationship to the entity - -
-
- -
-
- -**address:** `typing.Optional[PersonAddressRequest]` — The person's address - -
-
- -
-
- -**citizenship:** `typing.Optional[AllowedCountries]` — Required for persons of US entities. The country of the person's citizenship, as a two-letter country code (ISO 3166-1 alpha-2). In case of dual or multiple citizenship, specify any. - -
-
- -
-
- -**date_of_birth:** `typing.Optional[str]` — The person's date of birth - -
-
- -
-
- -**id_number:** `typing.Optional[str]` — The person's ID number, as appropriate for their country - -
-
- -
-
- -**phone:** `typing.Optional[str]` — The person's phone number - -
-
- -
-
- -**ssn_last4:** `typing.Optional[str]` — The last four digits of the person's Social Security number - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.persons.get_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.get_by_id(person_id='person_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**person_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.persons.delete_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.delete_by_id(person_id='person_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**person_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.persons.update_by_id(...) -
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.update_by_id(person_id='person_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**person_id:** `str` - -
-
- -
-
- -**address:** `typing.Optional[OptionalPersonAddressRequest]` — The person's address - -
-
- -
-
- -**citizenship:** `typing.Optional[AllowedCountries]` — Required for persons of US entities. The country of the person's citizenship, as a two-letter country code (ISO 3166-1 alpha-2). In case of dual or multiple citizenship, specify any. - -
-
- -
-
- -**date_of_birth:** `typing.Optional[str]` — The person's date of birth - -
-
- -
-
- -**email:** `typing.Optional[str]` — The person's email address - -
-
- -
-
- -**first_name:** `typing.Optional[str]` — The person's first name - -
-
- -
-
- -**id_number:** `typing.Optional[str]` — The person's ID number, as appropriate for their country - -
-
- -
-
- -**last_name:** `typing.Optional[str]` — The person's last name - -
-
- -
-
- -**phone:** `typing.Optional[str]` — The person's phone number - -
-
- -
-
- -**relationship:** `typing.Optional[OptionalPersonRelationship]` — Describes the person's relationship to the entity - -
-
- -
-
- -**ssn_last4:** `typing.Optional[str]` — The last four digits of the person's Social Security number - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.entities.persons.upload_onboarding_documents(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Provide files for person onboarding verification -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.entities.persons.upload_onboarding_documents(person_id='person_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**person_id:** `str` - -
-
- -
-
- -**additional_verification_document_back:** `typing.Optional[str]` - -
-
- -
-
- -**additional_verification_document_front:** `typing.Optional[str]` - -
-
- -
-
- -**verification_document_back:** `typing.Optional[str]` - -
-
- -
-
- -**verification_document_front:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Payables LineItems -
client.payables.line_items.get(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.get(payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**order:** `typing.Optional[OrderEnum]` — Sort order (ascending by default). Typically used together with the `sort` parameter. - -
-
- -
-
- -**limit:** `typing.Optional[int]` — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. - -
-
- -
-
- -**pagination_token:** `typing.Optional[str]` - -A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. - -If not specified, the first page of results will be returned. - -
-
- -
-
- -**sort:** `typing.Optional[LineItemCursorFields]` — The field to sort the results by. Typically used together with the `order` parameter. - -
-
- -
-
- -**was_created_by_user_id:** `typing.Optional[str]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payables.line_items.create(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.create(payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**accounting_tax_rate_id:** `typing.Optional[str]` — ID of the tax rate reference used for accounting integration. May be used to override auto-picked tax rate reference in accounting platform in case of any platform-specific constraints. - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of the product. - -
-
- -
-
- -**ledger_account_id:** `typing.Optional[str]` — ID of the account record used to store bookkeeping entries for balance-sheet and income-statement transactions. - -
-
- -
-
- -**name:** `typing.Optional[str]` — Name of the product. - -
-
- -
-
- -**quantity:** `typing.Optional[float]` — The quantity of each of the goods, materials, or services listed in the payable. - -
-
- -
-
- -**tax:** `typing.Optional[int]` — VAT rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. - -
-
- -
-
- -**unit:** `typing.Optional[str]` — The unit of the product - -
-
- -
-
- -**unit_price:** `typing.Optional[int]` — The unit price of the product, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payables.line_items.replace(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -from monite import LineItemInternalRequest -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.replace(payable_id='payable_id', data=[LineItemInternalRequest()], ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**data:** `typing.Sequence[LineItemInternalRequest]` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payables.line_items.get_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.get_by_id(line_item_id='line_item_id', payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**line_item_id:** `str` - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payables.line_items.delete_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.delete_by_id(line_item_id='line_item_id', payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**line_item_id:** `str` - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.payables.line_items.update_by_id(...) -
-
- -#### 📝 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 - -
-
- -
-
- -```python -from monite import Monite -client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) -client.payables.line_items.update_by_id(line_item_id='line_item_id', payable_id='payable_id', ) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**line_item_id:** `str` - -
-
- -
-
- -**payable_id:** `str` - -
-
- -
-
- -**accounting_tax_rate_id:** `typing.Optional[str]` — ID of the tax rate reference used for accounting integration. May be used to override auto-picked tax rate reference in accounting platform in case of any platform-specific constraints. - -
-
- -
-
- -**description:** `typing.Optional[str]` — Description of the product. - -
-
- -
-
- -**ledger_account_id:** `typing.Optional[str]` — ID of the account record used to store bookkeeping entries for balance-sheet and income-statement transactions. - -
-
- -
-
- -**name:** `typing.Optional[str]` — Name of the product. - -
-
- -
-
- -**quantity:** `typing.Optional[float]` — The quantity of each of the goods, materials, or services listed in the payable. - -
-
- -
-
- -**tax:** `typing.Optional[int]` — VAT rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. - -
-
- -
-
- -**unit:** `typing.Optional[str]` — The unit of the product - -
-
- -
-
- -**unit_price:** `typing.Optional[int]` — The unit price of the product, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- diff --git a/requirements.txt b/requirements.txt index f502f1b..170f512 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ httpx>=0.21.2 pydantic>= 1.9.2 -pydantic-core==^2.18.2 +pydantic-core==2.18.2 typing_extensions>= 4.0.0 diff --git a/src/monite/__init__.py b/src/monite/__init__.py index fbd0cbc..0c72bb1 100644 --- a/src/monite/__init__.py +++ b/src/monite/__init__.py @@ -652,6 +652,7 @@ UnitResponse, UpdateCreditNote, UpdateCreditNotePayload, + UpdateEinvoicingAddress, UpdateEntityAddressSchema, UpdateEntityRequest, UpdateInvoice, @@ -1449,6 +1450,7 @@ "UnsupportedMediaTypeError", "UpdateCreditNote", "UpdateCreditNotePayload", + "UpdateEinvoicingAddress", "UpdateEntityAddressSchema", "UpdateEntityRequest", "UpdateInvoice", diff --git a/src/monite/accounting/ledger_accounts/client.py b/src/monite/accounting/ledger_accounts/client.py index 1b74aa4..17ac90d 100644 --- a/src/monite/accounting/ledger_accounts/client.py +++ b/src/monite/accounting/ledger_accounts/client.py @@ -44,10 +44,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -134,10 +136,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/accounting/ledger_accounts/raw_client.py b/src/monite/accounting/ledger_accounts/raw_client.py index 68bf733..fe446f3 100644 --- a/src/monite/accounting/ledger_accounts/raw_client.py +++ b/src/monite/accounting/ledger_accounts/raw_client.py @@ -39,10 +39,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -188,10 +190,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/accounting/synced_records/client.py b/src/monite/accounting/synced_records/client.py index e19a28f..bf23516 100644 --- a/src/monite/accounting/synced_records/client.py +++ b/src/monite/accounting/synced_records/client.py @@ -59,10 +59,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -224,10 +226,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/accounting/synced_records/raw_client.py b/src/monite/accounting/synced_records/raw_client.py index d3392f9..6ace964 100644 --- a/src/monite/accounting/synced_records/raw_client.py +++ b/src/monite/accounting/synced_records/raw_client.py @@ -55,10 +55,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -308,10 +310,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/accounting/tax_rates/client.py b/src/monite/accounting/tax_rates/client.py index 2a58be3..5ac747a 100644 --- a/src/monite/accounting/tax_rates/client.py +++ b/src/monite/accounting/tax_rates/client.py @@ -44,10 +44,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -134,10 +136,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/accounting/tax_rates/raw_client.py b/src/monite/accounting/tax_rates/raw_client.py index d2ff579..15f38fc 100644 --- a/src/monite/accounting/tax_rates/raw_client.py +++ b/src/monite/accounting/tax_rates/raw_client.py @@ -39,10 +39,12 @@ def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. @@ -188,10 +190,12 @@ async def get( Sort order (ascending by default). Typically used together with the `sort` parameter. limit : typing.Optional[int] - The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. + The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. + + When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. pagination_token : typing.Optional[str] - A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. + A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. If not specified, the first page of results will be returned. diff --git a/src/monite/core/client_wrapper.py b/src/monite/core/client_wrapper.py index c97465d..11b507c 100644 --- a/src/monite/core/client_wrapper.py +++ b/src/monite/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "monite/0.5.2", + "User-Agent": "monite/0.5.3", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "monite", - "X-Fern-SDK-Version": "0.5.2", + "X-Fern-SDK-Version": "0.5.3", } headers["x-monite-version"] = self._monite_version if self._monite_entity_id is not None: diff --git a/src/monite/core/pydantic_utilities.py b/src/monite/core/pydantic_utilities.py index 60a2c71..0360ef4 100644 --- a/src/monite/core/pydantic_utilities.py +++ b/src/monite/core/pydantic_utilities.py @@ -181,7 +181,7 @@ def deep_union_pydantic_dicts(source: Dict[str, Any], destination: Dict[str, Any if IS_PYDANTIC_V2: - class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore[name-defined, type-arg] + class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore[misc, name-defined, type-arg] pass UniversalRootModel: TypeAlias = V2RootModel # type: ignore[misc] diff --git a/src/monite/e_invoicing_connections/client.py b/src/monite/e_invoicing_connections/client.py index d9438cf..8c5d404 100644 --- a/src/monite/e_invoicing_connections/client.py +++ b/src/monite/e_invoicing_connections/client.py @@ -9,6 +9,7 @@ from ..types.einvoicing_address import EinvoicingAddress from ..types.einvoicing_connection_response import EinvoicingConnectionResponse from ..types.einvoicing_network_credentials_response import EinvoicingNetworkCredentialsResponse +from ..types.update_einvoicing_address import UpdateEinvoicingAddress from .raw_client import AsyncRawEInvoicingConnectionsClient, RawEInvoicingConnectionsClient # this is used as the default value for optional parameters @@ -58,6 +59,8 @@ def post_einvoicing_connections( *, address: EinvoicingAddress, entity_vat_id_id: typing.Optional[str] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> EinvoicingConnectionResponse: """ @@ -69,6 +72,12 @@ def post_einvoicing_connections( entity_vat_id_id : typing.Optional[str] Entity VAT ID identifier for the integration + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -85,7 +94,11 @@ def post_einvoicing_connections( client.e_invoicing_connections.post_einvoicing_connections(address=EinvoicingAddress(address_line1='address_line1', city='city', country="DE", postal_code='postal_code', ), ) """ _response = self._raw_client.post_einvoicing_connections( - address=address, entity_vat_id_id=entity_vat_id_id, request_options=request_options + address=address, + entity_vat_id_id=entity_vat_id_id, + is_receiver=is_receiver, + is_sender=is_sender, + request_options=request_options, ) return _response.data @@ -142,6 +155,52 @@ def delete_einvoicing_connections_id( ) return _response.data + def patch_einvoicing_connections_id( + self, + einvoicing_connection_id: str, + *, + address: typing.Optional[UpdateEinvoicingAddress] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> EinvoicingConnectionResponse: + """ + Parameters + ---------- + einvoicing_connection_id : str + + address : typing.Optional[UpdateEinvoicingAddress] + Integration Address + + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + EinvoicingConnectionResponse + Successful Response + + Examples + -------- + from monite import Monite + client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) + client.e_invoicing_connections.patch_einvoicing_connections_id(einvoicing_connection_id='einvoicing_connection_id', ) + """ + _response = self._raw_client.patch_einvoicing_connections_id( + einvoicing_connection_id, + address=address, + is_receiver=is_receiver, + is_sender=is_sender, + request_options=request_options, + ) + return _response.data + def post_einvoicing_connections_id_network_credentials( self, einvoicing_connection_id: str, @@ -230,6 +289,8 @@ async def post_einvoicing_connections( *, address: EinvoicingAddress, entity_vat_id_id: typing.Optional[str] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> EinvoicingConnectionResponse: """ @@ -241,6 +302,12 @@ async def post_einvoicing_connections( entity_vat_id_id : typing.Optional[str] Entity VAT ID identifier for the integration + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -260,7 +327,11 @@ async def main() -> None: asyncio.run(main()) """ _response = await self._raw_client.post_einvoicing_connections( - address=address, entity_vat_id_id=entity_vat_id_id, request_options=request_options + address=address, + entity_vat_id_id=entity_vat_id_id, + is_receiver=is_receiver, + is_sender=is_sender, + request_options=request_options, ) return _response.data @@ -323,6 +394,55 @@ async def main() -> None: ) return _response.data + async def patch_einvoicing_connections_id( + self, + einvoicing_connection_id: str, + *, + address: typing.Optional[UpdateEinvoicingAddress] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> EinvoicingConnectionResponse: + """ + Parameters + ---------- + einvoicing_connection_id : str + + address : typing.Optional[UpdateEinvoicingAddress] + Integration Address + + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + EinvoicingConnectionResponse + Successful Response + + Examples + -------- + from monite import AsyncMonite + import asyncio + client = AsyncMonite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", ) + async def main() -> None: + await client.e_invoicing_connections.patch_einvoicing_connections_id(einvoicing_connection_id='einvoicing_connection_id', ) + asyncio.run(main()) + """ + _response = await self._raw_client.patch_einvoicing_connections_id( + einvoicing_connection_id, + address=address, + is_receiver=is_receiver, + is_sender=is_sender, + request_options=request_options, + ) + return _response.data + async def post_einvoicing_connections_id_network_credentials( self, einvoicing_connection_id: str, diff --git a/src/monite/e_invoicing_connections/raw_client.py b/src/monite/e_invoicing_connections/raw_client.py index 73ead8b..69e7a19 100644 --- a/src/monite/e_invoicing_connections/raw_client.py +++ b/src/monite/e_invoicing_connections/raw_client.py @@ -22,6 +22,7 @@ from ..types.einvoicing_address import EinvoicingAddress from ..types.einvoicing_connection_response import EinvoicingConnectionResponse from ..types.einvoicing_network_credentials_response import EinvoicingNetworkCredentialsResponse +from ..types.update_einvoicing_address import UpdateEinvoicingAddress # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -125,6 +126,8 @@ def post_einvoicing_connections( *, address: EinvoicingAddress, entity_vat_id_id: typing.Optional[str] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[EinvoicingConnectionResponse]: """ @@ -136,6 +139,12 @@ def post_einvoicing_connections( entity_vat_id_id : typing.Optional[str] Entity VAT ID identifier for the integration + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -152,6 +161,8 @@ def post_einvoicing_connections( object_=address, annotation=EinvoicingAddress, direction="write" ), "entity_vat_id_id": entity_vat_id_id, + "is_receiver": is_receiver, + "is_sender": is_sender, }, headers={ "content-type": "application/json", @@ -436,6 +447,145 @@ def delete_einvoicing_connections_id( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + def patch_einvoicing_connections_id( + self, + einvoicing_connection_id: str, + *, + address: typing.Optional[UpdateEinvoicingAddress] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[EinvoicingConnectionResponse]: + """ + Parameters + ---------- + einvoicing_connection_id : str + + address : typing.Optional[UpdateEinvoicingAddress] + Integration Address + + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[EinvoicingConnectionResponse] + Successful Response + """ + _response = self._client_wrapper.httpx_client.request( + f"einvoicing_connections/{jsonable_encoder(einvoicing_connection_id)}", + method="PATCH", + json={ + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=UpdateEinvoicingAddress, direction="write" + ), + "is_receiver": is_receiver, + "is_sender": is_sender, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + EinvoicingConnectionResponse, + parse_obj_as( + type_=EinvoicingConnectionResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 422: + raise UnprocessableEntityError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + def post_einvoicing_connections_id_network_credentials( self, einvoicing_connection_id: str, @@ -667,6 +817,8 @@ async def post_einvoicing_connections( *, address: EinvoicingAddress, entity_vat_id_id: typing.Optional[str] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[EinvoicingConnectionResponse]: """ @@ -678,6 +830,12 @@ async def post_einvoicing_connections( entity_vat_id_id : typing.Optional[str] Entity VAT ID identifier for the integration + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -694,6 +852,8 @@ async def post_einvoicing_connections( object_=address, annotation=EinvoicingAddress, direction="write" ), "entity_vat_id_id": entity_vat_id_id, + "is_receiver": is_receiver, + "is_sender": is_sender, }, headers={ "content-type": "application/json", @@ -978,6 +1138,145 @@ async def delete_einvoicing_connections_id( raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + async def patch_einvoicing_connections_id( + self, + einvoicing_connection_id: str, + *, + address: typing.Optional[UpdateEinvoicingAddress] = OMIT, + is_receiver: typing.Optional[bool] = OMIT, + is_sender: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[EinvoicingConnectionResponse]: + """ + Parameters + ---------- + einvoicing_connection_id : str + + address : typing.Optional[UpdateEinvoicingAddress] + Integration Address + + is_receiver : typing.Optional[bool] + Set to `true` if the entity needs to receive e-invoices. + + is_sender : typing.Optional[bool] + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[EinvoicingConnectionResponse] + Successful Response + """ + _response = await self._client_wrapper.httpx_client.request( + f"einvoicing_connections/{jsonable_encoder(einvoicing_connection_id)}", + method="PATCH", + json={ + "address": convert_and_respect_annotation_metadata( + object_=address, annotation=UpdateEinvoicingAddress, direction="write" + ), + "is_receiver": is_receiver, + "is_sender": is_sender, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + EinvoicingConnectionResponse, + parse_obj_as( + type_=EinvoicingConnectionResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 422: + raise UnprocessableEntityError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + typing.Optional[typing.Any], + parse_obj_as( + type_=typing.Optional[typing.Any], # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + async def post_einvoicing_connections_id_network_credentials( self, einvoicing_connection_id: str, diff --git a/src/monite/types/__init__.py b/src/monite/types/__init__.py index 2081e18..74ed2e4 100644 --- a/src/monite/types/__init__.py +++ b/src/monite/types/__init__.py @@ -667,6 +667,7 @@ from .unit_response import UnitResponse from .update_credit_note import UpdateCreditNote from .update_credit_note_payload import UpdateCreditNotePayload +from .update_einvoicing_address import UpdateEinvoicingAddress from .update_entity_address_schema import UpdateEntityAddressSchema from .update_entity_request import UpdateEntityRequest from .update_invoice import UpdateInvoice @@ -1365,6 +1366,7 @@ "UnitResponse", "UpdateCreditNote", "UpdateCreditNotePayload", + "UpdateEinvoicingAddress", "UpdateEntityAddressSchema", "UpdateEntityRequest", "UpdateInvoice", diff --git a/src/monite/types/einvoicing_connection_response.py b/src/monite/types/einvoicing_connection_response.py index cf67b8e..a266ae3 100644 --- a/src/monite/types/einvoicing_connection_response.py +++ b/src/monite/types/einvoicing_connection_response.py @@ -36,6 +36,16 @@ class EinvoicingConnectionResponse(UniversalBaseModel): ID of the entity """ + is_receiver: typing.Optional[bool] = pydantic.Field(default=None) + """ + Set to `true` if the entity needs to receive e-invoices. + """ + + is_sender: typing.Optional[bool] = pydantic.Field(default=None) + """ + Set to `true` if the entity needs to send e-invoices. Either `is_sender` or `is_receiver` or both must be `true`. + """ + legal_name: str = pydantic.Field() """ Legal name of the Entity diff --git a/src/monite/types/update_einvoicing_address.py b/src/monite/types/update_einvoicing_address.py new file mode 100644 index 0000000..8d2b678 --- /dev/null +++ b/src/monite/types/update_einvoicing_address.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class UpdateEinvoicingAddress(UniversalBaseModel): + address_line1: str = pydantic.Field() + """ + Street address line 1 + """ + + address_line2: typing.Optional[str] = pydantic.Field(default=None) + """ + Street address line 2 + """ + + city: str = pydantic.Field() + """ + City name + """ + + postal_code: str = pydantic.Field() + """ + Postal/ZIP code + """ + + state: typing.Optional[str] = pydantic.Field(default=None) + """ + State/Province/County + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow