Skip to main content
API docs by Redocly

Receipt Wrangler API. (5.0.0)

Download OpenAPI specification:Download

License: GPLV3 Terms of Service

Dashboard

Get dashboards for a user by group id

This will get a dashboards for a user by group id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
string

Id of group to get dashboard for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update dashboard

This will update a dashboard

Authorizations:
bearerAuthapiKeyAuth
path Parameters
dashboardId
required
integer

Id of dashboard to operate on

Request Body schema: application/json
required

Dashboard to update

name
required
string

Dashboard name

groupId
required
string

Group foreign key

Array of objects (UpsertWidgetCommand)

Widgets associated to dashboard

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupId": "string",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "groupId": 0,
  • "userId": 0,
  • "updatedAt": "string",
  • "widgets": [
    ]
}

Delete dashboard

This will delete a dashboard by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
dashboardId
required
integer

Id of dashboard to operate on

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "groupId": 0,
  • "userId": 0,
  • "updatedAt": "string",
  • "widgets": [
    ]
}

Create dashboard

This will create a dashboard [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Dashboard

name
required
string

Dashboard name

groupId
required
string

Group foreign key

Array of objects (UpsertWidgetCommand)

Widgets associated to dashboard

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupId": "string",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "groupId": 0,
  • "userId": 0,
  • "updatedAt": "string",
  • "widgets": [
    ]
}

Widget

Get pie chart data

This will get pie chart data for a group based on the specified grouping

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Id of group to get pie chart data for

Request Body schema: application/json
required

Pie chart data request

chartGrouping
required
string (ChartGrouping)
Enum: "CATEGORIES" "TAGS" "PAIDBY"

What to group the pie chart by

object (ReceiptPagedRequestFilter)

Optional filter for receipts

Responses

Request samples

Content type
application/json
{
  • "chartGrouping": "CATEGORIES",
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Report

Generate a report

Generates a report over the receipts of one or more groups and streams it back as a file, or a zip when several formats are requested. Runs under the caller's group permissions and requires group.reports.read in every covered group.

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

The report builder configuration

name
string

Report name; used for the download filename

groupIds
required
Array of strings

Ids of the groups the report covers

required
object (ReportPeriod)
object (ReceiptPagedRequestFilter)

Which receipts go into the report

groupBy
Array of strings

Ordered engine field keys to nest the report by

required
object (ReportDetail)
required
Array of objects (ReportColumn)
subtotals
boolean

Emit a subtotal row at each grouping level

grandTotals
boolean

Emit one grand-total row across everything

object (ReportDocument)
formats
required
Array of strings
Items Enum: "csv" "xlsx" "pdf"

One or more output formats; multiple are zipped together

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupIds": [
    ],
  • "period": {
    },
  • "filter": {
    },
  • "groupBy": [
    ],
  • "detail": {
    },
  • "columns": [
    ],
  • "subtotals": true,
  • "grandTotals": true,
  • "document": {
    },
  • "formats": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Preview a report

Renders the current report configuration as HTML for the builder's live preview, along with the number of receipts it covers. Requires the app-level app.reports.read (or app.reports.readAll) and group.reports.read in every covered group. The preview is a row-capped sample of the engine's own output.

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

The report builder configuration

name
string

Report name; used for the download filename

groupIds
required
Array of strings

Ids of the groups the report covers

required
object (ReportPeriod)
object (ReceiptPagedRequestFilter)

Which receipts go into the report

groupBy
Array of strings

Ordered engine field keys to nest the report by

required
object (ReportDetail)
required
Array of objects (ReportColumn)
subtotals
boolean

Emit a subtotal row at each grouping level

grandTotals
boolean

Emit one grand-total row across everything

object (ReportDocument)
formats
required
Array of strings
Items Enum: "csv" "xlsx" "pdf"

One or more output formats; multiple are zipped together

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupIds": [
    ],
  • "period": {
    },
  • "filter": {
    },
  • "groupBy": [
    ],
  • "detail": {
    },
  • "columns": [
    ],
  • "subtotals": true,
  • "grandTotals": true,
  • "document": {
    },
  • "formats": [
    ]
}

Response samples

Content type
application/json
{
  • "html": "string",
  • "receiptCount": 0,
  • "allowedActions": [
    ]
}

Save a report template

Saves the current report configuration as a reusable template. App-scoped (requires app.reports.create) — it persists a configuration and touches no group's receipts.

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

The report builder configuration to save

name
string

Report name; used for the download filename

groupIds
required
Array of strings

Ids of the groups the report covers

required
object (ReportPeriod)
object (ReceiptPagedRequestFilter)

Which receipts go into the report

groupBy
Array of strings

Ordered engine field keys to nest the report by

required
object (ReportDetail)
required
Array of objects (ReportColumn)
subtotals
boolean

Emit a subtotal row at each grouping level

grandTotals
boolean

Emit one grand-total row across everything

object (ReportDocument)
formats
required
Array of strings
Items Enum: "csv" "xlsx" "pdf"

One or more output formats; multiple are zipped together

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupIds": [
    ],
  • "period": {
    },
  • "filter": {
    },
  • "groupBy": [
    ],
  • "detail": {
    },
  • "columns": [
    ],
  • "subtotals": true,
  • "grandTotals": true,
  • "document": {
    },
  • "formats": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "configuration": {
    },
  • "configurationVersion": 0,
  • "allowedActions": [
    ]
}

Get paged report templates

Returns a paged, sorted list of saved report templates. App-scoped (requires app.reports.read).

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Get report template options

Returns every report template as a lightweight {id, name, groupIds} option for the role-form access matrix. Gated on app.roles.read (the admin role editor may not personally hold report permissions), not a report permission.

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a report template

Returns a saved report template by id. Access is resolved per template (readAll, or the per-group ceiling plus the per-template matrix).

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "configuration": {
    },
  • "configurationVersion": 0,
  • "allowedActions": [
    ]
}

Update a report template

Updates a saved report template in place, replacing its name and stored configuration. App-scoped (requires app.reports.update).

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to update

Request Body schema: application/json
required

The report builder configuration to save over the existing template

name
string

Report name; used for the download filename

groupIds
required
Array of strings

Ids of the groups the report covers

required
object (ReportPeriod)
object (ReceiptPagedRequestFilter)

Which receipts go into the report

groupBy
Array of strings

Ordered engine field keys to nest the report by

required
object (ReportDetail)
required
Array of objects (ReportColumn)
subtotals
boolean

Emit a subtotal row at each grouping level

grandTotals
boolean

Emit one grand-total row across everything

object (ReportDocument)
formats
required
Array of strings
Items Enum: "csv" "xlsx" "pdf"

One or more output formats; multiple are zipped together

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "groupIds": [
    ],
  • "period": {
    },
  • "filter": {
    },
  • "groupBy": [
    ],
  • "detail": {
    },
  • "columns": [
    ],
  • "subtotals": true,
  • "grandTotals": true,
  • "document": {
    },
  • "formats": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "configuration": {
    },
  • "configurationVersion": 0,
  • "allowedActions": [
    ]
}

