DeliverynotesClient

class moloni.api.DeliverynotesClient(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: DeliverynotesCountModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesCountModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the DeliverynotesCountModel.

• customer_id (Union[str, int]): customer_id of the DeliverynotesCountModel.

• date (str): date of the DeliverynotesCountModel.

• document_set_id (Union[str, int]): document_set_id of the DeliverynotesCountModel.

• number (str): number of the DeliverynotesCountModel.

• salesman_id (Union[str, int]): salesman_id of the DeliverynotesCountModel.

• year (str): year of the DeliverynotesCountModel.

• your_reference (str): your_reference of the DeliverynotesCountModel.

Returns:

The response from the API.

Return type:

ApiResponse

delete(self, data: DeliverynotesDeleteModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesDeleteModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the DeliverynotesDeleteModel.

• document_id (Union[str, int]): document_id of the DeliverynotesDeleteModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_all(self, data: DeliverynotesGetAllModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesGetAllModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the DeliverynotesGetAllModel.

• customer_id (Union[str, int]): customer_id of the DeliverynotesGetAllModel.

• date (str): date of the DeliverynotesGetAllModel.

• document_set_id (Union[str, int]): document_set_id of the DeliverynotesGetAllModel.

• number (str): number of the DeliverynotesGetAllModel.

• offset (str): offset of the DeliverynotesGetAllModel.

• qty (str): qty of the DeliverynotesGetAllModel.

• salesman_id (Union[str, int]): salesman_id of the DeliverynotesGetAllModel.

• year (str): year of the DeliverynotesGetAllModel.

• your_reference (str): your_reference of the DeliverynotesGetAllModel.

Returns:

The response from the API.

Return type:

ApiResponse

get_one(self, data: DeliverynotesGetOneModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesGetOneModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the DeliverynotesGetOneModel.

• customer_id (Union[str, int]): customer_id of the DeliverynotesGetOneModel.

• date (str): date of the DeliverynotesGetOneModel.

• document_id (Union[str, int]): document_id of the DeliverynotesGetOneModel.

• document_set_id (Union[str, int]): document_set_id of the DeliverynotesGetOneModel.

• number (str): number of the DeliverynotesGetOneModel.

• salesman_id (Union[str, int]): salesman_id of the DeliverynotesGetOneModel.

• year (str): year of the DeliverynotesGetOneModel.

• your_reference (str): your_reference of the DeliverynotesGetOneModel.

Returns:

The response from the API.

Return type:

ApiResponse

insert(self, data: DeliverynotesInsertModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesInsertModel, dict]) –

A model instance or dictionary containing the following fields:

• associated_documents (str): associated_documents of the DeliverynotesInsertModel.

• company_id (Union[str, int]): company_id of the DeliverynotesInsertModel.

• customer_id (Union[str, int]): customer_id of the DeliverynotesInsertModel.

• date (str): date of the DeliverynotesInsertModel.

• delivery_datetime (str): delivery_datetime of the DeliverynotesInsertModel.

• delivery_departure_address (str): delivery_departure_address of the DeliverynotesInsertModel.

• delivery_departure_city (str): delivery_departure_city of the DeliverynotesInsertModel.

• delivery_departure_country (str): delivery_departure_country of the DeliverynotesInsertModel.

• delivery_departure_zip_code (str): delivery_departure_zip_code of the DeliverynotesInsertModel.

• delivery_destination_address (str): delivery_destination_address of the DeliverynotesInsertModel.

• delivery_destination_city (str): delivery_destination_city of the DeliverynotesInsertModel.

• delivery_destination_country (str): delivery_destination_country of the DeliverynotesInsertModel.

• delivery_destination_zip_code (str): delivery_destination_zip_code of the DeliverynotesInsertModel.

• delivery_method_id (Union[str, int]): delivery_method_id of the DeliverynotesInsertModel.

• document_set_id (Union[str, int]): document_set_id of the DeliverynotesInsertModel.

• notes (str): notes of the DeliverynotesInsertModel.

• products (str): products of the DeliverynotesInsertModel.

• related_documents_notes (str): related_documents_notes of the DeliverynotesInsertModel.

• salesman_commission (str): salesman_commission of the DeliverynotesInsertModel.

• salesman_id (Union[str, int]): salesman_id of the DeliverynotesInsertModel.

• status (str): status of the DeliverynotesInsertModel.

• vehicle_id (Union[str, int]): vehicle_id of the DeliverynotesInsertModel.

• your_reference (str): your_reference of the DeliverynotesInsertModel.

Returns:

The response from the API.

Return type:

ApiResponse

set_transport_code(self, data: DeliverynotesSetTransportCodeModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesSetTransportCodeModel, dict]) –

A model instance or dictionary containing the following fields:

• company_id (Union[str, int]): company_id of the DeliverynotesSetTransportCodeModel.

• document_id (Union[str, int]): document_id of the DeliverynotesSetTransportCodeModel.

• transport_code (str): transport_code of the DeliverynotesSetTransportCodeModel.

Returns:

The response from the API.

Return type:

ApiResponse

update(self, data: DeliverynotesUpdateModel | dict, **kwargs)

Parameters:

data (Union[DeliverynotesUpdateModel, dict]) –

A model instance or dictionary containing the following fields:

• associated_documents (str): associated_documents of the DeliverynotesUpdateModel.

• company_id (Union[str, int]): company_id of the DeliverynotesUpdateModel.

• customer_id (Union[str, int]): customer_id of the DeliverynotesUpdateModel.

• date (str): date of the DeliverynotesUpdateModel.

• delivery_datetime (str): delivery_datetime of the DeliverynotesUpdateModel.

• delivery_departure_address (str): delivery_departure_address of the DeliverynotesUpdateModel.

• delivery_departure_city (str): delivery_departure_city of the DeliverynotesUpdateModel.

• delivery_departure_country (str): delivery_departure_country of the DeliverynotesUpdateModel.

• delivery_departure_zip_code (str): delivery_departure_zip_code of the DeliverynotesUpdateModel.

• delivery_destination_address (str): delivery_destination_address of the DeliverynotesUpdateModel.

• delivery_destination_city (str): delivery_destination_city of the DeliverynotesUpdateModel.

• delivery_destination_country (str): delivery_destination_country of the DeliverynotesUpdateModel.

• delivery_destination_zip_code (str): delivery_destination_zip_code of the DeliverynotesUpdateModel.

• delivery_method_id (Union[str, int]): delivery_method_id of the DeliverynotesUpdateModel.

• document_id (Union[str, int]): document_id of the DeliverynotesUpdateModel.

• document_set_id (Union[str, int]): document_set_id of the DeliverynotesUpdateModel.

• notes (str): notes of the DeliverynotesUpdateModel.

• products (str): products of the DeliverynotesUpdateModel.

• related_documents_notes (str): related_documents_notes of the DeliverynotesUpdateModel.

• salesman_commission (str): salesman_commission of the DeliverynotesUpdateModel.

• salesman_id (Union[str, int]): salesman_id of the DeliverynotesUpdateModel.

• status (str): status of the DeliverynotesUpdateModel.

• vehicle_id (Union[str, int]): vehicle_id of the DeliverynotesUpdateModel.

• your_reference (str): your_reference of the DeliverynotesUpdateModel.

Returns:

The response from the API.

Return type:

ApiResponse

Models:

class moloni.api.DeliverynotesCountModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, number: str | None = None, salesman_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

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

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), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_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.DeliverynotesDeleteModel(*, 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.DeliverynotesGetAllModel(*, company_id: str | int, customer_id: str | int | None = None, date: str | None = None, document_set_id: str | int | None = None, number: str | None = None, offset: str | int | None = 0, qty: str | int | None = 25, salesman_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

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.

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), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'offset': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=0), 'qty': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=25), 'salesman_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.DeliverynotesGetOneModel(*, 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, number: str | None = None, salesman_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

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

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), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'salesman_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.DeliverynotesInsertModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, delivery_datetime: str | None = None, delivery_departure_address: str | None = None, delivery_departure_city: str | None = None, delivery_departure_country: str | None = None, delivery_departure_zip_code: str | None = None, delivery_destination_address: str | None = None, delivery_destination_city: str | None = None, delivery_destination_country: str | None = None, delivery_destination_zip_code: str | None = None, delivery_method_id: str | int | None = None, document_set_id: str | int | None = None, notes: str | None = None, products: List[Products] | None = None, related_documents_notes: str | None = None, salesman_commission: str | None = None, salesman_id: str | int | None = None, status: str | None = None, vehicle_id: str | int | 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

