v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

get/companies/{company}/reports/child_support_payments

Path parameters

companystring required

ID of the company to the report for.

Query parameters

startstring

Filter payments from payrolls with a payday on or after this date. Format: YYYY-MM-DD

endstring

Filter payments from payrolls with a payday on or before this date. Format: YYYY-MM-DD

Headers

Acceptstring

Either application/json or text/csv

Response

nextstring
previousstring

Example response

{
  "results": [
    {
      "employee_id": "emp_abc123",
      "first_name": "Tony",
      "last_name": "Stark",
      "payroll_id": "pay_abc123",
      "payroll_item_id": "itm_abc123",
      "payment_amount": "294.23",
      "expected_completion_date": "2024-11-19",
      "agency": "OH",
      "trace_number": "021000027897035",
      "status": "paid"
    }
  ]
}