Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Budget → Get List

AI-generated

Summary

Retrieves a list of budget records from Acumatica with optional filters.

Inputs

  • BranchFilter — Filters results by Branch using an operator (e.g., Equals, Contains).
  • ComparetoBranchFilter — Filters results by Compareto Branch using an operator (e.g., Equals).
  • ComparetoLedgerFilter — Filters results by Compareto Ledger using an operator (e.g., Equals).
  • ComparetoYearFilter — Filters results by Compareto Year using an operator (e.g., Equals).
  • FinancialYearFilter — Filters results by Financial Year using an operator (e.g., Equals).
  • LedgerFilter — Filters results by Ledger using an operator (e.g., Equals).
  • SubaccountFilterFilter — Filters results by Subaccount Filter using an operator (e.g., Equals).
  • TreeNodeFilterFilter — Filters results by Tree Node Filter using an operator (e.g., Equals).
  • customFilter — Advanced OData $filter expression (e.g., CustomerID/value eq 'CUST001'). Applied in addition to any filter fields above.

Output shape

a list of budget items, each containing fields defined by the Acumatica schema

Filters with empty values are ignored. The 'customFilter' field is combined with the UI filter fields.

Examples

Example 1: Retrieve all budgets for a specific Ledger

Set LedgerFilter.operator to 'eq' and LedgerFilter.value to the desired Ledger code.

Example 2: Find budgets matching multiple criteria

Combine LedgerFilter, FinancialYearFilter, and customFilter (e.g., 'Branch/value eq "HQ" and Status eq "Open"').

Links

Discussion