Cintra standard interface (education)

Prev Next

Cintra Payroll inbound standard interface guide

Key deliverables

  • Confirmed interface approach, including whether files will be loaded manually or transferred via SFTP.

  • Configured connectors for the required file types

  • Agreed CSV file structure and filename format for each connector.

  • Validated reference data alignment, including payroll, employer, payment, absence and pension scheme values.

  • Confirmed SFTP setup, credentials and polling/processing frequency, where automated transfer is required.

  • Successful test file submission and resolution of any validation or processing errors before go-live.

Source documents

Use the following source documents when preparing, configuring and supporting the interface.

Source document

Purpose

Cintra iQ standard interface help page (this article)

This article provides the standard interface specification, including the expected file structure, field requirements and processing guidance. See Cintra Payroll inbound standard interface specification (Education) below.

SFTP Agreement Form

Captures the information required to request and configure Cintra’s SFTP service, where this option is required.

Cintra payroll inbound standard interface guide (this article)

Provides supporting guidance for implementing and using the Cintra Payroll Inbound Standard Interface. See Cintra payroll inbound standard interface guide.

About the interface

Cintra's Standard Inbound Interface provides a convenient and secure way to import new starters or update existing employee information into your Cintra iQ application.

All processing of the input data is based on the build and configuration of your system, including any additional rules or calculation methods defined in your Cintra iQ application.

How the process works

Providing and processing the data files can be completed manually, or through a semi-automated or fully automated process.

Manual file loading and processing

  1. Load the file. Each connector is available through the Cintra iQ UI, allowing an operator to select and load the files to be imported.

  2. Queue. Once loaded, the file is placed into a processing queue, visible within the Interface UI.

  3. Process on demand. An operator triggers processing when required — pending files are processed in chronological order, oldest first.

Automated file loading and processing (SFTP)

  1. Secure transfer. The Standard Interface supports automated file transfer over SFTP — an additional option enabled under the interface configuration.

  2. Polling. The interface automatically connects and looks for files at the given SFTP location at a defined polling interval, pulling them into the queue. Files are deleted from the SFTP server once successfully picked up.

  3. Manual or automated processing. Once queued, files can either wait for manual processing, or be processed automatically at a defined frequency — always oldest first.

The six data files

Each connector requires a defined CSV file as its input source. Every file must start with a header row, and each record must contain all defined fields in order — if a field has no data, an empty value should still be passed. Fields marked Required must always contain a value.

File

Filename format

Base Data

{YYYYMMDD}_{HHMMSS}_BAS.csv

Employee in Post

{YYYYMMDD}_{HHMMSS}_EIP.csv

Fixed Payments

{YYYYMMDD}_{HHMMSS}_FIX.csv

Variable Payments

{YYYYMMDD}_{HHMMSS}_VAR.csv

Pensions & Benefits

{YYYYMMDD}_{HHMMSS}_PEN.csv

Absence

{YYYYMMDD}_{HHMMSS}_ABS.csv

Key things to get right: Full records & matching references

When submitting amendments for an existing employee, the information provided for any record is treated as a full record replacement — not just the changed fields. Every field defined for that file must be included with its current, correct value each time a record is submitted.

Common mistake to avoid: Sending only the fields that have changed and leaving the rest blank. Because each submission fully replaces the record, this will overwrite other fields with empty values rather than leaving them untouched.

Certain fields must also match reference values already configured in Cintra iQ exactly — including Payroll Name, Employer Name, Post Reference, Work Pattern Name, Payment Code, Absence Code, and Scheme Contribution Name.

Using a reference value that does not exactly match what is configured in Cintra iQ — including spacing, capitalisation, and punctuation. If these do not match precisely, the record will fail to process.

Setting up the SFTP connection

  1. Connection details. The interface establishes an SFTP connection using basic authentication — this requires a hostname or IP address, port number, username, and password.

  2. Your own SFTP server. If you have your own SFTP server, these connection and authentication details need to be provided to Cintra so the option can be configured within the Standard Interface.

  3. Cintra's SFTP service. If you do not have your own SFTP server, Cintra can provide one — please request, complete, and return the SFTP agreement form using the Cintra help page: https://help.cintra.co.uk/iq/docs/cintra-sftp-service-agreement-and-request-of-access

  4. Credentials issued. Once configured, Cintra will send the SFTP credentials to the contacts listed on the completed form.

Additional options

  • Automated processing frequency: files can be set to process automatically at a defined interval, rather than waiting for manual triggering.

  • PGP file encryption: an additional layer of security, where files uploaded to the SFTP site are encrypted with a PGP key issued by Cintra.

