Update expense (fields format of expense record)

PUT

expenses

{expenseId}

?format=fields

curl --request PUT \
  --url 'https://stage-api.findity.com/api/v1/expense/expenses/{expenseId}?format=fields' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    {
      "name": "Id",
      "property": "id",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": false,
      "value": "99601cd0f6ba438cb16ca17b8edf25a0",
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": null,
      "property": "version",
      "controlType": "INTEGER",
      "mandatory": false,
      "visible": false,
      "value": 2,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Receipt",
      "property": "verification.receiptAttachment",
      "controlType": "CONTENT_HOLDER",
      "mandatory": false,
      "visible": true,
      "value": "receiptAttachmentId",
      "errorText": null,
      "error": null,
      "custom": false,
      "data": {
        "id": "receiptAttachmentId",
        "name": "name of receiptAttachment"
      }
    },
    {
      "name": "Category",
      "property": "categoryId",
      "controlType": "LIST",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/expensetypes/ReceiptVerification/categories"
    },
    {
      "name": "Expense report",
      "property": "expenseReportId",
      "controlType": "LIST",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "url": "/expensereports?statuses=NORMAL,NEW&organizationId=8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Verification number",
      "property": "verification.verificationNumber",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": true
    },
    {
      "name": "Description",
      "property": "verification.description",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Date of purchase",
      "property": "verification.purchaseDate",
      "controlType": "DATE",
      "mandatory": false,
      "visible": true,
      "value": "2019-09-30T14:33:26Z",
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "allowFutureDate": false
    },
    {
      "name": "Payment method",
      "property": "verification.paymentTypeId",
      "controlType": "LIST",
      "mandatory": true,
      "visible": true,
      "value": "f433bd56f038486faeee6a5ddd5177f2",
      "errorText": null,
      "error": null,
      "custom": false,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/paymenttypes",
      "data": {
        "iconUrl": null,
        "id": "f433bd56f038486faeee6a5ddd5177f2",
        "name": "Payment",
        "section": null
      }
    },
    {
      "name": "Store",
      "property": "verification.storeName",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Amount incl. VAT",
      "property": "verification.amount",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "scannable": true
    },
    {
      "name": "Tip",
      "property": "verification.tip",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "VAT",
      "property": "verification.taxAmount",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "scannable": true
    },
    {
      "name": "Currency",
      "property": "verification.currency",
      "controlType": "LIST",
      "mandatory": true,
      "visible": true,
      "value": "SEK",
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/currencies",
      "data": {
        "iconUrl": null,
        "id": "SEK",
        "name": "Swedish Krona",
        "section": null
      }
    },
    {
      "name": "Exchange rate",
      "property": "verification.exchangeRate",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": false,
      "value": 1,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Expense Level (not-changable)",
      "property": "8ab28c4f70f773590170f7cda2ea08bc",
      "controlType": "LIST",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/lists/CUSTOM_DIMENSIONS_4f38a4cc3fe242d394058626523044c1_8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Employee dim",
      "property": "8ab28c4f723887dd01723c5cae82020e",
      "controlType": "LIST",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/lists/CUSTOM_DIMENSIONS_d4c8684b75ff4026b69810c8d912aea4_8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Entertainment",
      "property": "verification.representation",
      "controlType": "FIELD_GROUP",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "fields": [
        {
          "name": "Type",
          "property": "verification.representation.type",
          "controlType": "LIST",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false,
          "requiresUpdate": true
        },
        {
          "name": "Included liquor/wine/strong beer",
          "property": "verification.representation.includesLiquor",
          "controlType": "SWITCH",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Attach guest list",
          "property": "verification.representation.guestListAttached",
          "controlType": "SWITCH",
          "mandatory": false,
          "visible": false,
          "value": false,
          "errorText": null,
          "error": null,
          "custom": false,
          "requiresUpdate": true
        },
        {
          "name": "Guests",
          "property": "verification.representation.guests",
          "controlType": "GUEST_LIST",
          "mandatory": false,
          "visible": false,
          "value": [],
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Number of guests",
          "property": "verification.representation.numberOfGuests",
          "controlType": "INTEGER",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Number of external guests",
          "property": "verification.representation.numberOfExternalGuests",
          "controlType": "INTEGER",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Place",
          "property": "verification.representation.place",
          "controlType": "TEXT",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Attached guest list",
          "property": "verification.representation.guestListAttachment",
          "controlType": "CONTENT_HOLDER",
          "mandatory": true,
          "visible": false,
          "value": "guestListAttachmentId",
          "errorText": null,
          "error": null,
          "custom": false,
          "data": {
            "id": "guestListAttachmentId",
            "name": "name of guestListAttachment"
          }
        }
      ],
      "commands": [
        {
          "text": "Clear guests",
          "confirmationRequired": true,
          "confirmation": "Are you sure you want to clear guests?",
          "command": "action=removeGuests"
        },
        {
          "text": "Clear representation",
          "confirmationRequired": true,
          "confirmation": "Are you sure you want to clear representation?",
          "command": "action=removeRepresentation"
        }
      ]
    },
    {
      "name": "Comment",
      "property": "verification.comment",
      "controlType": "MULTI_LINE_TEXT",
      "mandatory": false,
      "visible": true,
      "value": "Some comment",
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Card transaction",
      "property": "verification.cardTransaction",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": "Some id",
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": true
    },
    {
      "name": "Attachments",
      "property": "verification.attachments",
      "controlType": "CONTENT_HOLDER",
      "mandatory": false,
      "visible": true,
      "value": [
        "id1",
        "id2"
      ],
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": false,
      "data": [
        {
          "id": "id1",
          "name": "name of attachment with id1"
        },
        {
          "id": "id2",
          "name": "name of attachment with id2"
        }
      ]
    }
  ]
}
'

