action biapi_get_users_id_user_categories_full {
label: "Get the category"
description: "Ressource to get categories
"
provider: biapi
method: GET
path: "/users/{id_user}/categories/full"
encoding: json
input: {
type: "object"
properties: {
expand: {
type: "string"
}
id_user: {
type: "string"
}
}
required: ["id_user"]
additionalProperties: false
}
output: {
type: "object"
required: ["categorys"]
properties: {
categorys: {
type: "array"
items: {
type: "object"
required: ["id", "id_parent_category", "name", "color", "id_parent_category_in_menu", "refundable"]
properties: {
color: {
type: "string"
description: "Color of the category"
}
id: {
type: "integer"
description: "ID of the category"
}
id_logo: {
type: "integer"
description: "ID of the logo"
}
id_parent_category: {
type: "integer"
description: "ID of the parent category. If this is a parent category, it will be equal to its own ID"
}
id_parent_category_in_menu: {
type: "integer"
description: "ID of the parent category to be displayed"
}
id_user: {
type: "integer"
description: "If not null, this category is specific to a user"
}
income: {
type: "boolean"
description: "Is an income category. If null, this is both an income and an expense category"
}
name: {
type: "string"
description: "Name of the category"
}
name_displayed: {
type: "string"
description: "Displayed name, with HTML tags"
}
refundable: {
type: "boolean"
description: "This category accepts opposite sign of transactions"
}
}
}
}
total: {
type: "number"
description: "total number of results"
}
}
}
}