FIfireserviceusa
JobReferral

Previews loyalty reward that will be issued when closing a job (based on ActualRev delta)

get/api/v1/jobs/{jobId}/referrals/loyalty-rewards/preview

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/preview
  • Auth
    none declared

Path parameters

jobIdinteger required

The job ID

Response

Success

JobIdinteger

The job ID

IsEligibleboolean

Whether the job is eligible for loyalty rewards

MainReferrerIdinteger

The main referrer entity ID

MainReferrerNamestring nullable

The main referrer name

RewardRatenumber double

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

RewardRateDisplaystring nullable

The reward rate display string (e.g., "10%")

TotalRewardAmountnumber double

The total reward amount across all invoices

Messagestring nullable

A message about eligibility status

JobActualRevnumber double

Job ActualRev (new field for ActualRev-based rewards)

AlreadyIssuedThroughnumber double

Amount already issued through previous close cycles

EligibleRevenueDeltanumber double

Eligible revenue delta (ActualRev - AlreadyIssuedThrough)

Changes

No operation changes recorded.