libredte_lib_sdk.billing.document.models module

DTO del componente billing.document.

Encabezado/Detalle/etc. se pasan como dict tal cual el formato SII (ver builder.py); estas clases tipan solo lo que el SDK arma o recibe de la API.

Bases: object

Bolsa de un documento tributario.

Devuelta por document.builder::build/document.loader::loadXml/ document.parser::parse — todas en esta misma forma, con los campos que correspondan a cuánto se hizo con el documento. document (Encabezado/Detalle, con el merge de libredte_data.extra.dte si se pasó al renderizar) es la vista «de datos» limpia del documento — SIN los campos opcionales no usados (se omiten, no quedan en False). document_normalized es la data cruda tal como la usa el builder internamente para generar el XML (con esos campos opcionales en False en vez de omitidos): es la que hay que guardar para poder reconstruir el documento después con options={“normalizer”: {“normalize”: False}} sin volver a normalizar — usar document para eso corrompe la reconstrucción.

document_id/xml_base64 dan el documento construido completo — puede ser un borrador, un documento timbrado, o timbrado y firmado, no una subclase distinta: es el mismo recurso en distintos estados según qué datos se le hayan pasado a DocumentBuilderService. Un borrador sin folio asignado tiene folio 0 en document_id (ver AbstractDocument::getId() en la biblioteca), nunca lanza error.

document_stamp_base64 es el TED — None si el documento aún no está timbrado (ver is_timbrado). document_extra son los campos que el tipo de documento no admite en el XML (ej. TermPagoGlosa en una boleta) pero sí se pasaron como libredte_data al construir. document_auth viene poblado solo si el emisor incluyó su autorización SII.

options son las opciones efectivas de la bolsa (builder/ normalizer/parser/renderer/sanitizer/validator), tal como las devuelve la API — vacías ([]) para el worker que no recibió ninguna al construir/cargar el documento.

certificate/caf son None salvo que el documento se haya construido con ellos (build_signed, o un loadXml de un XML ya firmado/timbrado) — un borrador (build_draft) no los trae. emisor/receptor sí están siempre que haya un documento construido (Encabezado.Emisor/Encabezado.Receptor ya resueltos como entidad, con todos sus campos — no solo los que trae document). timbre es el TED ya parseado como dict (document_stamp_base64 es el mismo dato, pero como XML) — None si el documento aún no está timbrado.

Una bolsa que solo se parseó (DocumentParserService, o cada bolsa de un DocumentBatch) trae document_parsed (los datos en el formato DTE del SII, tal como los entregó el parser) y deja en None lo que requiere construir el documento: document, document_type, el XML, etc.

No usa XmlPayloadMixin: acá xml_base64 es una @property (el documento puede no estar construido), no un campo simple.

caf: Caf | None

certificate: Certificate | None

document: dict[str, Any] | None

document_auth: dict[str, Any] | None

document_extra: dict[str, Any] | None

document_id: str | None

document_normalized: dict[str, Any] | None

document_parsed: dict[str, Any] | None

document_stamp_base64: str | None

document_type: dict[str, Any] | None

document_xml_base64: str | None

emisor: dict[str, Any] | None

classmethod from_api(data: dict[str, Any]) → DocumentBag: Construye un DocumentBag desde el data de la API.

property is_timbrado: bool: Si el documento ya tiene Timbre Electrónico (TED).

options: dict[str, Any]

raw: dict[str, Any]

receptor: dict[str, Any] | None

require_document() → dict[str, Any]

Entrega document, o falla si la bolsa no tiene el documento.

Para quien sabe que la bolsa viene de construir o cargar un documento (builder, loader, dispatcher): document es opcional solo porque una bolsa que se parseó (parser, batch_processor) no lo trae, y esto evita revisar el None en cada acceso.

Muestra:: ValueError – Si document es None.

timbre: dict[str, Any] | None

property xml: str: XML del documento construido, como texto (ISO-8859-1).

property xml_base64: str: XML completo del documento construido, en base64.

property xml_bytes: bytes: XML del documento construido, decodificado desde base64.

class libredte_lib_sdk.billing.document.models.DocumentBatch(document_bags: tuple[DocumentBag, ...], raw: dict[str, Any])

Bases: object

Lote de documentos de una emisión masiva, ya parseado.

Devuelto por batch_processor::parse. document_bags trae una bolsa (DocumentBag) por cada documento del archivo, en el orden del archivo, con los datos parseados en document_parsed — todavía no se construyó ningún documento. No incluye el contenido enviado ni el certificado.

