Skip to main content
POST
Generate a NEST contribution schedule (CS) file

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Body

application/json
eped
string<date>
required

Earnings period end date of the schedule, as NEST shows it; must be the end of a pension pay reference period of the pay groups on this frequency

frequency
enum<string>
required

The schedule's frequency, as NEST shows it on the schedule

Available options:
WEEKLY,
TAX_WEEKLY,
MONTHLY,
TAX_MONTHLY
opt_outs_confirmed
boolean
required

Confirms every opt-out in the NEST mailbox was recorded in Intermezzo before generating; stored on the file

payment_due_date
string<date>
required

The schedule's payment due date, as NEST shows it

payment_source_name
string
required

The NEST payment source of the schedule, as named in NEST; every FILE scheme paying from it is covered

Required string length: 1 - 40
epsd
string<date> | null

Earnings period start date, copied from the NEST schedule screen. Sent only when given: NEST needs it only when two schedules share the other header values

overwrite_soft_validation
boolean
default:false

Request-scoped, not stored as a setting: generate even when there are warnings. The acknowledged warnings are recorded on the file

Response

Successful Response

created_at
string<date-time>
required
created_by
string | null
required
document_id
string | null
required
file_id
string
required
file_type
enum<string>
required

Which NEST file a row records.

Available options:
ME,
CS,
BASELINE
members
NestFileMemberResponse · object[]
required

ME and baseline members

problems
NestFileFinding · object[]
required

Why the file could not be produced; only when FAILED

record_count
integer
required
status
enum<string>
required

Lifecycle of one generated NEST file.

Uploads happen on the NEST website, so the UPLOADED states are set by the client. An ME is UPLOADED_ALL_ACCEPTED or UPLOADED_WITH_ERRORS; a CS, whose row errors are fixed online in NEST, is UPLOADED and then APPROVED_IN_NEST once the employer approves the schedule.

Available options:
GENERATED,
FAILED,
SUPERSEDED,
UPLOADED_ALL_ACCEPTED,
UPLOADED_WITH_ERRORS,
UPLOADED,
APPROVED_IN_NEST
uploaded_at
string<date-time> | null
required
uploaded_by
string | null
required
warnings
NestFileFinding · object[]
required

Warnings acknowledged with overwrite_soft_validation

approved_at
string<date-time> | null
approved_by
string | null
contributions
NestCsContributionResponse · object[]

Contribution schedule rows

corrects_id
string | null

The uploaded or approved schedule of the same key it corrects

eped
string<date> | null
epsd
string<date> | null
frequency
enum<string> | null

Contribution schedule frequencies (guide 3.2.1, field 7).

UPPER_SNAKE_CASE in the API like every enum; the file header carries NEST's label.

Available options:
WEEKLY,
TAX_WEEKLY,
MONTHLY,
TAX_MONTHLY
opt_outs_confirmed_at
string<date-time> | null
opt_outs_confirmed_by
string | null
payment_due_date
string<date> | null
payment_source_name
string | null
scheme_ids
string[] | null