GET /api/export/receipts
Get a list of receipts

Examples

{
  "total_amount": "10186.01",
  "total_records": "143",
  "collection": [
    {
      "id": 6211,
      "description": "some receipt for something important",
      "user_name": "John  Smith",
      "state": "accounted",
      "date": "2023-08-01",
      "cost_center_names": "Some Cost Center,Some Other Cost Center",
      "approved_by": "819,26",
      "user_id": 152,
      "cost_center_ids": [3222, 3217],
      "cost_center_external_ids": ["10041", "10115"],
      "sent_at": "2023-08-05",
      "created_by": "John  Smith",
      "updated_at": "2023-08-05",
      "paid_at": null,
      "batch_reference_number": "RF601077445632463",
      "credit_account_id": 2891,
      "expense_account_id": 2925,
      "tax_percentage": null,
      "total_cost": "12.40",
      "payment_method": "Company card",
      "purchase_type": "Travel expenses",
      "credit_acc_code": "2871",
      "debit_acc_code": "7800",
      "connected_to_bill_line": false,
      "participants": null,
      "vat_line_id": 7812,
      "vat_code": "KOOS",
      "vendor_id": null,
      "printed_id": null,
      "attachments": [
        {
          "id": 9678,
          "file": "https://example.com/9c55e33f-c32d-4601-b8ee-28eed58d98cc.png",
          "transaction_id": 6211
        }
      ]
    }
  ]
}

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 receipts by description or amount, e.g.: “Helsinki”, “12.40”.

Validations:

  • Must be a String
date_range
optional

Date range to filter receipts 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 receipts by.

Validations:

  • Must be a Integer
cost_center_id
optional

Cost center ID to filter receipts by.

Validations:

  • Must be a Integer
state
optional

State to filter receipts by.

Validations:

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

Date range when receipts 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
asset_account_id
optional

Asset account ID to filter receipts by.

Validations:

  • Must be a Integer
expense_account_id
optional

Expense account ID to filter receipts by.

Validations:

  • Must be a Integer
extended
optional

Pass true to include conditional values

Validations:

  • Must be one of: true, false.
sort
optional

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

Validations:

  • Must be one of: connected_to_bill_line, credit_acc_code, date, debit_acc_code, description, id, paid_at, payment_method, purchase_type, sent_at, state, total_cost, updated_at, user_name.
order
optional

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

Validations:

  • Must be one of: asc, desc.

Returns

Code: 200

Description:

OK

Param name Description
total_amount
required

Total amount for receipts matching filtering criteria, e.g. “104.50”.

Validations:

  • Must be a String
total_records
required

Total number of receipts matching filtering criteria, e.g. “27”.

Validations:

  • Must be a String
collection
required

List of receipts.

Validations:

  • Must be an array of any type