Sign in
Payroll

Delete Rule

Delete a rule for a pay statement item.

delete/employer/pay-statement-item/rule/{rule_id}

Query parameters

entity_idsstring[]

The entity IDs to delete the rule for. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

Successfully Deleted

idstring uuid

Finch id (uuidv4) for the rule.

priorityinteger

The priority of the rule.

created_atstring date-time

The datetime when the rule was created.

updated_atstring date-time

The datetime when the rule was last updated.

deleted_atstring date-time

The datetime when the rule was deleted.

effective_start_datestring nullable
effective_end_datestring nullable
entity_type'pay_statement_item'

The entity type to which the rule is applied.

Changes

Changed in 4 of the 53 revisions of this API.14

  • 0105d239fcaf1See the full diff
    • ○

      added the new optional query request parameter entity_ids

      new-optional-request-parameter

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 46640c1b46881See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

  • 57fcc886b05911See the full diff
    • ●

      removed the optional property allOf[CreateRuleRequest]/priority from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property allOf[subschema #1]/priority to the response with the 200 status

      response-optional-property-added

  • 0bd8297838a81See the full diff
    • ○

      endpoint added

      endpoint-added