Update expense report for organization

put

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/reports/{reportId}

Updates an expense report. When the action query parameter is provided, performs the specified action instead of a field update. Otherwise, updates the allowed fields (name, comment, customFields, expenseRecords); any other fields in the request body are silently ignored.

Path Params

organizationId

string

required

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

The unique identifier of the organization. String, UUID format (32-character hexadecimal). Required.

reportId

string

required

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

The id of the expense report to retrieve

Query Params

action

string

enum

Action to perform on the expense report instead of a field update. String, enum. Accepted values: reviewOk, clearTransactions. Optional.

Allowed:

Body Params

Fields that can be updated on an expense report. Any other fields in the request body are silently ignored.

name

string

The display name of the expense report. String, maximum 255 characters.

comment

string

Comment on the expense report. String, unlimited characters.

customFields

array of objects

Array of custom field values to set on the expense report. Each item must include a fieldDefinitionId and a value. Array of custom field objects.

customFields

expenseRecords

array of objects

Array of bare expense record objects to include in this report. Exclude a record to to delete it from a report.

expenseRecords

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Invalid action or missing parameter

403Forbidden — expense report not found or user does not have access