@fimwise-task/fimwise-budget

@fimwise-task/fimwise-budget is a Node.js module that provides various task handlers for managing budgets within the Fimwise platform. It includes handlers for retrieving budgets, budget items, and budget remainders.

Prerequisites

• Node.js (>= 20.x)
• npm (>= 10.x)

Usage

To use these task handlers, you need to define them in the process configuration file. Below are examples of how to define each task.

Get Budget

{
  "name": "package:@fimwise-task/fimwise-budget:get-budget",
  "parameters": {
    "budgetId": 123
  }
}

Get Budgets

{
  "name": "package:@fimwise-task/fimwise-budget:get-budgets",
  "parameters": {
    "organizationUnitPath": "/1/2",
    "period": "Q1",
    "year": 2023
  }
}

Parameters:

• organizationUnitPath: The path of the organization unit to filter budgets by. This is optional.
• period: The period to filter budgets by. This is optional.
• year: The year to filter budgets by. This is optional.

Get Budget Item

{
  "name": "package:@fimwise-task/fimwise-budget:get-budget-item",
  "parameters": {
    "budgetItemId": 456
  }
}

Parameters:

• budgetItemId: The ID of the budget item to retrieve. This is required.

Get Budget Items

{
  "name": "package:@fimwise-task/fimwise-budget:get-budget-items"
}

No parameters are required for this task.

Get Budget Remainder

{
  "name": "package:@fimwise-task/fimwise-budget:get-budget-remainder",
  "parameters": {
    "budgetRemainderId": 789
  }
}

Parameters:

• budgetRemainderId: The ID of the budget remainder to retrieve. This is required.

Get Budget Remainders

{
  "name": "package:@fimwise-task/fimwise-budget:get-budget-remainders",
  "parameters": {
    "organizationUnitPath": "/finance",
    "period": "Q1",
    "year": 2023
  }
}

Parameters:

• organizationUnitPath: The path of the organization unit to filter budget remainders by. This is optional.
• period: The period to filter budget remainders by. This is optional.
• year: The year to filter budget remainders by. This is optional.

Install the package

To install the package, run:

fimwise-bot install path/to/process.json

License

This project is licensed under the MIT License.