1. SCS APIs
SEAdmin & SCS Docs
  • Introduction
  • SCS APIs
    • 01 Authentication Updates
    • 02 Endpoints
    • 03 Get Rates API
    • 04 Get Trims By VIN API
    • 05 Get Lienholders API
    • 06 Generate Contract API
    • 07 Contract Void API
    • 08 Contract Info API
    • 09 Print Contract PDF API
    • 10 Print Generate Contract PDF API
    • 11 Update Contract API
    • 12 Reject Contract API
    • 13 Cancel Contract API
    • 14 Submit Remittance API
    • 15 Validate Generate Contract API
    • 16 Activate Contract API
    • 17 PureFI Claim API and Contract API (REST)
  • SEA APIs
    • Common API Docs
      • API Access
      • Managing Users
      • Introduction
      • Idp API
        • createToken
    • SEA REST APIs
      • Introduction
      • Audiences
      • Digital Retailing
      • ADMIN Users API
      • SEAdmin Swagger
        • GenericAccountHolders_GetAccountHolders
        • GenericAccountHolders_PostAccountHolderStatementRequest
        • GenericAccountHolders_PostAutoExpireRequest
        • AdminCompanies_GetGeneralSettingById
        • Agents_GetAgents
        • Agents_AddAgent
        • Agents_GetAgentById
        • Agents_UpdateAgent
        • Agents_GetCustomFields
        • Agents_AddCustomField
        • Agents_GetCustomFieldById
        • Agents_DeleteCustomField
        • Agents_UpdateCustomField
        • AutomaticProcessRuns_Search
        • AutomaticProcessRuns_Add
        • AutomaticProcessRuns_GetByGuid
        • AutomaticProcessRuns_Update
        • AvailablePaymentMethods_GetAvailablePaymentMethods
        • AvailablePaymentMethods_SaveAvailablePaymentMethod
        • AvailablePaymentMethods_DeleteAvailablePaymentMethod
        • AvailablePaymentMethods_SaveAllAvailablePaymentMethods
        • CancelMethods_GetCancelMethods
        • CancelMethods_GetCancelMethodById
        • CancelReasons_GetCancelReasons
        • CancelReasons_GetCancelReasonById
        • CancelRequests_GetCancelRequestById
        • CancelRequests_ExecuteCancelRequest
        • CancelRequests_GetCancelPaymentDetailsByCancelRequestId
        • Cancels_GetCancelById
        • Cancels_CreateCancelRequest
        • Cancels_GetCancelPaymentDetailsByCancelId
        • CashTransaction_GetCashTransactionSearch
        • CashTransaction_AddCashTransaction
        • CashTransaction_GetCashTransactionById
        • CashTransaction_PatchCashTransaction
        • CashTransaction_GetCustomFields
        • CashTransaction_AddCustomField
        • CashTransaction_GetCustomFieldById
        • CashTransaction_DeleteCustomField
        • CashTransaction_UpdateCustomField
        • ClaimPayees_GetClaimPayees
        • ClaimPayees_AddClaimPayee
        • ClaimPayees_GetClaimPayeeById
        • ClaimPayees_UpdateClaimPayee
        • Claims_GetClaimsSearch
        • Claims_Post
        • Claims_GetClaimById
        • Claims_Put
        • Claims_PatchClaim
        • Claims_GetClaimBenefits
        • Claims_GetClaimDocumentsForGapClaim
        • Claims_addClaimDocument
        • Claims_GetDocumentByGuid
        • Claims_PostClaimInspectionFile
        • Claims_AddInspection
        • Claims_UpdateInspection
        • Claims_TakeRejectInspection
        • ClaimNotes_Post
        • ClaimNotes_Get
        • ClaimNotes_GetAllNotesForClaim
        • Claims_PostPaymentRequest
        • Claims_GetPpmServices
        • Claims_GetCauses
        • Claims_GetComplaintsCausesCorrections
        • Claims_GetComplaints
        • Claims_GetComplaintsCausesCorrectionsTypes
        • Claims_GetCorrections
        • Claims_GetClaimDeniedReasons
        • Claims_GetClaimHoldReasons
        • Claims_GetInspections
        • Claims_GetClaimInspectionById
        • Inspection_SyncInspection
        • Inspection_SyncPostPutInspection
        • Contracts_GetContracts
        • Contracts_Post
        • Contracts_GetContractById
        • Contracts_PatchContract
        • Contracts_GetCancelPaymentDetailsByContractId
        • Contracts_GetCancelRequest
        • Contracts_CreateCancelRequest
        • Contracts_GetCancels
        • Contracts_CancelContract
        • ContractCobuyer_AddCobuyer
        • ContractCobuyer_DeleteCobuyer
        • Contracts_GetCoverageComponents
        • Contracts_GetCoverageGroups
        • Contracts_GetDocuments
        • Contracts_GenerateDocument
        • Contracts_GetContractEarningDetailsById
        • Contracts_GetContractFiles
        • Contracts_AddContractFile
        • Contracts_GetContractFileByGuid
        • Contracts_FinalizeContract
        • Contracts_GetHolds
        • Contracts_CreateHold
        • Contracts_GetResolvesForHold
        • Contracts_CreateResolve
        • Contracts_GetExistingContractLock
        • Contracts_ObtainContractLock
        • Contracts_ReleaseContractLock
        • Contracts_GetPpmServices
        • Contracts_RecalculateContractPurchaseSalesTax
        • Contracts_ReFinalizeContract
        • Contracts_RerateContract
        • Contracts_UpdateEarnings
        • Contracts_PostContractTransfer
        • Contracts_GetDuplicateGAPContracts
        • Contracts_AutoCancelGAPContract
        • Contracts_GetAutoExpireContractIds
        • Contracts_AutoExpireContract
        • Contracts_GetAutoVoidableContractIds
        • Contracts_AutoVoidContract
        • Contracts_DenyClaims
        • Contracts_GetHoldReasons
        • Contracts_UpdateEarnings
        • Customers_GetCustomers
        • Customers_GetCustomerById
        • Customers_UpdateCustomer
        • DealerGroups_GetDealerGroups
        • DealerGroups_AddDealerGroup
        • DealerGroups_GetDealerGroupById
        • DealerGroups_UpdateDealerGroup
        • DealerGroups_GetCustomFields
        • DealerGroups_AddCustomField
        • DealerGroups_GetCustomFieldById
        • DealerGroups_DeleteCustomField
        • DealerGroups_UpdateCustomField
        • Dealers_GetDealers
        • Dealers_AddDealer
        • Dealers_GetDealerById
        • Dealers_UpdateDealer
        • Dealers_GetCustomFields
        • Dealers_AddCustomField
        • Dealers_GetCustomFieldById
        • Dealers_DeleteCustomField
        • Dealers_UpdateCustomField
        • Dealers_GetDealerRateVisibilities
        • Dealers_GetDealersRateVisibilities
        • DisbursementAccounts_GetDisbursementAccounts
        • DisbursementAccounts_AddDisbursementAccount
        • DisbursementAccounts_GetDisbursementAccountById
        • DisbursementAccounts_UpdateDisbursementAccount
        • Documents_GetDocumentById
        • FactorTable_GetFactorTable
        • Files_GetFileById
        • GeneralSettings_GetGeneralSettings
        • GeneralSettings_GetGeneralSettingById
        • GeneralSettings_GetGeneralSettingGroups
        • GeneralSettings_GetGeneralSettingTypes
        • InProcessCashTransaction_GetInProcessCashTransactionSearch
        • InProcessCashTransaction_PostInProcessCashTransaction
        • InProcessCashTransaction_GetInProcessCashTransactionById
        • InProcessCashTransaction_DeleteInProcessCashTransaction
        • InProcessCashTransaction_ProcessInProcessCashTransaction
        • InspectionCompanies_GetInspectionCompanies
        • InspectionCompanies_AddInspectionCompany
        • InspectionCompanies_GetInspectionCompanyById
        • InspectionCompanies_UpdateInspectionCompany
        • Inspection_GetClaimInspectionReasons
        • Insurers_GetInsurers
        • Insurers_AddInsurer
        • Insurers_GetInsurerById
        • Insurers_UpdateInsurer
        • Ledgers_GetLedgersSearch
        • Ledgers_GetPayReceiveLedgers
        • Ledgers_ListUnpaidAccountingLedgerProducts
        • Ledgers_GetLedgerSummary
        • LienHolder_GetLienHolders
        • LienHolder_AddLienHolder
        • LienHolder_GetLienHolderById
        • LienHolder_UpdateLienHolder
        • MembershipGroups_Get
        • MembershipGroups_GetGroupsByIdOrName
        • MembershipRoles_Get
        • MembershipRoles_GetRolessByIdOrNameOrCategory
        • PortalVisibilityGroups_GetPortalVisibilityGroups
        • PortalVisibilityGroups_AddPortalVisibilityGroup
        • PortalVisibilityGroups_UpdatePortalVisibilityGroup
        • PortalVisibilityGroups_GetPortalVisibilityGroupById
        • PortalVisibilityGroups_DeletePortalVisibilityGroup
        • PortalVisibilityGroups_GetPortalVisibilityGroupDealers
        • PortalVisibilityGroups_GetPortalVisibilityGroupByCode
        • PortalVisibilityGroups_GetPortalVisibilityGroupDealersByCode
        • Rates_GetAssetTypes
        • Evaluates the provided criteria string based on the CriteriaRule grammar.
        • Rates_GetDeductiblesByProduct
        • Rates_GetDisbursementById
        • Rates_PatchDisbursementById
        • Rates_GetDisbursementByAccountHolder
        • Rates_AddDisbursementByAccountHolder
        • Rates_GetDisbursementAuditLogById
        • Rates_GetDisbursementCodes
        • Rates_GetDisbursementGroups
        • Rates_GetDisbursementLabels
        • Rates_GetPlans
        • Rates_GetProducts
        • Rates_GetPrograms
        • Rates_GetRateQuote
        • Rates_GetTermsPlanById
        • Rates_GetVehicleBodyStyles
        • Rates_GetVehicleMakes
        • Rates_GetVehicleModels
        • Rates_GetVehicleSegmentations
        • Rates_GetVehicleSeries
        • Rates_GetVehicleTrims
        • Inspection_GetClaimRejectInspectionReasons
        • RepairFacilities_GetRepairFacilities
        • RepairFacilities_AddRepairFacility
        • RepairFacilities_GetRepairFacilityById
        • RepairFacilities_UpdateRepairFacility
        • RepairFacilities_GetDealerGroupsOfRepairFacility
        • RepairFacilities_RemoveDealerGroupsFromRepairFacility
        • RepairFacilities_AddDealerGroupsToRepairFacility
        • RepairFacilities_GetDealersOfRepairFacility
        • RepairFacilities_RemoveDealersFromRepairFacility
        • RepairFacilities_AddDealersToRepairFacility
        • RepairFacilities_GetAssociatedRepairFacility
        • SalesTaxCalculation_GetSalesTaxDetails
        • Users_GetUsers
        • Users_Post
        • Users_Get
        • Users_Put
        • CancelMethods_GetCancelMethodsV2
        • CancelMethods_GetCancelMethodByGuid
        • CancelReasons_GetCancelReasonsV2
        • CancelReasons_GetCancelReasonByGuid
        • CancelRequests_GetCancelRequestByGuid
        • CancelRequests_ExecuteCancelRequest
        • CancelRequests_GetCancelPaymentDetailsByCancelRequestId
        • CashTransaction_GetCashTransactionSearchV2
        • Contracts_GetContractsV2
        • Contracts_GetContractByGuid
        • Contracts_GetCancelPaymentDetailsByContractById
        • Contracts_GetCancelRequest
        • Contracts_CreateCancelRequest
        • LienHolder_GetLienHoldersV2
        • UsersV2_GetUsers
        • UsersV2_Post
        • UsersV2_Get
        • UsersV2_Put
    • SEA Menu Integration Service
      • 04 Request Flow
      • 05 Samples
      • 02 Authentication Updates
      • 03 Endpoints
      • 01 Introduction
  • Schemas
    • AccessToken
    • ARCHService.Api.DTOs.Address
    • Contracts_ReleaseContractLockContractlockid
    • adminapi_ContractSearchResult
    • enterpriserepairorderapi_DMSTypes
    • Cancel Method
    • Cancel Reason
    • Create Contract Cancellation Request
    • Contract
    • Document
    • Refund Payment Details
    • Create Refund Quote Request
    • seainspections_Widget
    • AuthenticatorConfiguration
    • ARCHService.Api.DTOs.AuditLogResponse
    • Agents_UpdateAgentEditdata
    • adminapi_PaginationMetadata
    • enterpriserepairorderapi_DmsDealer
    • Cancel Method Paged Result
    • Cancel Reason Paged Result
    • Cancellation Request Response
    • Contract Summary
    • Unique Identifier
    • Refund Payment
    • Refund Quote
    • seainspections_BadRequest
    • TOTPAlgorithm
    • ARCHService.Api.DTOs.ClassDetail
    • RepairFacilities_AddDealerGroupsToRepairFacilityDealergroupids
    • adminapi_PagedContractSearchResult
    • enterpriserepairorderapi_DmsDealerConfig
    • Unique Identifier
    • Unique Identifier
    • cancellations_BadRequest
    • Contract Summary Paged Result
    • Document Name
    • Unique Identifier
    • Refund Quote Paged Result
    • seainspections_NotFound
    • TwoFactorMethod
    • ARCHService.Api.DTOs.ContractRate
    • adminapi_ErrorResponse
    • enterpriserepairorderapi_DmsDealerSearchResult
    • Date/Time
    • Cancel Reason Code
    • cancellations_NotFound
    • VIN
    • Date/Time
    • Contract Number
    • Unique Identifier
    • OAuthError
    • ARCHService.Api.DTOs.Deductible
    • adminapi_Address
    • Description
    • Description
    • Unique Identifier
    • Last Name
    • documents_BadRequest
    • Contract Status
    • Odometer Reading
    • OAuthErrorReason
    • ARCHService.Api.DTOs.DeductibleResponse
    • adminapi_Person
    • Is Deleted
    • cancelreasons_BadRequest
    • Date/Time
    • documents_NotFound
    • Money
    • Date/Time
    • OAuthErrorType
    • ARCHService.Api.DTOs.Disbursement
    • adminapi_Vehicle
    • cancelmethods_BadRequest
    • cancelreasons_NotFound
    • Unique Identifier
    • documents_Deprecated
    • Number
    • Cancel Reason
    • TokenType
    • ARCHService.Api.DTOs.DisbursementCodeResponse
    • adminapi_CreateContractRequest
    • cancelmethods_NotFound
    • Contract Status
    • documents_ServerError
    • Date/Time
    • Cancel Method
    • ARCHService.Api.DTOs.DisbursementGroupResponse
    • adminapi_CustomField
    • contracts_ProductType
    • Payee Type
    • Contract
    • ARCHService.Api.DTOs.DisbursementLabelResponse
    • adminapi_Resolve
    • Product Code
    • refundpayments_BadRequest
    • Retail Cost
    • ARCHService.Api.DTOs.FileInfo
    • adminapi_Hold
    • Product Name
    • refundpayments_NotFound
    • Non-Refundable Fee
    • ARCHService.Api.DTOs.GetDeductiblesResponseResult
    • adminapi_Program
    • Plan Code
    • Cancellation Fee
    • ARCHService.Api.DTOs.GetPlanResponseResult
    • adminapi_Product
    • Plan Name
    • Net Refund From Admin
    • ARCHService.Api.DTOs.MembershipGroup
    • adminapi_Plan
    • Term Months
    • Net Refund From Dealer
    • ARCHService.Api.DTOs.MembershipRole
    • adminapi_PDF
    • Term Miles
    • Cancel Refund Amount
    • ARCHService.Api.DTOs.Plan
    • adminapi_AdminCompany
    • Retail Cost
    • Cancel Factor Term Percent
    • ARCHService.Api.DTOs.PlanResponse
    • adminapi_Contract
    • Odometer Expiration
    • Cancel Factor Mileage Percent
    • ARCHService.Api.DTOs.PPMService
    • adminapi_UpdateContractRequest
    • contracts_Vehicle
    • Cancel Factor Percent
    • ARCHService.Api.DTOs.PPMServiceData
    • adminapi_ContractRerateResponse
    • Customer Name
    • Withheld Claim Amount
    • ARCHService.Api.DTOs.ProductResponse
    • adminapi_HoldReason
    • Lienholder
    • refundquotes_BadRequest
    • ARCHService.Api.DTOs.ProgramResponse
    • adminapi_HoldCreateData
    • Dealer
    • refundquotes_NotFound
    • ARCHService.Api.DTOs.RateDisbursementResponse
    • adminapi_CancelPaymentDetails
    • Document
    • Cancel Reason Code
    • ARCHService.Api.DTOs.RateField
    • adminapi_PPMServiceData
    • Contract Number
    • Description
    • ARCHService.Api.DTOs.RateResponse
    • adminapi_RelatedDealer
    • Admin Company
    • Code
    • ARCHService.Api.DTOs.RelatedRate
    • adminapi_ClaimSearchResult
    • Name
    • Description
    • ARCHService.Api.DTOs.Surcharge
    • adminapi_PagedClaimSearchResult
    • Code
    • Cancel Method Type
    • ARCHService.Api.DTOs.Term
    • adminapi_ClaimContract
    • contracts_BadRequest
    • Contract Number
    • ARCHService.Api.DTOs.TermPlan
    • adminapi_ClaimAsset
    • contracts_NotFound
    • Name
    • ARCHService.Api.DTOs.TermPlanResponse
    • adminapi_ClaimDocument
    • Product Type
    • ARCHService.Api.DTOs.ToAccount
    • adminapi_ClaimBenefit
    • Make
    • ARCHService.Api.DTOs.User
    • adminapi_Claim
    • Model
    • ARCHService.Api.DTOs.Vehicle
    • adminapi_ClaimHoldReason
    • Year
    • ARCHService.Api.DTOs.WarrantyInfo
    • adminapi_PPMContractResult
    • First Name
    • ARCHSite.WebApi.Models.Account.AccountingLedger
    • adminapi_PPMContractEventResult
    • Lienholder Code
    • ARCHSite.WebApi.Models.Account.Address
    • adminapi_CashTransactionCreateData
    • Lienholder Name
    • ARCHSite.WebApi.Models.Account.AutoPayReceiveRequest
    • adminapi_ClaimPaymentRequest
    • Phone Number
    • ARCHSite.WebApi.Models.Account.CashTransaction
    • adminapi_CCCType
    • Address
    • ARCHSite.WebApi.Models.Account.CashTransactionCreateData
    • adminapi_CCCTypeCategoryValue
    • Number
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomField
    • Name
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldCreateData
    • Dealer Address
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldEditData
    • Document Name
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldSearchData
    • Form Code
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldSearchResult
    • Description
    • ARCHSite.WebApi.Models.Account.CashTransactionSearchData
    • Name
    • ARCHSite.WebApi.Models.Account.CashTransactionSearchDataV1
    • Code
    • ARCHSite.WebApi.Models.Account.InProcessCashTransaction
    • Line 1
    • ARCHSite.WebApi.Models.Account.InProcessCashTransactionRequest
    • Line 2
    • ARCHSite.WebApi.Models.Account.InProcessCashTransactionSearchData
    • City
    • ARCHSite.WebApi.Models.Account.Ledger
    • State/Province
    • ARCHSite.WebApi.Models.Account.LedgerDetail
    • Postal Code (US, CA)
    • ARCHSite.WebApi.Models.Account.LedgerSearchData
    • ARCHSite.WebApi.Models.Account.LedgerSummary
    • ARCHSite.WebApi.Models.Account.LedgerSummaryRequest
    • ARCHSite.WebApi.Models.Account.Payment
    • ARCHSite.WebApi.Models.Account.PaymentRequest
    • ARCHSite.WebApi.Models.Account.Person
    • ARCHSite.WebApi.Models.Account.ProcessInProcessCashTransactionRequest
    • ARCHSite.WebApi.Models.Account.UnpaidLedgerFilter
    • ARCHSite.WebApi.Models.Account.UnpaidLedgerProduct
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolder
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderAutoExpireFailureResponse
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderAutoExpireResponse
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomField
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldCreateData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldEditData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldSearchData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderStatementRequest
    • ARCHSite.WebApi.Models.AccountHolder.Agent
    • ARCHSite.WebApi.Models.AccountHolder.AgentCreateData
    • ARCHSite.WebApi.Models.AccountHolder.AgentSearchData
    • ARCHSite.WebApi.Models.AccountHolder.AgentSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayee
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeCreateData
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeSearchData
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Customer
    • ARCHSite.WebApi.Models.AccountHolder.CustomerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.CustomerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Dealer
    • ARCHSite.WebApi.Models.AccountHolder.DealerCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroup
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.DealerInPortalVisibilityGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerRateVisibility
    • ARCHSite.WebApi.Models.AccountHolder.DealerRateVisibilityResult
    • ARCHSite.WebApi.Models.AccountHolder.DealerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccount
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.GenericAccountHolderSearchData
    • ARCHSite.WebApi.Models.AccountHolder.GetDealerRateVisibilityResult
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompany
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanyCreateData
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanySearchData
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanySearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Insurer
    • ARCHSite.WebApi.Models.AccountHolder.InsurerCreateData
    • ARCHSite.WebApi.Models.AccountHolder.InsurerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.InsurerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder2
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder2SearchData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderCreateData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderList
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderSearchData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroup
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupAddEditRequest
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupDealerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacility
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilityCreateData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilitySearchData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilitySearchResult
    • ARCHSite.WebApi.Models.AccountHolder.UserSearchData
    • ARCHSite.WebApi.Models.ACHTransactionRequest
    • ARCHSite.WebApi.Models.AutomaticProcessRun.AddRequest
    • ARCHSite.WebApi.Models.AutomaticProcessRun.AutomaticProcessRun
    • ARCHSite.WebApi.Models.AutomaticProcessRun.SearchRequest
    • ARCHSite.WebApi.Models.Claim.Adjustment
    • ARCHSite.WebApi.Models.Claim.CCCType
    • ARCHSite.WebApi.Models.Claim.CCCTypeCategoryValue
    • ARCHSite.WebApi.Models.Claim.CCCTypeCategoryValueSearchData
    • ARCHSite.WebApi.Models.Claim.CCCTypeSearchData
    • ARCHSite.WebApi.Models.Claim.Claim
    • ARCHSite.WebApi.Models.Claim.ClaimBenefit
    • ARCHSite.WebApi.Models.Claim.ClaimContract
    • ARCHSite.WebApi.Models.Claim.ClaimDetailComponent
    • ARCHSite.WebApi.Models.Claim.ClaimDocument
    • ARCHSite.WebApi.Models.Claim.ClaimIndexResult
    • ARCHSite.WebApi.Models.Claim.ClaimInspectionPatchRequest
    • ARCHSite.WebApi.Models.Claim.ClaimInspectionUpdate
    • ARCHSite.WebApi.Models.Claim.ClaimMiscPayment
    • ARCHSite.WebApi.Models.Claim.ClaimPaymentRequest
    • ARCHSite.WebApi.Models.Claim.ClaimSearchData
    • ARCHSite.WebApi.Models.Claim.CostData
    • ARCHSite.WebApi.Models.Claim.Deductible
    • ARCHSite.WebApi.Models.Claim.FileResultData
    • ARCHSite.WebApi.Models.Claim.GapData
    • ARCHSite.WebApi.Models.Claim.GapSettlement
    • ARCHSite.WebApi.Models.Claim.Inspection
    • ARCHSite.WebApi.Models.Claim.InspectionField
    • ARCHSite.WebApi.Models.Claim.InspectionFile
    • ARCHSite.WebApi.Models.Claim.InspectionFileData
    • ARCHSite.WebApi.Models.Claim.InspectionFileResult
    • ARCHSite.WebApi.Models.Claim.InspectionHoldReason
    • ARCHSite.WebApi.Models.Claim.InspectionNote
    • ARCHSite.WebApi.Models.Claim.InspectionReason
    • ARCHSite.WebApi.Models.Claim.Issue
    • ARCHSite.WebApi.Models.Claim.Labor
    • ARCHSite.WebApi.Models.Claim.MiscellaneousItem
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspection
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspectionField
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspectionNote
    • ARCHSite.WebApi.Models.Claim.Ngine.InspectionNotification
    • ARCHSite.WebApi.Models.Claim.Ngine.RepairFacility
    • ARCHSite.WebApi.Models.Claim.Ngine.Vehicle
    • ARCHSite.WebApi.Models.Claim.Note
    • ARCHSite.WebApi.Models.Claim.Part
    • ARCHSite.WebApi.Models.Claim.PPMClaimEvent
    • ARCHSite.WebApi.Models.Claim.RelatedDealer
    • ARCHSite.WebApi.Models.Claim.TakeRejectInspection
    • ARCHSite.WebApi.Models.Class.Asset
    • ARCHSite.WebApi.Models.Classing.Vehicle
    • ARCHSite.WebApi.Models.Contract.Cancel
    • ARCHSite.WebApi.Models.Contract.CancelMethod
    • ARCHSite.WebApi.Models.Contract.CancelMethodSearchData
    • ARCHSite.WebApi.Models.Contract.CancelPayment
    • ARCHSite.WebApi.Models.Contract.CancelPaymentDetails
    • ARCHSite.WebApi.Models.Contract.CancelReason
    • ARCHSite.WebApi.Models.Contract.CancelRequest
    • ARCHSite.WebApi.Models.Contract.CanceRequestExecutionData
    • ARCHSite.WebApi.Models.Contract.Contract
    • ARCHSite.WebApi.Models.Contract.ContractCancelData
    • ARCHSite.WebApi.Models.Contract.ContractDocument
    • ARCHSite.WebApi.Models.Contract.ContractSearchRequest
    • ARCHSite.WebApi.Models.Contract.ContractSearchResult
    • ARCHSite.WebApi.Models.Contract.ContractTransferRequest
    • ARCHSite.WebApi.Models.Contract.ExistingItemLockResult
    • ARCHSite.WebApi.Models.Contract.GeneratedContractDocument
    • ARCHSite.WebApi.Models.Contract.Hold
    • ARCHSite.WebApi.Models.Contract.HoldCreateData
    • ARCHSite.WebApi.Models.Contract.NewCancelRequestData
    • ARCHSite.WebApi.Models.Contract.NewCancelRequestOverrideData
    • ARCHSite.WebApi.Models.Contract.PDF
    • ARCHSite.WebApi.Models.Contract.RerateRequest
    • ARCHSite.WebApi.Models.Contract.Resolve
    • ARCHSite.WebApi.Models.Contract.SyncEarnings
    • ARCHSite.WebApi.Models.Contract.SyncEarnings.ContractEarningData
    • ARCHSite.WebApi.Models.Contract.SyncEarnings.ContractEarningData.EarningResult
    • ARCHSite.WebApi.Models.Control.ClaimHoldReason
    • ARCHSite.WebApi.Models.Control.ContractComponent
    • ARCHSite.WebApi.Models.Control.ContractCoverageGroup
    • ARCHSite.WebApi.Models.Control.CustomField
    • ARCHSite.WebApi.Models.Control.GeneralSetting
    • ARCHSite.WebApi.Models.Control.GeneralSettingGroup
    • ARCHSite.WebApi.Models.Control.GeneralSettingSearchData
    • ARCHSite.WebApi.Models.Control.GeneralSettingSearchResult
    • ARCHSite.WebApi.Models.Control.HoldReason
    • ARCHSite.WebApi.Models.Control.LimitOfLiability
    • ARCHSite.WebApi.Models.Control.LimitOfLiabilityResult
    • ARCHSite.WebApi.Models.Control.LimitOfLiabilityRule
    • ARCHSite.WebApi.Models.Document
    • ARCHSite.WebApi.Models.DocumentPostResponse
    • ARCHSite.WebApi.Models.DocumentService.DocumentCreateData
    • ARCHSite.WebApi.Models.ExternalReference
    • ARCHSite.WebApi.Models.FinancingData
    • ARCHSite.WebApi.Models.IdNameDescription
    • ARCHSite.WebApi.Models.InsurancePolicy
    • ARCHSite.WebApi.Models.InsuranceSettlement
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Account.CashTransaction]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Account.UnpaidLedgerProduct]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.AccountHolder.LienHolder2]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Claim.ClaimIndexResult]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Contract.ContractSearchResult]
    • ARCHSite.WebApi.Models.PagedResult[System.String]
    • ARCHSite.WebApi.Models.PaymentMethod
    • ARCHSite.WebApi.Models.Rate.AdminCompany
    • ARCHSite.WebApi.Models.Rate.AssetTypeRequestData
    • ARCHSite.WebApi.Models.Rate.CCCType
    • ARCHSite.WebApi.Models.Rate.ClaimSetting
    • ARCHSite.WebApi.Models.Rate.DisbursementRequestData
    • ARCHSite.WebApi.Models.Rate.Plan
    • ARCHSite.WebApi.Models.Rate.Product
    • ARCHSite.WebApi.Models.Rate.Program
    • ARCHSite.WebApi.Models.Rate.RateQuoteRequest
    • ARCHSite.WebApi.Models.Rate.VehicleBodyStyleRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleMakeRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleModelRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleSegmentationRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleSeriesRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleTrimRequestData
    • ARCHSite.WebApi.Models.Reference
    • ARCHSite.WebApi.Models.SalesTax.SalesTaxCalculationRequest
    • ARCHSite.WebApi.Models.Warranty
    • Sefi.Admin.Accounting.SalesTax.CalculatedLineItemDetail
    • Sefi.Admin.Accounting.SalesTax.ContractSalesTaxDetail
    • Sefi.Admin.Accounting.SalesTax.SalesTaxLineItem
    • Sefi.Admin.Accounting.SalesTax.SalesTaxRule
    • Sefi.Admin.Accounting.SalesTax.SalesTaxType
    • SeFi.Documents.Model.Document
    • SeFi.Documents.Model.DocumentVersion
    • SeFi.Documents.Model.PresignedLink
    • SEServices.Warranty.ARCH.Environment.AccountHolderACH
    • SEServices.Warranty.ARCH.Environment.AvailablePaymentMethod
    • SEServices.Warranty.ARCH.Environment.ClaimInspectionReason
    • SEServices.Warranty.ARCH.Environment.Criterion
    • SEServices.Warranty.ARCH.Environment.CriterionGroup
    • SEServices.Warranty.ARCH.Environment.DuplicateGAPContracts_Result
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Cancel
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.CancelDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Contract
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractEarningDetails
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractHold
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractHoldDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.LedgerDelete
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.LedgerEdit
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Reinstatement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementHold
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementHoldDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Resolve
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ResolveDisbursement
    • SEServices.Warranty.ARCH.Environment.FactorTable
    • SEServices.Warranty.ARCH.Environment.FactorTableEntry
    • SEServices.Warranty.ARCH.Environment.PaymentMethodACH
    • System.Net.Http.HttpMethod
  1. SCS APIs

