Skip to main content
GET
Get test-in-live FPS submission details

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
payroll_status_id
string
required

Response

Successful Response

sm_id
string
required
state
enum<string>
required
Available options:
CREATED,
VALIDATED,
SUBMITTED,
ACKNOWLEDGED,
SUCCESS,
DELETED,
ERROR,
ARCHIVED
fps_kind
enum<string>
required

FPS-TIL for a test-in-live submission, FPS for a live one

Available options:
FPS,
FPS-TIL
tax_year
integer
required
tax_month
integer
required
created_at
string<date-time>
required
submitted_at
string<date-time> | null

SUBMITTED transition

acknowledged_at
string<date-time> | null

First ACKNOWLEDGED transition: when polling found HMRC still processing. Depends on polling frequency; null if HMRC answered finally on the first poll.

completed_at
string<date-time> | null

SUCCESS or ERROR transition

fps_document
Fps Document · object | null

The validated FPS document, keyed by field name; null before it's validated

hmrc_response
string | null

HMRC's terminal response (success or rejection) as XML; null until HMRC has given one