Skip to content
/
Update queue item status

Update queue item status

Request

Requires scope: payroll_hours.

You can update the status of a queue item in Dyflexis when processing the payroll period queue. The status is displayed in the Dyflexis payroll page.

Security
apiKey(Required scopes: payroll_hours)
Path
queueIdstringrequired

The queue item id for which to update the status

Bodyapplication/jsonrequired
statusstring(PayrollStatus)required
One of:

One of "in progress", "success", "failed", "partial"

string
Enum:"in progress""success""failed""partial"
applicationstringrequired

An external application identifier. This allows multiple applications to process queue items and send individual status updates.

messagestring, <= 1000 characters

The reason for this status

Example:"Invalid contract for user 125"
urlstring, <= 255 characters

URL for more information about this status

Example:"https://www.example-payrollapplication.com/api-processing/error/1234-AA9D"
curl -i -X POST \
  'https://developer.dyflexis.com/_mock/openapi/api2/payroll/queue/{queueId}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "in progress",
    "application": "string",
    "message": "Invalid contract for user 125",
    "url": "https://www.example-payrollapplication.com/api-processing/error/1234-AA9D"
  }'

Responses

OK

Bodyapplication/json
payrollPeriodStatusobject
Response
{
  "payrollPeriodStatus": {
    "queueId": 0,
    "application": "string",
    "status": "string",
    "message": "string",
    "url": "string"
  }
}