Delete a report template

Deletes a saved report template by id. Requires app.reports.delete.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Duplicate a report template

Duplicates a saved report template by id, returning the new copy. App-scoped (requires app.reports.duplicate).

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to duplicate

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "configuration": {
    },
  • "configurationVersion": 0,
  • "allowedActions": [
    ]
}

Generate a report from a saved template

Generates a saved report template by id and streams the file. Enforces the per-template generate grant (generateAll, or the per-group ceiling plus the matrix), loading the stored configuration server-side.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to generate

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Render a saved template as HTML for the dashboard report widget

Renders a saved report template by id as a self-contained HTML document over the full dataset (unlike /report/preview, which caps the sample) for the dashboard report widget, loading the stored configuration server-side. Re-resolves the caller's access on every call; when the caller may not view the template (or it was deleted) a restricted-notice HTML document is returned at 200 with empty allowedActions, so the widget always has HTML to render. allowedActions carries the actions the caller may perform (drives the widget's download button).

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of the report template to render

Responses

Response samples

Content type
application/json
{
  • "html": "string",
  • "receiptCount": 0,
  • "allowedActions": [
    ]
}

Category

Get category count by name

This will return a count of categories with the same name

Authorizations:
bearerAuthapiKeyAuth
path Parameters
categoryName
required
string

Category name to get count of

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get paged categories

This will return paged categories

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Get all categories

This will return all categories in the system

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create category

This will create a category

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Category to create

createdAt
string
createdBy
integer <uint64>
id
integer <uint64>
name
string

Name of the category

description
string

Description of the category

updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "updatedAt": "string"
}

Update category

This will update a category

Authorizations:
bearerAuthapiKeyAuth
path Parameters
categoryId
required
integer

Category Id to get

Request Body schema: application/json
required

Category to update

createdAt
string
createdBy
integer <uint64>
id
integer <uint64>
name
string

Name of the category

description
string

Description of the category

updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete category

This will delete a category by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
categoryId
required
integer

Category Id to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Comment

Add comment

This will add a comment to a receipt, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Comment to create

comment
required
string

Comment itself

receiptId
required
integer

Receipt foreign key

userId
integer

User foreign key

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "receiptId": 0,
  • "userId": 0
}

Response samples

Content type
application/json
{
  • "additionalInfo": "string",
  • "comment": "string",
  • "commentId": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "receiptId": 0,
  • "updatedAt": "string",
  • "userId": 0
}

Delete comment

This will delete a comment by id [SYSTEM User]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
commentId
required
integer

Comment Id to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

CustomField

Create custom field

This will create a custom field

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Custom field to create

name
required
string

Custom Field name

type
required
string (CustomFieldType)
Enum: "TEXT" "DATE" "SELECT" "CURRENCY" "BOOLEAN"
description
string

Custom Field description

Array of objects (UpsertCustomFieldOptionCommand)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "TEXT",
  • "description": "string",
  • "options": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "type": "TEXT",
  • "description": "string",
  • "options": [
    ]
}

Get custom field

This will get a custom field by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
customFieldId
required
integer

Custom field Id to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "type": "TEXT",
  • "description": "string",
  • "options": [
    ]
}

Delete custom field

This will delete a custom field by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
customFieldId
required
integer

Custom field Id to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get paged custom fields

This will return paged custom fields

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Export

Exports receipts

