v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Recovery Cases

Get all recovery cases for a company

Fetch all recovery cases for a company.

scope: recovery_cases:read

get/v1/companies/{company_uuid}/recovery_cases

Path parameters

company_uuidstring required

The UUID of the company

Query parameters

pageinteger

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

perinteger

Number of objects per page. For majority of endpoints will default to 25

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Successful

uuidstring required

Unique identifier of an recovery case

company_uuidstring

Unique identifier of the company to which the recovery case belongs

status'open' | 'redebit_initiated' | 'wire_initiated' | 'recovered' | 'lost'

Status of the recovery case

latest_error_codestring nullable

The latest bank error code for the recovery case. See this doc for a list of common ACH return codes.

original_debit_datestring nullable

Date when funds were originally debited from the company's bank account

check_datestring

Check date for the associated payroll or contractor payments

payroll_uuidstring nullable

The uuid of the associated payroll for which the recovery case was created. If the recovery case was created for a contractor payment, this field will be null.

contractor_payment_uuidsstring[] nullable

The uuids of the associated contractor payments for which the recovery case was created. If the recovery case was created for a payroll, this field will be null.

amount_outstandingstring

Amount outstanding for the recovery case

event_total_amountstring

Total amount to be debited from the payroll or contractor payments