Budgeting

Budgets in iplicit allow you to define planned financial amounts against accounts and legal entities across financial periods.

Name Method Path
GetBudgetings GET /api/Budgeting
Get a list of budgets with a search filter
GetBudgeting GET /api/Budgeting/{budgetingRef}
Get a budget
GetBudgetingAmounts GET /api/Budgeting/{budgetingId}/amounts
Get budget amounts for a budget

Searching budgets

Existing budgets can be searched using GET /api/Budgeting.

This is a paginated response and will return up to 100 results by default. Use the skip and take query parameters to page through results:

`GET /api/Budgeting?skip=0&take=100`
Note

Maximum of 1000 budgets can be retrieved in a single request.

Search filter parameters

Parameter Type Description
codeContains string Only return budgets where the code contains this text
nameContains string Only return budgets where the name contains this text
descriptionContains string Only return budgets where the description contains this text
currency string Only return budgets with this currency
financialYearGroup string Only return budgets with this financial year group. Accepts id
financialYear string Only return budgets with this financial year. Accepts id
isFinalised boolean Only return budgets that are finalised
isArchived boolean Only return budgets that are archived
isDuplicate boolean Only return budgets that are a duplicate
isRevision boolean Only return budgets that are a revision
isForecast boolean Only return budgets that are a forecast
isCheckBudget boolean Only return budgets flagged for budget checking
includeClosed boolean Include closed budgets in the results

Example search response

`GET /api/Budgeting?codeContains=FY25&take=2`

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "code": "FY25-MAIN",
    "name": "FY 2025 Main Budget",
    "description": "Main operating budget for financial year 2025",
    "currency": "GBP",
    "financialYearGroupId": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "financialYearId": "c3d4e5f6-a7b8-90cd-ef12-345678901234",
    "startPeriodId": null,
    "endPeriodId": null,
    "includeSpecialPeriods": false,
    "legalEntityIds": ["d4e5f6a7-b8c9-0def-1234-567890abcdef"],
    "accountIds": null,
    "createdBy": "admin@example.com",
    "createdDate": "2024-11-01T09:00:00Z",
    "lastModifiedBy": "admin@example.com",
    "lastModified": "2025-01-15T14:30:00Z",
    "isActive": true,
    "isFinalised": true,
    "isArchived": false,
    "isDuplicate": false,
    "isRevision": false,
    "isForecast": false,
    "isCheckBudget": false,
    "hasNotes": false,
    "hasAttachments": false
  }
  /*...*/
]

Retrieving a budget

A budget can be retrieved by its id or code:

  • GET /api/Budgeting/a1b2c3d4-e5f6-7890-abcd-ef1234567890
  • GET /api/Budgeting/FY25-MAIN

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "code": "FY25-MAIN",
  "name": "FY 2025 Main Budget",
  "description": "Main operating budget for financial year 2025",
  "currency": "GBP",
  "financialYearGroupId": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
  "financialYearId": "c3d4e5f6-a7b8-90cd-ef12-345678901234",
  "startPeriodId": null,
  "endPeriodId": null,
  "includeSpecialPeriods": false,
  "legalEntityIds": ["d4e5f6a7-b8c9-0def-1234-567890abcdef"],
  "accountIds": null,
  "createdBy": "admin@example.com",
  "createdDate": "2024-11-01T09:00:00Z",
  "lastModifiedBy": "admin@example.com",
  "lastModified": "2025-01-15T14:30:00Z",
  "isActive": true,
  "isFinalised": true,
  "isArchived": false,
  "isDuplicate": false,
  "isRevision": false,
  "isForecast": false,
  "isCheckBudget": false,
  "hasNotes": false,
  "hasAttachments": false
}

Response fields

Field Type Description
id guid Unique id for the budget
code string Unique code for the budget
name string Name for the budget
description string Description of the budget
currency string The currency for the budget
financialYearGroupId guid The id of the financial year group for the budget
financialYearId guid The id of the financial year for the budget
startPeriodId guid The id of the custom start period for the budget
endPeriodId guid The id of the custom end period for the budget
includeSpecialPeriods boolean Whether special periods are included in the budget
legalEntityIds guid[] The legal entity ids for the budget
accountIds guid[] The account ids for the budget
createdBy string The user who created the budget
createdDate datetime The date and time the budget was created
lastModifiedBy string The user who last modified the budget
lastModified datetime The date and time the budget was last modified
isActive boolean Whether the budget is active
isFinalised boolean Whether the budget is finalised
isArchived boolean Whether the budget is archived
isDuplicate boolean Whether the budget is a duplicate
isRevision boolean Whether the budget is a revision
isForecast boolean Whether the budget is a forecast
isCheckBudget boolean Whether the budget is flagged for budget checking
hasNotes boolean Whether the budget has notes
hasAttachments boolean Whether the budget has attachments

Retrieving budget amounts

Budget amounts for a budget can be retrieved using GET /api/Budgeting/{budgetingId}/amounts.

This is a paginated response and will return up to 1000 results by default. Use the skip and take query parameters to page through results:

GET /api/Budgeting/a1b2c3d4-e5f6-7890-abcd-ef1234567890/amounts?skip=0&take=1000

Maximum of 10000 budget amounts can be retrieved in a single request.

Amount filter parameters

Parameter Type Description
row string Only return amounts for the specified budget row. Accepts id
legalEntity string Only return amounts for the specified legal entity. Accepts id or code
account string Only return amounts for the specified account. Accepts id or code
period string Only return amounts for the specified period. Accepts id

Example amounts response

GET /api/Budgeting/a1b2c3d4-e5f6-7890-abcd-ef1234567890/amounts?legalEntity=LEGEA&take=2

[
  {
    "id": "e5f6a7b8-c9d0-1234-5678-90abcdef1234",
    "legalEntityId": "d4e5f6a7-b8c9-0def-1234-567890abcdef",
    "accountId": "b8c9d0e1-f2a3-4567-89ab-cdef01234567",
    "attributes": [
      {
        "typeName": "CostCentre",
        "value": "CC100"
      }
    ],
    "budgetingAmounts": [
      {
        "id": "f6a7b8c9-d0e1-2345-6789-0abcdef12345",
        "periodId": "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
        "amount": 5000.00
      },
      {
        "id": "07b8c9d0-e1f2-3456-789a-bcdef0123456",
        "periodId": "b8c9d0e1-f2a3-4567-89ab-cdef01234567",
        "amount": 5000.00
      }
      /*...*/
    ]
  }
  /*...*/
]

Amount response fields

BudgetingRow

Field Type Description
id guid Unique id for the budget row
legalEntityId guid Legal entity id for the budget row
accountId guid Account id for the budget row
attributes BudgetingAttribute[] Attributes for the budget row (e.g. cost centre, department)
budgetingAmounts BudgetingAmount[] Budget amounts for each period in the budget row

BudgetingAttribute

Field Type Description
typeName string The type name of the attribute (e.g. CostCentre, Department)
value string The value of the attribute

BudgetingAmount

Field Type Description
id guid Unique id for the budget amount
periodId guid The period id for the budget amount
amount decimal The budget amount for the period

Updated July 2026