FIfireserviceusa
JobReferral

Manually creates a new loyalty reward for a referring entity

post/api/v1/jobs/{jobId}/referrals/loyalty-rewards

Request

  • Base URL
    https://api.fireserviceusa.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.fireserviceusa.com/api/v1/jobs/{jobId}/referrals/loyalty-rewards
  • Auth
    none declared

Path parameters

jobIdinteger required

The job ID

Request body

ReferringEntityIdinteger

The referring entity ID to receive the reward

JobIdinteger nullable

The job ID for this reward (optional, can override URL parameter)

LoyaltyRewardAmountnumber double

The loyalty reward amount

IsApprovedboolean nullable

Whether to auto-approve the reward (default: true)

DateApprovedstring date-time nullable

The date the reward was approved (defaults to now if approved)

Response

Success

Idinteger

The loyalty reward record ID

JobIdinteger nullable

The job ID (null if loyalty reward is not tied to a specific job)

ReferringEntityIdinteger

The referring entity ID

ReferringEntityNamestring nullable

The referring entity name

DateCreatedstring date-time

The date created

DateApprovedstring date-time nullable

The date approved

IsApprovedboolean

Whether the loyalty reward is approved

LoyaltyRewardAmountnumber double

The loyalty reward amount

LoyaltyRewardsRatenumber double nullable

The loyalty rewards rate (decimal, e.g., 0.10 for 10%)

Statusstring nullable

The status of the loyalty reward

CreatedBystring nullable

Created by user

ApprovedBystring nullable

Approved by user

Changes

No operation changes recorded.