11 Update Contract API

SCS Update Contract API

Overview

The SCS Auto Platform provides a web service that allows external systems (Integration Partners) to validate and execute contract update transactions electronically. The web service will verify all the business rules necessary to execute the transaction, and if these are met will execute the transaction. If any business rules are not met the web service will specify these in the error/warning response.

This document addresses the methods ‘ValidateUpdateContract’ and ‘UpdateContract’ that allow validation and execution of contract update transactions. The ValidateUpdateContract method can be used to validate an update contract transaction and verify all business rules in SCS without executing the contract update transaction. If any business rules are not met, then the response will specify what, if any are not met. This will enable requestors to know exactly what data elements to fix such that these transactions can be resubmitted to the UpdateContract method to be successfully processed. The UpdateContract method also verifies all business rules and specifies all error messages if there are any issues; further, if the UpdateContract request is valid, it will go ahead and update the contract as well.

Validation

  1. The contract to be updated will be looked up based on the contract number only. If the contract is not found based on the contract number, nothing else can be validated. This also means that the contract numbers cannot be updated.

  2. The request will validate all data elements in the request. If all the data elements needed for validation are not present in the request, they will be read from the given Contract’s values stored in SCS unless there is a Remove tag with a value ‘R’ indicating that the stored SCS value be replaced with a blank. If fields are empty, therefore, they will still be validated.

  3. If the contract is in Expired status, only Customer Address fields can be updated. Contracts in Cancelled, Void, or Rejected status cannot be updated via web services.

  4. ‘Active’, ‘Pending’, or ‘Pending Billed’ contracts will be updated per the following process:

  5. Credential Validation –The request needs to provide valid TPA and userid/password information. If the request does not pass this stage of validation, then no data elements in the request will be validated against SCS Contract Update business logic. The data elements will have their formats and presence validated only.

  6. Seller number will be validated next, if supplied. If supplied, it must match what is in SCS. If not, the validation & update will fail.

  7. Customer name will be validated, if supplied. Updating the customer name is possible only when the contract is in ‘Pending’ status. Updating the Customer Name is for 'Active or 'Pending Billed' contracts is not possible through web services as this is considered a Contract Transfer transaction which can only be done via the SCS Auto Contract Entry screen. If values for the Customer Name are supplied in the request for a contract in ‘Active’ or ‘Pending Billed’ status and the values supplied do not match exactly what is in the system already, then the validation & update will fail.

  8. All other SCS business rules applied during the contract update process via the SCS Contract Entry screen will then be applied to the contract update via web services based on the inputs provided and the contract’s current state.

  9. The request schema includes a Rerate tag.

    • If left unspecified, rerate will be performed if any contract data elements that are inputs to rating are specified in the update request. For example, a VIN change will trigger a rerate.
    • If set to true, rerate will be performed even if no contract data elements that affect rating are specified in the update request.
    • If set to false, rerate will not be performed. If contract data elements that affect rating are specified and are different from values that are stored with the contract in SCS, then Validate and ContractUpdate will fail with an error message.
  10. When an UpdateContract request is sent to update a contract, the contract will be updated if it meets all the update contract business rules. Upon update of an ‘Active’ or ‘Pending Billed’ contract a note will be generated in SCS with Update information as a result of a successful update request:

    • If the contract was not re-rated then the message is: ‘Contract was modified without a re-rate via ContractUpdate web service’.
    • If the contract was re-rated then the message is: ‘Contract was re-rated via ContractUpdate web service’.
    • The userid is recorded with the note
  11. Locking on Validate and UpdateContract request

    • If the contract is locked the response object will return a ResponseCode=0 and a ‘Contract is locked’ error message.
  12. Actions that require Underwriting Supervisor permission will not be performed by any of the webservice methods.

  13. Updating the contract may involve either Adding, removing, or changing the value of fields and/or objects that comprise a Contract. Accordingly, most objects in the request schema have an Action tag that enable specifying what action is desired: Add, Remove, or Update. Most fields in the request schema will have a corresponding remove tag that enables removing the fields SCS stored value when the value passed is ‘R’. The default action for objects and fields is Update.

    • The 'Remove' action in the objects will have the priority over the 'Update' action. Example: If the TermMile object Action is 'Remove' and the Termvalue is different from the database value then the expected action will be that all values in the object will be removed from the database.
    • A Remove tag for individual fields with a value 'R' will have the priority over an update action. Example: If the SaleDate value is different from the database value and the SaleDateRemove value is 'R' the expected action will be that the fields SCS stored value is removed from the database.
