Skip to content

Document global invoice automation - #287

Open
javorosas wants to merge 10 commits into
mainfrom
agent/document-global-invoice-receipt-limits
Open

Document global invoice automation#287
javorosas wants to merge 10 commits into
mainfrom
agent/document-global-invoice-receipt-limits

Conversation

@javorosas

@javorosas javorosas commented Jul 29, 2026

Copy link
Copy Markdown
Member

What

  • Documents global invoice automation settings in the public organization API.
  • Documents the 5,000-open-receipt batching behavior, repeated requests, and nullable completion response.
  • Documents the existing public error code global_invoice_too_many_items with its receipt-based batching semantics.
  • Documents grouped_items_invoice and clarifies that it does not affect global invoices.
  • Updates Spanish and English guides and OpenAPI definitions.

Why

This documents the public contract introduced by FacturAPI/facturapi#2123 without exposing internal automation implementation details.

Impact

The OpenAPI contract now exposes activate_global_invoice, grouped_items_invoice, and limit_to_max_receipts. Existing receipt-settings examples now use the actual periodicity field. The guide points users to Dashboard receipt settings to monitor automatic and scheduled tasks.

Checks

  • pnpm --dir website typecheck
  • pnpm --dir website build
  • OpenAPI YAML syntax validation
  • git diff --check

@javorosas javorosas self-assigned this Aug 21, 2026
@javorosas
javorosas force-pushed the agent/document-global-invoice-receipt-limits branch from f6abc65 to 39ce562 Compare August 21, 2026 12:39
@javorosas
javorosas marked this pull request as ready for review August 24, 2026 13:09
@javorosas
javorosas requested review from raul-facturapi and a balanced review from Copilot August 24, 2026 15:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents global invoice automation, batching behavior, nullable responses, and receipt settings in both languages.

Changes:

  • Adds 5,000-receipt batching and completion behavior.
  • Exposes automation and item-grouping settings.
  • Updates receipt guides, examples, and error documentation.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
website/openapi_v2.yaml Updates Spanish API contract and examples.
website/openapi_v2.en.yaml Updates English API contract and examples.
website/docs/guides/receipts.mdx Documents batching and automation in Spanish.
website/docs/guides/self-invoice.mdx Corrects the Spanish periodicity field.
website/docs/getting-started/errors.mdx Clarifies Spanish batching errors.
website/i18n/en/docusaurus-plugin-content-docs/current/guides/receipts.mdx Documents batching and automation in English.
website/i18n/en/docusaurus-plugin-content-docs/current/guides/self-invoice.mdx Corrects the English periodicity field.
website/i18n/en/docusaurus-plugin-content-docs/current/getting-started/errors.mdx Clarifies English batching errors.
Suppressed comments (2)

website/openapi_v2.yaml:18420

  • The update schema uses grouped_items_invoice, while the public field identified by this PR is group_similar_self_invoice_items. Clients generated from this schema would send the wrong request key.
        grouped_items_invoice:

website/openapi_v2.en.yaml:18190

  • The English update schema exposes grouped_items_invoice instead of the PR's public field group_similar_self_invoice_items, causing generated clients to send an unsupported key.
        grouped_items_invoice:

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread website/openapi_v2.yaml
Comment thread website/openapi_v2.en.yaml
Comment thread website/docs/guides/receipts.mdx
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.

2 participants