cdek.apps.payment package

class cdek.apps.payment.PaymentApp(client: CdekClient)

Базовые классы: App

Класс для работы с переводами наложенного платежа

get(date: date) → PaymentInfoResponse

Запрос на получение информации о переводе наложенного платежа

Args:

date: дата для получения информации о переводе наложенного платежа

Returns:

PaymentInfoResponse: объект с информацией о переводе наложенного платежа

Raises:

ValueError: если date не является объектом Date

get_registries(date: date) → PaymentResponse

Получение информации о реестрах НП

Args:

date: дата для получения информации о реестрах НП

Returns:

PaymentResponse: объект с информацией о реестрах НП

Raises:

ValueError: если date не является объектом Date

class cdek.apps.payment.PaymentInfoResponse(*, orders: list[PaymentOrder] | None = None, errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)

Базовые классы: BaseModel

errors: list[Error] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

orders: list[PaymentOrder] | None

warnings: list[WarningModel] | None

class cdek.apps.payment.PaymentOrder(*, order_uuid: UUID, cdek_number: int, number: str)

Базовые классы: BaseModel

cdek_number: int

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: str

order_uuid: UUID

class cdek.apps.payment.PaymentResponse(*, registries: list[Registry] | None = None, errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)

Базовые классы: BaseModel

errors: list[Error] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

registries: list[Registry] | None

warnings: list[WarningModel] | None

class cdek.apps.payment.Registry(*, registry_number: int, payment_date: date | None = None, sum: float, payment_order_number: str | None = None, orders: list[RegistryOrder], date_created: datetime | None = None)

Базовые классы: BaseModel

date_created: DateTime | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

orders: list[RegistryOrder]

payment_date: Date | None

payment_order_number: str | None

registry_number: int

serialize_date_created(date_created: datetime) → str

Вернуть дату создания реестра в формате ISO 8601

serialize_payment_date(payment_date: date) → str

Представить дату оплаты реестра в формате YYYY-MM-DD

sum: float

class cdek.apps.payment.RegistryOrder(*, cdek_number: str, transfer_sum: float, payment_sum: float, total_sum_without_agent: float, agent_commission_sum: float)

Базовые классы: BaseModel

agent_commission_sum: float

cdek_number: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_sum: float

total_sum_without_agent: float

transfer_sum: float

Submodules

cdek.apps.payment.payment module

class cdek.apps.payment.payment.PaymentApp(client: CdekClient)

Базовые классы: App

Класс для работы с переводами наложенного платежа

get(date: date) → PaymentInfoResponse

Запрос на получение информации о переводе наложенного платежа

Args:

date: дата для получения информации о переводе наложенного платежа

Returns:

PaymentInfoResponse: объект с информацией о переводе наложенного платежа

Raises:

ValueError: если date не является объектом Date

get_registries(date: date) → PaymentResponse

Получение информации о реестрах НП

Args:

date: дата для получения информации о реестрах НП

Returns:

PaymentResponse: объект с информацией о реестрах НП

Raises:

ValueError: если date не является объектом Date

cdek.apps.payment.responses module

class cdek.apps.payment.responses.PaymentInfoResponse(*, orders: list[PaymentOrder] | None = None, errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)

Базовые классы: BaseModel

errors: list[Error] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

orders: list[PaymentOrder] | None

warnings: list[WarningModel] | None

class cdek.apps.payment.responses.PaymentOrder(*, order_uuid: UUID, cdek_number: int, number: str)

Базовые классы: BaseModel

cdek_number: int

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: str

order_uuid: UUID

class cdek.apps.payment.responses.PaymentResponse(*, registries: list[Registry] | None = None, errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)

Базовые классы: BaseModel

errors: list[Error] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

registries: list[Registry] | None

warnings: list[WarningModel] | None

class cdek.apps.payment.responses.Registry(*, registry_number: int, payment_date: date | None = None, sum: float, payment_order_number: str | None = None, orders: list[RegistryOrder], date_created: datetime | None = None)

Базовые классы: BaseModel

date_created: DateTime | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

orders: list[RegistryOrder]

payment_date: Date | None

payment_order_number: str | None

registry_number: int

serialize_date_created(date_created: datetime) → str

Вернуть дату создания реестра в формате ISO 8601

serialize_payment_date(payment_date: date) → str

Представить дату оплаты реестра в формате YYYY-MM-DD

sum: float

class cdek.apps.payment.responses.RegistryOrder(*, cdek_number: str, transfer_sum: float, payment_sum: float, total_sum_without_agent: float, agent_commission_sum: float)

Базовые классы: BaseModel

agent_commission_sum: float

cdek_number: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_sum: float

total_sum_without_agent: float

transfer_sum: float