Contract ObjectUpdate Criteria & NotesActions SupportedResult
SalesPersonAction tag. The action will be applied to each element in the object.Remove; UpdateRemove: Removes the value from each element in the object. The sales person’s first and last name will be removed. Update: Update is the default action and will update using the values provided in the request. When values are not provided then the update will use the values stored in SCS. Update will match to an existing F&I Manager using both the first and last name. If it finds a match, the matching name will be used. If at matching the F&I Manager record is not found a new F&I Manager record will be created and associated to the contract.
TermMileAction tag. The action will be applied to each element in the object.Remove; UpdateRemove: Removes the value from each element in the object. The contract’s term and mileage values will be removed. Update: Update is the default action and will update using the values provided in the request. When values are not provided then the update will use the values stored in SCS.
DeductibleAction tag. The action will be applied to each element in the object.Remove; UpdateRemove: Removes the value from each element in the object. The contract’s deductible amount, deductible type and deductible reduced amount values will be removed. Update: Update is the default action and will update using the values provided in the request. When values are not provided then the update will use the values stored in SCS.
VehicleAction tag. The action will be applied to each element in the object.Remove; UpdateRemove: Removes the value from each element in the object. The contract’s VIN and all vehicle information are removed. Update: Update is the default action and will update using the values provided in the request. Vehicle Object attributes other than the VIN can be updated to blank (i.e. shown as n/a when viewed on screen) if that is a valid value as populated in the VIN description table for that combination of Year/Make/Model/other vehicle attributes. These attributes should either not be sent or sent with blank value in order to set them to blank. This differs from the behavior of any other attributes in the UpdateContract request in that passing in a blank or not passing the attribute at all in the request is construed as ‘update from SCS stored value’, rather than set the value to blank.
LienHolderAction tag. The action will be applied to each element in the object.Remove;UpdateRemove: Removes the value from each element in the object. If present the lienholder number and information are removed from the contract. Update: Update is the default action and will update using the values provided in the request. When values are not provided then the update will use the values stored in SCS. Update will match the lienholder Name, Address1 and ZipCode information to one in SCS. If it finds a match, the matching lienholder's lienholder number will be used. If at matching the lienholder record is not found a new lienholder will be created.
AdditonalContractInfoThe object will be validated if the product is defined to use additional contract information otherwise no validation will occur.
Contract OptionOptions can only be added or removed to update a contract. Options to be added/removed are looked up based on the value of the Description field. Note to SCS Customers: The value in the Description field is compared with the Preference Manager text specified for application=’*’ for that option object. If no preference manager text is specified, the option description is used for matching. Option IDs can be specified, but not required, in which case the Option ID is used for matching instead of the Description.Remove;AddRemove: Removes specified option from the contract and rerates it to reduce contract cost by the cost of the option removed. Add: Adds specified option to the contract and rerates it to increase contract cost by cost of the option.