This will export all receipts that belong to a group based on a filter [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Get all receipts that belong to groupId

query Parameters
format
required
string (ExportFormat)
Value: "CSV"
Request Body schema: application/json
required
page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""
object (ReceiptPagedRequestFilter)
fullReceipts
boolean

Whether to include all receipt associations (receiptItems, comments, customFields, imageFiles, etc.)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc",
  • "filter": {
    },
  • "fullReceipts": true
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Exports receipts

This will export individual receipts [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
query Parameters
format
required
string (ExportFormat)
Value: "CSV"
receiptIds
Array of integers

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

FeatureConfig

Get feature config

This will get the server's feature config

Responses

Response samples

Content type
application/json
{
  • "aiPoweredReceipts": true,
  • "enableLocalSignUp": true
}

Groups

Get groups for user

This will get groups for the currently logged in user

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create group

This will create a group

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Group to create

required
Array of objects (UpsertGroupMemberCommand)

Members of the group

isDefault
boolean

Is default group (not used yet)

name
required
string

Name of the group

isAllGroup
boolean

Is all group for user

status
required
string (GroupStatus)
Enum: "ACTIVE" "ARCHIVED"

Responses

Request samples

Content type
application/json
{
  • "groupMembers": [
    ],
  • "isDefault": true,
  • "name": "string",
  • "isAllGroup": true,
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Poll group email

This will poll the group email for new receipts and add them to the group

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to poll

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Gets a group by Id

This will get a group by Id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Update a group

This will update a group

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to get

Request Body schema: application/json
required

Group to update

createdAt
string
createdBy
integer <uint64>
object (GroupSettings)
required
object (GroupReceiptSettings)
required
Array of objects (GroupMember)

Members of the group

id
required
integer <uint64>
isDefault
boolean

Is default group (not used yet)

name
required
string

Name of the group

isAllGroup
required
boolean

Is all group for user

status
required
string (GroupStatus)
Enum: "ACTIVE" "ARCHIVED"
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "groupSettings": {
    },
  • "groupReceiptSettings": {
    },
  • "groupMembers": [
    ],
  • "id": 0,
  • "isDefault": true,
  • "name": "string",
  • "isAllGroup": true,
  • "status": "ACTIVE",
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete group

This will delete a group by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Update group settings

This will update the group settings for a group

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to update

Request Body schema: application/json
required

Group settings to update

systemEmailId
required
integer

System email foreign key

emailIntegrationEnabled
boolean

Whether email integration is enabled

emailBodyProcessingEnabled
boolean

Whether email body text processing is enabled (opt-in, default false)

required
Array of objects (SubjectLineRegex)

Subject line regexes

required
Array of objects (GroupSettingsWhiteListEmail)

Email white list

emailDefaultReceiptStatus
string (ReceiptStatus)
Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""

Default receipt status

emailDefaultReceiptPaidById
integer

User foreign key

promptId
integer

Prompt foreign key

fallbackPromptId
integer

Fallback prompt foreign key

Responses

Request samples

Content type
application/json
{
  • "systemEmailId": 0,
  • "emailIntegrationEnabled": true,
  • "emailBodyProcessingEnabled": true,
  • "subjectLineRegexes": [
    ],
  • "emailWhiteList": [
    ],
  • "emailDefaultReceiptStatus": "OPEN",
  • "emailDefaultReceiptPaidById": 0,
  • "promptId": 0,
  • "fallbackPromptId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "groupId": 0,
  • "emailIntegrationEnabled": true,
  • "emailBodyProcessingEnabled": true,
  • "systemEmailId": 0,
  • "systemEmail": {
    },
  • "emailToRead": "string",
  • "subjectLineRegexes": [
    ],
  • "emailWhiteList": [
    ],
  • "emailDefaultReceiptStatus": "OPEN",
  • "emailDefaultReceiptPaidById": 0,
  • "prompt": {
    },
  • "promptId": 0,
  • "fallbackPrompt": {
    },
  • "fallbackPromptId": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "updatedAt": "string"
}

Update group receipt settings

This will update the group receipt settings for a group

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Group Id to update

Request Body schema: application/json
required

Group settings to update

hideImages
boolean

Hide receipt images

hideReceiptCategories
boolean

Hide receipt categories

hideReceiptTags
boolean

Hide receipt tags

hideItemCategories
boolean

Hide receipt item categories

hideItemTags
boolean

Hide receipt item tags

hideComments
boolean

Hide receipt comments

hideShareCategories
boolean

Hide share categories

hideShareTags
boolean

Hide share tags

quickScanPaidByEnabled
boolean

Show the paid by field in quick scan

quickScanPaidByRequired
boolean

Require the paid by field in quick scan

quickScanDefaultPaidByType
string (QuickScanDefaultPaidByType)
Enum: "UPLOADER" "USER" ""

How the default paid-by is resolved for optional quick-scan paid-by

quickScanDefaultPaidById
integer or null

Default paid by user id when paid by is optional and type is USER

quickScanStatusEnabled
boolean

Show the status field in quick scan

quickScanStatusRequired
boolean

Require the status field in quick scan

quickScanDefaultStatus
string (ReceiptStatus)
Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""

Status of a receipt

quickScanCategoriesEnabled
boolean

Show the categories field in quick scan

quickScanCategoriesRequired
boolean

Require the categories field in quick scan

quickScanTagsEnabled
boolean

Show the tags field in quick scan

quickScanTagsRequired
boolean

Require the tags field in quick scan

Responses

Request samples

Content type
application/json
{
  • "hideImages": true,
  • "hideReceiptCategories": true,
  • "hideReceiptTags": true,
  • "hideItemCategories": true,
  • "hideItemTags": true,
  • "hideComments": true,
  • "hideShareCategories": true,
  • "hideShareTags": true,
  • "quickScanPaidByEnabled": true,
  • "quickScanPaidByRequired": true,
  • "quickScanDefaultPaidByType": "UPLOADER",
  • "quickScanDefaultPaidById": 0,
  • "quickScanStatusEnabled": true,
  • "quickScanStatusRequired": true,
  • "quickScanDefaultStatus": "OPEN",
  • "quickScanCategoriesEnabled": true,
  • "quickScanCategoriesRequired": true,
  • "quickScanTagsEnabled": true,
  • "quickScanTagsRequired": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "groupId": 0,
  • "hideImages": true,
  • "hideReceiptCategories": true,
  • "hideReceiptTags": true,
  • "hideItemCategories": true,
  • "hideItemTags": true,
  • "hideComments": true,
  • "hideShareCategories": true,
  • "hideShareTags": true,
  • "quickScanPaidByEnabled": true,
  • "quickScanPaidByRequired": true,
  • "quickScanDefaultPaidByType": "UPLOADER",
  • "quickScanDefaultPaidById": 0,
  • "quickScanStatusEnabled": true,
  • "quickScanStatusRequired": true,
  • "quickScanDefaultStatus": "OPEN",
  • "quickScanCategoriesEnabled": true,
  • "quickScanCategoriesRequired": true,
  • "quickScanTagsEnabled": true,
  • "quickScanTagsRequired": true
}

Get paged groups

This will return paged groups

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""
object (GroupFilter)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc",
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Auth

Login

This will log a user into the system

query Parameters
tokensInBody
boolean
Default: false

When true, tokens are returned in the response body only without setting cookies

Request Body schema: application/json
required

Login data

username
required
string

User's username

password
required
string

User's password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "about": {
    },
  • "claims": {
    },
  • "groups": [
    ],
  • "users": [
    ],
  • "userPreferences": {
    },
  • "featureConfig": {
    },
  • "categories": [
    ],
  • "tags": [
    ],
  • "jwt": "string",
  • "refreshToken": "string",
  • "currencyDisplay": "string",
  • "currencyThousandthsSeparator": ",",
  • "currencyDecimalSeparator": ",",
  • "currencySymbolPosition": "START",
  • "currencyHideDecimalPlaces": true,
  • "icons": [
    ],
  • "appPermissions": [
    ],
  • "groupPermissions": {
    },
  • "groupCategories": {
    },
  • "groupTags": {
    }
}

Logout

This will log a user out of the system and revoke their token [SYSTEM USER]

Request Body schema: application/json
optional

Refresh token

refreshToken
required
string

Refresh token

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Signs up

This will sign a user up for the system

Request Body schema: application/json
required

Sign up data

username
required
string

User's username

password
required
string

User's password

displayName
string

User's displayname

isDummyUser
boolean

Whether the user is a dummy user

appRoleId
integer or null <uint64>

Id of the modern app role to assign. Honored by admin user creation; ignored on public sign-up, where any caller-supplied value is stripped server-side.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "displayName": "string",
  • "isDummyUser": true,
  • "appRoleId": 0
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get fresh tokens

This will get a fresh token pair for the user

Request Body schema: application/json
optional

Refresh token body for clients that don't use cookies

refreshToken
required
string

Refresh token

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
Example
{
  • "jwt": "string",
  • "refreshToken": "string"
}

Notifications

Get all user notifications

This will get all the notifications for the currently logged in user

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete all notifications for user

This deletes all notifications for a user

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete notification by id

This deletes a notification by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
notificationId
required
integer

Notification Id to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Notification count

This will get the notification count for the currently logged in user

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
0
0

Receipt

Create receipt

This will create a receipt [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Receipt to create

name
required
string

Receipt name

amount
required
string

Receipt total amount

date
required
string

Receipt date

groupId
required
integer

Group foreign key

paidByUserId
required
integer

User paid foreign key

status
required
string (ReceiptStatus)
Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""

Status of a receipt

Array of objects (UpsertCategoryCommand)

Categories associated to receipt

Array of objects (UpsertTagCommand)

Tags associated to receipt

Array of objects (UpsertItemCommand)

Items associated to receipt

Array of objects (UpsertCommentCommand)

Comments associated to receipt

Array of objects (UpsertCustomFieldValueCommand)

Custom fields associated to receipt

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "amount": "string",
  • "date": "string",
  • "groupId": 0,
  • "paidByUserId": 0,
  • "status": "OPEN",
  • "categories": [
    ],
  • "tags": [
    ],
  • "receiptItems": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "categories": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ],
  • "createdAt": "string",
  • "createdBy": 0,
  • "date": "string",
  • "groupId": 0,
  • "id": 0,
  • "imageFiles": [
    ],
  • "name": "string",
  • "paidByUserId": 0,
  • "receiptItems": [
    ],
  • "resolvedDate": "string",
  • "status": "OPEN",
  • "tags": [
    ],
  • "updatedAt": "string",
  • "createdByString": "string"
}

Quick scan a receipt