document_bags: tuple[DocumentBag, ...]

classmethod from_api(data: dict[str, Any]) → DocumentBatch: Construye un DocumentBatch desde el data de la API.

raw: dict[str, Any]

class libredte_lib_sdk.billing.document.models.DocumentEnvelope(tag: str, xml_base64: str, documents: tuple[DocumentBag, ...], caratula: dict[str, Any] | None)

Bases: XmlPayloadMixin

Sobre EnvioDTE, ya sea recién construido o cargado desde un XML.

documents trae una bolsa (DocumentBag) por cada documento tributario que el sobre contiene — uno solo si se armó con create(), uno o más si se armó con createMany() o si se cargó con loadXml() un sobre que agrupaba varios documentos. caratula es el dict con los datos de la carátula del sobre (RutEmisor, RutEnvia, RutReceptor, FchResol, NroResol, TmstFirmaEnv, SubTotDTE).

caratula: dict[str, Any] | None

documents: tuple[DocumentBag, ...]

classmethod from_api(data: dict[str, Any]) → DocumentEnvelope: Construye un DocumentEnvelope desde el data de la API.

tag: str

xml_base64: str

class libredte_lib_sdk.billing.document.models.Example(id: str, example: dict[str, Any], expected: dict[str, Any])

Bases: object

Un ejemplo de documento, tal como lo devuelve examples::get().

example se pasa directamente al parámetro input_data de DocumentBuilderService.build_draft()/.build_signed() — mismo Encabezado/Detalle que usa el resto del SDK, sin transformación. expected son los valores esperados del caso (totales, etc.) que usa la suite de tests de libredte-lib-core para validarlo — información de referencia, no un dato del documento en sí.

example: dict[str, Any]

expected: dict[str, Any]

classmethod from_api(data: dict[str, Any]) → Example: Construye un Example desde el data que devuelve la API.

id: str

class libredte_lib_sdk.billing.document.models.ExampleSummary(id: str, category: str, case: str)

Bases: object

Un ejemplo listado por DocumentExamplesService.list().

case: str

category: str

classmethod from_api(data: dict[str, Any]) → ExampleSummary: Construye un ExampleSummary desde un ítem de la lista.

id: str

class libredte_lib_sdk.billing.document.models.RenderResult(renderings: tuple[RenderedDocument, ...])

Bases: object

Resultado de un renderizador.

Ej. DocumentRendererService.render(), PayrollRendererService .render(). renderings trae un ítem por copia generada. Para document.renderer: por defecto (sin pedir renderings explícito) es un único “tributaria”; pidiendo más de una presentación y/o copia (ej. renderings={“tributaria”: 2, “cedible”: 1}), trae uno por cada copia efectivamente generada — una presentación que la API no pudo generar para ese documento (ej. “cedible” en un tipo de documento sin acuse de recibo) se omite en silencio, no rompe la llamada. Para payroll.renderer (que no modela presentaciones) siempre trae un único elemento, sin label. .first es un atajo para el caso más común (un solo archivo); .by_label() filtra por presentación cuando se pidió más de una.

by_label(label: str) → tuple[RenderedDocument, ...]: Los renderings de una presentación (ej. “tributaria”).

property first: RenderedDocument: El primer archivo generado.

classmethod from_api(data: dict[str, Any]) → RenderResult: Construye un RenderResult desde el data que devuelve la API.

renderings: tuple[RenderedDocument, ...]

class libredte_lib_sdk.billing.document.models.RenderedDocument(content_base64: str, mime_type: str, filename: str, label: str | None, copies: int, copy_number: int)

Bases: object

Un archivo generado por un renderizador.

Ej. DocumentRendererService.render(), PayrollRendererService .render(). content_base64 es el archivo completo en base64 (un PDF, un HTML, lo que sea — mime_type dice qué es). label es la presentación pedida en renderings (ej. “tributaria”, “cedible”) cuando el renderizador modela más de una presentación posible; None cuando no aplica (ej. una liquidación de sueldo, que siempre es un único archivo). copies/copy_number identifican esta copia entre las pedidas de ese mismo label (ej. copies=2, copy_number=1 es la primera de 2 copias tributarias). El nombre de los campos en la API (content/mimeType/filename/copyNumber) es camelCase; acá quedan en snake_case como el resto del SDK.

content_base64: str

property content_bytes: bytes: Contenido del archivo, decodificado desde base64.

copies: int

copy_number: int

filename: str

classmethod from_api(data: dict[str, Any]) → RenderedDocument: Construye desde un ítem de data.renderings.

label: str | None

mime_type: str