Item types - GET

View the available item types.

Item types dictate the type of item that gets added below a resource, item types adjust both the structure of the item object and the functions available.

Support for new item types needs to be added in the code, we don't allow it to be changed via the API so no POST endpoint

Supported item types

The Costs to Expect API, supports five item types:

Allocated Expense

Chronological expenses tracking, use by the Expense App. In addition to defining the data for an expense, you can set a publish after date and allocate a percentage of the total cost. Expenses can be partially transferred to other resources to split the cost and transferred entirely to another resource to move the cost.

Allocated Transaction

Chronological tracking of both income and expenses in a single tracker. Behaves the same as Allocated Expense (publish after date, allocated percentage, partial and full transfers between resources) but each item also records a transaction_type of expense or income, so a single tracker can hold both, and the collection can be filtered by transaction type.

Budget

Budget items are used by the Budget App. Budgets items are a definition of a planned expense and the frequency with which it occurs.

Budget Pro

Budget Pro items are used by the Budget App. Budgets items are a definition of a planned expense and the frequency with which it occurs.

Game

Game items are used by out scoring Apps, Yahtzee and Yatzy. Game items are specific to the game but typically they are used to record the players, the winner(s) and the final score.

Request

URL : /v3/item-types/

Method : GET

Parameters :

Parameter	Type	Default	Description	Example
collection	boolean	false	Override pagination and return the entire collection	collection=true
limit	integer	25	Limit the collection	limit=25
offset	integer	0	Limit offset	offset=0
search	string		Search collection fields	search=field1:partial_search_term
sort	string		Sort collection	sort=field1:asc

Response

Code : 200 OK

Content :

[
    {
        "id": "WkxwR04GPo",
        "name": "budget-pro",
        "friendly_name": "Budgeting",
        "description": "Plan your budgets",
        "example": "Annual Personal Budget, Business Budget, Savings plan...",
        "created": "2023-06-01 15:20:43"
    },
    {
        "id": "VezyrJyMlk",
        "name": "budget",
        "friendly_name": "Budgeting",
        "description": "Plan your budgets",
        "example": "Annual Personal Budget, Business Budget, Savings plan...",
        "created": "2022-08-04 15:55:36"
    },
    {
        "id": "2AP1axw6L7",
        "name": "game",
        "friendly_name": "Track a game",
        "description": "Track your board, card and dice game sessions.",
        "example": "Check the item_subtype collection, more added on request",
        "created": "2020-10-08 09:33:25"
    },
    {
        "id": "OqZwKX16bW",
        "name": "allocated-expense",
        "friendly_name": "Create an expense chronological tracker",
        "description": "Track expenses over time, additionally, an expense can be partially allocated to another tracker.",
        "example": "Examples include, the cost to raise a child and start-up expenses for your business.",
        "created": "2019-09-18 12:47:07"
    },
    {
        "id": "X3VylR1Gkb",
        "name": "allocated-transaction",
        "friendly_name": "Create a transaction chronological tracker",
        "description": "Track income and expenses over time in a single tracker.",
        "example": "Examples include, a shared household account or a small business current account.",
        "created": "2026-09-27 18:12:56"
    }
]