This take an image and use magic fill to fill and save the receipt [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: multipart/form-data
required

Quick scan data

files
required
Array of strings <binary> [ items <binary > ]
groupIds
required
Array of integers
paidByUserIds
required
Array of integers
statuses
required
Array of strings (ReceiptStatus)
Items Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""
categoryIds
Array of strings
tagIds
Array of strings

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Has access to receipt

This will return whether or not the currently logged in user has access to the receipt

Authorizations:
bearerAuthapiKeyAuth
query Parameters
receiptId
required
integer
permission
required
string (Permission)
Enum: "app.users.create" "app.users.read" "app.users.update" "app.users.delete" "app.prompts.create" "app.prompts.read" "app.prompts.update" "app.prompts.delete" "app.categories.create" "app.categories.read" "app.categories.update" "app.categories.delete" "app.tags.create" "app.tags.read" "app.tags.update" "app.tags.delete" "app.custom-fields.create" "app.custom-fields.read" "app.custom-fields.delete" "app.system-settings.read" "app.system-settings.update" "app.system-settings.restart-task-server" "app.receipt-processing-settings.create" "app.receipt-processing-settings.read" "app.receipt-processing-settings.update" "app.receipt-processing-settings.delete" "app.system-emails.create" "app.system-emails.read" "app.system-emails.update" "app.system-emails.delete" "app.system-tasks.read" "app.imports.run" "app.groups.create" "app.groups.read" "app.groups.update-settings" "app.api-keys.create" "app.api-keys.read" "app.api-keys.read-any" "app.api-keys.update" "app.api-keys.delete" "app.api-keys.delete-any" "app.roles.create" "app.roles.read" "app.roles.update" "app.roles.delete" "app.notifications.read" "app.notifications.delete" "app.user-preferences.read" "app.user-preferences.update" "app.account.read" "app.account.update" "app.account.delete" "app.receipts.search" "app.reports.create" "app.reports.delete" "app.reports.duplicate" "app.reports.generate" "app.reports.read" "app.reports.update" "app.reports.readAll" "app.reports.createAll" "app.reports.updateAll" "app.reports.deleteAll" "app.reports.duplicateAll" "app.reports.generateAll" "group.view" "group.update" "group.delete" "group.receipts.create" "group.receipts.read" "group.receipts.update" "group.receipts.delete" "group.receipts.duplicate" "group.receipts.magic-fill" "group.receipts.quick-scan" "group.comments.create" "group.comments.delete" "group.dashboards.create" "group.dashboards.read" "group.dashboards.update" "group.dashboards.delete" "group.widgets.read" "group.reports.read" "group.activities.read" "group.activities.rerun" "group.email.poll"

Group permission required to access the receipt

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get receipt

This will get a receipt by receipt id [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptId
required
integer

Id of receipt to get

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "categories": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ],
  • "createdAt": "string",
  • "createdBy": 0,
  • "date": "string",
  • "groupId": 0,
  • "id": 0,
  • "imageFiles": [
    ],
  • "name": "string",
  • "paidByUserId": 0,
  • "receiptItems": [
    ],
  • "resolvedDate": "string",
  • "status": "OPEN",
  • "tags": [
    ],
  • "updatedAt": "string",
  • "createdByString": "string"
}

Update receipt

This will update a receipt by receipt id [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptId
required
integer

Id of receipt to get

Request Body schema: application/json
required

Receipt to update

name
required
string

Receipt name

amount
required
string

Receipt total amount

date
required
string

Receipt date

groupId
required
integer

Group foreign key

paidByUserId
required
integer

User paid foreign key

status
required
string (ReceiptStatus)
Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""

Status of a receipt

Array of objects (UpsertCategoryCommand)

Categories associated to receipt

Array of objects (UpsertTagCommand)

Tags associated to receipt

Array of objects (UpsertItemCommand)

Items associated to receipt

Array of objects (UpsertCommentCommand)

Comments associated to receipt

Array of objects (UpsertCustomFieldValueCommand)

Custom fields associated to receipt

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "amount": "string",
  • "date": "string",
  • "groupId": 0,
  • "paidByUserId": 0,
  • "status": "OPEN",
  • "categories": [
    ],
  • "tags": [
    ],
  • "receiptItems": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ]
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "categories": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ],
  • "createdAt": "string",
  • "createdBy": 0,
  • "date": "string",
  • "groupId": 0,
  • "id": 0,
  • "imageFiles": [
    ],
  • "name": "string",
  • "paidByUserId": 0,
  • "receiptItems": [
    ],
  • "resolvedDate": "string",
  • "status": "OPEN",
  • "tags": [
    ],
  • "updatedAt": "string",
  • "createdByString": "string"
}

Delete receipt

This will delete a receipt by id [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptId
required
integer

Id of receipt to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Duplicate receipt

This will duplicate a receipt [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptId
required
integer

Id of receipt to duplicate

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Bulk receipt status update

This will bulk update receipt statuses with the option of adding a comment to each [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Bulk status data

comment
string

Optional comment to leave on each receipt

status
required
string

Status to update to

receiptIds
required
Array of integers

Receipt ids to update

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "status": "string",
  • "receiptIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets receipts

This will return receipts with the option to sort and filter [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
groupId
required
integer

Get all receipts that belong to groupId

Request Body schema: application/json
required
page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""
object (ReceiptPagedRequestFilter)
fullReceipts
boolean

Whether to include all receipt associations (receiptItems, comments, customFields, imageFiles, etc.)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc",
  • "filter": {
    },
  • "fullReceipts": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

ReceiptImage

Uploads a receipt image

This will upload a receipt image, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: multipart/form-data
required

Receipt image to upload

file
required
string <binary>
receiptId
required
integer

Receipt foreign key

encodedImage
string

Base64 encoded image for file types that aren't viewable natively in the browser, such as PDFs

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "encodedImage": "string",
  • "name": "string"
}

Converts a receipt image to jpg

This will convert a receipt image to jpg, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: multipart/form-data
required

Receipt image to convert

file
required
string <binary>

Base64 encoded image

Responses

Response samples

Content type
application/json
{
  • "encodedImage": "string"
}

Reads a receipt image and returns the parsed results

This will parse and read a receipt image, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
query Parameters
receiptImageId
integer

Id of receipt image to perform magic fill on

Request Body schema: multipart/form-data
optional
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "amount": "string",
  • "categories": [
    ],
  • "comments": [
    ],
  • "customFields": [
    ],
  • "createdAt": "string",
  • "createdBy": 0,
  • "date": "string",
  • "groupId": 0,
  • "id": 0,
  • "imageFiles": [
    ],
  • "name": "string",
  • "paidByUserId": 0,
  • "receiptItems": [
    ],
  • "resolvedDate": "string",
  • "status": "OPEN",
  • "tags": [
    ],
  • "updatedAt": "string",
  • "createdByString": "string"
}

Get receipt image

This will get a receipt image by id, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptImageId
required
integer

Id of receipt image to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "encodedImage": "string",
  • "name": "string"
}

Delete receipt image

This will delete a receipt image by id [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptImageId
required
integer

Id of receipt image to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Download receipt image

This will download a receipt image by id, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
receiptImageId
required
integer

Id of receipt image to download

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Search

Receipt Search

This will search for receipts based on a search term

Authorizations:
bearerAuthapiKeyAuth
query Parameters
searchTerm
required
string

search term

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tag

Get paged tags

This will return paged tags

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Get tag count by name

This will count of names with the same name

Authorizations:
bearerAuthapiKeyAuth
path Parameters
tagName
required
string

Tag name to get count of

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Update tag

This will update a tag

Authorizations:
bearerAuthapiKeyAuth
path Parameters
tagId
required
integer

Id of tag to get

Request Body schema: application/json
required

Tag to update

id
integer

Tag id

name
required
string

Tag name

description
string

Tag description

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "updatedAt": "string"
}

Delete tag

This will delete a tag by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
tagId
required
integer

Id of tag to get

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get all tags

This will return all tags in the system

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create tag

This will create a tag

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Tag to create

id
integer

Tag id

name
required
string

Tag name

description
string

Tag description

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "createdBy": 0,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "updatedAt": "string"
}

