Guides

Introduction

Getting Started

Completing a Pay Run

Payslips

Year End Process

Operations

Account

AnalysisCategory

AttachmentOrder

Audit

Employer Audit Log

AutoEnrolment

AverageHolidayPayHistory

Benefits

Billing

Bureau

Cis300

CisVerification

CostCentre

Department

Dps

Email

Employee

EmployeeRole

Employer

EmployerGroup

EmployerTemplate

Engine

Eps

Exb

ExternalData

Fps

HmrcPayment

HolidayScheme

Import

Invitation

Job

JournalTemplate

JournalToken

Leave

Loan

Note

Nvr

OccupationalPolicy

OccupationalSickLeaveHistory

OpeningBalances

P11History

PayCode

PayCodeSet

Payee

PayRun

PayRunAsync

PaySchedule

PaySpine

Pension

PensionRefund

PensionScheme

ProcessingNote

ReportPack

Reports

ReportsAsync

Gross To Net async (beta)

ReportTemplate

Tenant

TenantEmail

TermCalendar

TermCalendarYear

TierablePay

Calculate tierable pay

Tools

Calculate Net of On Costs

Webhook

WorkingPattern

Models

Account Models

CIS Models

Config Models

Email Models

Papdis Models

PayRun Models

Pension Models

Report Models

RTI Models

Other Models

List Benefits

Get

/employers/{employerId}/employees/{employeeId}/benefits

Returns a CSV file containing contributions for the specified payrun in a format specific to the ExternalDataProvider

Store values

Parameters

id string

employerId string

payPeriod string

periodNumber integer

taxYear string

schemeId string

The Id of the Pension Scheme you want a file for. (optional)

ordinal integer

(optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`string`	application/json