SOsoldo
Expense Reviews

Get Expense Review

Changed on

Endpoint to get the ExpenseReview of a specific User.

get/business/v2/expense-review/{userId}

Request

Path parameters

userIdstring required

The ID of the User.

Example:XMPL1234-000001

Query parameters

statusExpenseStatus[]

The status of the ExpenseReview.

fromDatestring date-time

The beginning of the period of the search fromDate included (i.e. greater than or equal to) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

toDatestring date-time

The end of the period of the search toDate included (i.e. less than) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

paymentMethodExpensePaymentMethod[]

It determines the filter by payment method of the transaction.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3
sinteger

It indicates the number of items per page.

Example:25
d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC
propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The returned resource is a ExpenseReview.

user_idstring

The ID of the User (sortable: no).

user_namestring

The name of the User (sortable: yes).

user_surnamestring

The surname of the User (sortable: yes).

job_titlestring

The job title of the User (sortable: yes).

to_review_transactioninteger

The number of the Transaction items in status TO_REVIEW (sortable: no).

reviewed_transactioninteger

The number of the Transaction items in status REVIEWED (sortable: no).

exported_transactioninteger

The number of the Transaction items in status EXPORTED (sortable: no).

total_transactioninteger

The number of Transaction items (sortable: no).

from_datestring

The beginning of the period of the search (sortable: no).

to_datestring

The end of the period of the search (sortable: no).

transaction_to_reviewstring[]

The array contains ID of the Transaction in status TO_REVIEW (sortable: no).

transaction_reviewedstring[]

The array contains ID of the Transaction in status REVIEWED (sortable: no).

transaction_exportedstring[]

The array array contains ID of the Transaction in status EXPORTED (sortable: no).

Example response

{
  "user_id": "XMPL1234-000001",
  "user_name": "JOHN",
  "user_surname": "DOE",
  "job_title": "CTO",
  "to_review_transaction": 1,
  "reviewed_transaction": 2,
  "exported_transaction": 1,
  "total_transaction": 3,
  "from_date": "2017-06-01T12:48:40Z",
  "to_date": "2017-06-05T12:48:40Z",
  "transaction_to_review": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "transaction_reviewed": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "transaction_exported": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ]
}

Changes

  • 7be21448a2b3Revision changes
    • info

      for the query request parameter fromDate, the type was generalized from no type to string, and format from no format to date-time

    • info

      for the query request parameter toDate, the type was generalized from no type to string, and format from no format to date-time