Standard API
Standard Payslip API
Method:
Endpoint: /payslip/{AccountReference}/{periodid}
The key dependencies are:
AccountReference
- Cannot be Null
- You must input an existing Account Reference
PeriodId
- Cannot be Null
- You must input a periodid
- Format supported 20231001000
The optional parameters are:
BusinessUnitReference - string
WorkerReference - string
If you do not supply the correct information, then the response will return a 404 message.
Page – decimal only minimum 1, max 10
Size – decimal only max 50 – this defines how many records to return in the response at one time.
If the results are displayed, then it should return 200 OK with results.
Response key mapping
Location
Response body properties
key
header
"workerReference": "156435",
"paymentDate": "12/01/2024",
"payePeriod": "41",
"title": "Mr",
"forename": "Unique",
"surname": "Hackett",
"dob": "21/04/1986",
"address1": "6727 Efrain Creek",
"address2": "",
"address3": "",
"town": "Leicester",
"county": "Leicestershire",
"postcode": "LE4 5NU",
"internationalAddress": true,
"Country": "France",
"niNumber": "NR156435B",
"niLetter": "A",
"taxCode": "C1257L",
"taxReference": "328/A328",
"paymentMethod": "BACS",
"grossPayThisPeriod": "144.00",
"netThisPeriod": "144.00",
"niThisPay": "0.00",
"periodNo": "41",
"workerEngagementType": "PAYE",
"payeDate": "05/01/2024",
"taxBasis": "NC",
"paymentFrequency": "W",
"accountName": "New NI Jan Change",
"businessUnit": "Default Unit",
"email": " tawef48287@othao.com ",
"message": "this is a message",
NC = Non Cumulative and isWeek1 = falseC = Cumulative and isWeek1 = true
W = WeeklyM = Monthly
Payslip Message set in the account configuration
Payments/timesheets
"payments": [
{
"reference": "TS00039A",
"weekEnding": "05/01/2024",
"payElementName": "Payment - Basic Pay",
"payHours": "12.00",
"payRate": "12.00",
"payValue": "144.00",
"workedWeek": "41"
}
],
deductions
"deductions": [
{
"name": "Paye - Paye Deductions",
"amount": "0.00"
},
{
"name": "EeNi - Employee NI",
"amount": "0.00"
}
footer
"yearToDateTotals": {
"grossPay": "624.00",
"payeTax": "147.60",
"pensionablePay": "0",
"taxablePay": "1624.00",
"nonTaxablePay": "0.00",
"niablePay": "624.00",
"ni": "28.56",
"erNi": "42.09",
"erPension": "0",
"vat": "0"
footer
"taxPeriodSummary": {
"taxablePay": "144.00",
"erNi": "0.00",
"erPension": "0.00",
"niablePay": "144.00"
Example responses
PAYE worker
{"items": [{"workerReference": "321253","paymentDate": "2024-01-12T00:00:00","payePeriod": "41","title": "Mr","forename": "Alexandro","surname": "Schimmel","dob": "1986-04-21T00:00:00","address1": "53825 Adell Inlet","address2": "","address3": "","town": "Leicester","county": "Leicestershire","postcode": "LE4 5NU","country": "France","internationalAddress": true,"niNumber": "NR321253B","niLetter": "A","taxCode": "1257L","taxReference": "328/A328","paymentMethod": "BACS","grossPayThisPeriod": 4000.00,"netThisPeriod": 2615.02,"niThisPay": 200.82,"periodNo": "41","workerEngagementType": "PAYE","payeDate": "2024-01-05T00:00:00","taxBasis": "NC","paymentFrequency": "W","accountName": "New NI Jan Change","businessUnit": "Default Unit","email": "Raymundo@test.com","message": "this is a message","payments": [{"reference": "TS00049A","weekEnding": "2024-01-05T00:00:00","name": "Payment - Basic Pay","units": 50.00,"rate": 40.00,"amount": 2000.00,"workedWeek": "41"},{"reference": "TS00050A","weekEnding": "2023-12-22T00:00:00","name": "Payment - Basic Pay","units": 50.00,"rate": 40.00,"amount": 2000.00,"workedWeek": "39"}],"deductions": [{"name": "Deduction - EE Pension","units": 1.00,"rate": 67.76,"amount": 67.76,"workedWeek": "41"},{"name": "Paye - Paye Deductions","units": 1.00,"rate": 1116.40,"amount": 1116.40,"workedWeek": "41"},{"name": "EeNi - Employee NI","units": 1.00,"rate": 200.82,"amount": 200.82,"workedWeek": "41"}],"yearToDateTotals": {"grossPay": 5200.00,"payeTax": 1359.60,"pensionablePay": 5200.00,"taxablePay": 6200.00,"niablePay": 5200.00,"ni": 286.74,"erNi": 621.00,"erPension": 80.62},"taxPeriodSummary": {"taxablePay": 4000.00,"erNi": 503.70,"erPension": 50.82,"niablePay": 4000.00}}],"count": 1,"iteration": 1,"size": 50}
Contractor worker paid inside IR35
{"supplierReference": "31764","supplierName": "EETT","supplierUtr": "1234567890","workerReference": "31764","paymentDate": "12/01/2024","payePeriod": "41","title": "Mr","forename": "Xander","surname": "Thiel","dob": "15/10/1986","address1": "75 Exploration Drive","address2": "","address3": "","town": "Leicester","county": "Leicestershire","postcode": "LE4 5NU","country": "Japan","internationalAddress": true,"niNumber": "NR421221B","niLetter": "A","taxCode": "1257L","taxReference": "328/A328","paymentMethod": "BACS","grossPayThisPeriod": 572.80,"netThisPeriod": 482.20,"niThisPay": 30.20,"periodNo": "41","workerEngagementType": "Contractor","payeDate": "05/01/2024","insideIr35": true,"taxBasis": "NC","paymentFrequency": "W","vatNumber": "GB1234","companyName": "EETT","accountName": "New NI Jan Change","businessUnit": "Default Unit","email": "EETT@worker.com","message": "this is a message","payments": [{"reference": "TS00043A","weekEnding": "05/01/2024","payElementName": "Payment - Basic Pay","payHours": 12.00,"payRate": 12.00,"payValue": 144.00,"workedWeek": "41"},{"reference": "WR00017A","weekEnding": "05/01/2024","payElementName": "Payment - VAT Adjustment","payValue": 400.00},{"weekEnding": "05/01/2024","payElementName": "Vat - VAT","payValue": 28.80,"vatRate": "V1"}],"deductions": [{"name": "Paye - Paye Deductions","amount": 60.40},{"name": "EeNi - Employee NI","amount": 30.20}],"yearToDateTotals": {"grossPay": 1444.00,"payeTax": 192.00,"taxablePay": 1444.00,"nonTaxablePay": -400.00,"niablePay": 1444.00,"ni": 109.16,"erNi": 150.97,"vat": 608.80},"taxPeriodSummary": {"taxablePay": 544.00,"erNi": 50.92,"niablePay": 544.00}},
Contractor worker (NON IR35)
{"supplierReference": "31764","supplierName": "EETT","supplierUtr": "1234567890","workerReference": "31764","paymentDate": "12/01/2024","payePeriod": "41","title": "Mr","forename": "Xander","surname": "Thiel","dob": "15/10/1986","address1": "75 Exploration Drive","address2": "","address3": "","town": "Leicester","county": "Leicestershire","postcode": "LE4 5NU","country": "Japan","internationalAddress": true,"niNumber": "NR421221B","niLetter": "A","taxCode": "1257L","taxReference": "328/A328","paymentMethod": "BACS","grossPayThisPeriod": 3400.00,"netThisPeriod": 3400.00,"periodNo": "41","workerEngagementType": "Contractor","payeDate": "05/01/2024","insideIr35": false,"taxBasis": "NC","paymentFrequency": "W","vatNumber": "GB1234","companyName": "EETT","accountName": "New NI Jan Change","businessUnit": "Default Unit","email": "EETT@worker.com","message": "this is a message","payments": [{"reference": "TS00047A","weekEnding": "05/01/2024","payElementName": "Payment - Basic Pay","payHours": 50.00,"payRate": 50.00,"payValue": 2500.00,"workedWeek": "41"},{"reference": "WR00017A","weekEnding": "05/01/2024","payElementName": "Payment - VAT Adjustment","payValue": 400.00},{"weekEnding": "05/01/2024","payElementName": "Vat - VAT","payValue": 500.00,"vatRate": "V1"}],"deductions": [{"name": "Paye - Paye Deductions","amount": 0.00},{"name": "EeNi - Employee NI","amount": 0.00}]},Supplier Agency{"items": [{"supplierReference": "SU00099","supplierName": "Agency Supplier","supplierUtr": "1111111111","workerReference": "W12972A","paymentDate": "2023-06-02T00:00:00","payePeriod": "09","title": "Mr","forename": "Agency","surname": "Two","dob": "1992-04-21T00:00:00","address1": "17 Chartwell Drive","address2": "","town": "Wigston","county": "Leicestershire","postcode": "LE18 2FL","country": "United Kingdom","internationalAddress": false,"niNumber": "NR418175B","taxReference": "328/A328","paymentMethod": "BACS","grossPayThisPeriod": 2500.00,"netThisPeriod": 3000.00,"periodNo": "09","workerEngagementType": "Agency","payeDate": "2023-05-26T00:00:00","paymentFrequency": "W","vatNumber": "11111111","companyName": "Agency Supplier","accountName": "Agency","businessUnit": "Default Unit","email": "Two@test.com","payments": [{"reference": "TS09820A","weekEnding": "2023-03-31T00:00:00","name": "Payment - Basic Pay","units": 50.00,"rate": 50.00,"amount": 2500.00,"workedWeek": "09"},{"weekEnding": "2023-05-26T00:00:00","name": "Vat - VAT","units": 1.00,"rate": 500.00,"amount": 500.00,"vatRate": "V1"}]}],"count": 1,"iteration": 1,"size": 50}
Standard Billing API
Method:
Endpoint: /Invoice/{AccountReference}/{periodid}
The key dependencies are:
AccountReference
- Cannot be Null
- You must input an existing Account Reference
PeriodId
- Cannot be Null
- You must input a periodid
- Format supported 20231001000
The optional parameters are:
BusinessUnitReference - string
CustomerReference - string
If you do not supply the correct information, then the response will return a 404 message.
Page – decimal only minimum 1, max 10
Size – decimal only max 50 – this defines how many records to return in the response at one time.
If the results are displayed, then it should return 200 OK with results.
Response key mapping
Location
Response body properties
Key
header
"number": "INV000065",
"type": "Invoice",
"date": "2023-12-01T00:00:00",
"dueDate": "2023-12-29T00:00:00",
"status": "Draft",
"customerReference": "CU00001A",
"billingSchemeReference": "Default",
"billingPeriod": 20233601000,
"accountPeriod": 20234101000,
"accountReference": "06",
"businessUnitReference": "DEF",
Type = Credit OR
Type = Invoice
Status = Draft
Status = Sent
Status = Confirmed
To address
"toAddress": {
"name": "Billing Contact",
"address1": "test",
"address2": "test",
"town": "test",
"county": "test",
"postCode": "le46rd",
"vatNumber": "12345"
From address
"fromAddress": {
"name": "New NI Jan Change",
"address1": "fsddf",
"address2": "sfdfds",
"postCode": "LE46RD",
"vatNumber": "124"
Timesheets, on costs and backing data elements
"timesheetPayments": [
{
"timesheetRates": [
{
"date": "2024-01-05T00:00:00",
"reference": "TS00039A",
"description": "Basic Pay",
"unit": 50.00,
"rate": 12.00,
"amount": 600.00,
"vatCode": "V1"
},
{
"date": "2024-01-05T00:00:00",
"reference": "TS00039A",
"unit": 1.0,
"rate": 0.00,
"amount": 113.85,
"vatCode": "V0"
},
{
"date": "2024-01-05T00:00:00",
"reference": "TS00039A",
"unit": 1.0,
"rate": 0.00,
"amount": 120.69,
"vatCode": "V0"
},
{
"date": "2024-01-05T00:00:00",
"reference": "TS00039A",
"unit": 1.0,
"rate": 0.00,
"amount": 25.41,
"vatCode": "V1"
}
],
"backingData": [
{
"name": "Worker name: ",
"value": "Unique Hackett"
}
]
},
{
"timesheetRates": [
{
"date": "2024-01-05T00:00:00",
"reference": "TS00046A",
"description": "Basic Pay",
"unit": 50.00,
"rate": 50.00,
"amount": 2500.00,
"vatCode": "V1"
}
],
"backingData": [
{
"name": "Worker name: ",
"value": "Agent One"
}
]
},
{
"timesheetRates": [
{
"date": "2024-01-05T00:00:00",
"reference": "TS00047A",
"description": "Basic Pay",
"unit": 50.00,
"rate": 50.00,
"amount": 2500.00,
"vatCode": "V1"
}
],
"backingData": [
{
"name": "Worker name: ",
"value": "Xander Thiel"
}
]
}
],
Footer: vat breakdowns
"vatBreakdowns": [
{
"code": "V1",
"description": "Standard",
"net": 5625.41,
"rate": 20.00,
"amount": 1125.08
},
{
"code": "V0",
"description": "Zero Rated",
"net": 234.54,
"rate": 0.0,
"amount": 0.00
}
Footer: totals
"totals": {
"vat": 1125.08,
"net": 5859.95,
"gross": 6985.03
},
Footer: bank account and message
"bankAccount": {
"name": "test",
"sortCode": "565665",
"accountNumber": "56656565"
},
"bankDetailText": "Please remit payment to
account for test
- Sort Code: 565665 Account Number: 56656565"
}
Response example:
{"items": [{"number": "INV000065","type": "Invoice","date": "2023-12-01T00:00:00","dueDate": "2023-12-29T00:00:00","status": "Draft","customerReference": "CU00001A","billingSchemeReference": "Default","billingPeriod": 20233601000,"accountPeriod": 20234101000,"accountReference": "06","businessUnitReference": "DEF","toAddress": {"address1": "test","address2": "test","town": "test","county": "test","postCode": "le46rd","vatNumber": "12345"},"fromAddress": {"name": "New NI Jan Change","address1": "fsddf","address2": "sfdfds","postCode": "LE46RD","vatNumber": "124"},"timesheetPayments": [{"timesheetRates": [{"date": "2024-01-05T00:00:00","reference": "TS00039A","description": "Basic Pay","unit": 50.00,"rate": 12.00,"amount": 600.00,"vatCode": "V1"},{"date": "2024-01-05T00:00:00","reference": "TS00039A","unit": 1.0,"rate": 0.00,"amount": 113.85,"vatCode": "V0"},{"date": "2024-01-05T00:00:00","reference": "TS00039A","unit": 1.0,"rate": 0.00,"amount": 120.69,"vatCode": "V0"},{"date": "2024-01-05T00:00:00","reference": "TS00039A","unit": 1.0,"rate": 0.00,"amount": 25.41,"vatCode": "V1"}],"backingData": [{"name": "Worker name: ","value": "Unique Hackett"}]},{"timesheetRates": [{"date": "2024-01-05T00:00:00","reference": "TS00046A","description": "Basic Pay","unit": 50.00,"rate": 50.00,"amount": 2500.00,"vatCode": "V1"}],"backingData": [{"name": "Worker name: ","value": "Agent One"}]},{"timesheetRates": [{"date": "2024-01-05T00:00:00","reference": "TS00047A","description": "Basic Pay","unit": 50.00,"rate": 50.00,"amount": 2500.00,"vatCode": "V1"}],"backingData": [{"name": "Worker name: ","value": "Xander Thiel"}]}],"vatBreakdowns": [{"code": "V1","description": "Standard","net": 5625.41,"rate": 20.00,"amount": 1125.08},{"code": "V0","description": "Zero Rated","net": 234.54,"rate": 0.0,"amount": 0.00}],"totals": {"vat": 1125.08,"net": 5859.95,"gross": 6985.03},"bankAccount": {"name": "test","sortCode": "565665","accountNumber": "56656565"},"bankDetailText": "Please remit payment to account for test - Sort Code: 565665 Account Number: 56656565"}],"count": 1,"iteration": 1,"size": 50}
Standard Payslip PDF API
Method:
Endpoint:{{publicApiUrl}}/DocumentExport/{{accountReference}}/{{businessUnitReference}}/Payslip/periodid
The key dependencies are:
AccountReference
- Cannot be Null
- You must input an existing Account Reference
BusinessUnitReference
- Cannot be null
- You must input an existing businessUnitReference
PeriodId
- Cannot be Null
- You must input a periodid
- Format supported 20231001000
Required parameters are:
workerReference
- string
Standard Invoice PDF API
Method:
Endpoint:{{publicApiUrl}}/DocumentExport/{{accountReference}}/{{businessUnitReference}}/Invoice/InvoiceReference
The key dependencies are:
AccountReference
- Cannot be Null
- You must input an existing Account Reference
BusinessUnitReference
- Cannot be null
- You must input an existing businessUnitReference
PeriodId
- Cannot be Null
- You must input a periodid
- Format supported 20231001000
Standard Remittance PDF API
The key dependencies are:
AccountReference
- Cannot be Null
- You must input an existing Account Reference
BusinessUnitReference
- Cannot be null
- You must input an existing businessUnitReference
PeriodId
- Cannot be Null
- You must input a periodid
- Format supported 20231001000
Required parameters are:
SupplierReference
- string
The contents of this document, along with any associated documents, are the property of PurePro Solutions Ltd. and are shared in strict confidence with the intended recipient. These materials may not be reproduced, shared, or used in any manner without prior written consent from PurePro Solutions Ltd. Unauthorized use or distribution is prohibited.