associated_documents: List[Associated_documents] | None

customer_id: str | int | None

date: str | 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

notes: str | None

products: List[Products] | None

related_documents_notes: str | None

salesman_commission: str | None

salesman_id: str | int | None

status: str | None

vehicle_id: str | int | 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]] = {'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), '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), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, 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), '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.

class moloni.api.DeliverynotesSetTransportCodeModel(*, company_id: str | int, document_id: str | int | None = None, transport_code: 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

document_id: str | int | None

transport_code: 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), 'document_id': FieldInfo(annotation=Union[str, int, NoneType], required=False, default=None), 'transport_code': 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.DeliverynotesUpdateModel(*, company_id: str | int, associated_documents: List[Associated_documents] | None = None, customer_id: str | int | None = None, date: str | None = None, delivery_datetime: str | None = None, delivery_departure_address: str | None = None, delivery_departure_city: str | None = None, delivery_departure_country: str | None = None, delivery_departure_zip_code: str | None = None, delivery_destination_address: str | None = None, delivery_destination_city: str | None = None, delivery_destination_country: str | None = None, delivery_destination_zip_code: str | None = None, delivery_method_id: str | int | None = None, document_id: str | int | None = None, document_set_id: str | int | None = None, notes: str | None = None, products: List[Products] | None = None, related_documents_notes: str | None = None, salesman_commission: str | None = None, salesman_id: str | int | None = None, status: str | None = None, vehicle_id: str | int | 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

associated_documents: List[Associated_documents] | None

customer_id: str | int | None

date: str | 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

notes: str | None

products: List[Products] | None

related_documents_notes: str | None

salesman_commission: str | None

salesman_id: str | int | None

status: str | None

vehicle_id: str | int | 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]] = {'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), '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), 'notes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'products': FieldInfo(annotation=Union[List[Products], NoneType], required=False, default=None), 'related_documents_notes': FieldInfo(annotation=Union[str, 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), '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.