Job
Create Job
Changed onpost/api/v1/Jobs
Request
- Base URLhttps://api.fireserviceusa.com (the document declares no server; this is the origin it was published from)
- URLhttps://api.fireserviceusa.com/api/v1/Jobs
- Authnone declared
Query parameters
createJobTypeDependenciesboolean
createProjectboolean
projectIdinteger
Request body
JobIdinteger
JobNamestring nullable
JobAccountIdinteger required
JobAddressIdinteger nullable
JobAddressTypestring nullable
JobAddress1string nullable
JobAddress2string nullable
JobCitystring nullable
JobStatestring nullable
JobCountystring nullable
JobCountrystring nullable
JobZipstring nullable
JobPhone1string nullable
JobPhone1Typestring nullable
JobPhone2string nullable
JobPhone2Typestring nullable
JobEmailstring nullable
BillAddressTypestring nullable
BillAddress1string nullable
BillAddress2string nullable
BillCitystring nullable
BillStatestring nullable
BillCountystring nullable
BillCountrystring nullable
BillZipstring nullable
BillPhone1string nullable
BillPhone1Typestring nullable
BillPhone2string nullable
BillPhone2Typestring nullable
BillEmailstring nullable
StartAfter5PMboolean
FullyPaidboolean
ARTrxCountinteger nullable
JobTrxCountinteger nullable
ReferringAccountIdinteger nullable
BillAccountIdinteger nullable
BillAddressIdinteger nullable
JobAddressIdV2integer nullable
BillAddressIdV2integer nullable
JobContactIdinteger nullable
JobStartDatestring date-time nullable
JobEndDatestring date-time nullable
JobCloseDatestring date-time nullable
LastDayOfWorkstring date-time nullable
LienDatestring date-time nullable
CreateDatestring date-time nullable
JobTypeIdinteger required
JobTypestring nullable
JobTypeCodestring nullable
JobSubTypeIdinteger nullable
JobSubTypestring nullable
JobStatusIdinteger nullable
DivisionIdinteger nullable
Divisionstring nullable
TeamIdinteger nullable
Teamstring nullable
Managerstring nullable
BusDevUserstring nullable
ReceivedByIdinteger nullable
ReportedByIdinteger nullable
AdSourceIdinteger nullable
AdSourcestring nullable
ReferredContactIdinteger nullable
InsuranceClaimNumstring nullable
InsuranceCompanyIdinteger nullable
TpaCompanyIdinteger nullable
PolicyHolderIdinteger nullable
AdjustingCompanyIdinteger nullable
AdjusterIdinteger nullable
LossDescriptionIdinteger nullable
LossDescriptionstring nullable
LossInstructionIdinteger nullable
LossInstructionsstring nullable
SpecialBillingInstructionsIdinteger nullable
SpecialBillingInstructionsstring nullable
LossDirectionIdinteger nullable
LossDirectionsstring nullable
InActiveboolean
Signedboolean
Reviewedboolean
Closedboolean
IsSelfPayboolean
VerbalAuthboolean
AccountingAuthboolean
DateSignedstring date-time nullable
SignaturePathstring nullable
WarmTransferPerformedboolean
NotesAndPaperworkCompleteboolean
HasDigitalPhotosboolean
HasThermalPhotosboolean
WorkAuthUndersignedNamestring nullable
WorkAuthUndersignedRolestring nullable
WorkAuthAddressstring nullable
WorkAuthInsuranceCostring nullable
WorkAuthMortgagestring nullable
WorkAuthFSDKRepNamestring nullable
WorkAuthRespPartyDescstring nullable
WorkAuthFSDKRepDatestring date-time nullable
WorkAuthUndersignedDatestring date-time nullable
WorkAuthUndersignedSignatureUrlstring nullable
WorkAuthFSDKRepSignatureUrlstring nullable
UseSecondaryWorkAuthboolean
ForceUseSecondaryAuthboolean
CatPackCustomerNamestring nullable
CatPackAddressLine1string nullable
CatPackAddressLine2string nullable
CatPackContactNamestring nullable
CatPackContactPhonestring nullable
CatPackUndersignedNamestring nullable
CatPackUndersignedRolestring nullable
CatPackRespPartyDescstring nullable
CatPackFSDKRepNamestring nullable
CatPackNotToExceedAmountstring nullable
CatPackInitialDepositAmountstring nullable
CatPackFSDKRepDatestring date-time nullable
CatPackUndersignedDatestring date-time nullable
CatPackUndersignedInitialDatestring date-time nullable
CatPackUndersignedSignatureUrlstring nullable
CatPackFSDKRepSignatureUrlstring nullable
CatPackUndersignedInitialUrlstring nullable
CatPackPageInitialsobject nullable
CatPackIsSignedboolean
EstRevnumber double nullable
ActRevnumber double nullable
ActCostnumber double nullable
LoyaltyRewardsIssuedThroughActualRevnumber double nullable
Tracks how much ActualRev has already earned loyalty rewards to keep issuance idempotent.
ProjectClosedboolean
HasJobBeenPhasedboolean
JobInspectionDatestring date-time nullable
TimeLine Fields
EstimateSentDatestring date-time nullable
EstimatedCompletionDatestring date-time nullable
DispatchTimestring date-time nullable
ArrivalTimestring date-time nullable
CallTimestring date-time nullable
IsScheduledboolean
FTPRPCompleteboolean
ClosingPeriodstring nullable
Last commission period name written when CommissionPeriodId was set. Empty until the first close.
ClosingPeriodStartDatestring date-time nullable
CommissionPeriods.CommissionPeriodStartDate for the closing period. Not stored on the job.
ClosingPeriodEndDatestring date-time nullable
CommissionPeriods.CommissionPeriodEndDate for the closing period. Not stored on the job.
JobEstimatorIdinteger nullable
NoEstimateProvidedboolean
NoEstimateReasonCodeIdinteger nullable
NoEstimateProvidedReasonstring nullable
InactivationReasonCodeIdinteger nullable
InactivationReasonOtherstring nullable
Response
Success
Changes
- info
added the new optional request property
///(media type: application/json-patch+json) - info
added the new optional request property
///(media type: application/json) - info
added the new optional request property
///(media type: text/json) - info
added the new optional request property
///(media type: application/*+json)
- info