Export Daily Allowances

>>>

GET /api/export/daily_allowances
Get a list of daily allowances

Examples

{
  "total_amount": "1280.00",
  "total_records": "6",
  "collection": [
    {
      "id": 992,
      "description": "some daily allowance",
      "user_name": "John Smith",
      "state": "accounted",
      "date": "2023-08-03",
      "cost_center_names": "",
      "approved_by": "42",
      "user_id": 819,
      "cost_center_ids": [],
      "cost_center_external_ids": [],
      "sent_at": "2023-08-17",
      "created_by": "John Smith",
      "updated_at": "2023-08-17",
      "paid_at": "2023-08-17",
      "batch_reference_number": "RF225474853987121",
      "start_time": "2023-08-01T09:00:00.000Z",
      "end_time": "2023-08-03T09:00:00.000Z",
      "countries": "Finland",
      "total_cost": "64.50",
      "debit_account_code": "7880"
    }
  ]
}

Params

Param name Description
page
optional

Page number.

Validations:

  • Must be a Integer
per_page
optional

Number of records per page. Default: 25.

Validations:

  • Must be a Integer
q
optional

Query to filter daily allowances by description or amount, e.g.: “Helsinki”, “12.40”.

Validations:

  • Must be a String
date_range
optional

Date range to filter daily allowances by. Format: “DD/MM/YYYY - DD/MM/YYYY”, e.g. “01/09/2023 - 04/09/2023”.

Validations:

  • Must be a String
user_id
optional

User ID to filter daily allowances by.

Validations:

  • Must be a Integer
cost_center_id
optional

Cost center ID to filter daily allowances by.

Validations:

  • Must be a Integer
state
optional

State to filter daily allowances by.

Validations:

  • Must be one of: draft, reviewing, unapproved, queue, accounted, failed.
updated_at_range
optional

Date range when daily allowances were last updated to filter by. Format: “DD/MM/YYYY - DD/MM/YYYY”, e.g. “01/09/2023 - 04/09/2023”.

Validations:

  • Must be a String
sort
optional

Parameter to sort daily allowances by. Sorted by updated date in descending order by default.

Validations:

  • Must be one of: countries, description, end_time, paid_at, sent_at, start_time, state, total_cost, updated_at, user_name.
order
optional

Sort daily allowances by sort param in ascending or descending order. Default: asc.

Validations:

  • Must be one of: asc, desc.
extended
optional

Pass true to include conditional values

Validations:

  • Must be one of: true, false.

Returns

Code: 200

Description:

OK

Param name Description
total_amount
required

Total amount for daily allowances matching filtering criteria, e.g. “154.25”.

Validations:

  • Must be a String
total_records
required

Total number of daily allowances matching filtering criteria, e.g. “5”.

Validations:

  • Must be a String
collection
required

List of daily allowances.

Validations:

  • Must be an array of any type