User

Get users

This will get all the users in the system and return a view without sensative information

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user

This will to create a user, [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

User to create

password
string

User's password

username
required
string

User's username used to login

createdAt
string
createdBy
integer <uint64>
defaultAvatarColor
string

Default avatar color

displayName
required
string

Display name

id
required
integer
isDummyUser
required
boolean

Is dummy user

updatedAt
string
appRoleId
integer or null <uint64>

Id of the modern app role assigned to the user

lastLoginDate
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string",
  • "createdAt": "string",
  • "createdBy": 0,
  • "defaultAvatarColor": "string",
  • "displayName": "string",
  • "id": 0,
  • "isDummyUser": true,
  • "updatedAt": "string",
  • "appRoleId": 0,
  • "lastLoginDate": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Update user by id

This will update a user by id, [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
userId
required
integer

Id of user to update

Request Body schema: application/json
required

User to update

password
string

User's password

username
required
string

User's username used to login

createdAt
string
createdBy
integer <uint64>
defaultAvatarColor
string

Default avatar color

displayName
required
string

Display name

id
required
integer
isDummyUser
required
boolean

Is dummy user

updatedAt
string
appRoleId
integer or null <uint64>

Id of the modern app role assigned to the user

lastLoginDate
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string",
  • "createdAt": "string",
  • "createdBy": 0,
  • "defaultAvatarColor": "string",
  • "displayName": "string",
  • "id": 0,
  • "isDummyUser": true,
  • "updatedAt": "string",
  • "appRoleId": 0,
  • "lastLoginDate": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete user

This will delete a system user by id [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
userId
required
integer

Id of user to update

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Converts dummy user

This will convert a dummy user to a normal system user, [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
userId
required
integer

Id of user to convert to normal system user

Request Body schema: application/json
required

Login credentials for new user

password
required
string

User's new password

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Reset password

This will reset a password for a user, [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
path Parameters
userId
required
integer

Id of user to reset password

Request Body schema: application/json
required

Login credentials for new user

password
required
string

User's new password

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get username count

This will return the number of users in the system with the same username

Authorizations:
bearerAuthapiKeyAuth
path Parameters
username
required
string

Username to get the count of

Responses

Response samples

Content type
application/json
0
0

Get amount owed for user

This will return the amount owed for the logged in user, in the specified group, [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
query Parameters
groupId
integer

The Id of the group to get amount owed for

receiptIds
Array of integers

The Id of the receipts to get amount owed for

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get claims for logged in user

This will return the user's token claims for the currently logged in user [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "displayName": "",
  • "defaultAvatarColor": "",
  • "username": "",
  • "iss": "",
  • "sub": "",
  • "aud": [ ],
  • "exp": 0,
  • "nbf": 0,
  • "iat": 0,
  • "jti": ""
}

Update user profile

This will update the logged in user's user profile

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

User profile to update

displayName
required
string

User's displayName

defaultAvatarColor
required
string

Color of default avatar

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "defaultAvatarColor": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete own account

This will delete the currently logged in user's account after verifying their password

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Password confirmation for account deletion

password
required
string

User's current password for confirmation

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Get app data

This will return the user's app data for the currently logged in user [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "about": {
    },
  • "claims": {
    },
  • "groups": [
    ],
  • "users": [
    ],
  • "userPreferences": {
    },
  • "featureConfig": {
    },
  • "categories": [
    ],
  • "tags": [
    ],
  • "jwt": "string",
  • "refreshToken": "string",
  • "currencyDisplay": "string",
  • "currencyThousandthsSeparator": ",",
  • "currencyDecimalSeparator": ",",
  • "currencySymbolPosition": "START",
  • "currencyHideDecimalPlaces": true,
  • "icons": [
    ],
  • "appPermissions": [
    ],
  • "groupPermissions": {
    },
  • "groupCategories": {
    },
  • "groupTags": {
    }
}

Bulk delete users

This will delete multiple users by their IDs [SYSTEM ADMIN]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

User IDs to delete

userIds
required
Array of strings

User IDs to delete

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

UserPreferences

Get user preferences

This will return the user's preferences for the currently logged in user [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "userId": 0,
  • "quickScanDefaultGroupId": 0,
  • "quickScanDefaultPaidById": 0,
  • "quickScanDefaultStatus": "OPEN",
  • "showLargeImagePreviews": null,
  • "userShortcuts": [
    ]
}

Update user preferences

This will update the user's preferences for the currently logged in user [SYSTEM USER]

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

User preferences to update

id
required
integer <uint64>

User preferences id

createdAt
required
string
createdBy
integer <uint64>
Default: 0
createdByString
string
Default: ""

Created by entity's name

updatedAt
string
Default: ""
userId
required
integer

User foreign key

quickScanDefaultGroupId
integer
Default: 0

Group foreign key

quickScanDefaultPaidById
integer
Default: 0

User foreign key

quickScanDefaultStatus
string (ReceiptStatus)
Default: "OPEN"
Enum: "OPEN" "NEEDS_ATTENTION" "RESOLVED" "DRAFT" ""

Default quick scan status

showLargeImagePreviews
boolean
Default: null

Whether to show large image previews

Array of objects (UserShortcut)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "userId": 0,
  • "quickScanDefaultGroupId": 0,
  • "quickScanDefaultPaidById": 0,
  • "quickScanDefaultStatus": "OPEN",
  • "showLargeImagePreviews": null,
  • "userShortcuts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "userId": 0,
  • "quickScanDefaultGroupId": 0,
  • "quickScanDefaultPaidById": 0,
  • "quickScanDefaultStatus": "OPEN",
  • "showLargeImagePreviews": null,
  • "userShortcuts": [
    ]
}

SystemEmail

Create system email

This will create a system email

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

System email to create

host
required
string

IMAP host

port
required
string

IMAP port

username
required
string

IMAP username

password
required
string

IMAP password

useStartTLS
boolean

Whether to use STARTTLS

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "port": "string",
  • "username": "string",
  • "password": "string",
  • "useStartTLS": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "host": "string",
  • "port": "string",
  • "username": "string",
  • "password": "string",
  • "useStartTLS": true
}

