ReceiptsClient
- class moloni.api.ReceiptsClient(environment: MoloniBaseUrl = MoloniBaseUrl.PROD, *, auth_config: AuthConfig = AuthConfig(client_id=None, client_secret=None, refresh_token=None, username=None, password=None), version: str = 'v1', validate: bool = True, log_level: str = 'INFO')
- count(self, data: ReceiptsCountModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsCountModel, dict]) –
A model instance or dictionary containing the following fields:
company_id (Union[str, int]): company_id of the ReceiptsCountModel.
customer_id (Union[str, int]): customer_id of the ReceiptsCountModel.
date (str): date of the ReceiptsCountModel.
document_set_id (Union[str, int]): document_set_id of the ReceiptsCountModel.
expiration_date (str): expiration_date of the ReceiptsCountModel.
number (str): number of the ReceiptsCountModel.
our_reference (str): our_reference of the ReceiptsCountModel.
salesman_id (Union[str, int]): salesman_id of the ReceiptsCountModel.
supplier_id (Union[str, int]): supplier_id of the ReceiptsCountModel.
year (str): year of the ReceiptsCountModel.
your_reference (str): your_reference of the ReceiptsCountModel.
- Returns:
The response from the API.
- Return type:
- delete(self, data: ReceiptsDeleteModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsDeleteModel, dict]) –
A model instance or dictionary containing the following fields:
company_id (Union[str, int]): company_id of the ReceiptsDeleteModel.
document_id (Union[str, int]): document_id of the ReceiptsDeleteModel.
- Returns:
The response from the API.
- Return type:
- get_all(self, data: ReceiptsGetAllModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsGetAllModel, dict]) –
A model instance or dictionary containing the following fields:
company_id (Union[str, int]): company_id of the ReceiptsGetAllModel.
customer_id (Union[str, int]): customer_id of the ReceiptsGetAllModel.
date (str): date of the ReceiptsGetAllModel.
document_set_id (Union[str, int]): document_set_id of the ReceiptsGetAllModel.
expiration_date (str): expiration_date of the ReceiptsGetAllModel.
number (str): number of the ReceiptsGetAllModel.
offset (str): offset of the ReceiptsGetAllModel.
our_reference (str): our_reference of the ReceiptsGetAllModel.
qty (str): qty of the ReceiptsGetAllModel.
salesman_id (Union[str, int]): salesman_id of the ReceiptsGetAllModel.
supplier_id (Union[str, int]): supplier_id of the ReceiptsGetAllModel.
year (str): year of the ReceiptsGetAllModel.
your_reference (str): your_reference of the ReceiptsGetAllModel.
- Returns:
The response from the API.
- Return type:
- get_one(self, data: ReceiptsGetOneModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsGetOneModel, dict]) –
A model instance or dictionary containing the following fields:
company_id (Union[str, int]): company_id of the ReceiptsGetOneModel.
customer_id (Union[str, int]): customer_id of the ReceiptsGetOneModel.
date (str): date of the ReceiptsGetOneModel.
document_id (Union[str, int]): document_id of the ReceiptsGetOneModel.
document_set_id (Union[str, int]): document_set_id of the ReceiptsGetOneModel.
expiration_date (str): expiration_date of the ReceiptsGetOneModel.
number (str): number of the ReceiptsGetOneModel.
our_reference (str): our_reference of the ReceiptsGetOneModel.
salesman_id (Union[str, int]): salesman_id of the ReceiptsGetOneModel.
supplier_id (Union[str, int]): supplier_id of the ReceiptsGetOneModel.
year (str): year of the ReceiptsGetOneModel.
your_reference (str): your_reference of the ReceiptsGetOneModel.
- Returns:
The response from the API.
- Return type:
- insert(self, data: ReceiptsInsertModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsInsertModel, dict]) –
A model instance or dictionary containing the following fields:
associated_documents (str): associated_documents of the ReceiptsInsertModel.
company_id (Union[str, int]): company_id of the ReceiptsInsertModel.
customer_id (Union[str, int]): customer_id of the ReceiptsInsertModel.
date (str): date of the ReceiptsInsertModel.
document_set_id (Union[str, int]): document_set_id of the ReceiptsInsertModel.
net_value (str): net_value of the ReceiptsInsertModel.
notes (str): notes of the ReceiptsInsertModel.
payments (str): payments of the ReceiptsInsertModel.
related_documents_notes (str): related_documents_notes of the ReceiptsInsertModel.
status (str): status of the ReceiptsInsertModel.
- Returns:
The response from the API.
- Return type:
- update(self, data: ReceiptsUpdateModel | dict, **kwargs)
- Parameters:
data (Union[ReceiptsUpdateModel, dict]) –
A model instance or dictionary containing the following fields:
associated_documents (str): associated_documents of the ReceiptsUpdateModel.
company_id (Union[str, int]): company_id of the ReceiptsUpdateModel.
customer_id (Union[str, int]): customer_id of the ReceiptsUpdateModel.
date (str): date of the ReceiptsUpdateModel.
document_id (Union[str, int]): document_id of the ReceiptsUpdateModel.
document_set_id (Union[str, int]): document_set_id of the ReceiptsUpdateModel.
net_value (str): net_value of the ReceiptsUpdateModel.
notes (str): notes of the ReceiptsUpdateModel.
payments (str): payments of the ReceiptsUpdateModel.
related_documents_notes (str): related_documents_notes of the ReceiptsUpdateModel.
status (str): status of the ReceiptsUpdateModel.
- Returns:
The response from the API.
- Return type:
Models:
- class moloni.api.ReceiptsCountModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, expiration_date: str | None = None, number: str | None = None, our_reference: str | None = None, salesman_id: str | int | None = None, supplier_id: str | int | None = None, year: str | None = None, your_reference: str | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- customer_id: str | int | None
- date: str | None
- document_set_id: str | int | None
- expiration_date: str | None
- number: str | None
- our_reference: str | None
- salesman_id: str | int | None
- supplier_id: str | int | None
- year: str | None
- your_reference: str | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'expiration_date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'our_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'supplier_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- class moloni.api.ReceiptsDeleteModel(*, company_id: str | int, document_id: str | int | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- document_id: str | int | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- class moloni.api.ReceiptsGetAllModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, expiration_date: str | None = None, number: str | None = None, offset: str | int | None = 0, our_reference: str | None = None, qty: str | int | None = 25, salesman_id: str | int | None = None, supplier_id: str | int | None = None, year: str | None = None, your_reference: str | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- customer_id: str | int | None
- date: str | None
- document_set_id: str | int | None
- expiration_date: str | None
- number: str | None
- offset: str | int | None
- our_reference: str | None
- qty: str | int | None
- salesman_id: str | int | None
- supplier_id: str | int | None
- year: str | None
- your_reference: str | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'expiration_date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'offset': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=0), 'our_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'qty': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=25), 'salesman_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'supplier_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- class moloni.api.ReceiptsGetOneModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_id: str | int | None = None, document_set_id: str | int | None = None, expiration_date: str | None = None, number: str | None = None, our_reference: str | None = None, salesman_id: str | int | None = None, supplier_id: str | int | None = None, year: str | None = None, your_reference: str | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- customer_id: str | int | None
- date: str | None
- document_id: str | int | None
- document_set_id: str | int | None
- expiration_date: str | None
- number: str | None
- our_reference: str | None
- salesman_id: str | int | None
- supplier_id: str | int | None
- year: str | None
- your_reference: str | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'expiration_date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'our_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'supplier_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'year': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'your_reference': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- class moloni.api.ReceiptsInsertModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, net_value: str | None = None, notes: str | None = None, payments: List[Payments] | None = None, related_documents_notes: str | None = None, status: str | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- associated_documents: List[Associated_documents] | None
- customer_id: str | int | None
- date: str | None
- document_set_id: str | int | None
- net_value: str | None
- notes: str | None
- payments: List[Payments] | None
- status: str | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'associated_documents': FieldInfo(annotation=Union[List[Associated_documents], NoneType], required=False, default=None), 'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'net_value': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'payments': FieldInfo(annotation=Union[List[Payments], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- class moloni.api.ReceiptsUpdateModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, document_id: str | int | None = None, document_set_id: str | int | None = None, net_value: str | None = None, notes: str | None = None, payments: List[Payments] | None = None, related_documents_notes: str | None = None, status: str | None = None)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
- company_id: str | int
- associated_documents: List[Associated_documents] | None
- customer_id: str | int | None
- date: str | None
- document_id: str | int | None
- document_set_id: str | int | None
- net_value: str | None
- notes: str | None
- payments: List[Payments] | None
- status: str | None
- request(self) ApiResponse
Make an API request using the initialized client.
This method checks if the _api_client attribute is set (i.e., if the client has been initialized via the connect method). If the client is initialized, it will make an API request using the provided method name and the model’s data, excluding the _api_client attribute itself from the request payload. If the client is not initialized, it will raise a ValueError.
- Returns:
The response from the API.
- Raises:
ValueError – If the client is not initialized via the connect method.
Example
# Assuming you have a model instance request_model and an API client api_client
..code-block:: python
- with request_model.connect(auth_config=auth_config) as api:
response = api.request()
# The above example assumes that the connect method has been used to initialize the client. # The request method then sends the model’s data to the API and returns the API’s response.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'associated_documents': FieldInfo(annotation=Union[List[Associated_documents], NoneType], required=False, default=None), 'company_id': FieldInfo(annotation=Union[str, int], required=True), 'customer_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'date': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'document_set_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'net_value': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'payments': FieldInfo(annotation=Union[List[Payments], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.