v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB
Payroll

Delete payroll

Delete a payroll entry for the given id

delete/v6/payroll/{id}

Path parameters

idstring required

The id of the payroll

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": {
    "id": "prl_12345",
    "status": "ACTIVE",
    "date": "2024-01-15",
    "description": "Payroll Period 01/01/2024 - 01/15/2024",
    "notes": "Check #1234 issued 2024-01-15",
    "apiName": "GUSTO",
    "apiSourceId": "gst_payroll_20240115",
    "children": [
      {
        "id": "pli_12345",
        "type": "STAFF_WAGES",
        "glAccount": {
          "id": "gla_38560327",
          "name": "Officer(s) Salaries and Wages",
          "accountNo": "60210",
          "type": "EXPENSE",
          "iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png",
          "displayName": "#60210 Officer(s) Salaries and Wages"
        },
        "amount": 500000,
        "reconciliationMatch": {
          "bankAccount": {
            "id": "bka_7542850",
            "name": "Business Checking",
            "displayName": "Business Checking *1687"
          }
        }
      }
    ],
    "customData": {
      "internal_key": "some_internal_key",
      "some_other_field": 23434
    }
  }
}