Evenbead docs
Contents

Payroll

4 operations. All areas

GET/v1/payroll/ytd

Payroll year to date imported from the previous provider: per employee and payroll item, with the W-2 boxes it implies

  • Operation getPayrollYtd
  • Scope: read
  • Read
Parameters
  • year query, integer, required
Responses
  • 200 Payroll YTD (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

POST/v1/payroll/ytd

Import the previous payroll provider's year-to-date report (CSV: one row per employee; Employee, Gross Wages and the withholding and employer-tax columns ADR-0185 lists). dry_run previews. People only (a firm member needs the client's admin capability); agents read and are refused.

  • Operation importPayrollYtd
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Request body
  • csv string, required The CSV text (UTF-8, a header row first).
  • provider string, required
  • tax_year integer, required
  • period_through string, required Calendar date, YYYY-MM-DD.
  • switch_id string
  • dry_run boolean
Responses
  • 200 Checked (dry run or problems) (object)
  • 201 Imported (object)
  • Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/payroll/ytd/{id}/void

Void an imported payroll report, with a reason. People only (a firm member needs the client's admin capability); agents read and are refused.

  • Operation voidPayrollYtd
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • reason string, required
Responses
  • 200 Voided (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/payroll/ytd/{id}/summary-entry

Post the summary journal entry for January to the switch from the payroll report (for payroll NOT in the migrated history; refused when the wages account already holds the year's wages). People only (a firm member needs the client's admin capability); agents read and are refused.

  • Operation postPayrollSummary
  • Scope: admin
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • entry_date string, required Calendar date, YYYY-MM-DD.
  • wages_account string, required
  • employer_tax_account string, required
  • liability_account string, required
  • net_pay_account string, required
Responses
  • 201 Posted (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)