List the lock history of a payroll run

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payroll/{payrollConfigId}/{year}/{period}/history \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/payroll/{payrollConfigId}/{year}/{period}/history"

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/payroll/{payrollConfigId}/{year}/{period}/history', 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/payroll/{payrollConfigId}/{year}/{period}/history",
  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/payroll/{payrollConfigId}/{year}/{period}/history"

	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/payroll/{payrollConfigId}/{year}/{period}/history")
  .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/payroll/{payrollConfigId}/{year}/{period}/history")

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": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": [
      {
        "cycle": 123,
        "unlockedEmployeeIds": [
          "<string>"
        ],
        "fpsSubmissions": [
          {
            "status": "<string>",
            "recordedDate": "<string>",
            "submissionId": "<string>",
            "submissionDate": "<string>",
            "correlationId": "<string>",
            "lateReason": "<string>",
            "previewDownloadUrl": "<string>",
            "submissionDownloadUrl": "<string>",
            "errors": [
              "<string>"
            ],
            "hmrcResponse": "<string>"
          }
        ],
        "current": true,
        "lockedBy": "<string>",
        "lockedDate": "<string>",
        "completedDate": "<string>",
        "unlockedBy": "<string>",
        "unlockedDate": "<string>",
        "unlockReason": "<string>",
        "unlockScope": "<string>",
        "lateReportingReason": "<string>",
        "totalBalances": {
          "baseValues": {
            "gross": 306,
            "grossTaxable": 306,
            "grossNi": 306,
            "grossForEmployerNi": 306,
            "grossForEmployerClass1ANi": 306,
            "grossPensionable": 306,
            "grossForCourtOrders": 306,
            "tax": 45.2,
            "ni": 25.3,
            "pension": 0,
            "employerNi": 35.4,
            "employerClass1ANI": 35.4,
            "employerPension": 0,
            "studentLoan": 0,
            "postgraduateLoan": 0,
            "net": 235.5,
            "netDeductions": 0,
            "totalPayable": 235.5,
            "totalEmployerCost": 306,
            "niBand": {},
            "statutory": {
              "SSP": 0,
              "SMP": 0
            },
            "pensionContributionsByType": {
              "NetPayArrangement": 0,
              "ReliefAtSource": 0,
              "SalarySacrifice": 0
            },
            "qualifyingEarningsForPension": 0,
            "apprenticeshipLevy": 1.53,
            "employmentAllowance": 0,
            "apprenticeshipLevyAllowance": 0,
            "statutoryRecovery": {
              "StatutoryMaternityPay": {
                "reclaimed": 100,
                "nicCompensationRecovered": 8.5
              }
            },
            "isEmpty": false,
            "pensionRefundsByType": {
              "ReliefAtSource": 146.76
            },
            "employerPensionRefundsByType": {
              "ReliefAtSource": 110.07
            }
          },
          "statutoryPaymentsReclaims": {}
        },
        "reopenExpected": 123,
        "reopenDone": 123,
        "unlockOverriddenBy": "<string>",
        "unlockedWith": "<string>",
        "leaversWithIssuedP45": [
          "<string>"
        ]
      }
    ]
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}