Check system email connectivity

This will check system email connectivity

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

System email to check connectivity

id
integer

System email id

host
string

IMAP host

port
integer

IMAP port

username
string

IMAP username

password
string

IMAP password

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "host": "string",
  • "port": 0,
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "type": "OCR_PROCESSING",
  • "status": "SUCCEEDED",
  • "startedAt": "string",
  • "endedAt": "string",
  • "associatedEntityId": 0,
  • "associatedEntityType": "NOOP_ENTITY_TYPE",
  • "ranByUserId": 0,
  • "receiptId": 0,
  • "groupId": 0,
  • "resultDescription": "string",
  • "apiKeyId": "string",
  • "childSystemTasks": [
    ]
}

Get system email by id

This will get a system email by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of system email to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "host": "string",
  • "port": "string",
  • "username": "string",
  • "password": "string",
  • "useStartTLS": true
}

Update system email by id

This will update a system email by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of system email to update

query Parameters
updatePassword
required
boolean

Whether or not to update the password

Request Body schema: application/json
required

System email to update

host
required
string

IMAP host

port
required
string

IMAP port

username
required
string

IMAP username

password
required
string

IMAP password

useStartTLS
boolean

Whether to use STARTTLS

Responses

Request samples

Content type
application/json
{
  • "host": "string",
  • "port": "string",
  • "username": "string",
  • "password": "string",
  • "useStartTLS": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "host": "string",
  • "port": "string",
  • "username": "string",
  • "password": "string",
  • "useStartTLS": true
}

Delete system email by id

This will delete a system email by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of system email to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Gets paged system emails

This will return paged and sorted system emails

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

SystemTask

Gets paged system tasks

This will return paged system tasks

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

associatedEntityId
integer

Associated entity id

associatedEntityType
string (AssociatedEntityType)
Enum: "NOOP_ENTITY_TYPE" "RECEIPT" "SYSTEM_EMAIL" "RECEIPT_PROCESSING_SETTINGS" "PROMPT" "API_KEY"
page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "associatedEntityId": 0,
  • "associatedEntityType": "NOOP_ENTITY_TYPE",
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Gets paged activities

This will return paged activities for a list of groups

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""
groupIds
Array of integers

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc",
  • "groupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Attempts to rerun activity

This will rerun a failed activity

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of activity to restart

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Prompt

Create prompt

This will create a prompt

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Prompt to create

name
required
string

Prompt name

description
string

Prompt description

prompt
required
string

Prompt text

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

Get prompt by id

This will get a prompt by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of prompt to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

Update prompt by id

This will update a prompt by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of prompt to update

Request Body schema: application/json
required

Prompt to update

name
required
string

Prompt name

description
string

Prompt description

prompt
required
string

Prompt text

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

Delete prompt by id

This will delete a prompt by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of prompt to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Gets paged prompts

This will return paged prompts

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Create default prompt

This will create a default prompt

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "prompt": "string"
}

ReceiptProcessingSettings

Get receipt processing settings by id

This will get receipt processing settings by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of receipt processing settings to get

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "isVisionModel": true,
  • "enforceJsonResponseFormat": true,
  • "ocrEngine": "TESSERACT",
  • "prompt": {
    },
  • "promptId": 0
}

Update receipt processing settings by id

This will update receipt processing settings by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of receipt processing settings to update

query Parameters
updateKey
required
boolean

Whether or not to update the key

Request Body schema: application/json
required

Receipt processing settings to update

name
required
string

Name of the settings

description
string

Description of the settings

aiType
required
string (AiType)
Enum: "OPEN_AI_CUSTOM" "OPEN_AI" "GEMINI" "OLLAMA"
url
string

URL for custom endpoints

key
string

Key for endpoints that require authentication

model
string

LLM model

isVisionModel
boolean

Is vision model

enforceJsonResponseFormat
boolean

Enforce JSON response format on the LLM provider. Disable if the provider does not support this flag.

ocrEngine
required
string (OcrEngine)
Enum: "TESSERACT" "EASY_OCR"
promptId
required
integer

Prompt foreign key

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "isVisionModel": true,
  • "enforceJsonResponseFormat": true,
  • "ocrEngine": "TESSERACT",
  • "promptId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "isVisionModel": true,
  • "enforceJsonResponseFormat": true,
  • "ocrEngine": "TESSERACT",
  • "prompt": {
    },
  • "promptId": 0
}

Delete receipt processing settings by id

This will delete receipt processing settings by id

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
integer

Id of receipt processing settings to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Create receipt processing settings

This will create receipt processing settings

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Receipt processing settings to create

name
required
string

Name of the settings

description
string

Description of the settings

aiType
required
string (AiType)
Enum: "OPEN_AI_CUSTOM" "OPEN_AI" "GEMINI" "OLLAMA"
url
string

URL for custom endpoints

key
string

Key for endpoints that require authentication

model
string

LLM model

isVisionModel
boolean

Is vision model

enforceJsonResponseFormat
boolean

Enforce JSON response format on the LLM provider. Disable if the provider does not support this flag.

ocrEngine
required
string (OcrEngine)
Enum: "TESSERACT" "EASY_OCR"
promptId
required
integer

Prompt foreign key

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "isVisionModel": true,
  • "enforceJsonResponseFormat": true,
  • "ocrEngine": "TESSERACT",
  • "promptId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "name": "string",
  • "description": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "isVisionModel": true,
  • "enforceJsonResponseFormat": true,
  • "ocrEngine": "TESSERACT",
  • "prompt": {
    },
  • "promptId": 0
}

Gets paged processing settings

This will return paged processing settings

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Check receipt processing settings connectivity

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Receipt processing settings to check connectivity

id
integer

Receipt processing settings id

name
string

Name of the settings

aiType
string (AiType)
Enum: "OPEN_AI_CUSTOM" "OPEN_AI" "GEMINI" "OLLAMA"
url
string

URL for custom endpoints

key
string

Key for endpoints that require authentication

model
string

LLM model

enforceJsonResponseFormat
boolean

Enforce JSON response format on the LLM provider. Disable if the provider does not support this flag.

numWorkers
integer

Number of workers to use

ocrEngine
string (OcrEngine)
Enum: "TESSERACT" "EASY_OCR"
promptId
integer

Prompt foreign key

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "aiType": "OPEN_AI_CUSTOM",
  • "url": "string",
  • "key": "string",
  • "model": "string",
  • "enforceJsonResponseFormat": true,
  • "numWorkers": 0,
  • "ocrEngine": "TESSERACT",
  • "promptId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "type": "OCR_PROCESSING",
  • "status": "SUCCEEDED",
  • "startedAt": "string",
  • "endedAt": "string",
  • "associatedEntityId": 0,
  • "associatedEntityType": "NOOP_ENTITY_TYPE",
  • "ranByUserId": 0,
  • "receiptId": 0,
  • "groupId": 0,
  • "resultDescription": "string",
  • "apiKeyId": "string",
  • "childSystemTasks": [
    ]
}

SystemSettings

