Check configuration
csv2zugferd_config_getLoads a YAML config from a path or text and reports effective settings, field mappings, typos, invalid values with CLI fallbacks, missing sections, and optional CSV header checks.
Instructions
Loads a YAML configuration from configPath or configYaml and reports its structure: effective settings and modes, every mapped field with its sources, unknown keys (typos), values outside the allowed sets with the fallback the CLI would apply, and ignored or missing sections. With csvPath the referenced columns are compared with the CSV header (missing and unused columns). Does not read cell values and does not calculate totals; use csv2zugferd_invoice_get for a trial run. Read-only, writes no files.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csvPath | No | Optional CSV file whose header is compared with the referenced columns (structural check, no cell values are read). | |
| configPath | No | Path to an existing YAML configuration file. Use either configPath or configYaml, not both. | |
| configYaml | No | YAML configuration as text (the content of config.yml). Use either configPath or configYaml, not both. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | Yes | Effective CSV settings. | |
| source | Yes | Where the configuration came from. | |
| zugferd | Yes | Effective output settings after fallbacks (canonical spelling). | |
| warnings | Yes | Structural findings: ignored or missing sections for the chosen modes, fallbacks of version, profile and format. | |
| totalsMode | Yes | Effective totals mode after fallback. | |
| unknownKeys | Yes | Keys in the YAML that no configuration key matches (typos); they are silently ignored by the CLI. | |
| mappedFields | Yes | Every configured field mapping with its configured sources in resolution order. | |
| columnsUnused | No | Only with csvPath: header columns no mapping refers to. | |
| invalidValues | Yes | Configured values outside their value set (version, profile, format, modes, currency, country, unit code, tax codes, type codes, schemes). | |
| lineItemsMode | Yes | Effective line item mode after fallback. | |
| columnsMissing | No | Only with csvPath: referenced columns without any match in the header (case-insensitive), neither direct nor indexed. | |
| columnsReferenced | Yes | CSV column names the configuration can read in the effective mode (direct names; in columns mode also the indexed names built from columnPattern). |