Sign in

v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get Paper Checks Report

get/payrolls/{payroll}/reports/paper_checks

Path parameters

payrollstring required

Returns paper checks report for this payroll ID

Query parameters

representationstring

default or checkeeper. If checkeeper is selected, report entries will be formatted to be compatible with Checkeeper's paper checks import flow.

address_typestring

payee or company. If payee is selected, the address for each entry is set to the individual payee's mailing address, as recorded in Check. If set to company, all entries will have the mailing address set to the company's address.

Headers

Acceptstring

Either application/json or text/csv

Request body

{"stackTrail":"paths:/payrolls/{payroll}/reports/paper_checks:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

OR

Example response

{
  "results": [
    {
      "payee": "Tony Stark",
      "address_line1": "630 Bedford Road",
      "address_line2": "APT 1201",
      "address_city": "Tarrytown",
      "address_state": "NY",
      "address_postalcode": "10591",
      "amount": "831.66",
      "date": "2022-10-31",
      "payroll_item": "itm_NlBENQZ0eNWQqx46oQbZ"
    }
  ]
}