Job

SubmitWorkAuthorization

Changed on
post/api/v1/Jobs/SubmitWorkAuthorizationFromProject

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

Query parameters

isVerbalAuthboolean
jobIdinteger

Request body

JobIdinteger
JobIdStringstring nullable
JobNamestring required
JobStartDatestring date-time nullable
JobEndDatestring date-time nullable
JobCloseDatestring date-time nullable
LastDayOfWorkstring date-time nullable
LienDatestring date-time nullable

Lien due date — auto-set to LastDayOfWork + 90 days when Last Day of Work is entered/updated.

JobAccountIdinteger required
JobAddressIdinteger nullable
BillAccountIdinteger nullable
ReferringAccountIdinteger nullable
BillAddressIdinteger nullable
BillAddressIdV2integer nullable

The V2 billing address ID.

JobAddressIdV2integer nullable

The V2 job address ID.

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
JobContactIdinteger nullable
JobTypeIdinteger required
JobSubTypeIdinteger
JobStatusIdinteger nullable
DivisionIdinteger nullable
TeamIdinteger nullable
BusDevUserstring nullable
ReceivedByIdinteger nullable
ReportedByIdinteger nullable
AdSourceIdinteger nullable
ReferredContactIdinteger nullable
LossDescriptionIdinteger nullable
LossInstructionIdinteger nullable
LossDirectionIdinteger nullable
SpecialBillingInstructionsIdinteger nullable
InActiveboolean
Reconciledboolean
Signedboolean
Signaturestring byte nullable
Reviewedboolean
Closedboolean
IsSelfPayboolean
FullyPaidboolean
VerbalAuthboolean
AccountingAuthboolean
ThirtyDayNoticeSentboolean
LienLetterSentboolean
StartAfter5PMboolean
NTOSentboolean
ThirtyDayLetterUrlstring nullable
ClaimOfLienLetterUrlstring nullable
ClaimOfLienCoverLetterUrlstring nullable
SatisfactionOfLienLetterUrlstring nullable
ConditionalWaiverOfLienLetterUrlstring nullable
ContractorFinalPaymentLetterUrlstring nullable
CertOfSatisfactionLetterUrlstring nullable
LegalDemandWithInterestLetterUrlstring nullable
LegalDemandNoInterestLetterUrlstring nullable
RefusalAndReleaseLetterUrlstring nullable
NoticeToOwnerCoverLetterUrlstring nullable
NoticeToOwnerLetterUrlstring nullable
DateNoticeToOwnerLetterSentstring date-time nullable
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
InsuranceCompanyIdinteger nullable
InsuranceClaimNumstring nullable
TpaCompanyIdinteger nullable
PolicyHolderIdinteger nullable
AdjustingCompanyIdinteger nullable
AdjusterIdinteger nullable
ActualRevnumber double nullable
LoyaltyRewardsIssuedThroughActualRevnumber double nullable

Tracks how much ActualRev has already earned loyalty rewards to keep issuance idempotent.

ActualPaynumber double nullable
ActualCostnumber double nullable
EstJobCostnumber double nullable
EstJobRevnumber double nullable
DateSignedstring date-time nullable

Signatures

SignaturePathstring nullable
ReasonCodeIdinteger nullable

ReasonCode

CreateDatestring date-time

Auditing

CreateUserstring nullable
UpdateDatestring date-time
UpdateUserstring nullable
WarmTransferPerformedboolean

ESP

NotesAndPaperworkCompleteboolean
HasDigitalPhotosboolean
HasThermalPhotosboolean
DateOfLastNotestring date-time nullable
MostRecentNotesstring nullable
CommissionPeriodIdinteger nullable
ClosingPeriodstring nullable

Commission period name last written when CommissionPeriodId was set to a period. Reopen clears the id and leaves this name. A later close replaces it.

ClosingPeriodStartDatestring date-time nullable

Display-only range from CommissionPeriods. Not stored on the job.

ClosingPeriodEndDatestring date-time nullable

Display-only range from CommissionPeriods. Not stored on the job.

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
Xactimateboolean

Xactimate Fields

XactimateDatestring date-time nullable
FTPRPCompleteboolean
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

      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

      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)