Start receipt export job

Request

Forwards the receipt export request to the expenses service and returns a background job id.

Security

oauth2ClientCredentials(Required scopes: expenses:write)

org_wallet_refstring

Organization wallet reference, defaults to "1" if not provided

business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired

fromdatestring

Export start date in ISO format

Example:"2026-01-01"

todatestring

Export end date in ISO format

Example:"2026-12-31"

accountrefstring

Optional compatibility field from the dashboard payload. The middleware overrides this with the trusted org_wallet_ref header.

Example:"1"

pagenumber

Page number from the dashboard request payload

Example:1

limitnumber

Requested export limit

Example:5000

orderstring

Sort direction passed by the dashboard

Example:"desc"

isExportboolean

Optional compatibility field from the dashboard payload. The middleware always forwards isExport=true for this endpoint.

Example:true

employeestring

Optional employee filter

Example:"employee-123"

teamstring

Optional reviewer/team filter

Example:"team-123"

statusstring

Optional expense status filter

Example:"pending"

subcategorystring

Optional subcategory filter

Example:"sub-123"

categorySubcategoriesobject(StringArrayFilterDto)

Optional category filter payload

payment_statusstring

Optional payment status filter

Example:"paid"

tagsobject(StringArrayFilterDto)

Optional tags filter payload

levelnumber

Optional expense level filter

Example:2

amount_filter_typestring

Optional amount filter type

Example:"greater_than"

amount_valuenumber

Optional amount filter exact value

Example:1000

amount_minnumber

Optional minimum amount filter

Example:100

amount_maxnumber

Optional maximum amount filter

Example:5000

customerstring

Optional customer filter

Example:"customer-123"

searchstring

Optional dashboard search query

Example:"hotel"

curl -i -X POST \
  https://developer.boyahq.com/_mock/v2/openapi/expenses/export-receipts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string' \
  -d '{
    "fromdate": "2026-01-01",
    "todate": "2026-12-31",
    "accountref": "1",
    "page": 1,
    "limit": 5000,
    "order": "desc",
    "isExport": true,
    "employee": "employee-123",
    "team": "team-123",
    "status": "pending",
    "subcategory": "sub-123",
    "categorySubcategories": {
      "data": [
        "cat-1",
        "cat-2"
      ]
    },
    "payment_status": "paid",
    "tags": {
      "data": [
        "cat-1",
        "cat-2"
      ]
    },
    "level": 2,
    "amount_filter_type": "greater_than",
    "amount_value": 1000,
    "amount_min": 100,
    "amount_max": 5000,
    "customer": "customer-123",
    "search": "hotel"
  }'

Responses

Receipt export job accepted