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

07 Contract Void API

SCS Contract Void API#

Contract Void#

This method allows a selling dealer to ‘void’ a previously submitted contract. Only the dealer who sold the contract can request the voiding of a contract. The contract can only be voided if the contract is not already in ‘active’ status in SCS or if no payment has been yet applied to it. If the contract cannot be voided for any reason other than the request coming in from a non-selling dealer, an error message is returned.

Request Schema#

VoidContract Object#

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
RequestingUserX(50)RThe name of the F&I manager, office manager or other user of the system that is requesting the void.
ContractNumberX(20)RContract Number to be voided.
VINX(17)RVehicle Identification Number.
DealerNumberX(18)RDealer Number

Response Schema#

VoidContractResponse Object#

TagContent ItemsFormatDescription
ContractVoid
VoidContractResult
ResponseCode1 = Successful, the contract was voided; 0 = Contract was not voided. See Message Object for Type
MessagesMessage ObjectCollection of Messages.

Message Object#

TagFormatReq/ Opt/ CondValid valuesDescription
TypeIntegerR1 = Error, 2 = Info, 3 = Warning, 4 = SuccessMessage Type
CodeStringOReserved for future use
TextStringRMessage Text

Error Messages#

Message TypeError codeMessage Text
ErrorVD0001Invalid contract number.
ErrorrfvTpaCodeTPA Code is required.
ErrorVD0003TPA is invalid.
ErrorVD0004Invalid Seller Number.
ErrorrfvContractNumberContract Number is required.
ErrorVD0001Invalid contract number.
ErrorVD0006Only selling dealers can void contracts.
ErrorVD0015Requesting User is required.
ErrorVOID_CONTRACT_BILLEDThis contract cannot be voided because it has been billed.
ErrorVD0007VIN does not match VIN on the contract.
ErrorVD0014Contract # …. is locked by another user. Please unlock the contract before making changes.
Modified at 2026-09-08 21:56:42
Previous
06 Generate Contract API
Next
08 Contract Info API
Built with