UpdateContract Web Service Specifications Data Format

The following table represents the data formats used in the XML coding (Use to reference the “Format” column in the following XML schema tables)

Data typeDescriptionExample
X(10)Characters of max length of 10ABCDEABCDE
Dateyyyy-mm-dd2000-12-21
DateTimeyyyy-mm-ddThh:mm:ss2000-12-21T12:24:40
N(5)Number,max length of 512345
N(8,2)Number with two decimals, max length of 8.123456.78
BooleanBoolean true or falsetrue

UpdateContract

Request Schema

UpdateContractRequest

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
TpaCodeX(4)RThird Party Administrator Code
UserIdX(30)RUser ID issued to the requesting system
PasswordX(255)RPassword issued to the requesting system
ContractNumberX(20)CContract Number to be validated for update.
DealerNumberX(18)RDealer Number If supplied, it must match what is in SCS. If not, the update and validation will fail with the message “Contract move between sellers is not supported. Contract <contract#> is assigned to seller <seller#> and cannot be changed to the seller <seller# as sent in the request>”
ReRateBooleanOTrue FalseReRate indicator The tag does not have to be included in the request. When the tag is not included in the request, rerate will be performed only if any contract data elements that affect rating are changed, otherwise rerate will not occur. If set to true, rerate will be performed even if no contract data elements that affect rating are changed. (Example: a plan has been modified to add a surcharge and all contracts in force for that plan need that surcharge, then update request required data elements will be the contract number and Rerate set to true). If set to false, rerate will not be performed. If contract data elements that affect rating are changed, then rerate for this contract will fail with an error message. Rerate a contract with odometers whose band codes require ‘Underwriting Supervisor’ approval will fail.
SaleDateDateORating triggerSale Date
SaleDateRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
ProgramNameX(100)ORating triggerProgram name
ProgramNameRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
PlanTypeX(1)ORating triggerN, UPlan Type Value will be used to determine plan and rates. Required for non-GAP products.
PlanTypeRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
PlanCodeX(2)ORating triggerPlan Code
PlanCodeRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
SaleOdometerN(7)ORating triggerSale Odometer
SaleOdometerRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
VehiclePurchasePriceN(8,2)CRating triggerVehicle Purchase Price. Required for some GAP contracts
VehiclePurchasePriceRe moveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
VehiclePurchaseDateDateCRating triggerVehicle Purchase Date. Required for some plans.
VehiclePurchaseDateRe moveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
InserviceDateDateCRating triggerIn Service Date Required for some plans
InserviceDateRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FinanceTypeX(4)CRating triggerBALL LEAS LOAN CASHFinance Type Required for some GAP contracts. Values are BALL (balloon), LEAS (lease), LOAN, and CASH.
FinanceTypeRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FinancedAmountN(8,2)CRating triggerFinance Amount Required for some GAP contracts.
FinancedAmountRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FinanceAPRN(2,2)CRating triggerFinance APR Required for some GAP contracts.
FinanceAPRRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FinanceTermN(3)CRating triggerFinance Term Required for some GAP contracts.
FinanceTermRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
MSRPN(8,2)CRating triggerMSRP Required for some GAP contracts.
MSRPRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
MonthlyPaymentN(8,2)CMonthly Payment Required for some GAP contracts. GAP contract supplemental Loan/Lease information. No impact on rating.
MonthlyPaymentRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FirstPaymentDateDateCFirst Payment Date Required for some GAP contracts. GAP contract supplemental Loan/Lease information. No impact on rating.
FirstPaymentDateRemov eX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
BalloonAmountN(8,2)CBalloon Amount GAP contract supplemental Loan/Lease information. No impact on rating.
BalloonAmountRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
ResidualValueN(8,2)CResidual Value GAP contract supplemental Loan/Lease information. No impact on rating.
ResidualValueRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
BaseACVN(8,2)CBase ACV GAP contract supplemental Loan/Lease information. No impact on rating.
BaseACVRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
NADAValueN(8,2)CNADA Value Required for some GAP contracts. GAP contract supplemental Loan/Lease information. No impact on rating.
NADAValueRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
InsuranceDeductibleN(5,2)CInsurance Deductible GAP contract supplemental Loan/Lease information. No impact on rating.
InsuranceDeductibleRem oveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
RetailCostN(5,2)ORetail Cost The price charged to the customer for the contract. Any value sent will be validated against the plan’s Retail Rules Only User with ‘Underwriting Supervisor’ can override a regulated retail cost
RetailCostRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
StockNumberX(30)OStock number **10/2015 Added in Release 8.14.2
DealNumberX(30)ODeal number
RegenerateContractDocu mentBooleanRTrue FalseRegenerate Contract Document If set to True, an updated contract document is generated and returned in response. If set to False, no contract document is generated. If tag is not sent or no value is sent, the default value will be False, and no contract document will be generated
SalesPersonOSales Person object
TermMileORating triggerTerm Mile object
DeductibleORating triggerDeductible object
VehicleORating triggerVehicle Information object
CustomerOCustomer object
LienHolderOLienholder object
ContractOptionsORating triggerContract Options object
AdditionalContractInfoCAdditional Contract Info object.
PaymentOptionX(4)CPayment Option code. Required if other changes to the plan require reselecting one. Ignored for contracts that are billed and a payment has been applied. Ignored for billed contracts from a previous billing cycle.
PaymentOptionRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
OwnershipX(1)C ‘N’ – New, ‘P’ – Pre- OwnedVehicle Ownership
RecipientIdX(20)ORecipient ID

