EstimatesClient

class moloni.api.EstimatesClient(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: EstimatesCountModel | dict, **kwargs)

Parameters:

data (Union[EstimatesCountModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesCountModel.
customer_id (Union[str, int]): customer_id of the EstimatesCountModel.
date (str): date of the EstimatesCountModel.
document_set_id (Union[str, int]): document_set_id of the EstimatesCountModel.
expiration_date (str): expiration_date of the EstimatesCountModel.
number (str): number of the EstimatesCountModel.
salesman_id (Union[str, int]): salesman_id of the EstimatesCountModel.
year (str): year of the EstimatesCountModel.
your_reference (str): your_reference of the EstimatesCountModel.

Returns:

The response from the API.

Return type:

ApiResponse

delete(self, data: EstimatesDeleteModel | dict, **kwargs)

Parameters:

data (Union[EstimatesDeleteModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesDeleteModel.
document_id (Union[str, int]): document_id of the EstimatesDeleteModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_all(self, data: EstimatesGetAllModel | dict, **kwargs)

Parameters:

data (Union[EstimatesGetAllModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesGetAllModel.
customer_id (Union[str, int]): customer_id of the EstimatesGetAllModel.
date (str): date of the EstimatesGetAllModel.
document_set_id (Union[str, int]): document_set_id of the EstimatesGetAllModel.
expiration_date (str): expiration_date of the EstimatesGetAllModel.
number (str): number of the EstimatesGetAllModel.
offset (str): offset of the EstimatesGetAllModel.
qty (str): qty of the EstimatesGetAllModel.
salesman_id (Union[str, int]): salesman_id of the EstimatesGetAllModel.
year (str): year of the EstimatesGetAllModel.
your_reference (str): your_reference of the EstimatesGetAllModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_one(self, data: EstimatesGetOneModel | dict, **kwargs)

Parameters:

data (Union[EstimatesGetOneModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesGetOneModel.
customer_id (Union[str, int]): customer_id of the EstimatesGetOneModel.
date (str): date of the EstimatesGetOneModel.
document_id (Union[str, int]): document_id of the EstimatesGetOneModel.
document_set_id (Union[str, int]): document_set_id of the EstimatesGetOneModel.
expiration_date (str): expiration_date of the EstimatesGetOneModel.
number (str): number of the EstimatesGetOneModel.
salesman_id (Union[str, int]): salesman_id of the EstimatesGetOneModel.
year (str): year of the EstimatesGetOneModel.
your_reference (str): your_reference of the EstimatesGetOneModel.

Returns:

The response from the API.

Return type:

ApiResponse

insert(self, data: EstimatesInsertModel | dict, **kwargs)

Parameters:

data (Union[EstimatesInsertModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesInsertModel.
customer_id (Union[str, int]): customer_id of the EstimatesInsertModel.
date (str): date of the EstimatesInsertModel.
deduction_id (Union[str, int]): deduction_id of the EstimatesInsertModel.
delivery_datetime (str): delivery_datetime of the EstimatesInsertModel.
delivery_departure_address (str): delivery_departure_address of the EstimatesInsertModel.
delivery_departure_city (str): delivery_departure_city of the EstimatesInsertModel.
delivery_departure_country (str): delivery_departure_country of the EstimatesInsertModel.
delivery_departure_zip_code (str): delivery_departure_zip_code of the EstimatesInsertModel.
delivery_destination_address (str): delivery_destination_address of the EstimatesInsertModel.
delivery_destination_city (str): delivery_destination_city of the EstimatesInsertModel.
delivery_destination_country (str): delivery_destination_country of the EstimatesInsertModel.
delivery_destination_zip_code (str): delivery_destination_zip_code of the EstimatesInsertModel.
delivery_method_id (Union[str, int]): delivery_method_id of the EstimatesInsertModel.
document_set_id (Union[str, int]): document_set_id of the EstimatesInsertModel.
expiration_date (str): expiration_date of the EstimatesInsertModel.
financial_discount (str): financial_discount of the EstimatesInsertModel.
notes (str): notes of the EstimatesInsertModel.
products (str): products of the EstimatesInsertModel.
salesman_commission (str): salesman_commission of the EstimatesInsertModel.
salesman_id (Union[str, int]): salesman_id of the EstimatesInsertModel.
special_discount (str): special_discount of the EstimatesInsertModel.
status (str): status of the EstimatesInsertModel.
vehicle_id (Union[str, int]): vehicle_id of the EstimatesInsertModel.
your_reference (str): your_reference of the EstimatesInsertModel.

Returns:

The response from the API.

Return type:

ApiResponse

update(self, data: EstimatesUpdateModel | dict, **kwargs)

Parameters:

data (Union[EstimatesUpdateModel, dict]) –

A model instance or dictionary containing the following fields:

company_id (Union[str, int]): company_id of the EstimatesUpdateModel.
customer_id (Union[str, int]): customer_id of the EstimatesUpdateModel.
date (str): date of the EstimatesUpdateModel.
deduction_id (Union[str, int]): deduction_id of the EstimatesUpdateModel.
delivery_datetime (str): delivery_datetime of the EstimatesUpdateModel.
delivery_departure_address (str): delivery_departure_address of the EstimatesUpdateModel.
delivery_departure_city (str): delivery_departure_city of the EstimatesUpdateModel.
delivery_departure_country (str): delivery_departure_country of the EstimatesUpdateModel.
delivery_departure_zip_code (str): delivery_departure_zip_code of the EstimatesUpdateModel.
delivery_destination_address (str): delivery_destination_address of the EstimatesUpdateModel.
delivery_destination_city (str): delivery_destination_city of the EstimatesUpdateModel.
delivery_destination_country (str): delivery_destination_country of the EstimatesUpdateModel.
delivery_destination_zip_code (str): delivery_destination_zip_code of the EstimatesUpdateModel.
delivery_method_id (Union[str, int]): delivery_method_id of the EstimatesUpdateModel.
document_id (Union[str, int]): document_id of the EstimatesUpdateModel.
document_set_id (Union[str, int]): document_set_id of the EstimatesUpdateModel.
expiration_date (str): expiration_date of the EstimatesUpdateModel.
financial_discount (str): financial_discount of the EstimatesUpdateModel.
notes (str): notes of the EstimatesUpdateModel.
products (str): products of the EstimatesUpdateModel.
salesman_commission (str): salesman_commission of the EstimatesUpdateModel.
salesman_id (Union[str, int]): salesman_id of the EstimatesUpdateModel.
special_discount (str): special_discount of the EstimatesUpdateModel.
status (str): status of the EstimatesUpdateModel.
vehicle_id (Union[str, int]): vehicle_id of the EstimatesUpdateModel.
your_reference (str): your_reference of the EstimatesUpdateModel.

Returns:

The response from the API.

Return type:

ApiResponse

Models:

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

salesman_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].

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.EstimatesDeleteModel(*, 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.

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.

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

qty: str | int | None

salesman_id: str | int | None

year: str | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

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].

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.

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

salesman_id: str | int | None

year: str | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

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].

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.

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

deduction_id: str | int | None

delivery_datetime: str | None

delivery_departure_address: str | None

delivery_departure_city: str | None

delivery_departure_country: str | None

delivery_departure_zip_code: str | None

delivery_destination_address: str | None

delivery_destination_city: str | None

delivery_destination_country: str | None

delivery_destination_zip_code: str | None

delivery_method_id: str | int | None

document_set_id: str | int | None

expiration_date: str | None

financial_discount: str | None

notes: str | None

products: List[Products] | None

salesman_commission: str | None

salesman_id: str | int | None

special_discount: str | None

status: str | None

vehicle_id: str | int | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

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), 'deduction_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'delivery_datetime': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_method_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), 'financial_discount': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'salesman_commission': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'special_discount': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vehicle_id': FieldInfo(annotation=Union[str, int, 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.

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

deduction_id: str | int | None

delivery_datetime: str | None

delivery_departure_address: str | None

delivery_departure_city: str | None

delivery_departure_country: str | None

delivery_departure_zip_code: str | None

delivery_destination_address: str | None

delivery_destination_city: str | None

delivery_destination_country: str | None

delivery_destination_zip_code: str | None

delivery_method_id: str | int | None

document_id: str | int | None

document_set_id: str | int | None

expiration_date: str | None

financial_discount: str | None

notes: str | None

products: List[Products] | None

salesman_commission: str | None

salesman_id: str | int | None

special_discount: str | None

status: str | None

vehicle_id: str | int | None

your_reference: str | None

request(self) → ApiResponse

Make an API request using the initialized client.

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), 'deduction_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'delivery_datetime': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_departure_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_address': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_city': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_destination_zip_code': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'delivery_method_id': FieldInfo(annotation=Union[str, int, 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), 'financial_discount': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'salesman_commission': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'special_discount': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'vehicle_id': FieldInfo(annotation=Union[str, int, 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.