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

06 Generate Contract API

SCS Generate Contract API

Overview

The SCS Auto Platform provides web services that allow external systems (Integration Partners) to provide accurate rates to dealers and submit contracts electronically using the eRating and eContracting Web Services. Customers of PCMI (Providers) on the SCS Auto platform can enable their dealers and other customers to access their rates and to submit contracts electronically via F&I Presentation and Contracting software that has a certified integration status with SCS Auto. This document describes the technical specifications of the eContracting Web Services that allows submitting a finalized contract to providers who are customers of SCS Auto based on a quote sent earlier in the F&I process via the SCS eRating service.

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

Generate Contract

Request Schema

GenerateContractRequest

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, If not provided SCS will generate one
DealerNumberX(18)RDealer Number
ContractFormNumberX(60)RThis is the PDFFormNo from the rating response.
RegisterNumberX(10)ORegister Number
InserviceDateDateOIn Service Date (manufacturer warranty start date. Required if the vehicle type is NEW and product type is not GAP
SaleDateDateRSale Date
VehiclePurchaseDateDateOVehicle Purchase Date. Required for some products.
SaleOdometerN(7)R
ManufWarrTermN(3)O
ManufWarrMilesN(7)O
VehiclePurchasePriceN(8,2)ORequired for some products.
QuoteIdN(15)RValue from eRating response that identifies the Quote that was used to produce the contract.
PlanCodeX(2)RValue from eRating response
RateBookN(15)RValue from eRating response
GenerateContractDoc umentBooleanOtrue falseTrue = PDF will be generated and returned in Contract response
FinalCopyBooleanOtrue falseFalse = Preview contract will be generated. Validation on all fields will be performed but no contract created. True = Contract created. Default Value is true.
NetCostN(8,2)RThe amount due to the provider for the contract (aka Remit Amount). This value should be the sum of net rate for the selected plan plus the net cost for each of the selected options and surcharges.
RetailCostN(8,2)RThe price charged to the customer for the contract. This value should be the sum of net rate for the selected plan plus the net cost for each of the selected options and surcharges plus the markup added by the dealer.
BaseMarkupN(8,2)OBase markup. If base markup is specified, then RetailCost must equal NetCost + BaseMarkup + FIMarkup
FIMarkupN(8,2)OF&I Markup. If F&I markup is specified, then RetailCost must equal NetCost + BaseMarkup + FIMarkup
FinanceTypeX(4)CBALL LEAS LOAN CASHRequired for some products such as GAP. Values are BALL (balloon), LEAS (lease), LOAN, and CASH.
FinancedAmountN(8,2)CRequired for some products such as GAP.
FinanceAPRN(2,2)CRequired for some products such as GAP.
FinanceTermN(3)CRequired for some products such as GAP.
MsrpN(8,2)CRequired for some products such as GAP.
MonthlyPaymentN(8,2)CGAP contract supplemental Loan/Lease information
FirstPaymentDateN(8,2)OGAP contract supplemental Loan/Lease information
BalloonAmountN(8,2)OGAP contract supplemental Loan/Lease information
ResidualValueN(8,2)OGAP contract supplemental Loan/Lease information
BaseACVN(8,2)OBase ACV is the retail price of the car minus all the options (e.g. roof rack, floor mats, etc.)
NADAValueN(8,2)OGAP contract supplemental Loan/Lease information
InsuranceDeductibleN(5,2)OGAP contract supplemental Loan/Lease information
SalesPersonFnameX(30)OThe First Name of the F&I Mgr/Seller employee who sold the contract.
SalesPersonLnameX(30)OThe Last Name of the F&I Mgr/Seller employee who sold the contract.
ProgramNameX(100)OProgram name
StockNumberX(30)OStock number
DealNumberX(15)ODMS deal number
TermMileRTermMileTerm Mile object
DeductibleRDeductibleDeductible object
VehicleRVehicleVehicle Information object
CustomerRCustomerCustomer object
LienHolderOLienHolderLienholder object
ContractOptionsOContractOption sContract Options object
AdditionalContractInfoCAdditionalContr actInfoAdditional Contract Info object. Required for some products.
TaxInfoRequestC
ContractPDFOBase-64 encoded string that is a digital representation of the filled- out contract in PDF format.
Digitally signedBooleanRtrue, false (default )Whether the contract is digitally signed or not
IsTaxExemptBooleanRtrue, false (default )Indicates if the customer is tax exempt.
AdditionalBaseWarrantyT ermN(3)OAdditional Base Warranty Term (Months)
AdditionalBaseWarranty MilesN(7)OAdditional Base Warranty Miles
AdditionalPowertrainWar rantyTermN(3)OAdditional Powertrain Warranty Term (Months)
AdditionalPowertrain WarrantyMilesN(7)OAdditional Powertrain Warranty Miles
RecipientIdX(20)O

TermMile Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
TermIdN(15)RThe unique number of the term Value from rating engine response
TermN(3)RTerm Value from rating engine response
MileageN(6)RMileage Value from rating engine response

Deductible Object

TagFormatReq/ Opt/ CondAttributesValid ValuesDescription
DeductIdN(15)RThe unique identification number of the deductible Value from rating engine response
DeductAmtN(5,2)RMax value is 1000Deductible amount. Value from rating engine response
DeductTypeX(255)RDisp, Reducing, StandardDeductible type. Value from rating engine response
ReducedAmountN(5,2)CReduced Amount. Required if DeductType = “Reducing”. Value from rating engine response

Vehicle Object

TagFormatReq/ Opt/ CondAttributesValid ValuesDescription
VinNumberX(17)RVIN
VehicleTypeX(1)RN, UVehicle Type. New or Used. This must be the same as the value for NewUsed for the selected plan from the rating response.
AssetTypeX(25)O
YearN(4)O
MakeX(25)O
ModelX(25)O
TrimX(100)O
EngineSizeN(7)O
EngineSizeUnitX(3)OCC, CID
CylX(4)O
DrvX(4)O
FuelX(4)O
AspirationCodeX(4)O
SegmentationCodeX(2)O
TonRatingX(4)O
GVWRX(4)O
BodyStyleX(4)O
OwnershipX(1)C ‘N’ = New ‘P’ = Pre-OwnedOwnership of the vehicle

Customer Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
TitleX(20)O
FirstNameX(30)R
LastNameX(60)R
MiddleInitialX(30)O
EmailX(100)O
AddressRAddressAddress object
AlternateContactX(60)OCo-Buyer name

Address Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
Address1X(30)R
Address2X(30)O
CityX(20)R
StateX(2)R
ZipCodeX(10)R
HomePhoneX(10)O
HomePhoneExtX(4)O
WorkPhoneX(10)O
WorkPhoneExtX(4)O

LienHolder Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
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
ContractOptionGrouping tag used to allow specifying more than one contract option in a single request.
IdN(15)CValue from rating engine response (OptionId).
Required if contract includes options or surcharges.
DescriptionX(60)CValue from rating engine response (OptionDesc). Required if contract includes options or surcharges.
IsSurchargeBooleanCtrue, falseValue from rating engine response (IsSurcharge). Required if contract includes options or surcharges.
NetCostN(8,2)CValue from rating engine response (NetRate). Required if contract includes options or surcharges.

AdditionalContractInfo Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
FieldLabelX(50)CValue from eRating response for Field Label
FieldValueX(50)CData collected for additional contract info.

TaxInfoRequest Object

TagFormatReq/ Opt/ CondAttributesValid valuesDescription
NetTaxAmt1N(8,2)CNet Tax Amount 1. Allows for tax amount to be passed in with the contract request. If Tax is passed with the eContracting request, do not calculate sales tax per SCS configurations, if they exist.
NetTaxAmt2N(8,2)CNet Tax Amount 2. Allows for tax amount to be passed in with the contract request. If Tax is passed with the eContracting request, do not calculate sales tax per SCS configurations, if they exist.
RetailTaxAmt1N(8,2)CRetail Tax Amount 1. Allows for tax amount to be passed in with the contract request. If Tax is passed with the eContracting request, do not calculate sales tax per SCS configurations, if they exist.
RetailTaxAmt2N(8,2)CRetail Tax Amount 2. Allows for tax amount to be passed in with the contract request. If Tax is passed with the eContracting request, do not calculate sales tax per SCS configurations, if they exist.

Sample SOAP Request

<soap:Envelope>
    <soap:Body>
        <GenerateContract [xmlns="http://tempuri.org/ContractService/">
            <contract>
                <ContractOptions>
                    <ContractOption>
                        <Id>**int**</Id>
                        <Description>**string**</Description>
                        <IsSurcharge>**boolean**</IsSurcharge>
                        <NetCost>**decimal**</NetCost>
                    </ContractOption>
                    <ContractOption>
                        <Id>**int**</Id>
                        <Description>**string**</Description>
                        <IsSurcharge>**boolean**</IsSurcharge>
                        <NetCost>**decimal**</NetCost>
                    </ContractOption>
                </ContractOptions>
                <Deductible>
                    <DeductTypeDescriptions>
                        <GlobalInformation xsi:nil="true" />
                        <GlobalInformation xsi:nil="true" />
                    </DeductTypeDescriptions>
                    <DeductId>**int**</DeductId>
                    <DeductAmt>**decimal**</DeductAmt>
                    <DeductType>**string**</DeductType>
                    <ReducedAmount>**decimal**</ReducedAmount>
                </Deductible>
                <TermMile>
                    <TermId>**int**</TermId>
                    <Term>**int**</Term>
                    <Mileage>**int**</Mileage>
                </TermMile>
                <LienHolder>
                    <State>**string**</State>
                    <Phone>**string**</Phone>
                    <City>**string**</City>
                    <ZipCode>**string**</ZipCode>
                    <Name>**string**</Name>
                    <Address1>**string**</Address1>
                    <Address2>**string**</Address2>
                </LienHolder>
                <Vehicle>
                    <Cyl>**string**</Cyl>
                    <Fuel>**string**</Fuel>
                    <Model>**string**</Model>
                    <Drv>**string**</Drv>
                    <VinNumber>**string**</VinNumber>
                    <Make>**string**</Make>
                    <Year>**int**</Year>
                    <VehicleType>**string**</VehicleType>
                    <AspirationCode>**string**</AspirationCode>
                    <SegmentationCode>**string**</SegmentationCode>
                    <TonRating>**string**</TonRating>
                    <GVWR>**string**</GVWR>
                </Vehicle>
                <Customer>
                    <Title>**string**</Title>
                    <FirstName>**string**</FirstName>
                    <LastName>**string**</LastName>
                    <MiddleInitial>**string**</MiddleInitial>
                    <Email>**string**</Email>
                    <Address>
                        <Address1>**string**</Address1>
                        <Address2>**string**</Address2>
                        <City>**string**</City>
                        <State>**string**</State>
                        <ZipCode>**string**</ZipCode>
                        <HomePhone>**string**</HomePhone>
                        <HomePhoneExt>**string**</HomePhoneExt>
                        <WorkPhone>**string**</WorkPhone>
                        <WorkPhoneExt>**string**</WorkPhoneExt>
                    </Address>
                    <AlternateContact>**string**</AlternateContact>
                </Customer>
                <AdditionalContractInfo>
                    <FieldLabel>**string**</FieldLabel>
                    <FieldValue>**string**</FieldValue>
                </AdditionalContractInfo>
                <TaxInfoRequest>
                    <NetTaxAmt1>string</NetTaxAmt1>
                    <NetTaxAmt2>string</NetTaxAmt2>
                    <RetailTaxAmt1>string</RetailTaxAmt1>
                    <RetailTaxAmt2>string</RetailTaxAmt2>
                </TaxInfoRequest>
                <ContractNumber>**string**</ContractNumber>
                <ContractFormNumber>**string**</ContractFormNumber>
                <RegisterNumber>**string**</RegisterNumber>
                <DealerNumber>**string**</DealerNumber>
                <InserviceDate>**dateTime**</InserviceDate>
                <SaleDate>**dateTime**</SaleDate>
                <VehiclePurchaseDate>**dateTime**</VehiclePurchaseDate>
                <SaleOdometer>**int**</SaleOdometer>
                <ManufWarrTerm>**int**</ManufWarrTerm>
                <ManufWarrMiles>**int**</ManufWarrMiles>
                <VehiclePurchasePrice>**decimal**</VehiclePurchasePrice>
                <PlanCode>**string**</PlanCode>
                <RateBook>**int**</RateBook>
                <FinalCopy>**boolean**</FinalCopy>
                <RetailCost>**decimal**</RetailCost>
                <NetCost>**decimal**</NetCost>
                <FinanceType>**string**</FinanceType>
                <FinancedAmount>**decimal**</FinancedAmount>
                <FinanceApr>**decimal**</FinanceApr>
                <FinanceTerm>**int**</FinanceTerm>
                <Msrp>**decimal**</Msrp>
                <MonthlyPayment>**decimal**</MonthlyPayment>
                <FirstPaymentDate>**dateTime**</FirstPaymentDate>
                <BalloonAmount>**decimal**</BalloonAmount>
                <ResidualValue>**decimal**</ResidualValue>
                <BaseACV>**decimal**</BaseACV>
                <NADAValue>**decimal**</NADAValue>
                <InsuranceDeductible>**decimal**</InsuranceDeductible>
                <SalesPersonFname>**string**</SalesPersonFname>
                <SalesPersonLname>**string**</SalesPersonLname>
                <ContractPDF>**string**</ContractPDF>
                <DigitallySigned>**boolean**</DigitallySigned>
                <QuoteId>**int**</QuoteId>
                <GenerateContractDocument>**boolean**</GenerateContractDocument>
                <IsTaxExempt>**boolean**</IsTaxExempt>
                <BaseMarkup>**decimal**</BaseMarkup>
                <FIMarkup>**decimal**</FIMarkup>
                <ProgramName>**string**</ProgramName>
                <StockNumber>**string**</StockNumber>
                <DealNumber>**string**</DealNumber>
            </contract>
        </GenerateContract>
    </soap:Body>

Response Schema

GenerateContractResponse Object

TagContent ItemsFormatDescription
Response Code2 = Successful, passed with a warning. 1 = Successful. 0 = Failed. Error returned. see Message Object for Type
ContractDocumentContract Document
ContractNumberN(12)
EffectiveDateDate
EffectiveOdometerN(7)
ExpirationDateDate
ExpirationOdometerN(7)
AdditionalBaseWarrantyTermN(3)Value specified in the eContracting request.
AdditionalBaseWarrantyMilesN(7)Value specified in the eContracting request.
AdditionalPowertrainWarrantyTermN(3)Value specified in the eContracting request.
AdditionalPowertrainWarrantyMilesN(7)Value specified in the eContracting request.
TotalBaseWarrantyTermN(3)The sum of the configured Base Warranty (term) plus the Additional Base Warranty (term)
TotalBaseWarrantyMilesN(7)The sum of the configured Base Warranty (miles) plus the Additional Base Warranty (miles)
TotalPowertrainWarrantyTermN(3)The sum of the configured Powertrain Warranty (term) plus the Additional Powertrain Warranty (term)
TotalPowertrainWarrantyMilesN(7)The sum of the configured Powertrain Warranty (miles) plus the Additional Powertrain Warranty (miles)
TaxTax Object
MessagesMessage ObjectCollection of Messages.

Tax Object

TagFormatReq/ Opt/ CondValid valuesDescription
NetTaxAmt1N(8,2)CReturned if taxes are configured.
NetTaxAmt2N(8,2)CReturned if taxes are configured.
RetailTaxAmt1N(8,2)CReturned if taxes are configured.
RetailTaxAmt1N(8,2)CReturned if taxes are configured.
TotalRetailTaxAmtN(8,2)CReturned if taxes are configured.
Tax1TaxLabelX(50)CReturned if taxes are configured.
Tax2TaxLabelX(50)CReturned if taxes are configured.

Message Object

TagFormatReq/ Opt/ CondValid valuesDescription
TypeIntegerR1. – Error 2. – Info 3. – Warning 4. - SuccessMessage Type
CodeString X(30)R
TextString X(2000)RMessage Text

eSignature

Signature fields are sent on the PDF documents. Signature fields can be identified by the names of these fields. All signature fields will have the following format:

Sign<SignatureType><Actor><Date>

The most common field names would be:
SignFullBuyer
SignFullBuyerDate
SignFullCoBuyer1
SignFullCoBuyer1Date
SignFullSeller
SignFullSellerDate
SignInitBuyer
SignInitCoBuyer1

Error Messages

Message TypeError codeMessage Text
ErrorrfvTPACodeTPA Code is required.
ErrorVD0003TPA is invalid.
ErrorERRSESSIONUnable to create session.
ErrorWSLICEN001License not available.
ErrorVD0009Authentication Failed.
ErrorWSSECUR001You do not have necessary permission to execute this web method.
ErrorERRINREQError in request.
ErrorNOQUOTEFNDInvalid Quote ID.
ErrorQUOTEEXPQuote ID {0} has expired as of {1}.
ErrorIMP_CNTR_0023Seller not enabled for contracting.
ErrorDLRNOTEXISTDealer does not exist.
ErrorIMP_CNTR_0074Either seller does not have sale authority for the plan, or that the plan is ineligible due to plan configuration (date and state intervals).
ErrorPHONEINVALIDInvalid Phone number.
ErrorrfvCustLastNameCustomer Last Name is required.
ErrorrfvCustAddressCustomer Address is required.
ErrorrfvCustCityCustomer City is required.
ErrorrfvCustStateCustomer State is required.
ErrorrfvCustZipCodeCustomer Zip Code is required.
ErrorINVCUSTSTAInvalid Customer state code.
ErrorCNTR_SRVC_0003Watermark file name is not provided.
ErrorIMP_CNTR_0058Invalid form directory path.
ErrorCNTR_SRVC_0001Error finding forms directory.
ErrorDEALER_NOT_ACTIVE_SALEDATEThe seller account is not active for this sale date.
ErrorNO_SALE_AUTHORITYSeller does not have Sale Authority for this product as of {0}
ErrorPROGRAM_INVALIDProgram is Invalid
ErrorVEHTYPREQDVehicle Type is required.
ErrorVEHTYPINVDInvalid Vehicle Type.
ErrorIMP_CNTR_0030Plan information is invalid.
ErrorIMP_CNTR_0079A unique plan could not be identified since multiple plan codes for the same rate book and/or program are eligible for sale. Provide the Program and/or Rate book to assist in the return of a single plan
ErrorrfvInServiceDateIn Service Date is required.
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_0015Duplicate contract number.
ErrorIMP_CNTR_0051Contract already exists having the same “Sale Date, Plan Code, VIN”
WarningIMP_CNTR_0052Contract already exists having the same “Plan Code, VIN”
WarningIMP_CNTR_0053VIN is already in use by another contract.
ErrorIMP_CNTR_0047Sale odometer cannot be over {0} if Sale date and In Service Date are the same.
ErrorINVALID_SALE_ODOMInvalid Sale Odometer.
ErrorIMP_CNTR_0031Insurance Carrier information 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.
ErrorIMP_CNTR_0033Term and Mileage information is invalid.
ErrorDEDUCT_INVALIDThe deductible is invalid.
ErrorVIN_NOT_ENTERVIN is not entered.
ErrorVEHICLEINFOMISGVehicle information is missing or not valid.
WarningIMP_CNTR_0068VIN could not be decoded.
ErrorIMP_CNTR_0046This vehicle is not eligible based on the sale odometer, model year and/or manufacturer warranty information supplied.
ErrorRetailMarkupComputeThe contract is not eligible because the Retail Cost must equal Net Cost plus Base Markup and F&I Markup.
ErrorIMP_CNTR_0020Error Creating the Register.
ErrorIMP_CNTR_0017Invalid Register Number. The register is used by another seller.
ErrorSALEODOM_EXCEED_MILEThe sale odometer exceeds the odometer eligibility mileage.
ErrorEXPDATE_LT_SALEDATE_ECONTRThe contract cannot be created because the expiration date {1} is earlier than the sale date {2}.
ErrorIMP_CNTR_0040Incorrect Contract Form Number. Form# {0} must be used.
ErrorIMP_CNTR_0056Invalid watermark file path.
ErrorIMP_CNTR_0055Contract form not found.
ErrorIMP_CNTR_0057Form File handling error.
ErrorIMP_CNTR_0058Invalid form directory path.
ErrorIMP_CNTR_0036The submitted option (Id: Description: ) does not match the surcharge tag value.
ErrorIMP_CNTR_0001Submitted Option Cost ({0}) is different from Rate Option Cost ({1}) for Option {2}.
ErrorIMP_CNTR_0038Option {0} is a surcharge and is not selected.
ErrorIMP_CNTR_0039Option {0} is invalid.
ErrorIMP_CNTR_0024Submitted Total Contract Cost ({0:c}) is different from Rated Total Contract Cost({1:c}).
ErrorrfvFinanceAmountFinanced Amount is required.
ErrorIMP_CNTR_0076{0} Retail must be {1:c} based on plan eligibility rules.
ErrorIMP_CNTR_0048Retail Price must be between {0:c} and {1:c} based on plan eligibility rules.
ErrorIMP_CNTR_0077Retail must be less than or equal to {0:c} based on eligibility rules.
ErrorIMP_CNTR_0078Retail must be greater than or equal to {0:c} based on eligibility rules.
ErrorRETAIL_RATE_DISCOUNTEDRetail Price must be less than or equal to {0:c}.
ErrorIMP_CNTR_0049Retail Price must be {0:c} based on plan eligibility rules.
ErrorSALEDATE_EXCEED_MINSale Date cannot be less than {0}.
ErrorSALEDATE_EXCEEDSale Date exceeds future Sale Date limit.
ErrorrfvSaleDateSale Date is required.
ErrorVPDTGTTODAY2Vehicle Purchase Date cannot be greater than today's date.
ErrorEFFDATE_GT_EXPDATEEffective Date cannot be greater than or equal to Expiration Date.
ErrorEFFODOM_GT_EXPODOMEffective Odometer is greater than the Expiration Odometer based on plan eligibility rules. Contract cannot be saved.
ErrorSALEODOM_LT_EXPODOMSale Odometer must be less than Expiration Odometer.
ErrorEMAILVALIDEmail not in correct format.
ErrorrevZipCodeInvalid Zip/Postal Code.
ErrorFIMgrReqOnContractPlease select F&I Manager, it is required to issue a commission payment.
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.
ErrorSTOCK_NUMBER_TOO_LONGStock Number must be 30 characters or less.
ErrorERATING_TRIMREQThere are more rates available which require specification of a Trim value. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5]. Please resubmit the rating request with the Trim specified.
ErrorTrim is required.
ErrorINVALIDTRIMTrim is invalid for VIN. The VIN’s available Trims are [Trim1], [Trim2], … and [Trim5].
ErrorAsset Type is required.
ErrorINVDADDLBASEWARRAdditional Base Warranty is invalid, both Term and Mileage must be provided.
ErrorADDLBASETERMMILEREQDAdditional Base Warranty term and mileage specified are not valid for use as an Additional Base Warranty.
ErrorINVDADDLPWRWARRAdditional Powertrain Warranty is invalid, both Term and Mileage must be provided.
ErrorADDLPWRTERMMILEREQDAdditional Powertrain Warranty term and mileage specified are not valid for use as an Additional Powertrain Warranty.
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)
Modified at 2026-10-01 16:23:56
Previous
05 Get Lienholders API
Next
07 Contract Void API
Built with