Skip to main content
PUT
/
notifications
/
{notificationId}
/
employee
cURL
curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications/{notificationId}/employee \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "employeeId": "<string>",
  "assignedBy": "<string>",
  "reason": "<string>"
}
'
{
  "content": {
    "data": {
      "notificationId": "<string>",
      "formType": "<string>",
      "issueDate": "2023-11-07T05:31:56Z",
      "effectiveDate": "2023-11-07T05:31:56Z",
      "createdDate": "2023-11-07T05:31:56Z",
      "appliedDate": "2023-11-07T05:31:56Z",
      "dismissedDate": "2023-11-07T05:31:56Z",
      "actionNeeded": true,
      "notificationEmployeeData": {
        "nationalInsuranceNumber": "<string>",
        "worksNumber": "<string>",
        "name": "<string>",
        "title": "<string>",
        "forename": "<string>",
        "surname": "<string>"
      },
      "matchedEmployeeId": "<string>",
      "content": {
        "effectiveDate": "2023-11-07T05:31:56Z",
        "taxYearEnd": 123,
        "formType": "<string>",
        "priority": 123,
        "sequenceNumber": 123,
        "isEmployeeSpecific": true,
        "p6": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "taxCode": "<string>",
          "isWeek1Month1Basis": true,
          "taxRegime": "<string>",
          "totalPreviousPay": 123,
          "totalPreviousPayCurrency": "<string>",
          "totalPreviousTax": 123,
          "totalPreviousTaxCurrency": "<string>",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "p9": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "taxCode": "<string>",
          "isWeek1Month1Basis": true,
          "taxRegime": "<string>",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "sL1": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "loanType": "<string>",
          "planType": "<string>",
          "loanStartDate": "2023-11-07T05:31:56Z",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "sL2": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "loanType": "<string>",
          "loanEndDate": "2023-11-07T05:31:56Z",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "pgL1": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "loanType": "<string>",
          "planType": "<string>",
          "loanStartDate": "2023-11-07T05:31:56Z",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "pgL2": {
          "employeeNationalInsuranceNumber": "<string>",
          "worksNumber": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "loanType": "<string>",
          "loanEndDate": "2023-11-07T05:31:56Z",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "ar": {
          "reminderType": "<string>",
          "taxYear": "<string>",
          "dueDate": "2023-11-07T05:31:56Z",
          "amountDue": 123,
          "hmrcOffice": "<string>",
          "agentName": "<string>",
          "employerRef": "<string>",
          "employerAddressLines": [
            "<string>"
          ],
          "employerPostCode": "<string>",
          "employerCountry": "<string>",
          "aoRef": "<string>",
          "hmrcOfficeNumber": "<string>",
          "hmrcOfficeReference": "<string>",
          "hmrcOfficeName": "<string>",
          "hmrcOfficeAddressLines": [
            "<string>"
          ],
          "hmrcTelephoneNumber": "<string>",
          "hmrcTelephoneExtension": "<string>",
          "hmrcTelephoneType": "<string>",
          "hmrcTelephoneMobile": "<string>",
          "hmrcTelephonePreferred": "<string>",
          "agentId": "<string>",
          "agentAddressLines": [
            "<string>"
          ],
          "agentPostCode": "<string>",
          "agentCountry": "<string>",
          "liabilityTypes": [
            "<string>"
          ],
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "rti": {
          "employeeNationalInsuranceNumber": "<string>",
          "payrollId": "<string>",
          "employeeName": "<string>",
          "employeeTitle": "<string>",
          "employeeInitials": "<string>",
          "employeeSurname": "<string>",
          "correlationId": "<string>",
          "requiredAction": "<string>",
          "correctNino": "<string>",
          "providedNino": "<string>",
          "isFromNinoVerificationRequest": true,
          "isFromFullPaymentSubmission": true,
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "p35": {
          "notificationType": "<string>",
          "messageText": "<string>",
          "periodEnding": "2023-11-07T05:31:56Z",
          "headerText": "<string>",
          "employerRef": "<string>",
          "employerAddressLines": [
            "<string>"
          ],
          "employerPostCode": "<string>",
          "employerCountry": "<string>",
          "aoRef": "<string>",
          "hmrcOfficeNumber": "<string>",
          "hmrcOfficeReference": "<string>",
          "hmrcOfficeName": "<string>",
          "hmrcOfficeAddressLines": [
            "<string>"
          ],
          "hmrcTelephoneNumber": "<string>",
          "hmrcTelephoneExtension": "<string>",
          "hmrcTelephoneType": "<string>",
          "hmrcTelephoneMobile": "<string>",
          "hmrcTelephonePreferred": "<string>",
          "agentId": "<string>",
          "agentName": "<string>",
          "agentAddressLines": [
            "<string>"
          ],
          "agentPostCode": "<string>",
          "agentCountry": "<string>",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "p11Db": {
          "notificationType": "<string>",
          "messageText": "<string>",
          "periodEnding": "2023-11-07T05:31:56Z",
          "formType": "<string>",
          "headerText": "<string>",
          "taxYearEnd": 123,
          "employerRef": "<string>",
          "employerAddressLines": [
            "<string>"
          ],
          "employerPostCode": "<string>",
          "employerCountry": "<string>",
          "aoRef": "<string>",
          "hmrcOfficeNumber": "<string>",
          "hmrcOfficeReference": "<string>",
          "hmrcOfficeName": "<string>",
          "hmrcOfficeAddressLines": [
            "<string>"
          ],
          "hmrcTelephoneNumber": "<string>",
          "hmrcTelephoneExtension": "<string>",
          "hmrcTelephoneType": "<string>",
          "hmrcTelephoneMobile": "<string>",
          "hmrcTelephonePreferred": "<string>",
          "agentId": "<string>",
          "agentName": "<string>",
          "agentAddressLines": [
            "<string>"
          ],
          "agentPostCode": "<string>",
          "agentCountry": "<string>",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "cis": {
          "messageText": "<string>",
          "uniqueId": "<string>",
          "defaultPeriodEnding": "2023-11-07T05:31:56Z",
          "employerAccountsOfficeReference": "<string>",
          "subcontractorInfo": [
            {
              "name": "<string>",
              "utr": "<string>",
              "directCostOfMaterialsAmount": 123,
              "totalPaymentsMadeAmount": 123
            }
          ],
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "incentive": {
          "incentiveType": "<string>",
          "messageText": "<string>",
          "incentiveAmount": 123,
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "penalty": {
          "penaltyType": "<string>",
          "messageText": "<string>",
          "periodEnding": "2023-11-07T05:31:56Z",
          "dateOfReceipt": "2023-11-07T05:31:56Z",
          "penaltyAmount": 123,
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "nonFiling": {
          "noticeType": "<string>",
          "messageText": "<string>",
          "periodEnding": "2023-11-07T05:31:56Z",
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        },
        "generic": {
          "messageText": "<string>",
          "notificationType": "<string>",
          "messageTypeId": 123,
          "messageTypeTitle": "<string>",
          "dutyType": "<string>",
          "informationItems": [
            {
              "id": "<string>",
              "displayName": "<string>",
              "value": "<string>",
              "sequence": 123,
              "valueType": "<string>"
            }
          ],
          "changeItems": [
            {
              "id": "<string>",
              "displayName": "<string>",
              "previousValue": "<string>",
              "newValue": "<string>",
              "sequence": 123,
              "previousValueType": "<string>",
              "newValueType": "<string>"
            }
          ],
          "actionRequired": "<string>",
          "actionDescription": "<string>",
          "actionDueDate": "2023-11-07T05:31:56Z"
        }
      },
      "rawXml": "<string>",
      "createdBy": "<string>",
      "appliedBy": "<string>",
      "dismissedBy": "<string>",
      "appliedChanges": {
        "previousTaxCode": "<string>",
        "previousIsWeek1Month1": true,
        "newValue": "<string>",
        "changeType": "<string>",
        "capturedAt": "2023-11-07T05:31:56Z"
      }
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

Authentication token for API access

Path Parameters

​
notificationId
string
required

Body

application/json
​
employeeId
string
required
​
assignedBy
string
required
​
reason
string | null

Response

OK

​
content
object
​
metadata
object
​
errors
object[] | null
​
message
object