Jump to Content
API Reference
Latest
Log In
API Reference
Search
Log In
Latest
API Reference
My Requests
All
Pages
Start typing to search…
JUMP TO
Getting Started
Authentication
My Requests
MCP Server
MCP
Organisation Setup
Organisation Setup Overview
Organisation
Information
Update organisation information
post
Get organisation information
get
Get multiple organisation information
get
HMRC
Update the HMRC settings for the current organisation
post
Get the HMRC settings for the current organisation
get
Balances
Get organisation opening balances by tax year
get
Update organisation opening balances by tax year
post
Get year-to-date running balances by tax year
get
Get month to date running balances by tax year and month
get
Payroll Config
Create a new payroll configuration
post
Read all payroll configurations
get
Read a payroll configuration
get
Update a payroll configuration
put
Delete a payroll configuration
del
Pay Elements
Get the pay elements for the current organisation
get
Get a specific pay element by ID
get
Update a specific pay element by ID
put
Delete a specific pay element by ID
del
Create a new pay element for the current organisation
post
Payment
List all available payment configurations
get
Get payment configuration for an organisation
get
Create payment configuration for an organisation
post
Update payment configuration for an organisation
put
Delete payment configuration for an organisation
del
Get payment file for a pay run
get
Pension
Employee pensions
Associate an employee to a pension group
post
Get employee pension association
get
Get employee pension associations (batch)
get
Delete employee pension association
del
Employee postponement
Get employee postponement
get
Update employee postponement
put
Delete employee postponement
del
Pension groups
Get pension group
get
Create pension group
post
Update pension group
put
Delete pension group
del
Pension schemas
Get pension scheme by ID
get
Get pension schemes for organisation
get
Create pension scheme
post
Update pension scheme
put
Delete pension scheme
del
Pension providers
Get pension provider by ID
get
Get pension provider by slug
get
Get pension providers
get
Create pension provider
post
Update pension provider
put
Delete pension provider
del
Pension defaults
Get organisation pension defaults
get
Update auto enrolment settings
put
Update postponement settings
put
Get allowed pension bases
get
Holiday Configuration
Get organisation holiday configuration
get
Create organisation holiday configuration
post
Update organisation holiday configuration
put
Delete organisation holiday configuration
del
Pay API
Pay API Overview
Payroll
Upload payroll lines
post
Get payroll lines for an employee from the effective range only
get
Create a line item attachment
Delete a line item attachment
del
Create payroll run for a given period
post
Create next payroll run
post
Get payroll run(lock) data
get
Locks a payroll
post
Employees
List employees with pagination
get
Create a new employee
post
Get employee data
get
Find employee by National Insurance Number
get
Find employee by Payroll ID
get
Update an existing employee
put
Delete an existing employee
del
Update the leaver details for a specific employee
put
Update the opening balance for an employee
put
Update the payroll configuration for an employee
put
Update the starter details for a specific employee
put
Court Orders
Create court order
post
Get court orders by organisation
get
Get court order
get
Update court order
put
Delete court order
del
Add court order attachments
post
Delete court order attachment
del
Get court orders by employee
get
Create payee
post
Get all payees
get
Get payee
get
Update payee
put
Delete payee
del
Pension
Pension calculations
Get pension calculations by month
get
Get employee pension calculations by month and provider
get
Update employee pension calculation
post
Pension exports
Generate pension calculation export files
post
Get pension calculation export files
get
Get pension calculation CSV
get
Retrieve pension calculation export files
get
Auto enrolment insight
Get auto enrolment assessments by pay run
get
Get complete auto enrolments by pay run
get
Get not auto enrolments
get
Get not complete auto enrolments
get
Employee pension info
Get pension information
get
Enrolment letters
Send enrolment letter
post
Statutory
Preview statutory pay calculation without employee data
post
Calculate statutory pay for an employee
post
Check linking periods for statutory sick pay
post
Get statutory pay history for an employee
get
Create statutory pay record for an employee
post
Get all statutory pay records for an employee
get
Get all statutory pay records for an organisation
get
Get a statutory pay record by ID
get
Get average earnings for an employee
get
Get line items for a statutory pay record
get
Reconcile statutory payments
post
Detect Alabaster pay rises for statutory maternity pay
get
Recalculate Alabaster statutory maternity pay
post
Update pending line items for Alabaster calculation
post
Update a statutory pay record
put
Delete a statutory pay record
del
Get available tax years for statutory rates
get
Get statutory rates for a tax year
get
Payslip
Get all payslip data for an employee within a date range
get
Get all payslips by pay run
get
Create or update payslip metadata such as notes and payment date overwrite
post
Get payslip data for an employee
get
Send payslip notification emails to employees
post
RTI
Eps
Get all EPS submissions by tax year
get
Get EPS submission by tax year and submission ID
get
Submit EPS from monthly balances
post
Submit EPS manually
post
Resubmit EPS manually
post
Fps
Get HMRC RTI FPS for payroll run
get
Trigger send HMRC RTI FPS for payroll run
post
HMRC P Forms
Get HMRC P45 employee form data
get
HMRC DPS
Get Stored Notifications
get
Get Notification
get
Update Notification Status
put
Apply Notification
post
Dismiss Notification
post
Assign Employee
put
Bulk Apply Notifications Async
post
Bulk Dismiss Notifications Async
post
Initialize Organization Pagination
post
Get All Pagination States
get
Start Retrieve All Notifications
post
Get Async Job Status
get
Get Async Jobs
get
Get Last Job
get
Cancel Async Job
post
Holiday
Leave
Get employee leave
get
Create employee leave
post
Update employee leave
put
Delete employee leave
del
Opening Balance
Get employee opening balance
get
Create employee opening balance
post
Update employee opening balance
put
Delete employee opening balance
del
History
Get employee holiday history
get
Get employee average rate
get
Employee Configuration
Get employee holiday configuration
get
Create employee holiday configuration
post
Update employee holiday configuration
put
Bill API
Bill API Overview
Clients
List clients
get
Create a client
post
Get client details
get
Update a client
put
Delete a client
del
Get client finance settings
get
Update client finance settings
put
Unarchive client
patch
Invoices
List invoices for organisation
get
List invoices for client
get
Get invoice details
get
Get invoice line items
get
Update open invoice
put
Update invoice (e.g. close)
patch
Email invoice
post
Add invoice attachments
post
Delete invoice attachment
del
Void invoice
post
Refresh line item mappings
post
Credit entire invoice
post
Bulk invoice action
post
Credit Notes
List credit notes for organisation
get
Create draft credit note
post
List credit notes for client
get
Get credit note by ID
get
List credit note line items
get
Update draft credit note
put
Add credit note attachments
post
Delete credit note attachment
del
Delete draft credit note
del
Authorise credit note
post
Void credit note
post
Allocate credit to invoice
post
Remove credit allocation
del
Finance Settings
List tax rates
get
Create custom tax rate
post
Update tax rate
put
Delete tax rate
del
Archive tax rate
post
Unarchive tax rate
post
List account codes
get
Create account code
post
Update account code
put
Delete account code
del
Archive account code
post
Unarchive account code
post
Get organisation pay element mappings
get
Update organisation pay element mappings
put
Get organisation finance defaults
get
Update organisation finance defaults
put
Get organisation invoice template
get
Update organisation invoice template
put
Get organisation credit note template
get
Update organisation credit note template
put
Get line item description formula placeholders
get
getattachmentlimits
Accounting Sync
Push invoice to accounting provider
post
Push client and contacts to accounting provider
post
Push credit note to accounting provider
post
Download invoice PDF from provider
get
Download credit note PDF from provider
get
List tax rates from connected provider
get
Import tax rates from provider
post
List account codes from connected provider
get
Import account codes from provider
post
List contacts from connected provider
get
Import contacts from provider
post
Integrations
Get OAuth login URI
get
getcallback
Exchange OAuth code for tokens
post
Get integration setup info
get
Save integration credentials
put
Test and save custom connection
post
List integration connections
get
List integration tenants
get
Switch integration tenant
put
Disconnect integration
del
Powered by
••••••8976
Endpoint
Method
Status
User Agent