{
  "organizationId": "ff808181963de13701963de1789d00ad",
  "version": 2,
  "lastUpdated": "2025-04-16T09:15:09Z",
  "dateCreated": "2025-04-16T09:15:09Z",
  "processStatus": "DRAFT",
  "status": "NORMAL",
  "expenseDate": "2023-03-21T10:58:14Z",
  "personId": "ff808181963de13701963de177e00083",
  "id": "5ca0dfa6def943eab46d240d3680c323",
  "reimbursementCurrency": "SEK",
  "categoryId": "9ed4618ae74e4f17b69005f699c104f3",
  "verification": {
    "amount": 230,
    "purchaseDate": "2023-03-21T10:58:14Z",
    "attachments": [
      {
        "name": "attachments2",
        "isTemporary": false,
        "id": "ff808181963e296501963e29ac6d00be",
        "contentType": "image/jpeg"
      },
      {
        "name": "attachments1",
        "isTemporary": false,
        "id": "ff808181963e296501963e29ac5e00bc",
        "contentType": "image/jpeg"
      }
    ],
    "customFields": [
      {
        "fieldDefinitionId": "2b965c866b634698811dabf45a491089",
        "value": true
      },
      {
        "fieldDefinitionId": "5a3f0c9e904d3a1e3aa90b034c79e0f4",
        "value": "string"
      },
      {
        "fieldDefinitionId": "904d3e1a3aa90b034c79e0f45a491089",
        "value": 10
      }
    ],
    "description": "verification-description",
    "type": "ReceiptVerification",
    "lastUpdated": "2025-04-16T09:15:09Z",
    "dateCreated": "2025-04-16T09:15:09Z",
    "paymentTypeId": "ed0d98d4e3834714bbca45f889d4584b",
    "exchangeRate": 1,
    "verificationNumber": "verification-number",
    "comment": "verification-comment",
    "currency": "SEK",
    "taxAmount": 23,
    "receiptAttachment": {
      "name": "file-name607803656",
      "personId": "ff808181963de13701963de177e00083",
      "isTemporary": false,
      "id": "ff808181963de13701963de179b900b9",
      "contentType": "image/png"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

expenseId

string

required

The id of the expense to retrieve UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Query Parameters

format

string

required

Info about the structure passed in the body of request Parameter should be set to 'fields' value

forceSave

boolean

When true, saves the report even if non-blocking validation warnings exist; validation errors still abort. Defaults to false.

organizationId

string

The id of the organization UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

expenseType

enum<string>

The expense type of the expense

Available options:

CarSpecification,

FoodBenefitsSpecification,

ReceiptVerification,

SubsistenceAllowance

Body

application/json

Fields format of expense record

fields

object[]

Field-builder array describing the editable properties of the resource. Each entry pairs a property name with a value and any errors.

Hide child attributes

fields.name

string | null

A translated name of the field, can be used to present to to the user

fields.hint

string

A translated input hint (placeholder) for the field, for example "Enter first name" or "Select currency". Clients can show it in the empty input. Absent when the field has no hint, which is always the case for custom fields.

fields.property

string

Identifier of the field. Contains the path to the property in the expense API, for example verification.amount, cardLiability. Expense record and expense report fields include a hidden (visible: false) version field (controlType INTEGER) holding the optimistic-lock version of the stored object (null for a new object). Send it back unchanged in the fields of the update request; if the object has been modified since it was read, the update is rejected with 409 CONCURRENT_MODIFICATION.

fields.controlType

enum<string>

Available options:

TEXT,

MULTI_LINE_TEXT,

DOUBLE,

INTEGER,

SWITCH,

DATE,

DATE_TIME,

LIST,

CONTENT_HOLDER,

GUEST_LIST,

FIELD_GROUP,

LOCAL_DATE_TIME,

INFORMATION,

COMMAND,

MILEAGE_ROUTE,

MULTI_VALUE

fields.mandatory

boolean

The field is required

fields.visible

boolean

Only fields with visible = true should be shown

fields.requiresUpdate

boolean

Tells the client that if this field is changed, the client must call the API again with the fields data

fields.url

string

If controlType is LIST this property contains an url to the selectable values for this field

fields.custom

boolean

Indicates if this is a custom field not part of the standard fields

fields.scannable

boolean

Indicates if this field is part of the data extracted by the receipt scanning

fields.qrCodeSupported

boolean

Set on the verification.receiptAttachment (CONTENT_HOLDER) field when the organization's booking country uses fiscal QR codes on receipts (currently Portugal). When true, clients should offer a QR-scan step in the receipt capture flow and, on success, send the decoded string as the qrScan header on POST /content. Absent when not applicable.

fields.value

any

The value of the field, this is dynamic based on the control type. For example if the control type is DOUBLE the value property must have a double type. For SubsistenceAllowance and property = verification.specification[x].date1 or date2, this value is set/delivered in format "yyyy-MM-dd HH:mm" where the date is at UTC date time

fields.data

object

When calling the fields-endpoint initially, this may contain a list object for fields with control type LIST. This way the client does not have to make a call to the list endpoint to fetch the value. This has the same structure as the result in the list. For a multiSelect field it is an array of such objects. Absent when there is no data.

Hide child attributes

fields.data.id

string

Represents the id of the value that is set in this Field

fields.data.name

string

Representable text for chosen list item for set id

fields.data.section

integer | null

fields.data.iconUrl

string | null

fields.allowFutureDate

boolean

If controlType is DATE or DATE_TIME or LOCAL_DATE_TIME, this property is set. Default value is false. If the value is false, then date picker shouldn't allow setting date to value higher than today's date.

fields.error

string | null

A string that represents the error. This property is not empty when there is some error related to the specific field.

fields.errorText

string | null

Human readable description of value returned in error property. This property is not empty when there is some error related to the specific field.

fields.disabled

boolean

Indicates if property should be enabled or disabled for editing. In Approval flow, this property is always set to "true".

fields.fields

array

This property is populated when controlType="FIELD_GROUP" and it has the same structure as this array of objects. The list of objects represents all fields that are related to the specific field group.

fields.deletable

boolean

This property is used for removable fields, for example on the FIELD_GROUP for a specification in allowance

fields.deleteCommand

object

This property is used to define the command available on the filed of controlType=FIELD_GROUP

Hide child attributes

fields.deleteCommand.text

string

This property contains the text for the command to be displayed

fields.deleteCommand.confirmationRequired

boolean

This property indicates if the client should display a dialog with confirmation as result of it

fields.deleteCommand.confirmation

string

This property contains the text that should be displayed in case that confirmationRequired=true and client decided to perform the command/action

fields.deleteCommand.command

string

This property contains the command that can be executed by performing the PUT request with it on the fields endpoint

fields.informationType

enum<string>

This property is set when controlType=INFORMATION and it should indicate which type of information the field is

Available options:

NORMAL,

INFORMATION,

WARNING,

ERROR,

SUCCESS

fields.dismissible

boolean

This property is set when controlType=INFORMATION to indicate if the information is dismissible or not

fields.multiSelect

boolean

This property is going in combination with controlType=LIST to indicate that multiple values can be selected from the list

fields.listItemType

string

This property is set when there is controlType=LIST & multiSelect=true to indicate which type of item is list made of

fields.accessorIconUrl

string

This property is set by the URL value for the icon which can indicate access to different provided commands. It is usually provided within the field of controlType=FIELD_GROUP

fields.accessorText

string

This property represents the text that can be set as replacement for all the fields behind the defined FIELD_GROUP. It can be used as display for accessor to the list of the fields provided in the FIELD_GORUP

fields.numberOfDecimals

integer

The maximum number of decimals this field can present, uses current currency. only set for fields with an amount in value.

fields.summary

object[]

Contains summarised information about the resource, as rows to display in order

Hide child attributes

fields.summary.type

enum<string>

Kind of row: property_value is a labelled value, separator divides groups of rows and has no property or value, and image shows the image referenced by value and has no property. Clients should tolerate other values.

Available options:

property_value,

separator,

image

fields.summary.property

string

Label of the row. Only present on property_value rows.

fields.summary.value

string

Display value of a property_value row, or the image reference of an image row. Omitted when there is no value.

fields.commands

object[] | null

This property contains the list of possible commands that can be performed on the specific field

Hide child attributes

fields.commands.text

string

This property contains the text for the command to be displayed

fields.commands.confirmationRequired

boolean

This property indicates if the client should display a dialog with confirmation as result of it

fields.commands.confirmation

string

This property contains the text that should be displayed in case that confirmationRequired=true and client decided to perform the command/action

fields.commands.command

string

This property contains the command that can be executed by performing the PUT request with it on the fields endpoint

fields.clientCommand

object | null

Action the client performs itself when the field is activated, such as opening an edit dialog or a web view. Present (possibly null) on fields with controlType COMMAND or FIELD_GROUP; absent on other fields.

Hide child attributes

fields.clientCommand.clientAction

string

The client-side action to perform, e.g. editEmail, editPhone, openChangePassword, openWebView.

Example:

"editEmail"

fields.clientCommand.entityId

string

Id of the entity the action applies to. Omitted when not applicable.

fields.clientCommand.organizationId

string

Organization the action applies to. Omitted when not applicable.

fields.clientCommand.url

string

URL to open, for actions such as openWebView. Omitted when not applicable.

fields.clientCommand.isWebView

boolean

true when url should be opened in an in-app web view. Only present when true.

validationErrors

object[]

Response-only. Server-populated array of validation errors that apply to the resource as a whole (not tied to a specific field).

Hide child attributes

validationErrors.errorMessage

string

description provided for errorCode

validationErrors.errorCode

string

textual code of error

validationErrors.checkType

enum<string>

BLOCKER indicates that expense instance cannot be sent unless the issue is corrected, ERROR indicates issue with storing/saving expense instances, WARNING indicates there is an issue with the expense instance but it allows to user to send the expense instance

Available options:

BLOCKER,

ERROR,

WARNING

validationErrors.property

string

The field (property of a field in fields) the error applies to. Omitted when the error is not tied to a field.

validationErrors.expenseRecordId

string

Id of the expense record the error applies to. Omitted when not applicable.

Response

ExpenseRecord format

string

read-only

status

enum<string>

read-only

Available options:

NEW,

NORMAL,

APPROVAL,

APPROVED,

REJECTED

processStatus

enum<string>

read-only

Simplified status of the expense record: DRAFT while it is editable, REJECTED when rejected in approval, PROCESSING while in approval or transfer, and PROCESSED once sent or paid. Omitted when it cannot be derived from status.

Available options:

DRAFT,

REJECTED,

PROCESSING,

PROCESSED

personId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

dateCreated

string

read-only

lastUpdated

string

read-only

version

integer<int64>

Optimistic-lock counter, incremented on every update. On PUT, echo back the value from the last GET/PUT response to detect if the expense was changed by someone else since it was read; a mismatch returns 409. Optional; omit to skip this check. For the actions without a request body (action=send, action=merge, action=connectToOrganization and DELETE), pass it as the version query parameter instead.

expenseDate

string

read-only

Date that the user has selected for the expense. For receipt expenses it is purchase date. For mileages it is travel date and for per diems it is the first travel date.

organizationId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

categoryId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

rejectComment

string

read-only

reimbursement

number

read-only

reimbursementCurrency

string

read-only

meta

object

read-only

Hide child attributes

meta.categoryIconUrl

string

Example:

"https://expense.findity.com/api/resources/8a5f867e9b204742a8cc2ca2b6c57358"

meta.person

object

Hide child attributes

meta.person.firstName

string

Example:

"Anna"

meta.person.lastName

string

Example:

"Andersson"

meta.person.email

string

Example:

"anna.andersson@example.com"

meta.abbreviation

object

Hide child attributes

meta.abbreviation.iconUrl

string

URL to icon

Example:

"https://expense.findity.com/api/resources/ff808181963e689301963e68ea0502c2"

meta.abbreviation.dateDescription

string

Date for expense supplied in a descriptive way

Example:

"31 January 2023"

meta.abbreviation.sortDescription

string

Date used for sorting expenses supplied in a descriptive way

Example:

"14 February 2023"

meta.abbreviation.userDescription

string

Users description of the expense

Example:

"pencils and erasers"

meta.abbreviation.expenseDescription

string

Formatted presentation of the expense category

Example:

"Receipt verification category name"

meta.abbreviation.reimbursementDescription

string

Reimbursement in preferred currency presented in a user friendly way

Example:

"SEK 80.50"

meta.abbreviation.totalReimbursementDescription

string

Total reimbursement in preferred currency presented in a user friendly way

Example:

"SEK 100.50"

meta.abbreviation.expenseType

string

Expense type of the record: ReceiptVerification, CarSpecification, SubsistenceAllowance, FoodBenefitsSpecification or FuelBenefitsSpecification, or UNKNOWN when the record has no verification yet (e.g. created from a card transaction). Clients should tolerate other values.

Example:

"ReceiptVerification"

meta.abbreviation.expenseTypeDescription

string

Expense Type presented in user friendly way. Omitted when expenseType is UNKNOWN.

Example:

"Receipt verification"

meta.abbreviation.originalAmountDescription

string

Original amount in original currency presented in user friendly way

Example:

"EUR 9.50"

meta.abbreviation.createdFromTransaction

boolean

Whether the record is linked to a card transaction.

Example:

false

meta.abbreviation.transactionMessage

string

Localized note about the linked card transaction, e.g. "Created from card transaction". Only present when createdFromTransaction is true.

Example:

"Created from card transaction"

meta.abbreviation.alert

boolean

used to indicate if attention is needed

Example:

true

meta.abbreviation.isComplete

boolean

indicates if entity is considered complete, can contain warnings.

Example:

true

meta.abbreviation.labels

object[]

List of labels for the expense

Hide child attributes

meta.abbreviation.labels.property

string

The property this label relates to

Example:

"label.autoApproval"

meta.abbreviation.labels.text

string

The label text to display

Example:

"Auto-approved"

meta.abbreviation.labels.priority

enum<string>

Priority level of the label

Available options:

NORMAL,

IMPORTANT,

CRITICAL

Example:

"NORMAL"

meta.abbreviation.labels.type

enum<string>

Type of label indicating its semantic meaning

Available options:

NORMAL,

SUCCESS,

INFORMATION,

WARNING,

ERROR

Example:

"SUCCESS"

meta.abbreviation.labels.iconUrl

string

Optional URL to an icon for the label

Example:

"https://expense.findity.com/api/resources/ic_ai_sparkles.svg"

meta.capabilities

object

Hide child attributes

meta.capabilities.canBeAddedToReport

boolean

Indicates if the expense record can be added to a report

Example:

false

meta.capabilities.canBeRemovedFromReport

boolean

Indicates if the expense record can be removed from a report

Example:

false

meta.capabilities.canBeDeleted

boolean

Indicates if the expense record can be deleted

Example:

true

meta.capabilities.canBeSentIn

boolean

true if the expense record can be sent in directly without report

Example:

true

meta.capabilities.canBeSplit

boolean

Indicates if the expense record can be split

Example:

false

meta.capabilities.canBeEdited

boolean

Indicates if the expense record can be edited

Example:

true

meta.capabilities.canBeMerged

boolean

Indicates if the expense record can be merged with another expense record. Will only be true for expense records that are based on card transaction, has not been split and is editable by end user.

Example:

false

meta.capabilities.canAddBreakfast

boolean

ONLY PART OF FoodBenefitsSpecifications! Indicates if breakfast is available for meal benefits.

Example:

false

meta.capabilities.canAddLunch

boolean

ONLY PART OF FoodBenefitsSpecifications! Indicates if lunch is available for meal benefits.

Example:

false

meta.capabilities.canAddDinner

boolean

ONLY PART OF FoodBenefitsSpecifications! Indicates if dinner is available for meal benefits.

Example:

false

meta.cardTransaction

object

Hide child attributes

meta.cardTransaction.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Example:

"4a17f93476ce4bf2832236be26743853"

meta.cardTransaction.amount

number<double>

Example:

120

meta.cardTransaction.name

string

Example:

"Bank name"

meta.cardTransaction.cardNumber

string

Example:

"xxxxxxxxxxxx1234"

verification

object

The expense-type-specific payload — receipt details, mileage details, per-diem details, or food-benefit details. Shape selected by the nested type discriminator.

Option 1
Option 2
Option 3
Option 4

Hide child attributes

verification.type

enum<string>

required

Verification type. Always ReceiptVerification for a receipt verification.

Available options:

ReceiptVerification

verification.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.reimbursement

number

verification.comment

string

verification.amount

number

verification.taxAmount

number

verification.tip

number<double>

The tip amount for the receipt, expressed as a non-negative decimal number in the receipt's currency. This is the canonical location for tip. For backwards compatibility the value is also mirrored on the deprecated representation.tip property.

Required range: x >= 0

verification.exchangeRate

number

verification.currency

string

verification.description

string

verification.purchaseDate

string<date-time>

verification.dateCreated

string

verification.lastUpdated

string

verification.storeName

string

verification.verificationNumber

string

verification.paymentTypeId

string

verification.cardTransactionId

string

verification.eventType

enum<string>

Available options:

AUTHORIZATION_ACCEPTED,

AUTHORIZATION_REJECTED,

AUTHORIZATION_REVERSAL,

CAPTURE,

REFUND

verification.receiptAttachment

object

Hide child attributes

verification.receiptAttachment.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.receiptAttachment.personId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.receiptAttachment.contentType

string

verification.receiptAttachment.isTemporary

boolean

verification.receiptAttachment.signatureType

enum<string>

Available options:

EU

verification.receiptAttachment.signatureUrl

string

verification.receiptAttachment.name

string

verification.receiptAttachment.description

string

verification.receiptAttachment.qrScan

string

Decoded fiscal QR string as sent in the qrScan request header on POST. Omitted when the resource has no QR data attached. Currently populated for Portuguese receipts.

verification.receiptAttachment.scanResult

object

read-only

Hide child attributes

verification.receiptAttachment.scanResult.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.receiptAttachment.scanResult.amount

number<double>

verification.receiptAttachment.scanResult.taxAmount

number<double>

verification.receiptAttachment.scanResult.currency

string

verification.receiptAttachment.scanResult.purchaseDate

string

verification.receiptAttachment.scanResult.categoryIds

string[]

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.receiptAttachment.scanResult.categoryId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Example:

{
  "id": "62bfaa54dc9341819cd6f4ff4ae39f44",
  "personId": "063ee3c7fa4b4728b418097299447f9d",
  "contentType": "application/pdf",
  "isTemporary": true,
  "name": "receipt-photo.jpg",
  "description": "Receipt photo",
  "qrScan": "A:514482621*B:501878076*C:PT*D:FR*E:N*F:20260508*G:111 26A/154*H:J6Z9V4MR-154*I1:PT-MA*I7:68.50*I8:15.76*N:15.76*O:84.26*Q:T4Fn*R:116",
  "scanResult": {
    "id": "a185160800524ac68cbf0a18ad59649b",
    "amount": 135,
    "taxAmount": 23,
    "currency": "SEK",
    "purchaseDate": "2023-04-20",
    "categoryIds": [
      "575ba2572de74f38b947a07df93a2909",
      "350dadb020694421aebc1d9473fa64a9"
    ],
    "categoryId": "575ba2572de74f38b947a07df93a2909"
  }
}

verification.representation

object

Hide child attributes

verification.representation.type

string

verification.representation.guestListAttached

boolean

default:false

verification.representation.includesLiquor

boolean

default:false

verification.representation.numberOfGuests

integer

verification.representation.numberOfExternalGuests

integer

verification.representation.place

string

verification.representation.tip

number<double>

deprecated

Deprecated. Tip is now a root receipt verification property (tip). A non-negative decimal number in the receipt's currency. This property is kept for backwards compatibility and mirrors the root value.

Required range: x >= 0

verification.representation.guestListAttachment

object

Hide child attributes

verification.representation.guestListAttachment.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.representation.guestListAttachment.personId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.representation.guestListAttachment.contentType

string

verification.representation.guestListAttachment.isTemporary

boolean

verification.representation.guestListAttachment.signatureType

enum<string>

Available options:

EU

verification.representation.guestListAttachment.signatureUrl

string

verification.representation.guestListAttachment.name

string

verification.representation.guestListAttachment.description

string

verification.representation.guestListAttachment.qrScan

string

Decoded fiscal QR string as sent in the qrScan request header on POST. Omitted when the resource has no QR data attached. Currently populated for Portuguese receipts.

verification.representation.guestListAttachment.scanResult

object

read-only

Hide child attributes

verification.representation.guestListAttachment.scanResult.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.representation.guestListAttachment.scanResult.amount

number<double>

verification.representation.guestListAttachment.scanResult.taxAmount

number<double>

verification.representation.guestListAttachment.scanResult.currency

string

verification.representation.guestListAttachment.scanResult.purchaseDate

string

verification.representation.guestListAttachment.scanResult.categoryIds

string[]

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.representation.guestListAttachment.scanResult.categoryId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Example:

{
  "id": "62bfaa54dc9341819cd6f4ff4ae39f44",
  "personId": "063ee3c7fa4b4728b418097299447f9d",
  "contentType": "application/pdf",
  "isTemporary": true,
  "name": "receipt-photo.jpg",
  "description": "Receipt photo",
  "qrScan": "A:514482621*B:501878076*C:PT*D:FR*E:N*F:20260508*G:111 26A/154*H:J6Z9V4MR-154*I1:PT-MA*I7:68.50*I8:15.76*N:15.76*O:84.26*Q:T4Fn*R:116",
  "scanResult": {
    "id": "a185160800524ac68cbf0a18ad59649b",
    "amount": 135,
    "taxAmount": 23,
    "currency": "SEK",
    "purchaseDate": "2023-04-20",
    "categoryIds": [
      "575ba2572de74f38b947a07df93a2909",
      "350dadb020694421aebc1d9473fa64a9"
    ],
    "categoryId": "575ba2572de74f38b947a07df93a2909"
  }
}

verification.representation.guests

object[]

Hide child attributes

verification.representation.guests.name

string

verification.representation.guests.company

string

verification.attachments

object[]

Hide child attributes

verification.attachments.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.attachments.personId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.attachments.contentType

string

verification.attachments.isTemporary

boolean

verification.attachments.signatureType

enum<string>

Available options:

EU

verification.attachments.signatureUrl

string

verification.attachments.name

string

verification.attachments.description

string

verification.attachments.qrScan

string

Decoded fiscal QR string as sent in the qrScan request header on POST. Omitted when the resource has no QR data attached. Currently populated for Portuguese receipts.

verification.attachments.scanResult

object

read-only

Hide child attributes

verification.attachments.scanResult.id

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.attachments.scanResult.amount

number<double>

verification.attachments.scanResult.taxAmount

number<double>

verification.attachments.scanResult.currency

string

verification.attachments.scanResult.purchaseDate

string

verification.attachments.scanResult.categoryIds

string[]

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.attachments.scanResult.categoryId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.customFields

object[]

Hide child attributes

verification.customFields.fieldDefinitionId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.customFields.value

any

Can be: string, number, integer, date, boolean

verification.taxRates

object[]

Hide child attributes

verification.taxRates.taxRateId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

verification.taxRates.rate

number<double>

verification.taxRates.taxAmount

number<double>

verification.purchaseIsAbroad

boolean | null

Marks the receipt as a purchase made abroad. When true, the receipt's VAT is a single amount in taxAmount and any taxRates are removed. When false, the VAT is split over taxRates. If you leave it out or send null, it is determined from the receipt: a value set earlier, or otherwise the currency.

expenseReportId

string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

⌘I

curl --request PUT \
  --url 'https://stage-api.findity.com/api/v1/expense/expenses/{expenseId}?format=fields' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    {
      "name": "Id",
      "property": "id",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": false,
      "value": "99601cd0f6ba438cb16ca17b8edf25a0",
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": null,
      "property": "version",
      "controlType": "INTEGER",
      "mandatory": false,
      "visible": false,
      "value": 2,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Receipt",
      "property": "verification.receiptAttachment",
      "controlType": "CONTENT_HOLDER",
      "mandatory": false,
      "visible": true,
      "value": "receiptAttachmentId",
      "errorText": null,
      "error": null,
      "custom": false,
      "data": {
        "id": "receiptAttachmentId",
        "name": "name of receiptAttachment"
      }
    },
    {
      "name": "Category",
      "property": "categoryId",
      "controlType": "LIST",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/expensetypes/ReceiptVerification/categories"
    },
    {
      "name": "Expense report",
      "property": "expenseReportId",
      "controlType": "LIST",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "url": "/expensereports?statuses=NORMAL,NEW&organizationId=8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Verification number",
      "property": "verification.verificationNumber",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": true
    },
    {
      "name": "Description",
      "property": "verification.description",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Date of purchase",
      "property": "verification.purchaseDate",
      "controlType": "DATE",
      "mandatory": false,
      "visible": true,
      "value": "2019-09-30T14:33:26Z",
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "allowFutureDate": false
    },
    {
      "name": "Payment method",
      "property": "verification.paymentTypeId",
      "controlType": "LIST",
      "mandatory": true,
      "visible": true,
      "value": "f433bd56f038486faeee6a5ddd5177f2",
      "errorText": null,
      "error": null,
      "custom": false,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/paymenttypes",
      "data": {
        "iconUrl": null,
        "id": "f433bd56f038486faeee6a5ddd5177f2",
        "name": "Payment",
        "section": null
      }
    },
    {
      "name": "Store",
      "property": "verification.storeName",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Amount incl. VAT",
      "property": "verification.amount",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "scannable": true
    },
    {
      "name": "Tip",
      "property": "verification.tip",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "VAT",
      "property": "verification.taxAmount",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": true,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "scannable": true
    },
    {
      "name": "Currency",
      "property": "verification.currency",
      "controlType": "LIST",
      "mandatory": true,
      "visible": true,
      "value": "SEK",
      "errorText": null,
      "error": null,
      "custom": false,
      "requiresUpdate": true,
      "scannable": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/currencies",
      "data": {
        "iconUrl": null,
        "id": "SEK",
        "name": "Swedish Krona",
        "section": null
      }
    },
    {
      "name": "Exchange rate",
      "property": "verification.exchangeRate",
      "controlType": "DOUBLE",
      "mandatory": false,
      "visible": false,
      "value": 1,
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Expense Level (not-changable)",
      "property": "8ab28c4f70f773590170f7cda2ea08bc",
      "controlType": "LIST",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/lists/CUSTOM_DIMENSIONS_4f38a4cc3fe242d394058626523044c1_8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Employee dim",
      "property": "8ab28c4f723887dd01723c5cae82020e",
      "controlType": "LIST",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": true,
      "url": "/me/organizations/8ab28cb36ccde07d016ccdfb47d00216/lists/CUSTOM_DIMENSIONS_d4c8684b75ff4026b69810c8d912aea4_8ab28cb36ccde07d016ccdfb47d00216"
    },
    {
      "name": "Entertainment",
      "property": "verification.representation",
      "controlType": "FIELD_GROUP",
      "mandatory": false,
      "visible": false,
      "value": null,
      "errorText": null,
      "error": null,
      "custom": false,
      "fields": [
        {
          "name": "Type",
          "property": "verification.representation.type",
          "controlType": "LIST",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false,
          "requiresUpdate": true
        },
        {
          "name": "Included liquor/wine/strong beer",
          "property": "verification.representation.includesLiquor",
          "controlType": "SWITCH",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Attach guest list",
          "property": "verification.representation.guestListAttached",
          "controlType": "SWITCH",
          "mandatory": false,
          "visible": false,
          "value": false,
          "errorText": null,
          "error": null,
          "custom": false,
          "requiresUpdate": true
        },
        {
          "name": "Guests",
          "property": "verification.representation.guests",
          "controlType": "GUEST_LIST",
          "mandatory": false,
          "visible": false,
          "value": [],
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Number of guests",
          "property": "verification.representation.numberOfGuests",
          "controlType": "INTEGER",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Number of external guests",
          "property": "verification.representation.numberOfExternalGuests",
          "controlType": "INTEGER",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Place",
          "property": "verification.representation.place",
          "controlType": "TEXT",
          "mandatory": false,
          "visible": false,
          "value": null,
          "errorText": null,
          "error": null,
          "custom": false
        },
        {
          "name": "Attached guest list",
          "property": "verification.representation.guestListAttachment",
          "controlType": "CONTENT_HOLDER",
          "mandatory": true,
          "visible": false,
          "value": "guestListAttachmentId",
          "errorText": null,
          "error": null,
          "custom": false,
          "data": {
            "id": "guestListAttachmentId",
            "name": "name of guestListAttachment"
          }
        }
      ],
      "commands": [
        {
          "text": "Clear guests",
          "confirmationRequired": true,
          "confirmation": "Are you sure you want to clear guests?",
          "command": "action=removeGuests"
        },
        {
          "text": "Clear representation",
          "confirmationRequired": true,
          "confirmation": "Are you sure you want to clear representation?",
          "command": "action=removeRepresentation"
        }
      ]
    },
    {
      "name": "Comment",
      "property": "verification.comment",
      "controlType": "MULTI_LINE_TEXT",
      "mandatory": false,
      "visible": true,
      "value": "Some comment",
      "errorText": null,
      "error": null,
      "custom": false
    },
    {
      "name": "Card transaction",
      "property": "verification.cardTransaction",
      "controlType": "TEXT",
      "mandatory": false,
      "visible": true,
      "value": "Some id",
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": true
    },
    {
      "name": "Attachments",
      "property": "verification.attachments",
      "controlType": "CONTENT_HOLDER",
      "mandatory": false,
      "visible": true,
      "value": [
        "id1",
        "id2"
      ],
      "errorText": null,
      "error": null,
      "custom": false,
      "disabled": false,
      "data": [
        {
          "id": "id1",
          "name": "name of attachment with id1"
        },
        {
          "id": "id2",
          "name": "name of attachment with id2"
        }
      ]
    }
  ]
}
'

{
  "organizationId": "ff808181963de13701963de1789d00ad",
  "version": 2,
  "lastUpdated": "2025-04-16T09:15:09Z",
  "dateCreated": "2025-04-16T09:15:09Z",
  "processStatus": "DRAFT",
  "status": "NORMAL",
  "expenseDate": "2023-03-21T10:58:14Z",
  "personId": "ff808181963de13701963de177e00083",
  "id": "5ca0dfa6def943eab46d240d3680c323",
  "reimbursementCurrency": "SEK",
  "categoryId": "9ed4618ae74e4f17b69005f699c104f3",
  "verification": {
    "amount": 230,
    "purchaseDate": "2023-03-21T10:58:14Z",
    "attachments": [
      {
        "name": "attachments2",
        "isTemporary": false,
        "id": "ff808181963e296501963e29ac6d00be",
        "contentType": "image/jpeg"
      },
      {
        "name": "attachments1",
        "isTemporary": false,
        "id": "ff808181963e296501963e29ac5e00bc",
        "contentType": "image/jpeg"
      }
    ],
    "customFields": [
      {
        "fieldDefinitionId": "2b965c866b634698811dabf45a491089",
        "value": true
      },
      {
        "fieldDefinitionId": "5a3f0c9e904d3a1e3aa90b034c79e0f4",
        "value": "string"
      },
      {
        "fieldDefinitionId": "904d3e1a3aa90b034c79e0f45a491089",
        "value": 10
      }
    ],
    "description": "verification-description",
    "type": "ReceiptVerification",
    "lastUpdated": "2025-04-16T09:15:09Z",
    "dateCreated": "2025-04-16T09:15:09Z",
    "paymentTypeId": "ed0d98d4e3834714bbca45f889d4584b",
    "exchangeRate": 1,
    "verificationNumber": "verification-number",
    "comment": "verification-comment",
    "currency": "SEK",
    "taxAmount": 23,
    "receiptAttachment": {
      "name": "file-name607803656",
      "personId": "ff808181963de13701963de177e00083",
      "isTemporary": false,
      "id": "ff808181963de13701963de179b900b9",
      "contentType": "image/png"
    }
  }
}

Authentication

Findity Expense API

Findity Admin API

Findity Admin API V0

Findity Connect API

Update expense (fields format of expense record)

Authorizations

Path Parameters

Query Parameters

Body

Response