Skip to content
Open appBook a five-day pilot

Preview the Gusto payroll reconciliation

POST/api/v1/payroll/gusto/reconcile/preview

Reads the Gusto exports given (Payroll Journal / Register, Contractor Payments, Bank Transactions; uploaded via s3_key or pasted), matches them to the Gusto bank rows in the range and returns the plan: per row the new description, counterparty, ledger, the per-employee split of each NET lump, and the accrual bill each TAX / reimbursement debit pays; plus everything left outstanding on either side and a plan_hash for apply. Nothing is changed.

Operation ID: gusto_reconcile_preview·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: GustoReconcileRequest

reportsarray · GustoReportInputGustoReportInput

Gusto exports: Payroll Journal (or Payroll Register), Contractor Payments and/or Bank Transactions. Without any, only the bank lines' own descriptors are used (contractor payee, fee).

3 fields
s3_keystring

S3 key from POST /uploads (or generate_upload_url) of a CSV/XLSX exported from Gusto > Reports.

contentstring

The report pasted as CSV / tab-separated text.

filenamestring

Original file name (format hint).

bank_ledger_idstring

Bank account Gusto debits. Omit to consider every bank account of the business.

start_datestring · daterequired

First bank date considered

end_datestring · daterequired

Last bank date considered

ledger_overridesGustoLedgerOverrides
amount_tolerance_centsinteger

Largest difference accepted between a payroll lump and the register total; the difference becomes a rounding leg.

create_billsboolean

Book tax and reimbursement debits as an accrual bill per pay period (vendor Gusto) paid by the bank row. False categorizes them directly instead.

Responses

200Successful Response

Schema: SuccessEnvelope_GustoReconcilePreviewResponse_

successboolean
messagestring
codestring
dataGustoReconcilePreviewResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.