Get system settings

This will get system settings

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "enableLocalSignUp": false,
  • "currencyDisplay": "$",
  • "currencyThousandthsSeparator": ",",
  • "currencyDecimalSeparator": ",",
  • "currencySymbolPosition": "START",
  • "currencyHideDecimalPlaces": false,
  • "debugOcr": false,
  • "numWorkers": 1,
  • "emailPollingInterval": 1800,
  • "receiptProcessingSettingsId": 0,
  • "fallbackReceiptProcessingSettingsId": 0,
  • "taskConcurrency": 10,
  • "pdfDpi": 300,
  • "taskQueueConfigurations": [
    ],
  • "mcpEnabled": false,
  • "mcpPublicUrl": "string"
}

Update system settings

This will update system settings

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

System settings to update

enableLocalSignUp
boolean

Whether local sign up is enabled

currencyDisplay
string

Currency display

currencyThousandthsSeparator
required
string (CurrencySeparator)
Enum: "," "."
currencyDecimalSeparator
required
string (CurrencySeparator)
Enum: "," "."
currencySymbolPosition
required
string (CurrencySymbolPosition)
Enum: "START" "END"
currencyHideDecimalPlaces
required
boolean

Whether to hide decimal places

debugOcr
boolean
numWorkers
integer
Default: 1

Number of workers to use

emailPollingInterval
integer

Email polling interval

receiptProcessingSettingsId
integer

Receipt processing settings foreign key

fallbackReceiptProcessingSettingsId
integer

Fallback receipt processing settings foreign key

taskConcurrency
required
integer

Concurrency for task worker

pdfDpi
integer [ 72 .. 1200 ]

DPI used when rasterizing PDFs for OCR/vision processing

Array of objects (UpsertTaskQueueConfiguration)
mcpEnabled
boolean

Whether the OAuth 2.1-protected MCP server is enabled

mcpPublicUrl
string

Externally reachable origin used for MCP OAuth/metadata/redirect URLs and token audience

Responses

Request samples

Content type
application/json
{
  • "enableLocalSignUp": true,
  • "currencyDisplay": "string",
  • "currencyThousandthsSeparator": ",",
  • "currencyDecimalSeparator": ",",
  • "currencySymbolPosition": "START",
  • "currencyHideDecimalPlaces": true,
  • "debugOcr": true,
  • "numWorkers": 1,
  • "emailPollingInterval": 0,
  • "receiptProcessingSettingsId": 0,
  • "fallbackReceiptProcessingSettingsId": 0,
  • "taskConcurrency": 0,
  • "pdfDpi": 72,
  • "taskQueueConfigurations": [
    ],
  • "mcpEnabled": true,
  • "mcpPublicUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "createdAt": "string",
  • "createdBy": 0,
  • "createdByString": "",
  • "updatedAt": "",
  • "enableLocalSignUp": false,
  • "currencyDisplay": "$",
  • "currencyThousandthsSeparator": ",",
  • "currencyDecimalSeparator": ",",
  • "currencySymbolPosition": "START",
  • "currencyHideDecimalPlaces": false,
  • "debugOcr": false,
  • "numWorkers": 1,
  • "emailPollingInterval": 1800,
  • "receiptProcessingSettingsId": 0,
  • "fallbackReceiptProcessingSettingsId": 0,
  • "taskConcurrency": 10,
  • "pdfDpi": 300,
  • "taskQueueConfigurations": [
    ],
  • "mcpEnabled": false,
  • "mcpPublicUrl": "string"
}

Restart task server

This will restart the task server

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Import

Import config json

This will import a config json

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: multipart/form-data
required

Config json to import

file
required
string <binary>

Files to quick scan

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

ApiKey

Create API key

Create a new API key for the authenticated user

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

API key details

name
required
string

API key name

description
string

API key description

scope
required
string (ApiKeyScope)
Enum: "r" "w" "rw"

Scope/permissions for API keys

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": "r"
}

Response samples

Content type
application/json
{
  • "key": "string"
}

Get paged API keys

This will return paged API keys for the authenticated user or all API keys for admins

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Paging and sorting data

page
required
integer

Page number

pageSize
required
integer

Number of records per page

orderBy
string

field to order on

sortDirection
string (SortDirection)
Enum: "asc" "desc" ""
object (ApiKeyFilter)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "orderBy": "string",
  • "sortDirection": "asc",
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Update API key

This will update an API key. Users can only update their own API keys.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
string

API key ID to update

Request Body schema: application/json
required

API key details to update

name
required
string

API key name

description
string

API key description

scope
required
string (ApiKeyScope)
Enum: "r" "w" "rw"

Scope/permissions for API keys

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": "r"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Delete API key

Delete an API key. Admins can delete any API key, non-admins can only delete their own API keys.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
id
required
string

API key ID to update

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Permission

List all permission descriptors

Returns the full catalog of permission strings the API recognizes, with metadata for UI rendering.

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Role

List all roles

Returns the full pool of roles, both app-scoped and group-scoped.

Authorizations:
bearerAuthapiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create role

This will create an app-scoped or group-scoped role.

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required

Role to create

name
required
string
description
string
scope
required
string (PermissionScope)
Enum: "APP" "GROUP"

Whether a permission applies app-wide or within a single group.

permissions
required
Array of strings (Permission)
Items Enum: "app.users.create" "app.users.read" "app.users.update" "app.users.delete" "app.prompts.create" "app.prompts.read" "app.prompts.update" "app.prompts.delete" "app.categories.create" "app.categories.read" "app.categories.update" "app.categories.delete" "app.tags.create" "app.tags.read" "app.tags.update" "app.tags.delete" "app.custom-fields.create" "app.custom-fields.read" "app.custom-fields.delete" "app.system-settings.read" "app.system-settings.update" "app.system-settings.restart-task-server" "app.receipt-processing-settings.create" "app.receipt-processing-settings.read" "app.receipt-processing-settings.update" "app.receipt-processing-settings.delete" "app.system-emails.create" "app.system-emails.read" "app.system-emails.update" "app.system-emails.delete" "app.system-tasks.read" "app.imports.run" "app.groups.create" "app.groups.read" "app.groups.update-settings" "app.api-keys.create" "app.api-keys.read" "app.api-keys.read-any" "app.api-keys.update" "app.api-keys.delete" "app.api-keys.delete-any" "app.roles.create" "app.roles.read" "app.roles.update" "app.roles.delete" "app.notifications.read" "app.notifications.delete" "app.user-preferences.read" "app.user-preferences.update" "app.account.read" "app.account.update" "app.account.delete" "app.receipts.search" "app.reports.create" "app.reports.delete" "app.reports.duplicate" "app.reports.generate" "app.reports.read" "app.reports.update" "app.reports.readAll" "app.reports.createAll" "app.reports.updateAll" "app.reports.deleteAll" "app.reports.duplicateAll" "app.reports.generateAll" "group.view" "group.update" "group.delete" "group.receipts.create" "group.receipts.read" "group.receipts.update" "group.receipts.delete" "group.receipts.duplicate" "group.receipts.magic-fill" "group.receipts.quick-scan" "group.comments.create" "group.comments.delete" "group.dashboards.create" "group.dashboards.read" "group.dashboards.update" "group.dashboards.delete" "group.widgets.read" "group.reports.read" "group.activities.read" "group.activities.rerun" "group.email.poll"
categoryGrants
Array of integers <uint64> [ items <uint64 > ]

