Batch service: Prepare batch from paths

Load invoice XML files from disk and prepare a batch package.

Sync

Called on auth.batch

Source src/ksef2/services/batch.py:97 Generated from async source src/ksef2/services/async_batch.py

auth.batch.prepare_batch_from_paths

auth.batch.prepare_batch_from_paths(*, invoice_paths: Iterable[Path | str], form_code: FormSchema = FormSchema.FA3, offline_mode: bool = False, max_part_size: int = MAX_BATCH_PART_SIZE) -> PreparedBatch

Returns

PreparedBatch

Parameters

invoice_paths Iterable[Path | str]

required / keyword-only

form_code FormSchema

default FormSchema.FA3 / keyword-only

offline_mode bool

default False / keyword-only

max_part_size int

default MAX_BATCH_PART_SIZE / keyword-only

Async

Called on auth.batch

Source src/ksef2/services/async_batch.py:99 Authored source

await auth.batch.prepare_batch_from_paths

await auth.batch.prepare_batch_from_paths(*, invoice_paths: Iterable[Path | str], form_code: FormSchema = FormSchema.FA3, offline_mode: bool = False, max_part_size: int = MAX_BATCH_PART_SIZE) -> PreparedBatch

Returns

PreparedBatch

Parameters

invoice_paths Iterable[Path | str]

required / keyword-only

form_code FormSchema

default FormSchema.FA3 / keyword-only

offline_mode bool

default False / keyword-only

max_part_size int

default MAX_BATCH_PART_SIZE / keyword-only