Skip to content

[SYFT-1621] Update budgets OpenAPI contract - #850

Open
mbridge90 wants to merge 2 commits into
XeroAPI:masterfrom
mbridge90:syft-1621-ecosystem-budgets
Open

mbridge90 wants to merge 2 commits into
XeroAPI:masterfrom
mbridge90:syft-1621-ecosystem-budgets

Conversation

@mbridge90

Copy link
Copy Markdown

Description

Description

Align the Accounting API Budgets OpenAPI response contract with the Xero Analytics migration.

  • Add CreatedIn to the Budget schema, identifying the tool used to create the budget. Its supported values are XERO_ANALYTICS and BUDGETS_MANAGER.
  • Remove UnitAmount and Notes from the BudgetBalance schema.
  • Update the GET /Budgets and GET /Budgets/{BudgetID} examples to show CreatedIn and omit Notes.

This does not change endpoint parameters, top-level metadata, OAuth scopes, or other API schemas.

Validation: the updated YAML parses successfully, and git diff --check passes.

Ticket: https://xero.atlassian.net/browse/SYFT-1621
Companion documentation PR: https://github.com/xero-internal/ecosystem-devx-technical-markdown-documentation/pull/1076

@mbridge90
mbridge90 force-pushed the syft-1621-ecosystem-budgets branch from a421bd8 to ccdc33c Compare September 30, 2026 12:53
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