These options are available as standard but not automatically switched on, as they need to be configured for your specific setup. If you would like either enabled, please let your Cintra contact know.

If you have any questions about the interface or need any assistance, please do not hesitate to get in touch with your Cintra contact.

Cintra Payroll inbound standard interface specification (Education)

This section defines the standard inbound interface specification for education payroll data processed within Cintra iQ. It sets out the expected file formats, mandatory and optional data fields, validation requirements, processing logic and error-handling approach required to support secure and consistent payroll data imports.

Key Deliverables

  • Definition of the standard inbound education payroll interface and supported file types.

  • Specification of SFTP, encryption and file-processing configuration requirements.

  • Documented validation rules for each data file, including required fields, accepted formats and additional mapping notes.

  • Processing overview for ingestion, validation, data updates, logging and error handling.

  • Detailed data structures for Base, Employee in Post, Fixed Payment, Variable Payment, Pension and Benefits, and Absence files.

  • Guidance on reference data dependencies that must be confirmed within Cintra iQ before interface processing.

Interface Data Processing Overview

Data Ingestion and Validation

  • Secure File Transfer: Files are automatically downloaded from the SFTP server using a local Windows service, based on the configured search criteria.

  • Decryption: Where applicable, downloaded files are decrypted to access the raw data.

  • Data Validation: The interface validates the number of columns, character length of each column, and expected data types. If validation errors are detected, the process terminates and an error report is produced.

Data Processing

  • File Prioritisation: A catalogue of file types is created based on creation date to establish the processing order.

  • Sequential Processing: Files are processed in the specified order, one file type at a time, for example BAS, EIP and FIX.

  • Data Extraction: File data is extracted and stored in a temporary table.

  • Row-by-Row Processing: Each row of the data file is processed sequentially.

  • Data Updates: Records are updated or inserted into the target SQL table or tables based on the defined processing logic.

  • Error Handling: If an error occurs during data processing, including SQL errors, the affected row process terminates and an error report is produced.

  • Process Continuation: Once all rows and files have been processed successfully, the integration moves to the next file or file type in the queue.

Interface Configuration

SFTP Configuration

Setting

Value

Polling Interval

1 hour

Encrypted Container

Available, not mandatory

Encryption Format

GnuPG

Data File Format

Setting

Value

Data File Structure

Text Delimited

Data File Header Count

1

Data File Column Delimiter

, (comma)

Data File Line Delimiter

Windows (CR LF)

Import process

A scheduled processing task monitors the SFTP location and processes all files according to the file import specification. The polling interval is specified above. All interface processing events are logged.

File processing errors / notifications

Any errors during file processing can be viewed in the Interface Definitions area within iQ. Email alerts can also be configured to be sent at the polling schedule when a file is received or when a file processing error occurs.

Data file structure

The following sections describe the expected data file structures to be processed. The maximum length and precision values are used for file structure validation. Additional formatting rules are applied during processing.

Base file

The Base Data file is used to import employees’ personal information, contact information, bank details, employment details and base payroll-related information. Provided data will either add new employee records or modify existing records. The file must contain only one record per employee, with a unique Employee Number defined for each employee.

Filename: {YYYYMMDD}_{HHMMSS}_BAS.csv, for example 20250610_163510_bas.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.
Unique per each employee.

Title

N

Max length: 4 characters
Accepts: letters (A-z), dash (-), space, dot (.)
Must start with a letter.

First Name

Y