Category ids to restrict a GROUP role's members to. Only valid on group roles; omit or leave empty for unrestricted access.

tagGrants
Array of integers <uint64> [ items <uint64 > ]

Tag ids to restrict a GROUP role's members to. Only valid on group roles; omit or leave empty for unrestricted access.

paidByUserGrants
Array of integers <uint64> [ items <uint64 > ]

User ids whose receipts a GROUP role's members may see (by the receipt's "paid by" user). Only valid on group roles; omit or leave empty (with includeOwnPaidReceipts false) for unrestricted access.

includeOwnPaidReceipts
boolean

Whether to also let each member see receipts they paid for. Only valid on group roles.

Array of objects (ReportTemplateGrant)

Per-template action grants for a GROUP role, restricting which report templates its members may act on. Only valid on group roles; omit or leave empty for unrestricted access.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": "APP",
  • "permissions": [
    ],
  • "categoryGrants": [
    ],
  • "tagGrants": [
    ],
  • "paidByUserGrants": [
    ],
  • "includeOwnPaidReceipts": true,
  • "reportTemplateGrants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "scope": "APP",
  • "isDefault": true,
  • "isSystem": true,
  • "permissions": [
    ],
  • "assignedCount": 0,
  • "categoryGrants": [
    ],
  • "tagGrants": [
    ],
  • "paidByUserGrants": [
    ],
  • "includeOwnPaidReceipts": true,
  • "reportTemplateGrants": [
    ]
}

Update role

Updates an existing app-scoped or group-scoped role. A role's type cannot be changed: the scope in the request must match the existing role's scope. System roles cannot be modified.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
roleId
required
integer

Id of the role to update

Request Body schema: application/json
required

Role to update

name
required
string
description
string
scope
required
string (PermissionScope)
Enum: "APP" "GROUP"

Whether a permission applies app-wide or within a single group.

permissions
required
Array of strings (Permission)
Items Enum: "app.users.create" "app.users.read" "app.users.update" "app.users.delete" "app.prompts.create" "app.prompts.read" "app.prompts.update" "app.prompts.delete" "app.categories.create" "app.categories.read" "app.categories.update" "app.categories.delete" "app.tags.create" "app.tags.read" "app.tags.update" "app.tags.delete" "app.custom-fields.create" "app.custom-fields.read" "app.custom-fields.delete" "app.system-settings.read" "app.system-settings.update" "app.system-settings.restart-task-server" "app.receipt-processing-settings.create" "app.receipt-processing-settings.read" "app.receipt-processing-settings.update" "app.receipt-processing-settings.delete" "app.system-emails.create" "app.system-emails.read" "app.system-emails.update" "app.system-emails.delete" "app.system-tasks.read" "app.imports.run" "app.groups.create" "app.groups.read" "app.groups.update-settings" "app.api-keys.create" "app.api-keys.read" "app.api-keys.read-any" "app.api-keys.update" "app.api-keys.delete" "app.api-keys.delete-any" "app.roles.create" "app.roles.read" "app.roles.update" "app.roles.delete" "app.notifications.read" "app.notifications.delete" "app.user-preferences.read" "app.user-preferences.update" "app.account.read" "app.account.update" "app.account.delete" "app.receipts.search" "app.reports.create" "app.reports.delete" "app.reports.duplicate" "app.reports.generate" "app.reports.read" "app.reports.update" "app.reports.readAll" "app.reports.createAll" "app.reports.updateAll" "app.reports.deleteAll" "app.reports.duplicateAll" "app.reports.generateAll" "group.view" "group.update" "group.delete" "group.receipts.create" "group.receipts.read" "group.receipts.update" "group.receipts.delete" "group.receipts.duplicate" "group.receipts.magic-fill" "group.receipts.quick-scan" "group.comments.create" "group.comments.delete" "group.dashboards.create" "group.dashboards.read" "group.dashboards.update" "group.dashboards.delete" "group.widgets.read" "group.reports.read" "group.activities.read" "group.activities.rerun" "group.email.poll"
categoryGrants
Array of integers <uint64> [ items <uint64 > ]

Category ids to restrict a GROUP role's members to. Only valid on group roles; omit or leave empty for unrestricted access.

tagGrants
Array of integers <uint64> [ items <uint64 > ]

Tag ids to restrict a GROUP role's members to. Only valid on group roles; omit or leave empty for unrestricted access.

paidByUserGrants
Array of integers <uint64> [ items <uint64 > ]

User ids whose receipts a GROUP role's members may see (by the receipt's "paid by" user). Only valid on group roles; omit or leave empty (with includeOwnPaidReceipts false) for unrestricted access.

includeOwnPaidReceipts
boolean

Whether to also let each member see receipts they paid for. Only valid on group roles.

Array of objects (ReportTemplateGrant)

Per-template action grants for a GROUP role, restricting which report templates its members may act on. Only valid on group roles; omit or leave empty for unrestricted access.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": "APP",
  • "permissions": [
    ],
  • "categoryGrants": [
    ],
  • "tagGrants": [
    ],
  • "paidByUserGrants": [
    ],
  • "includeOwnPaidReceipts": true,
  • "reportTemplateGrants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "scope": "APP",
  • "isDefault": true,
  • "isSystem": true,
  • "permissions": [
    ],
  • "assignedCount": 0,
  • "categoryGrants": [
    ],
  • "tagGrants": [
    ],
  • "paidByUserGrants": [
    ],
  • "includeOwnPaidReceipts": true,
  • "reportTemplateGrants": [
    ]
}

Delete role

Deletes an app-scoped or group-scoped role. The scope query parameter disambiguates the role id, since app and group role ids overlap. A role cannot be deleted while it is assigned to any user or group member, and system roles cannot be deleted.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
roleId
required
integer

Id of the role to update

query Parameters
scope
required
string (PermissionScope)
Enum: "APP" "GROUP"

Scope of the role to delete

Responses

Response samples

Content type
application/json
{
  • "errorMsg": "string"
}

Set default role

Makes the role the default for its scope — the role assigned to new accounts (APP) or to group creators (GROUP) — clearing the previous default. The scope query parameter disambiguates the role id, since app and group role ids overlap. System roles may be made default.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
roleId
required
integer

Id of the role to make the default for its scope

query Parameters
scope
required
string (PermissionScope)
Enum: "APP" "GROUP"

Scope of the role to make default

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "scope": "APP",
  • "isDefault": true,
  • "isSystem": true,
  • "permissions": [
    ],
  • "assignedCount": 0,
  • "categoryGrants": [
    ],
  • "tagGrants": [
    ],
  • "paidByUserGrants": [
    ],
  • "includeOwnPaidReceipts": true,
  • "reportTemplateGrants": [
    ]
}