Skip to content

Add ZUGFeRD endpoint examples - #134

Closed
datalogics-erics wants to merge 1 commit into
pdfrest:mainfrom
datalogics-erics:codex/pdfcloud-6315-zugferd-samples
Closed

datalogics-erics wants to merge 1 commit into
pdfrest:mainfrom
datalogics-erics:codex/pdfcloud-6315-zugferd-samples

Conversation

@datalogics-erics

@datalogics-erics datalogics-erics commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Why this change

pdfRest now supports creating and validating ZUGFeRD and Factur-X hybrid invoices. These examples give developers a clear, runnable starting point for both endpoints in each of the repository's primary languages.

What changed

Adds 24 endpoint examples for Create ZUGFeRD PDF (/zugferd-pdf) and Validate ZUGFeRD PDF (/validated-zugferd) in C#, Java, JavaScript, PHP, Python, and cURL. Each endpoint has a direct multipart upload example and an upload-then-JSON resource-ID example.

Creation examples generate a PDF/A-3 hybrid invoice from a standalone invoice XML file and illustrate optional presentation settings. Validation examples submit an existing hybrid ZUGFeRD/Factur-X PDF and print the full validation response.

The .NET dispatcher and usage help expose the four new .NET example commands alongside the existing endpoint samples.

Behavior changes

The JSON samples upload the local XML or PDF first and pass the returned resource ID to the processing endpoint. Multipart samples send the source file directly to the endpoint. No existing samples or API behavior change.

Validation

  • Shell syntax: cURL samples
  • node --check: JavaScript samples
  • python3 -m py_compile: Python samples
  • php -l: PHP samples
  • mvn compile: Java multipart and JSON directories
  • dotnet build: .NET samples

Risks and follow-ups

These examples use placeholder API keys and local input paths consistent with the rest of the repository. Users replace those values before running a sample. This PR adds endpoint examples only; it does not change API behavior.

@datalogics-erics datalogics-erics changed the title [PDFCLOUD-6315] Add ZUGFeRD API samples Add ZUGFeRD endpoint examples Sep 17, 2026
@datalogics-erics
datalogics-erics deleted the codex/pdfcloud-6315-zugferd-samples branch September 17, 2026 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant