Repository navigation
docs: align invoice and series response contracts - #310
Merged
Merged
Conversation
raul-facturapi
approved these changes
Oct 14, 2026
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Update cancellation guide links and replace request-only schema references in response models.
4 open findings
What changed in this PR
Corrects bilingual OpenAPI response schemas, restores public fields, and normalizes the cancellation receipt operation.
Changes:
- Returns organization series as arrays.
- Restores response properties across invoice, receipt, tax, and organization models.
- Renames the cancellation receipt operation and updates type fixtures.
| File | Description |
|---|---|
website/openapi_v2.yaml |
Spanish contract updates |
website/openapi_v2.en.yaml |
English contract updates |
website/test/openapi-types.fixture.txt |
Type-generation regression fixtures |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
javorosas
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Correct organization series responses to arrays and restore existing response fields for cancellation checks, fiscal stamps, invoice items, organization settings, receipts and taxes. Give the shared XML/PDF cancellation receipt download operation a neutral name.
Invoice responses now distinguish draft, pending, failed and stamped states. Valid and canceled invoices require their UUID and stamp fields; draft responses have no stamp. The invoice creation input and its type selector are unchanged. Cancellation check timestamps remain optional and are omitted until a check starts.
Spanish and English contracts remain aligned. All 127 operations, references and generated type fixtures pass, including response narrowing by status. Both locale production builds pass. These corrections describe the public API behavior and prevent SDK type regressions.