v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

allowances

Create an allowance and associate it with a location

post/api/serviceattendance/processes/allowances/createAndAssociate

Request body

locationUuidstring uuid

Location UUID to associate the allowance with

locationGroupUuidstring uuid

Location group UUID to associate the allowance with

Example request

{
  "allowance": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2017-07-21T17:32:28Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "b06d1e2a-64a8-40b4-bb05-a817d8049721",
    "allowanceSettingUuid": "e4be1a30-31f3-414d-b1f9-94fff3dda090",
    "type": "overtime",
    "code": "OT_1.5",
    "description": "Overtime pay at 1.5x rate",
    "flatRate": {
      "amount": 15.5,
      "currency": "USD"
    },
    "multiplier": 1.5,
    "minimumHours": 8,
    "updatedAt": "2017-07-21T17:32:28Z",
    "deletedAt": "2017-07-21T17:32:28Z",
    "deletedBy": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
  }
}

Response

Allowance created and associated successfully

uuidstring uuid

createdAtstring date-time

createdBystring uuid

lastUpdatedAtstring date-time

lastUpdatedBystring uuid

lastUpdatedByAudiencestring

lastUpdatedByAudienceUuidstring uuid

lastUpdatedByImpersonatedBystring uuid

lastUpdatedByCompanyUuidstring uuid

lastUpdatedByEnterpriseUuidstring uuid

companyUuidstring uuid

allowanceSettingUuidstring uuid required

type'allowance' | 'holiday' | 'overtime' | 'minimumHours' required

codestring required

descriptionstring required

multipliernumber

minimumHoursnumber

updatedAtstring date-time

deletedAtstring date-time

deletedBystring uuid

automaticBreakSettingsUuidstring uuid

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2017-07-21T17:32:28Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "companyUuid": "b06d1e2a-64a8-40b4-bb05-a817d8049721",
  "allowanceSettingUuid": "e4be1a30-31f3-414d-b1f9-94fff3dda090",
  "type": "overtime",
  "code": "OT_1.5",
  "description": "Overtime pay at 1.5x rate",
  "flatRate": {
    "amount": 15.5,
    "currency": "USD"
  },
  "multiplier": 1.5,
  "minimumHours": 8,
  "updatedAt": "2017-07-21T17:32:28Z",
  "deletedAt": "2017-07-21T17:32:28Z",
  "deletedBy": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
}