---
title: "Search reimbursements"
method: POST
path: "/reimbursements/search"
tags: ["Reimbursements"]
---

# Search reimbursements

`POST /reimbursements/search`

Search reimbursements under the given business entity, returning the same set the equivalent bulk update/delete operation would target with this body.

## Request body

- object
  - `business_entity_id` string, required
  - `work_assignments` object, required
    - `exclude` object
      - `ids` string[]
      - `payee_type` 'contractor' | 'employee'
      - `pay_schedule_id` string
      - `archived` boolean
      - `payee_names` string
  - `has_business_preset` boolean
  - `business_presets` object
    - `include` object
      - `ids` string[]
    - `exclude` object
      - `ids` string[]
  - `expense_accounting_codes` object
    - `include` object
      - `ids` string[]
    - `exclude` object
      - `ids` string[]
  - `liability_accounting_codes` object
    - `include` object
      - `ids` string[]
    - `exclude` object
      - `ids` string[]
  - `effective_on` string, date
  - `not_effective_on` string, date
  - `effective_from` string — The date from which this reimbursement is applied to Pay Stubs. Date filters support two formats: Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_from=2024-01-01` Use an array-like syntax to specify a range with one or more comparison operators: - `gt` (greater than) - `gte` (greater than or equal to) - `lte` (less than or equal to) - `lt` (less than) Example: `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`
  - `effective_to` string — The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely. Date filters support two formats: Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD` format for an exact match. Example: `effective_to=2024-01-01` Use an array-like syntax to specify a range with one or more comparison operators: - `gt` (greater than) - `gte` (greater than or equal to) - `lte` (less than or equal to) - `lt` (less than) Example: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`
  - `subtypes` object
    - `include` string[]
    - `exclude` string[]
  - `ids` object
    - `include` string[]
    - `exclude` string[]

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"reimbursement"`).
    - `data` Reimbursement
      - `work_assignment` object
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"work_assignment"`).
      - `reimbursement_type` object — The type of reimbursement, which determines how it is categorized and reported on Pay Stubs.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"reimbursement_type"`).
        - `data` ReimbursementType
          - `type` string, nullable — The string identifier for this reimbursement type.
          - `label` string, nullable — The human-readable display name for this reimbursement type.
          - `features` LineItemTypeFeature[]
            - `type` 'eht' | 'income_tax' | 'insurable' | 'pensionable' | 'vacationable' | 'wcb' — The payroll calculation this entry describes.
            - `label` string — Human-readable name for the payroll calculation.
            - `definitions` object[] — How this type affects the calculation, broken down by jurisdiction. Jurisdictions where it does not apply are omitted.
              - …
          - `form_mappings` LineItemFormMapping[]
            - `form` string — The form code (e.g. `t4`).
            - `form_label` string — Human-readable form name.
            - `mapping` array[] — The boxes on the form this type contributes to.
              - …
      - `title` string, nullable
      - `title_translations` Translations, nullable
        - `en` string
        - `fr` string
      - `title_translated` string — The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header.
      - `frequency` 'once' | 'per_month' | 'per_payroll' — The frequency at which this reimbursement is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month.
      - `date_basis` 'by_pay_date' | 'by_period_end_date' | 'by_period_start_date', nullable — Which payroll date determines the calendar month for the allocation. Applies only to `per_month` recurrences.
      - `pay_period_cadence` object, nullable — Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` recurrences.
      - `amount` number — The monetary amount applied each time this reimbursement is included on a Pay Stub.
      - `effective_from` string, date — The date from which this reimbursement is applied to Pay Stubs.
      - `effective_to` string, date, nullable — The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely.
      - `business_preset` unknown
      - `expense_accounting_code` unknown
      - `liability_accounting_code` unknown
      - `external_ref` string, nullable — A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
      - `created_at` string, dateTime — The date and time the object was created in Nmbr.
      - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)