SalesPerson Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
ActionX(6)ORemove UpdateIf value is set to ‘Remove’ then remove the values for the SalesPerson First name and Last name. 'Update' will match to an existing F&I Manager. If it finds a match, the matching name will be used. If at matching the F&I Manager record is not found a new F&I Manager record will be created and associated to the contract. Spaces should be trimmed from the front and end of the strings before matching/creation can occur. Update is the default Action.
FirstNameX(30)OSales Person First Name Validates for presence of both first and last name
LastNameX(30)OSales Person Last Name Validates for presence of both first and last name

TermMile Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
ActionX(6)ORemove UpdateIf value is set to ‘Remove’ then remove the values for the Term and Mileage. Update is the default Action
TermN(3)ORating triggerTerm Contract length in months. Value will be used to determine rates.
MileageN(6)ORating triggerMileage Contract length in mileage. Value will be used to determine rates.

Deductible Object

TagFormatReq/ Opt/ CondAttributesValid ValuesDescription
ActionX(6)ORemove UpdateIf value is set to ‘Remove’ then remove the values for the DeductAmt, DeductType and ReducedAmount. Update is the default Action
DeductAmtN(5,2)ORating triggerDeductible amount Max value is $1000.
DeductTypeX(10)CRating triggerDisp Reducin g StandardDeductible type Required if the Deductible Amount is specified. Match is based on the deduct type code configured in deduct type table.
ReducedAmountN(5,2)CRating triggerDeductible Reduced Amount. Required if DeductType = “Reducing”

Customer Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
TitleX(20)OTitle
TitleRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
FirstNameX(30)OFirst Name
FirstNameRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
LastNameX(60)OLast Name
LastNameRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
MiddleInitialX(30)OMiddle Initial
MiddleInitialRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
EmailX(100)OEmail ** Release 8.14.2 Updated to 100 characters
EmailRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
AddressOAddress object
IsTaxExemptBoolea nOTrue False (default )Indicates if the customer is tax exempt. This data element if different from the existing contract value, will lead to a cash adjustment transaction which reverses the tax amounts billed for the contract.

Address Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
Address1X(30)OFirst Address Line
Address1RemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
Address2X(30)OSecond Address Line
Address2RemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
CityX(20)OCity
CityRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
StateX(2)OState
StateRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
ZipCodeX(10)OZIP Code
ZipCodeRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
HomePhoneX(10)OHome Phone
HomePhoneRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
HomePhoneExtX(4)OHome Phone Extension
HomePhoneExtRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
WorkPhoneX(10)OWork Phone
WorkPhoneRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.
WorkPhoneExtX(4)OWork Phone Extension
WorkPhoneExtRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.

Vehicle Object

TagFormatReq/ Opt/ CondAttributesValid ValuesDescription
ActionX(6)ORemove UpdateIf value is set to ‘Remove’ then remove the values for the VIN and all vehicle information. Update is the default Action
VinNumberX(17)ORating triggerVIN If VIN is specified, that VIN will be used to determine Year/Make/Model and other vehicle elements. All other vehicle data elements sent in the request will be ignored. The contract’s vehicle attributes will be validated/updated with the exact tag values or absence of tags sent in the request. For example: a contract has a VIN and an update request is sent with values in the Year/Make/Model tags but without a VinNumber tag, then the update will remove the contract’s VIN and replace the Year/Make/Model attributes on successful validation. When a VIN is not specified, then the list of vehicle attributes is based on Year/Make/Model as specified in the VIN table (uploaded from Polk or manually entered). A vehicle attributes may have multiple valid values. A valid value must be in the request to pass validation. Example: 2012 Ford F150 has multiple valid values for the attribute Aspiration Code, a valid value for this attribute then must be sent in the request. Vehicle Object attributes other than the VIN can be updated to blank (i.e. shown as n/a when viewed on screen) if that is a valid value as populated in the VIN description table for that combination of Year/Make/Model/other vehicle attributes. These attributes should either not be sent or sent with blank value in order to set them to blank. This differs from the behavior of any other attributes in the UpdateContract request in that passing in a blank or not passing the attribute at all in the request is construed as ‘do not update’, rather than set the value to blank.
YearN(4)ORating triggerVehicle Year
MakeX(25)ORating triggerVehicle Make
ModelX(25)ORating triggerVehicle Model
CylX(2)ORating triggerCylinders
DrvX(2)ORating triggerDriving Wheels
FuelX(2)ORating triggerFuel Type
AspirationCodeX(2)ORating triggerAspiration Code
SegmentationCodeX(2)ORating triggerSegmentation Code
TonRatingX(2)ORating triggerTon Rating
GVWRX(2)ORating triggerGVWR

