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.
moveToNextStep moves a report that is in TRANSFER or TRANSFER_TO_RECIPIENT to the next step of its send chain: to the next recipient, or to SENT when the chain is complete. forwardToApprovalOrBooking forwards a report that is ON_HOLD back into the approval or booking flow. Both are support tools and are restricted to the developer role. The report must belong to the organization in the path; a report of another organization is answered with 404 EXPENSE_REPORT_NOT_FOUND even when the caller administers that organization.
sendReminder reminds the owner of the report about it, and takes { "message": "..." } as its body. Only reports that carry an invoice reference can be reminded, and only organization administrators and standard API keys may use it.

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. Optional. Accepted values: reviewOk, clearTransactions, approve, reject, simulateBilling, sendReminder, setStatus, moveToNextStep, forwardToApprovalOrBooking.
approve and reject submit an approval decision for the report's approval chain and require a request body holding approvalChainId. approve carries the per record decisions, so partial approvals are supported; reject rejects every expense record of the report unless explicit records are supplied.
simulateBilling assigns a generated billing file reference to the report and to its card transactions, sets the due date to tomorrow and renames the report. It requires the adminApiExpenseReports:updateExpenseReport-simulateBilling permission and is intended as a developer and support tool.
sendReminder reminds the owner of the report about it and takes an optional message in the request body. It requires the adminApiExpenseReports:updateExpenseReport-sendReminder permission, and only reports that carry an invoice reference can be reminded.
setStatus moves the report to the status given in the request body. Changing the status of several reports at once, and moving reports to another recipient, is a separate operation: PUT /organizations/{organizationId}/reports?action=setStatus.
moveToNextStep and forwardToApprovalOrBooking advance the report in its send chain. Both are restricted to the developer role and answer 403 for anyone else. Use PUT /organizations/{organizationId}/reports?action=moveToNextStep to advance several reports at once.

Body Params

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

404Not found — the expense report does not exist, or it belongs to another organization than the one in the path.