CHcheckhq

Get a Balancing Receipt

Changed on

Returns the balancing receipt for the specified payroll. The receipt provides a detailed breakdown of tax variances identified during the quarterly balancing process, including any amounts owed between Check and the employer and any refunds due from tax agencies.

This endpoint is only available for balancing payrolls. Calling it on a non-balancing payroll returns an error.

By default, the response is JSON. Use an Accept: application/pdf request header to download the receipt as a PDF document.

get/payrolls/{payroll}/paper_checks-1

Request

Path parameters

payrollstring required

The ID of the balancing payroll (e.g., pay_abc123).

Headers

Accept'application/json' | 'application/pdf'

Either application/json or application/pdf. Defaults to application/json.

Response

The balancing receipt for the specified payroll.

cash_requirement_totalnumber

The net amount to be collected or refunded from the employer directly in a transaction related to this payroll. (Note: If the total cash requirement across all taxes is $1.00 or less, this returns 0 - waiving any transaction with the employer - and the amount is reported in cash_requirement_waived instead.)

cash_requirement_waivednumber

The net cash requirement amount that was automatically absorbed because it fell at or below the $1.00 write-off threshold. This is 0 when the cash requirement exceeds $1.00.

agency_refund_totalnumber

The total amount refundable directly from tax agencies to the employer, separate of any direct transaction related to this payroll.

Changes