Get all ACH transactions for a company
GET {{baseUrl}}/v1/companies/:company_uuid/ach_transactions?contractor_payment_uuid=<string>&payroll_uuid=<string>&transaction_type=<string>&payment_direction=<string>
Fetches all ACH transactions for a company.
scope: ach_transactions:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
contractor_payment_uuid | string | The UUID of the contractor payment | |
payroll_uuid | string | The UUID of the payroll | |
transaction_type | string | Used to filter the ACH transactions to only include those with a specific transaction type, such as "Credit employee pay". | |
payment_direction | string | Used to filter the ACH transactions to only include those with a specific payment direction, either "credit" or "debit". |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"uuid":"123e4567-e89b-12d3-a456-426655440000,","company_uuid":"456e7890-e12b-34c5-d678-901234567890,","payment_event_type":"Payroll,","payment_event_uuid":"789e0123-e45f-67ab-c890-123456789012,","recipient_type":"Employee,","recipient_uuid":"012e3456-f78d-90ab-12cd-345678901234,","error_code":"null,","transaction_type":"Credit employee pay,","payment_status":"submitted,","payment_direction":"credit,","payment_event_check_date":"2023-10-02,","payment_date":"2023-10-17,","amount":"123.00,","description":"PAY 380654"}]