Max length: 30 characters
Accepts: letters (A-z), dash (-), space, single quote (')
Must start with a letter.

Middle Name

N

Max length: 30 characters
Accepts: letters (A-z), dash (-), space, single quote (')
Must start with a letter.

Surname

Y

Max length: 35 characters
Accepts: letters (A-z), dash (-), space, single quote (')
Must start with a letter.

NI Number

N – see addl info

9-character string
Accepts: letters (A-z), numbers (0-9)
Must be a valid National Insurance Number in the format of 2 letters, followed by 6 numbers and 1 letter.

Represents employee's National Insurance Number.
Not mandatory when setting up a new employee but required for HMRC (FPS) submission.

Date of Birth

N – see addl info

Date in the format YYYY-MM-DD

Not mandatory when setting up a new employee but required for HMRC (FPS) submission.

Gender

N – see addl info

Accepted values are "Male" or "Female"

Not mandatory when setting up a new employee but required for statutory parental pay calculations and HMRC (FPS) submission.

Marital Status

N

        Single character code:
        S = Single
        M = Married
        D = Divorced
        P = Separated
        L = Living with Partner
        N = Not Disclosed
        W = Widowed / Surviving Civil Partner
        C = Civil Partnership
        V = Annulled – Voidable Marriage / Civil Partnership
        Z = Annulled – Void Marriage / Civil Partnership
        A = Domestic Partnership      

Please send the single-character code corresponding to the employee's marital status.

Address Line 1

N – see addl info

Max length: 35 characters

Not mandatory, but at least two address lines must be provided for HMRC (FPS) submission.

Address Line 2

Max length: 35 characters

Address Line 3

Max length: 35 characters

Address Line 4

Max length: 35 characters

Post Code

N – see addl info

Max length: 8 characters
Must be a valid UK postcode.

Not mandatory but required for HMRC (FPS) submission.

Country

N

Max length: 35 characters

Home Tel

N

Max length: 50 characters

Mobile

N

Max length: 20 characters

Main Email Address

N

Max length: 250 characters

Must be a valid email address format.

Alternative Email Address

N

Max length: 250 characters

Must be a valid email address format.

Date Joined

Y

Date in the format YYYY-MM-DD

Continuous Service Date

N

Date in the format YYYY-MM-DD

Leaving Date

N

Date in the format YYYY-MM-DD

Employment Status

N

Accepted values are "Casual", "Permanent", or "Temporary"

Bank Account Title

N – see addl info

Max length: 60 characters

If left blank, the system automatically generates it using the Title, First Name and Surname.

Sort Code

N – see addl info

6 or 8-character string
Accepts: numbers (0-9), dash (-)
Accepted formats: 000000 or 00-00-00

Mandatory if Bank Account Title and Bank Account Number are provided.

Bank Account Number

N – see addl info

8-character string
Accepts: numbers (0-9)
Represents an 8-digit account number.

Mandatory if Sort Code and Bank Account Title are provided.

Bank Reference/Building Society Roll Number

N

Max length: 18 characters

Payroll Name

Y

Max length: 48 characters

Needs to match an existing Payroll within Cintra iQ. *

Employer Name

Y

Max length: 50 characters

Needs to match an existing Employer within Cintra iQ. *

Cost Code 1

N

Max length: 50 characters

Represents the default Standing Cost Allocation definition, where the cost code is allocated to the Account. **

Cost Code 2

N

Max length: 50 characters

Represents the default Standing Cost Allocation definition, where the cost code is allocated to the Department. **

Cost Code 3

N

Max length: 50 characters

This field is not included by default in Cintra iQ. If required, please inform your Cintra team. However, it should still be included in the file.

Pay Point

N

Max length: 50 characters

Employee in post file

The Employee in Post Data file is used to import employees’ post, working pattern, grade and spine point information. Provided data will either add new employee post records or modify existing post records. The file can contain multiple employee in post records per employee, with unique post references defined for each post.

Filename: {YYYYMMDD}_{HHMMSS}_EIP.csv, for example 20250610_163510_eip.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.

Post Reference

Y

Max length: 50 characters

Needs to match an existing Post Reference defined in Cintra iQ. *

From Date

Y

Date in the format YYYY-MM-DD

To Date

N

Date in the format YYYY-MM-DD

Reason For Change

N

Max length: 50 characters

Needs to match an existing value defined in Cintra iQ. *

Addition (Salary) Heading Name

N

Max length: 30 characters

Needs to match an existing value defined in Cintra iQ. *

Primary Earning

N

Max length: 1 character
Accepted values are "Y" or "N"

Additional Role

N

Max length: 1 character
Accepted values are "Y" or "N"

Cost Code 1

N

Max length: 50 characters

Represents the default Standing Cost Allocation definition, where the cost code is allocated to the Account. **

Cost Code 2

N

Max length: 50 characters

Represents the default Standing Cost Allocation definition, where the cost code is allocated to the Department. **

Cost Code 3

N

Max length: 50 characters

This field is not included by default in Cintra iQ. If required, please inform your Cintra team. However, even if it is not currently needed, the column should still be included in the file.

Grade

N – see addl info

Max length: 50 characters

Mandatory when updating or inserting a spine point. Must match a value in Cintra iQ. *

Spine Point ID

N – see addl info

Max length: 15 characters

Mandatory when updating or inserting a spine point. Must match an existing Spine Point ID defined in Cintra iQ. *

Spine Point Start Date

N – see addl info

Date in the format YYYY-MM-DD

Mandatory when updating or inserting a spine point.

Spine Point End Date

N

Date in the format YYYY-MM-DD

Work Pattern Name

N – see addl info

Max length: 20 characters

Mandatory when updating or inserting a work pattern. Must match an existing Work Pattern defined in Cintra iQ. *

Work Pattern Start Date

N

Date in the format YYYY-MM-DD

Mandatory when updating or inserting a work pattern.

Work Pattern End Date

N

Date in the format YYYY-MM-DD

FTC Calc Method

N – see addl info

Accepted values are "Based Upon Contract Hours", "Based upon Working Pattern", or "Direct Entry"

Mandatory when updating or inserting a work pattern.

Hours Per Week

N – see addl info

Decimal (5,2)

Mandatory if FTC Calc Method is "Based Upon Contract Hours".

Weeks Per Year

N – see addl info

Decimal (6,4)

Mandatory if FTC Calc Method is "Based Upon Contract Hours".

FTE Factor

N – see addl info

Decimal (7,6)
Accepted value: Between 0 and 2

Mandatory if FTC Calc Method is "Direct Entry"; otherwise leave empty.

Fixed payment file

The Fixed Payments file is used to define and import information about recurring employee additions or deductions, commencing at a defined Start Date and potentially ceasing at a defined End Date. Provided data will either add new or modify existing employees’ fixed payment records. The file may contain more than one record per employee, as long as the Employee Number defined is a valid number of an already existing employee within the system.

Filename: {YYYYMMDD}_{HHMMSS}_FIX.csv, for example 20250610_163510_fix.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.

Payment Code

Y

Max length: 3 characters

Needs to match an Import Code reference of an existing Payment Heading, Addition or Deduction defined in Cintra iQ. *

Payment Name

N

Max length: 30 characters

Start Date

Y

Date in the format YYYY-MM-DD

End Date

N

Date in the format YYYY-MM-DD

Annual Amount

Y

Decimal (18,2)

Represents the annual payment amount, based on which a pro-rata payment will be calculated for the defined period.

Period Amount

N

Decimal (18,2)

Represents the amount that will be paid for the defined period.

Post Reference

N – see addl info

Max length: 50 characters

Required if the addition heading type is an Employee in Post payment. The start and end dates of the fixed payment must fall within the post effective and end dates. Needs to match an existing Post Reference defined in Cintra iQ. *

Variable payment file

The Variable Payments file is used to define and import information about one-off payments or deductions to employees for a defined period between a Start Date and End Date. Values presented in this file will be paid during the current open period in Cintra IQ. Provided data within this file will result in adding new variable payment records for an employee. The file may contain more than one record per employee, as long as the Employee Number defined is a valid number of an already existing employee within the system.

Filename: {YYYYMMDD}_{HHMMSS}_VAR.csv, for example 20250610_163510_var.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.

Payment Code

Y

Max length: 3 characters

Needs to match an Import Code reference of an existing Payment Heading, Addition or Deduction defined in Cintra iQ. *

Payment Name

N

Max length: 30 characters

Start Date

Y

Date in the format YYYY-MM-DD

End Date

N

Date in the format YYYY-MM-DD

Annual Amount

Y

Decimal (18,2)

Represents the annual payment amount, based on which a pro-rata payment will be calculated for the defined period.

Period Amount

N

Decimal (18,2)

Represents the amount that will be paid for the defined period.

Post Reference

N – see addl info

Max length: 50 characters

Required if the addition heading type is an Employee in Post payment. The start and end dates of the fixed payment must fall within the post effective and end dates. Needs to match an existing Post Reference defined in Cintra iQ. *

Pension and benefits file

The Pensions and Benefits file is used to define and import employees’ pensions and benefits-related information, such as contribution amounts and opt-in and opt-out dates. Provided data within this file will either add new or modify existing employees’ pension and benefits records. The file may contain more than one record per employee, as long as the Employee Number defined is a valid number of an already existing employee within the system.

Filename: {YYYYMMDD}_{HHMMSS}_PEN.csv, for example 20250610_163510_pen.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.

Payment Code

Y

Max length: 3 characters

Needs to match an Import Code reference of an existing Payment Heading, Addition or Deduction defined in Cintra iQ. *

Payment Name

N

Max length: 30 characters

Start Date

Y

Date in the format YYYY-MM-DD

End Date

N

Date in the format YYYY-MM-DD

Annual Amount

Y

Decimal (18,2)

Represents the annual payment amount, based on which a pro-rata payment will be calculated for the defined period.

Period Amount

N

Decimal (18,2)

Represents the amount that will be paid for the defined period.

Post Reference

N – see addl info

Max length: 50 characters

Required if the addition heading type is an Employee in Post payment. The start and end dates of the fixed payment must fall within the post effective and end dates. Needs to match an existing Post Reference defined in Cintra iQ. *

Absence file

The Absence file is used to define and import information about employees’ absence for a defined period. Hourly and daily absence are supported, including half-day and full day absence definitions. Provided data within this file will either add new or modify existing employees’ absence records. The file may contain more than one record per employee, as long as the Employee Number defined is a valid number of an already existing employee within the system.

Filename: {YYYYMMDD}_{HHMMSS}_ABS.csv, for example 20250610_163510_abs.csv.

Name

Required

Format & Validation Rules

Additional Info

Employee Number

Y

Max length: 10 characters
Type: Alphanumeric
Accepts: Letters (A-z), Numbers (0-9)

Represents an Employee Identifier.

Absence Code

Y

Max length: 3 characters

Needs to match an Import Code reference of an existing Absence Record defined in Cintra iQ. *

Start Date

Y

Date in the format YYYY-MM-DD

End Date

Y

Date in the format YYYY-MM-DD

Start Date Half

N – see addl info

Accepted values: "am", "pm", "full"

Required if the absence is set up in Days.

End Date Half

N – see addl info

Accepted values: "am", "pm", "full"

Required if the absence is set up in Days.

Start Time

N – see addl info

Time in the format HH:MM

Required if the absence is set up in Hours.

End Time

N – see addl info

Time in the format HH:MM

Required if the absence is set up in Hours.

* Important: As the values need to match with how these have been set up within Cintra IQ, please refer to the Cintra team to set and confirm the respective reference values and ensure correct mapping.

** Please Note: Allocation percentage for the Standing Cost Allocations will be set as 100%. Allocations for Cost Code 1, Cost Code 2, and Cost Code 3 can be mapped differently based on your system setup, so please feel free to refer to the Cintra team to get a confirmation on these three fields' exact mapping structure.

Interface data processing steps

Base interface

This interface processes employee personal and employment data in Cintra iQ. It handles multiple files and updates or creates personal records, employment records, payroll memberships and banking details in a structured, transaction-safe manner.

Main components

  1. Main Procedure: Entry point procedure that manages the overall file processing workflow and handles multiple files in sequence.

  2. Temporary Table: Prepares data for processing, creates temporary storage for standardised data and performs initial cleansing.

  3. Person Data Process: Processes person records, handles updates and manages error logging.

Detailed Process Flow

  1. File Selection and Initialisation: The system identifies unprocessed files marked as Good To Go and processes them in transfer date order.

  2. Data Preparation: The temporary table is truncated and data is standardised, including title formatting, NI number standardisation, date conversion, address proper casing, postcode standardisation, bank sort code verification and account number validation.

  3. Person Processing: New person records are created where required and existing records are updated with personal details, contact information, gender, marital status, NI number, email addresses and validated address information.

  4. Employment Processing: The process verifies the personnel record, updates or creates employment records, validates payroll membership, handles late leaver corrections and manages employee banking information and account history.

  5. Error Handling and Logging: Errors and warnings are logged at each step, including process timings, specific messages and data quality warnings. Non-critical errors do not prevent continued processing.

Employee in post interface

The Employee in Post interface uses multiple stored procedures to manage employee position data, including post assignments, work patterns, grade and spine point information.

Main components

  1. Main Procedure: Orchestrates the process flow, identifies files marked as Good To Go, processes files by transfer date, manages sub-procedure execution and updates file status.

  2. Temporary Table: Truncates existing temporary data, imports inbound data, converts date formats and validates the structure.

  3. Employee in Post Process: Validates employment records, post references and addition heading details, then creates or updates employee post records.

  4. Work Pattern Process: Validates employment, employee in post and work pattern records, manages work pattern history and handles date overlaps.

  5. Spine Point Process: Validates employment, post, grade and spine point data, then manages spine point history and date overlaps.

Process flow details

  • Files are processed in transfer date order.

  • Each file passes through the relevant sub-processes.

  • Processing continues even if individual records fail.

  • Files are marked as processed when processing is complete.

Data validation rules

  1. Employment record must exist.

  2. Post reference must be valid.

  3. Work Pattern must be valid.

  4. FTE factor value must align with the calculation method.

  5. Grade must exist in the system.

  6. Spine point must be valid.

  7. Dates must be properly formatted and logical.