Get notifications

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications"

headers = {
    "X-Auth-Token": "<api-key>",
    "X-Org-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Auth-Token: <api-key>",
    "X-Org-Id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("X-Org-Id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications")
  .header("X-Auth-Token", "<api-key>")
  .header("X-Org-Id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/hmrc-dps/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ]
  },
  "content": {
    "data": {
      "notifications": [
        {
          "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"
          }
        }
      ],
      "totalCount": 123,
      "dueCount": 123,
      "appliedCount": 123,
      "dismissedCount": 123,
      "paginationToken": "<string>",
      "hasMorePages": true,
      "pageSize": 123
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ]
  },
  "content": {
    "data": {
      "error": "<string>",
      "message": "<string>",
      "details": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ]
}