LienHolder Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
ActionX(6)ORemove UpdateIf value is set to ‘Remove’ then remove the lienholder number and information if present from the contract. 'Update' will match the lienholder Name, Address1 and ZipCode information to one in the SCS database. If it finds a match, the matching lienholder's lienholder number will be used. If at matching the lienholder record is not found a new lienholder will be created. Update is the default Action
NameX(60)OLienholder name
Address1X(30)OLienholder address1
Address2X(30)OLienholder address2
StateX(2)OLienholder state
PhoneX(10)OLienholder phone
CityX(30)OLienholder city
ZipCodeX(10)OLienholder zip code
NumberX(18)OLienholder Number

ContractOptions Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
ContractOptionUpdateGrouping tag used to allow specifying more than one contract option in a single request.
IdN(15)OnillableValue if specified is the unique identifier of the Option ID in SCS. Option description will be ignored if this value is provided.
ActionX(6)OAdd RemoveAdd – The option ID will be added to the cost/coverage Remove – the option will be removed from the cost/coverage
DescriptionX(60)OOption Description within the Option group for the plan/term/deductible combination that must be added or removed. Option will be matched based on the preference manager text configured for web services.

AdditionalContractInfo Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
FieldLabelX(50)CField Label – required per business rule specification
FieldValueX(50)CField Value – required per business rule specification
FieldValueRemoveX(1)ORIf value is set to ‘R’ then remove the value stored in the database for the specified tag.

Sample SOAP Request

<soap:Envelope>
    <soap:Body>
        <UpdateContract>
            <updateContract>
                <UserId>?</UserId>
                <Password>?</Password>
                <TpaCode>?</TpaCode>
                <ContractOptions>
                    <ContractOptionUpdate>
                        <Id>**int**</Id>
                        <Description>**string**</Description>
                        <Action>**string**</Action>
                    </ContractOptionUpdate>
                    <ContractOptionUpdate>
                        <Id>**int**</Id>
                        <Description>**string**</Description>
                        <Action>**string**</Action>
                    </ContractOptionUpdate>
                </ContractOptions>
                <ContractNumber>**string**</ContractNumber>
                <DealerNumber>**string**</DealerNumber>
                <ReRate>**boolean**</ReRate>
                <SaleDate>**dateTime**</SaleDate>
                <SaleDateRemove>**string**</SaleDateRemove>
                <ProgramName>**string**</ProgramName>
                <ProgramNameRemove>**string**</ProgramNameRemove>
                <PlanCode>**string**</PlanCode>
                <PlanCodeRemove>**string**</PlanCodeRemove>
                <PlanType>**string**</PlanType>
                <PlanTypeRemove>**string**</PlanTypeRemove>
                <SaleOdometer>**int**</SaleOdometer>
                <SaleOdometerRemove>**string**</SaleOdometerRemove>
                <VehiclePurchasePrice>**decimal**</VehiclePurchasePrice>
                <VehiclePurchasePriceRemove>**string**</VehiclePurchasePriceRemove>
                <VehiclePurchaseDate>**dateTime**</VehiclePurchaseDate>
                <VehiclePurchaseDateRemove>**string**</VehiclePurchaseDateRemove>
                <InServiceDate>**dateTime**</InServiceDate>
                <InServiceDateRemove>**string**</InServiceDateRemove>
                <FinanceType>**string**</FinanceType>
                <FinanceTypeRemove>**string**</FinanceTypeRemove>
                <FinancedAmount>**decimal**</FinancedAmount>
                <FinancedAmountRemove>**string**</FinancedAmountRemove>
                <FinanceAPR>**decimal**</FinanceAPR>
                <FinanceAPRRemove>**string**</FinanceAPRRemove>
                <FinanceTerm>**int**</FinanceTerm>
                <FinanceTermRemove>**string**</FinanceTermRemove>
                <MSRP>**decimal**</MSRP>
                <MSRPRemove>**string**</MSRPRemove>
                <MonthlyPayment>**decimal**</MonthlyPayment>
                <MonthlyPaymentRemove>**string**</MonthlyPaymentRemove>
                <FirstPaymentDate>**dateTime**</FirstPaymentDate>
                <FirstPaymentDateRemove>**string**</FirstPaymentDateRemove>
                <BalloonAmount>**decimal**</BalloonAmount>
                <BalloonAmountRemove>**string**</BalloonAmountRemove>
                <ResidualValue>**decimal**</ResidualValue>
                <ResidualValueRemove>**string**</ResidualValueRemove>
                <BaseACV>**decimal**</BaseACV>
                <BaseACVRemove>**string**</BaseACVRemove>
                <NADAValue>**decimal**</NADAValue>
                <NADAValueRemove>**string**</NADAValueRemove>
                <InsuranceDeductible>**decimal**</InsuranceDeductible>
                <InsuranceDeductibleRemove>**string**</InsuranceDeductibleRemove>
                <RetailCost>**decimal**</RetailCost>
                <RetailCostRemove>**string**</RetailCostRemove>
                <PaymentOption>**string**</PaymentOption>
                <PaymentOptionRemove>**string**</PaymentOptionRemove>
                <StockNumber>**string**</StockNumber>
                <DealNumber>**string**</DealNumber>
                <RegenerateContractDocument>**boolean**</RegenerateContractDocument>
                <AdditionalContractInfo>
                    <FieldValueRemove>**string**</FieldValueRemove>
                </AdditionalContractInfo>
                <TermMile>
                    <Action>**string**</Action>
                </TermMile>
                <Deductible>
                    <Action>**string**</Action>
                </Deductible>
                <Vehicle>
                    <Action>**string**</Action>
                </Vehicle>
                <Customer>
                    <Title>**string**</Title>
                    <FirstName>**string**</FirstName>
                    <LastName>**string**</LastName>
                    <MiddleInitial>**string**</MiddleInitial>
                    <Email>**string**</Email>
                    <AlternateContact>**string**</AlternateContact>
                    <Address>
                        <Address1Remove>**string**</Address1Remove>
                        <Address2Remove>**string**</Address2Remove>
                        <CityRemove>**string**</CityRemove>
                        <StateRemove>**string**</StateRemove>
                        <ZipCodeRemove>**string**</ZipCodeRemove>
                        <HomePhoneRemove>**string**</HomePhoneRemove>
                        <HomePhoneExtRemove>**string**</HomePhoneExtRemove>
                        <WorkPhoneRemove>**string**</WorkPhoneRemove>
                        <WorkPhoneExtRemove>**string**</WorkPhoneExtRemove>
                    </Address>
                    <TitleRemove>**string**</TitleRemove>
                    <FirstNameRemove>**string**</FirstNameRemove>
                    <LastNameRemove>**string**</LastNameRemove>
                    <MiddleInitialRemove>**string**</MiddleInitialRemove>
                    <EmailRemove>**string**</EmailRemove>
                    <AlternateContactRemove>**string**</AlternateContactRemove>
                    <IsTaxExempt>**boolean**</IsTaxExempt>
                </Customer>
                <SalesPerson>
                    <Action>**string**</Action>
                    <FirstName>**string**</FirstName>
                    <LastName>**string**</LastName>
                </SalesPerson>
                <LienHolder>
                    <Action>**string**</Action>
                </LienHolder>
                <RecipientId>**string**</RecipientId>
                <RecipientIdRemove>**string**</RecipientIdRemove>
            </updateContract>
        </UpdateContract>
    </soap:Body>
</soap:Envelope>

Response Schema

GenerateContractResponse Object

TagContent ItemsFormatDescription
UpdateContractResponse/
UpdateContractResult
Response Code2 = Successful, UpdateContract passed with warning. This response code is returned for contract in Pending not billed status when a warning message is issued. 1 = Successful, UpdateContract passed. 0 = UpdateContract failed. See Message Object for Type
ContractDocumentContract Document
MessagesMessage ObjectCollection of Messages.

Message Object

TagFormatReq/ Opt/ CondValid valuesDescription
TypeIntegerR1 =Error, 2 = Info, 3 = Warning, 4 = SuccessMessage Type
CodeString X(30)RMessage Code
TextString X(2000)RMessage Text

Error Messages

