Payroll lines
Delete a payroll line
Deletes a specific payroll line for an employee.
DELETE
/
payroll
/
line
/
{employeeId}
/
{lineId}
Delete a payroll line
curl --request DELETE \
--url https://api.sandbox.flowpayroll.ai/v1/payroll/line/{employeeId}/{lineId} \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"id": "PAYLINE-001",
"clientId": "CLIENT-001",
"employeeId": "EMPLOYEE-001",
"date": "2024-05-20",
"payrollDate": "2024-07-06",
"originalValue": 123,
"canEdit": true,
"description": "Morning shift",
"unitType": "Amount",
"units": 8,
"payRate": 10.5,
"chargeRate": 15.5,
"chargeUnits": 1,
"chargeDescription": "<string>",
"payElementId": "PAYELEM-001",
"eligibility": {
"courtOrders": {
"cmsDeo": true,
"dea": true,
"aeoPriority": false,
"aeoNonPriority": false,
"ctaeo": false,
"ea": false,
"mcaeo": false
}
},
"paymentDetails": {
"accountName": "CMS Central Account",
"accountNumber": "12345678",
"sortCode": "12-34-56",
"paymentReference": "CMS-2025-UK01",
"paymentCategory": "CourtOrders"
},
"lineItemMetadata": {
"courtOrders": {
"protectedEarningsAmount": 100,
"shortfallCarryForward": 0,
"rateType": "StandardTable",
"adminFeeApplied": true,
"tableType": "A",
"remittanceReference": "REF123",
"remittanceDeadline": "5 days",
"jurisdiction": "ENGLAND",
"aeoCategory": "Priority"
}
},
"isPensionable": true,
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"attachments": [
{
"id": "<string>",
"lineItemId": "<string>",
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123,
"uploadedDate": "2023-11-07T05:31:56Z",
"uploadedBy": "<string>",
"downloadUrl": "<string>",
"downloadUrlExpiresAt": "2023-11-07T05:31:56Z"
}
],
"attachmentUploadUrls": [
{
"attachmentId": "<string>",
"filename": "<string>",
"uploadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
],
"invoiceId": "INV-001",
"creditNoteId": "CN-001",
"billingStatus": "None",
"poNumber": "PO-12345"
},
"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>"
}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
Access token obtained from OAuth2 client credentials flow
Was this page helpful?
⌘I
Delete a payroll line
curl --request DELETE \
--url https://api.sandbox.flowpayroll.ai/v1/payroll/line/{employeeId}/{lineId} \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"id": "PAYLINE-001",
"clientId": "CLIENT-001",
"employeeId": "EMPLOYEE-001",
"date": "2024-05-20",
"payrollDate": "2024-07-06",
"originalValue": 123,
"canEdit": true,
"description": "Morning shift",
"unitType": "Amount",
"units": 8,
"payRate": 10.5,
"chargeRate": 15.5,
"chargeUnits": 1,
"chargeDescription": "<string>",
"payElementId": "PAYELEM-001",
"eligibility": {
"courtOrders": {
"cmsDeo": true,
"dea": true,
"aeoPriority": false,
"aeoNonPriority": false,
"ctaeo": false,
"ea": false,
"mcaeo": false
}
},
"paymentDetails": {
"accountName": "CMS Central Account",
"accountNumber": "12345678",
"sortCode": "12-34-56",
"paymentReference": "CMS-2025-UK01",
"paymentCategory": "CourtOrders"
},
"lineItemMetadata": {
"courtOrders": {
"protectedEarningsAmount": 100,
"shortfallCarryForward": 0,
"rateType": "StandardTable",
"adminFeeApplied": true,
"tableType": "A",
"remittanceReference": "REF123",
"remittanceDeadline": "5 days",
"jurisdiction": "ENGLAND",
"aeoCategory": "Priority"
}
},
"isPensionable": true,
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"attachments": [
{
"id": "<string>",
"lineItemId": "<string>",
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123,
"uploadedDate": "2023-11-07T05:31:56Z",
"uploadedBy": "<string>",
"downloadUrl": "<string>",
"downloadUrlExpiresAt": "2023-11-07T05:31:56Z"
}
],
"attachmentUploadUrls": [
{
"attachmentId": "<string>",
"filename": "<string>",
"uploadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
],
"invoiceId": "INV-001",
"creditNoteId": "CN-001",
"billingStatus": "None",
"poNumber": "PO-12345"
},
"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>"
}