Record a PAYE payment for a specific tax year and period

curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>' \
  --data '
{
  "paymentReference": "PAYE_2024_001",
  "amountPaid": 1500,
  "paymentDate": "2024-05-22",
  "notes": "BACS payment via online banking"
}
'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period}"

payload = {
    "paymentReference": "PAYE_2024_001",
    "amountPaid": 1500,
    "paymentDate": "2024-05-22",
    "notes": "BACS payment via online banking"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "X-Org-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-Token': '<api-key>',
    'X-Org-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    paymentReference: 'PAYE_2024_001',
    amountPaid: 1500,
    paymentDate: '2024-05-22',
    notes: 'BACS payment via online banking'
  })
};

fetch('https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period}', 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/organisation/balances/paye-payments/{taxYear}/period/{period}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentReference' => 'PAYE_2024_001',
    'amountPaid' => 1500,
    'paymentDate' => '2024-05-22',
    'notes' => 'BACS payment via online banking'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period}"

	payload := strings.NewReader("{\n  \"paymentReference\": \"PAYE_2024_001\",\n  \"amountPaid\": 1500,\n  \"paymentDate\": \"2024-05-22\",\n  \"notes\": \"BACS payment via online banking\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("X-Org-Id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period}")
  .header("X-Auth-Token", "<api-key>")
  .header("X-Org-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentReference\": \"PAYE_2024_001\",\n  \"amountPaid\": 1500,\n  \"paymentDate\": \"2024-05-22\",\n  \"notes\": \"BACS payment via online banking\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period}")

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

request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentReference\": \"PAYE_2024_001\",\n  \"amountPaid\": 1500,\n  \"paymentDate\": \"2024-05-22\",\n  \"notes\": \"BACS payment via online banking\"\n}"

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

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>",
  "data": {
    "paymentReference": "PAYE_2024_001",
    "amountPaid": 1500,
    "paymentDate": "2024-05-22",
    "paymentId": "PAY_2024_001",
    "organisationId": "org_123",
    "dueDate": "2024-05-22",
    "isOnTime": true,
    "period": 5,
    "taxYear": 2024,
    "createdDate": "2024-05-22T10:00:00Z",
    "createdBy": "user_123",
    "updatedDate": "2024-05-22T10:00:00Z",
    "updatedBy": "user_123",
    "notes": "BACS payment via online banking"
  }
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}