Message TypeError codeMessage Text
Includes error messages from ValidateReRateError
ErrorVD0003TPA is invalid.
ErrorrfvTPACodeTPA Code is required.
ErrorWSLICEN001License not available.
ErrorVD0009Authentication Failed.
ErrorWSSECUR001You do not have necessary permission to execute this web method.
ErrorERRINREQError in request.
ErrorERRSESSIONUnable to create session.
ErrorDLRNOTEXISTDealer does not exist.
ErrorrfvDealerNumberSeller Number is required.
ErrorrfvContractNumberContract Number is required.
ErrorVD0001Invalid contract number.
ErrorCANNOT_EDIT_EXPRD_CNTUpdate cannot be processed - Contract {0} is in Expired status but only a change to customer address is allowed.
ErrorCANNOT_EDIT_RERATE_CNT_STATUSContract {0} is in {1} status and cannot be edited or re-rated.
ErrorUPD_001Contract move between sellers is not supported. Contract {0} is assigned to seller {1} and cannot be changed to seller {2}.
ErrorUPD_002Contract transfer to another customer is not supported. Contract {0} is assigned to customer {1} and cannot be changed to customer {2}.
ErrorCNTLOCKREMRecord is locked. The contract is marked for Remittance since {0}
ErrorVD0014Contract # {0} is locked by another user. Please unlock the contract before making changes.
ErrorNO_CONTRACT_ATTRIBUTENo contract changes were specified. Example: The error is triggered when only a contract number is sent in with ReRate=FALSE. In this case, there would be nothing to change on the contract.
ErrorINVALID_RERATE_FLGContract {0} cannot be updated since updating the attributes: {1} Requires re-rating the contract and ReRate flag is set to 'False'. Example: Contract ABC2200 cannot be updated since updating the attributes: <SaleDate>8/23/2013 12:00 AM</SaleDate> <SaleOdometer>12002</SaleOdometer> Requires re-rating the contract and ReRate flag is set to ‘False’
ErrorSALEDATE_EXCEED_MINSale Date cannot be less than {0}.
ErrorSALEDATE_EXCEEDSale Date exceeds future Sale Date limit.
Error/WarningrfvSaleDateSale Date is required. Warning when contract is in Pending not billed status.
Error/WarningDEALER_NOT_ACTIVE_SALEDATEThe seller account is not active for this sale date. Warning when contract is in Pending not billed status.
Error/WarningNO_SALE_AUTHORITYSeller does not have Sale Authority for this product as of {0} Warning when contract is in Pending not billed status.
Error/WarningPROGRAM_INVALIDProgram is Invalid. Warning when contract is in Pending not billed status.
Error/WarningrfvProgramProgram is required. Warning when contract is in Pending not billed status.
Error/WarningINVALIDPLANTYPEInvalid Plan Type. Warning when contract is in Pending not billed status.
Error/WarningrfvPlanPlan is required. Warning when contract is in Pending not billed status.
Error/WarningIMP_CNTR_0030Plan information is invalid. Warning when contract is in Pending not billed status.
Error/WarningPLANTYPEREQUIREDPlan Type is required. Warning when contract is in Pending not billed status.
ErrorINVALID_DEAL_TYPEDeal Type is invalid. This error applies to GAP contracts
ErrorINVALID_FINANCE_AMTFinance Amount is invalid. This error applies to GAP contracts
ErrorINVALID_FINANCE_APRFinance APR is invalid. This error applies to GAP contracts when eligibility is based on APR
ErrorINVALID_FINANCE_TERMFinance Term is invalid. * This error applies to GAP contracts*
ErrorINVALID_MSRPMSRP is invalid. This error applies to GAP contracts when eligibility is based on MSRP
ErrorINVALID_MONTHLYPAYMonthly payment is invalid.
ErrorINVALID_FIRST_PAYMENT_DATEFirst Payment Date must be greater than or equal to Sale Date.
ErrorINVALID_BALLOON_AMTBalloon amount is invalid.
ErrorINVALID_RESIDUAL_AMTResidual amount is invalid.
ErrorINVALID_BASE_ACVBase ACV is invalid.
ErrorINVALID_NADA_VALUENADA Value is invalid.
ErrorINVALID_INS_DEDUCTInsurance deductible is invalid.
ErrorIMP_CNTR_0032Lien holder information is invalid.
ErrorIMP_CNTR_0063Invalid Lienholder state code.
ErrorIMP_CNTR_0064Invalid Lienholder zipcode.
ErrorIMP_CNTR_0065Invalid Lienholder phone number.
Error/WarningTERM_INVALIDTerm is invalid. Warning when contract is in Pending not billed status.
Error/WarningTERM_MILE_NOT_FOUND_PLANTerm {0} is not configured/rate defined for the plan {1} Example: This will occur when the term specified in the update request is not available for the plan. Warning when contract is in Pending not billed status.
Error/WarningINVALID_DEDUCT_AMTDeductible Amount cannot be more than $1000. Warning when contract is in Pending not billed status.
Error/WarningINVALID_DEDUCT_TYPEDeductible Type is invalid. Warning when contract is in Pending not billed status.
Error/WarningDEDUCTIBLE_NOT_FOUNDDeductible {0} is not configured/rate defined for the plan {1} This error will occur when the term specified deductible in the update request is not available for the plan or has no rates specified. Warning when contract is in Pending not billed status.
Error/WarningrfvDeductDeductible is required. Warning when contract is in Pending not billed status.
Error/WarningDEDUCT_INVALIDThe deductible is invalid. Warning when contract is in Pending not billed status.
ErrorNEW_VIN_FOUND_VLDTThe specified vehicle {0} does not match the VIN data for the VIN {1} that is already associated with the contract {2}. The VIN is no longer associated with this contract. Example: The error could be triggered when contract update requested with a Year/Make/Model combination that does not exist in the VIN table.
Error/WarningVinLength1VIN must be 17 characters long. Warning when contract is in Pending not billed status.
Error/WarningIMP_CNTR_0068VIN could not be decoded. Warning when contract is in Pending not billed status.
Error/WarningVEHICLE_NOT_FOUNDThe vehicle {0} does not exist in the VIN table. Example: The error is triggered when contract update requested with a Year/Make/Model combination that does not exist in the VIN table. The vehicle 2012/HONDA/ACCORD does not exist in the VIN table Warning when contract is in Pending not billed status.
Error/WarningMULTIPLE_VEHICLES_FOUND{0} has multiple values possible for the following vehicle attributes. {1}A value for the above attributes must be specified before the contract can be updated. Example: When a VIN is not specified, then only the valid list of vehicle attributes are based on Year/Make/Model combination as specified in the VIN table (uploaded from POLK, or manually entered) will be allowed. If attribute values are not uniquely identifiable based on just Year/Make/Model as specified, then the contract update will fail to process the update with the above error message. Warning when contract is in Pending not billed status.
Error/WarningVEHICLE_FEATURE_IGNOREDYear/Make/Model not processed since VIN is specified. Warning when contract is in Pending not billed status.
Error/WarningPAYMENT_OPTION_REQUIREDPayment Option Required. Warning when contract is in Pending not billed status.
Error/WarningINVALID_PAYMENT_OPTIONSelected Payment Option is not valid. Warning when contract is in Pending not billed status.
ErrorTITLEINVALIDInvalid Customer Title
ErrorINVCUSTSTAInvalid Customer state code.
Error/WarningPHONEINVALIDInvalid Phone number. Warning when contract is in Pending not billed status.
Error/WarningEMAILVALIDEmail not in correct format. Warning when contract is in Pending not billed status.
Error/WarningVPDTGTSLDTVehicle Purchase Date cannot be greater than sale date. Warning when contract is in Pending not billed status
ErrorVPDTGTTODAY2Vehicle Purchase Date cannot be greater than today's date.
Error/WarningVPDTGTTODAYVehicle Purchase Date cannot be greater than today's date. Warning when contract is in Pending not billed status
Error/WarningrfvVehiclePurchaseDateVehicle Purchase Date is required. Warning when contract is in Pending not billed status
Error/WarningINSVDTGTSLDTIn Service Date cannot be greater than sale date. Warning when contract is in Pending not billed status
Error/WarningINSERVICE_GT_DATEIn Service Date cannot be greater than {0}. Warning when contract is in Pending not billed status
Error/WarningINSERVICE_LT_YEARIn Service Date cannot be less than year {0}. Warning when contract is in Pending not billed status
Error/WarningrfvInServiceDateIn Service Date is required. Warning when contract is in Pending not billed status
ErrorrfvTemplate{0} is required. This error is returned if the Additional Contract field value is required.
ErrorAdditionalInfoLengthInvalid {0}. {0} must be {1} characters. This error is returned if the Additional Contract field value does not meet the length requirement.
ErrorAdditionalInfoUniqueValue entered for {0} is not unique. Please enter a different value. This error is returned if the Additional Contract field value is not unique.
ErrorEXPDATE_LT_SALEDATEExpiration date {0} cannot be earlier than the sale date {1}.
ErrorINVALIDRETCOSTRetail cost is invalid.
ErrorCANNOTSAVESALEPERSONSales Person can not be saved
ErrorINVALIDSALESPERSONNAMESales Person First and Last name can not exceed 60 characters.
ErrorREQFIRSTLASTNAMEBoth First and Last name are required for Sales Person.
ErrorSALEPERSONNAMEFORMATSales Person name only accepts First and Last name.
ErrorDELETE_OPTION_FAILThe contract option can not be deleted.
ErrorIMP_CNTR_0039Option {0} is invalid. Contract VSE00013762 has not been edited/rerated. Contract VSE00013762 : Option (Id: 2012, Description: Option 2012) is invalid.
ErrorUPDATE_OPTION_FAILCannot save contract option.
ErrorCNTNOTEDITRATEContract {0} cannot be edited/rerated.
Error/WarningCNTCANTRATEContract {0} cannot be rated. Warning when contract is in Pending not billed status
Error/WarningRATENOTDEFINEDRates are not defined. Warning when contract is in Pending not billed status
Error/WarningrfvCustLastNameCustomer Last Name is required. Warning when contract is in Pending not billed status
Error/WarningrfvCustAddressCustomer Address is required. Warning when contract is in Pending not billed status
Error/WarningrfvCustCityCustomer City is required. Warning when contract is in Pending not billed status
Error/WarningrfvCustStateCustomer State is required. Warning when contract is in Pending not billed status
Error/WarningrfvCustZipCodeCustomer Zip Code is required. Warning when contract is in Pending not billed status
Error/WarningrevZipCodeInvalid Zip/Postal Code. Warning when contract is in Pending not billed status
Error/WarningVEHICLE_CLASS_NOT_FOUNDVehicle Class is not found. Warning when contract is in Pending not billed status
Error/WarningIMP_CNTR_0051Contract already exists having the same “Sale Date, Plan Code, VIN” Warning when contract is in Pending not billed status. Error when contract is in Pending Billed or Active statuses.
WarningIMP_CNTR_0052Contract already exists having the same “Plan Code, VIN” Warning will not prevent contract update
WarningIMP_CNTR_0053VIN is already in use by another contract. Warning will not prevent contract update
Error/WarningrfvFinanceAmountFinanced Amount is required. Warning when contract is in Pending not billed status
ErrorRETAILRULE3Retail Price is over by {0}.
ErrorRETAILRULE4Retail Price is under by {0}.
ErrorRETAILRULE5Retail Rate entered {0} is not equal to Regulated Retail of {1}.
ErrorRETAILRULE6Retail price must not exceed {0} in order to be activated.
ErrorRETAILRULE11Retail must be {0}.
Error/WarningGETRATES0001The contract is not eligible because the Financed Amount is greater than {0:P3} of the Vehicle Sale Price. Warning when contract is in Pending not billed status
Error/WarningGETRATES0002The contract is not eligible because the Vehicle Sale Price is greater than the Maximum Vehicle Sale Price. Warning when contract is in Pending not billed status
Error/WarningGETRATES0003Financed Amount is greater than {0:P3} of the MSRP. Warning when contract is in Pending not billed status
Error/WarningGETRATES0004MSRP exceeds Maximum MSRP limit of {0}. Warning when contract is in Pending not billed status
Error/WarningGETRATES0017APR is less than Minimum APR limit of {0:P3}. Warning when contract is in Pending not billed status
Error/WarningGETRATES0005APR exceeds Maximum APR limit of {0:P3}. Warning when contract is in Pending not billed status
Error/WarningGETRATES0006Financed Amount is less than Minimum Financed Amount of {0:c}. Warning when contract is in Pending not billed status
Error/WarningGETRATES0014Financed Amount is greater than Maximum Financed Amount of {0:c}. Warning when contract is in Pending not billed status
Error/WarningGETRATES0008APR is required. Warning when contract is in Pending not billed status
Error/WarningGETRATES0009Finance Term is required. Warning when contract is in Pending not billed status
Error/WarningGETRATES0013MSRP is required. Warning when contract is in Pending not billed status
Error/WarningGETRATES0018The term {0} months is not available for this plan. Warning when contract is in Pending not billed status
Error/WarningVIN_NOT_ENTERVIN is not entered. Warning when contract is in Pending not billed status
Error/WarningVIN_INVALIDInvalid VIN. Warning when contract is in Pending not billed status
Error/WarningVHL_ELIG_COVThis vehicle is not eligible for coverage (Eligibility For Manufacturer's Warranty). Warning when contract is in Pending not billed status
Error/WarningEXT_ELIG_REQ_APPRVThis extended eligibility requires approval. Warning when contract is in Pending not billed status
Error/WarningSALEODOM_EXCEED_MILEThe sale odometer exceeds the odometer eligibility mileage. Warning when contract is in Pending not billed status
Error/WarningSALEDATE_INSERVICEDATE_SAMESale date and in service date are the same and the sale odometer is over {0} miles. Warning when contract is in Pending not billed status
Error/WarningRTLRL035You do not have permissions to activate or bill a contract with a Retail Rate that differs from the Regulated Retail. Warning when contract is in Pending not billed status
Error/WarningRTLRL036You do not have permissions to activate or bill a contract with a Retail Rate that differs from allowable Markup. Warning when contract is in Pending not billed status
ErrorCANNOTCRTLIENCannot create lien holder.
ErrorCANNOT_SAVE_VEHICLECannot save vehicle information.
ErrorERROR_LOCKING_CONTRACTContract {0} cannot be locked.
ErrorMENU_DISABLEDMenu not enabled for eContracting.
ErrorCONT_GEN_ERRORCannot generate unique contract number.
ErrorinvldcyclmthrngInvalid cycle month range.
ErrorSAVEFAILCannot save record.
ErrorPAYOPTSAVEFAILCannot save payment option
ErrorBTFLDFORCNTRCreating Billing Transaction failed for Contract
ErrorDLRNOTEXISTDealer does not exist.
ErrorAGTNOTEXISTAgent does not exist on the contract record.
ErrorLINNOTEXISTLien Holder does not exist.
ErrorCycleMonthInvalid2Cycle month is not defined in SCS cycle months.
ErrorBILLPARTYNOTSETBilling Party cannot be set.
InformationCONTRACT_RERATEDWSContract was re-rated via ContractUpdate web service.
InformationCONTRACT_NOT_RERATEDWSContract was modified without a re-rate via ContractUpdate web service.
InformationCNTUPDATBYContract {0} was updated by {1}.
ErrorSTOCK_NUMBER_TOO_LONGStock Number must be 30 characters or less.
ErrorCNNFOUNDContract Number not set.
ErrorCISNOTSETInsured State not set.
ErrorCEDNOTSETContract Entry date not set.
ErrorCNTOPTSINVLDNot all contract options are valid.
ErrorDEALER_NOT_ACTIVE_SALEDATEThe seller account is not active for this sale date.
ErrorDEALER_SALE_AUTHORITYThe seller has no sale authority for this period.
ErrorrfvProgramProgram is required.
Error/WarningPROGRAM_INVALIDProgram is Invalid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorrfvPlanPlan is required.
Error/WarningPLAN_INVALIDPlan is invalid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorIMP_CNTR_0030Plan information is invalid.
ErrorrfvTermTerm is required.
ErrorTERM_INVALIDTerm is invalid.
ErrorrfvDeductDeductible is required.
ErrorDEDUCT_INVALIDThe deductible is invalid.
ErrorINSVDTGTSLDTIn Service Date cannot be greater than sale date.
ErrorINSERVICE_GT_DATEIn Service Date cannot be greater than {0}.
ErrorINSERVICE_LT_YEARIn Service Date cannot be less than year {0}.
ErrorrfvInServiceDateIn Service Date is required.
ErrorVPDTGTSLDTVehicle Purchase Date cannot be greater than sale date.
ErrorVPDTGTTODAYVehicle Purchase Date cannot be greater than {0}.
ErrorrfvVehiclePurchaseDateVehicle Purchase Date is required.
Error/WarningOLAPCNTRROnly pending or active contract can be rated. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningVEHICLEINFOMISGVehicle information is missing or not valid. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorINVALID_OwnershipOwnership Condition is invalid
ErrorINCORRECT_OwnershipOwnership is invalid for the Sale Date and VIN/Sale Odometer combination.
ErrorINVALID_NADANADA is invalid. (This error applies to GAP contracts when eligibility is based on NADA)
ErrorINVALID_RECIPIENT_IDRecipient Id is Invalid
ErrorrevInServiceDateMfg. Warranty Start Date is not within a year of the vehicle model year (e.g. for a 2013 vehicle, the manufacturer warranty start date must be between 1/1/2012 and 12/31/2014)

GetRates Error Messages

Message TypeError codeMessage Text
ErrorGETRATES1001Vehicle is not classified for this plan.
Error/WarningGETRATES1007Manufacturer warranty start date is required. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningGETRATES1008Vehicle’s manufacturer warranty information is not available. Please contact your product provider for further assistance. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningGETRATES1005This vehicle is only eligible for this plan if it is within {0} month(s) of the manufacturer’s base warranty period. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningGETRATES1006This vehicle is only eligible for this plan if it is within {0} miles by odometer of the manufacturer’s base warranty period. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningPlanDealTypePlan is only available for {0} deals. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorrfvVehiclePurchaseDateVehicle Purchase Date is required.
ErrorGETRATES0001The contract is not eligible because the Financed Amount is greater than {0:P3} of the Vehicle Sale Price.
ErrorGETRATES0002The contract is not eligible because the Vehicle Sale Price is greater than the Maximum Vehicle Sale Price.
ErrorGETRATES0003Financed Amount is greater than {0:P3} of the MSRP.
ErrorGETRATES0004MSRP exceeds Maximum MSRP limit of {0}.
ErrorGETRATES0017APR is less than Minimum APR limit of {0:P3}.
ErrorGETRATES0005APR exceeds Maximum APR limit of {0:P3}.
ErrorGETRATES0006Financed Amount is less than Minimum Financed Amount of {0:c}.
ErrorGETRATES0014Financed Amount is greater than Maximum Financed Amount of {0:c}.
ErrorrfvFinanceAmountFinanced Amount is required.
ErrorGETRATES0008APR is required.
ErrorGETRATES0009Finance Term is required.
ErrorrfvDealTypeDeal Type is required.
ErrorGETRATES0013MSRP is required.
ErrorGETRATES0018The term {0} months is not available for this plan.
Error/WarningGETRATES0020The Manufacturer Warranty Start Date for this vehicle is too old to provide any effective coverage. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorSALEODOM_EXCEED_MILEThe sale odometer exceeds the odometer eligibility mileage.
Error/WarningGETRATES1003Vehicle is ineligible for one or more terms based on odometer and/or model year rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningGETRATES1004Vehicle is ineligible for one or more terms based on odometer eligibility rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
Error/WarningGETRATES1009The contract is not eligible based on APR rules. ValidateUpdateContract & UpdateContract: Warning when contract is in Pending not billed status.
ErrorRTLRL035You do not have permissions to activate or bill a contract with a Retail Rate that differs from the Regulated Retail.
ErrorRTLRL036You do not have permissions to activate or bill a contract with a Retail Rate that differs from allowable Markup.
ErrorrevInServiceDateMfg. Warranty Start Date is not within a year of the vehicle model year (e.g. for a 2013 vehicle, the manufacturer warranty start date must be between 1/1/2012 and 12/31/2014).
Modified at 2026-09-08 21:56:52
Previous
10 Print Generate Contract PDF API
Next
12 Reject Contract API
Built with