SCS Submit Remittance API

Overview

The SubmitRemittance web service provides the ability to submit a list of contracts for remittance. The web service will create one or more remittances based on the contracts submitted. The web service will group contracts of the same products into multiple remittances; so as many remittances will be created as there are distinct produc ts in the contract set that is submitted.

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 type	Description	Example
X(10)	Characters of max length of 10	ABCDEABCDE
Date	yyyy-mm-dd	2000-12-21
DateTime	yyyy-mm-ddThh:mm:ss	2000-12-21T12:24:40
N(5)	Number,max length of 5	12345
N(8,2)	Number with two decimals, max length of 8.	123456.78
Boolean	Boolean true or false	true

SubmitRemittance Request Schema

SubmitRequest Object


Tag	Format	Req/ Opt/ Con d	Attributes	Valid values	Description
TpaCode	X(4)	R			Third Party Administrator Code. The three letter code assigned to each supported SCS Auto provider.
UserId	X(30)	R			User ID. Required for secure access to SCS Auto SubmitRemittance Web Service.
Password	X(255)	R			Password. Required for secure access to SCS Auto SubmitRemittance Web Service.
RequestingUser	X(100)	R			Required to track submitted remittance by Requesting User.
ContractNumbers		R			ContractNumbers object List of string values representing ContractNumbers List (array 1..N) of string
Sellers section (new in Release 9.5)					Optional section. If populated, seller number and contract number(s) are required. Seller number will be validated as the selling dealer for the contract numbers provided. NOTE: Remove the Sellers section from the request to continue using the Remittance API as it was prior to release 9.5.
SellerNumber	X(20)	C			Seller Number for the contracts being remitted.
ContractNumbers		C			ContractNumbers object List of string values representing ContractNumbers List (array 1..N) of string
AutomaticPendingBilled (new in Release 9.5)				False (default) True	False – Contracts will move to pending-billed when the nightly job runs (after the remittance has been submitted) True – Contracts will automatically move to pending- billed when the remittance is submitted.

ContractNumbers Object


Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
ContractNumber					Contract number to include in Remittance.

Sample Request (full request)

<soap:Envelope xmlns:soap="<http://www.w3.org/2003/05/soap-envelope>" xmlns:rem="<http://tempuri.org/RemittanceService/>">
<soap:Header/>
    <soap:Body>
        <Submit>
            <request>
                <UserId>?</UserId>
                <Password>?</Password>
                <TpaCode>?</TpaCode>
                <RequestingUser>?</RequestingUser>
                <ContractNumbers>
                    <ContractNumber>?</ContractNumber>
                </ContractNumbers>
                <sellers>
                    <seller>
                        <SellerNumber>?</SellerNumber>
                        <ContractNumbers>
                            <ContractNumber>?</ContractNumber>
                        </ContractNumbers>
                    </seller>
                </sellers>
                <AutomaticPendingBilled>false</AutomaticPendingBilled>
            </request>
        </Submit>
    </soap:Body>
</soap:Envelope>

Sample Request 1 (Sellers section removed, no seller number validation occurs)

<soap:Envelope xmlns:soap="<http://www.w3.org/2003/05/soap-envelope>" xmlns:rem="<http://tempuri.org/RemittanceService/>">
<soap:Header/>
    <soap:Body>
        <Submit>
            <request>
                <UserId>xxxx</UserId>
                <Password>xxxxx</Password>
                <TpaCode>xxxx</TpaCode>
                <RequestingUser>?</RequestingUser>
                <ContractNumbers>
                    <ContractNumber>DAP00000054</ContractNumber>
                    <ContractNumber>DAP00000055</ContractNumber>
                    <ContractNumber>DAP00000056</ContractNumber>
                </ContractNumbers>
                <AutomaticPendingBilled>false</AutomaticPendingBilled>
            </request>
        </Submit>
    </soap:Body>
</soap:Envelope>

Sample Request 2 (with seller number validation)

<soap:Envelope xmlns:soap="<http://www.w3.org/2003/05/soap-envelope>" xmlns:rem="<http://tempuri.org/RemittanceService/>">
<soap:Header/>
    <soap:Body>
        <Submit>
            <request>
                <UserId>xxx</UserId>
                <Password>xxxxx</Password>
                <TpaCode>xxx</TpaCode>
                <RequestingUser>?</RequestingUser>
                <ContractNumbers>
                    <ContractNumber>?</ContractNumber>
                </ContractNumbers>
                <sellers>
                    <seller>
                        <SellerNumber>1505</SellerNumber>
                        <ContractNumbers>
                            <ContractNumber>DAP00000054</ContractNumber>
                            <ContractNumber>DAP00000055</ContractNumber>
                            <ContractNumber>DAP00000056</ContractNumber>
                        </ContractNumbers>
                    </seller>
                </sellers>
                <AutomaticPendingBilled>false</AutomaticPendingBilled>
            </request>
        </Submit>
    </soap:Body>
</soap:Envelope>

Response Schema

SubmitResult Object


Tag	Content Items	Format	Description
SubmitResult/
	Response Code		2 = Successful, passed with a warning. 1 = Successful. 0 = Failed. Error returned. see Message Object for Type
	Messages	Message Object	Collection of Messages.
	Remittances	Remittances Object	Collection of Remittances

Remittances Object


Tag	Content Items	Format	Description
Remittances/
	RemittanceInformation	RemittanceInformation Object	Collection of Remittances

RemittanceInformation Object


Tag	Format	Req/ Opt/ Cond	Valid values	Description
RemittanceID (new in Release 9.5)				System generated remittance ID
RemittanceNumber				Remittance Number
SellerNumber				Seller Number
ProductType				Product Type
SubmittedDate				Date submitted
CycleMonth				Accounting month at the time of submission
TotalContractCount				Total number of included contracts
TotalAmount				Total dollar net cost of included contracts
Contracts				Contracts object. List of contracts included in the remittance
BillingParties				BillingParties object. List of Billing Parties.

Contracts Object


Tag	Format	Req/ Opt/ Cond	Valid values	Description
ContractNumber				Remittance Contract Number or List of Contract Numbers.

BillingParties Object


Tag	Format	Req/ Opt/ Cond	Valid values	Description

BillingPartyTypeCode				Type code for billing party
BillingParty				Billing Party reference (i.e. Seller Number, Agent Number, Lien Holder Number, or Customer Name)
BillingPartyTotalContr actCount				Total number of contracts for billing party type
BillingPartyTotalAmo unt				Total dollar net cost of contracts for billing party type

Message Object


Tag	Format	Req/ Opt/ Cond	Valid values	Description
Type	Integer	R	1 = Error, 2 = Info, 3 = Warning, 4 = Success	Message Type
Code	String X(30)	R
Text	String X(2000)	R		Message Text

Error Messages


Message Type	Error code	Message Text
Error	VD0003	TPA is invalid.
Error	VD0009	Authentication Failed.
Error	WSSECUR001	You do not have necessary permission to execute this web method.
Error	ContractNumber	Contract number is required
Error	ERRINREQ	Error in request.
Error	VD0015	Requesting User is required.
Error	REM_002	Remittance submission failed due to inclusion of non-Pending contract(s) [comma separated contract numbers]
Error	RemitSubmitLock	Remittance submission failed due to locked contracts [comma separated contract numbers]
Error	Contract_Num_Invalid	Incorrect Contract Number(s) submitted.
Error		One or more contracts have been already remitted. Please review the contracts again and remit them. Remittance not submitted. Dealer Number: [dealer number] No: [contract number], ProductTypeID: [product type id number]
Error	VD0004 .	Seller Number [seller number] is not a valid seller number
Error	SellerNumber	Seller Number is required to remit contracts [comma separated contract numbers].
Error	VD0001	Seller Number [dealer number] provided does not have contracts [comma separated contract numbers]
Error	VD0017	Seller Number [dealer number] provided does not match the selling dealer for contracts [comma separated contract numbers].
Error	ContractNumber	Use existing message 'Contract Number is required.' (Error Code 'ContractNumber')

Sample Response

<soap:Envelope xmlns:soap="<http://www.w3.org/2003/05/soap-envelope>" xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>" xmlns:xsd="<http://www.w3.org/2001/XMLSchema>">
    <soap:Body>
        <SubmitResponse xmlns="<http://tempuri.org/RemittanceService/>">
            <SubmitResult>
                <ResponseCode>1</ResponseCode>
                <Messages/>
                <Remittances>
                    <RemittanceInformation>
                        <RemittanceID>202</RemittanceID>
                        <RemittanceNumber>1505-003</RemittanceNumber>
                        <SellerNumber>1505</SellerNumber>
                        <ProductType>GAP</ProductType>
                        <SubmittedDate>2021-06-23T00:00:00</SubmittedDate>
                        <CycleMonth>2021-03-01T00:00:00</CycleMonth>
                        <TotalContractCount>1</TotalContractCount>
                        <TotalAmount>2000.0000</TotalAmount>
                        <Contracts>
                            <RemittanceContract>                           <RemittanceContractNumber>DAP00000050</RemittanceContractNumber>
                            </RemittanceContract>
                        </Contracts>
                        <BillingParties>
                            <RemittanceBillingParty>
                                <BillingPartyTypeCode>SLR</BillingPartyTypeCode>
                                <BillingParty>1505</BillingParty>
                                <BillingPartyTotalContractCount>1</BillingPartyTotalContractCount>
                                <BillingPartyTotalAmount>2260.0000</BillingPartyTotalAmount>
                            </RemittanceBillingParty>
                        </BillingParties>
                    </RemittanceInformation>
                    <RemittanceInformation>
                        <RemittanceID>203</RemittanceID>
                        <RemittanceNumber>1505-004</RemittanceNumber>
                        <SellerNumber>1505</SellerNumber>
                        <ProductType>VSC</ProductType>
                        <SubmittedDate>2021-06-23T00:00:00</SubmittedDate>
                        <CycleMonth>2021-03-01T00:00:00</CycleMonth>
                        <TotalContractCount>1</TotalContractCount>
                        <TotalAmount>2000.0000</TotalAmount>
                        <Contracts>
                            <RemittanceContract>
                            <RemittanceContractNumber>DAP00000049</RemittanceContractNumber>
                            </RemittanceContract>
                        </Contracts>
                        <BillingParties>
                            <RemittanceBillingParty>
                            <BillingPartyTypeCode>SLR</BillingPartyTypeCode>
                            <BillingParty>1505</BillingParty>
                        <BillingPartyTotalContractCount>1</BillingPartyTotalContractCount>
                            <BillingPartyTotalAmount>2100.0000</BillingPartyTotalAmount>
                            </RemittanceBillingParty>
                        </BillingParties>
                    </RemittanceInformation>
                    <RemittanceInformation>
                        <RemittanceID>204</RemittanceID>
                        <RemittanceNumber>1505-005</RemittanceNumber>
                        <SellerNumber>1505</SellerNumber>
                        <ProductType>MNT</ProductType>
                        <SubmittedDate>2021-06-23T00:00:00</SubmittedDate>
                        <CycleMonth>2021-03-01T00:00:00</CycleMonth>
                        <TotalContractCount>1</TotalContractCount>
                        <TotalAmount>150.2500</TotalAmount>
                        <Contracts>
                            <RemittanceContract>
                            <RemittanceContractNumber>DAP00000051</RemittanceContractNumber>
                            </RemittanceContract>
                        </Contracts>
                        <BillingParties>
                            <RemittanceBillingParty>
                                <BillingPartyTypeCode>SLR</BillingPartyTypeCode>
                                <BillingParty>1505</BillingParty>
                            <BillingPartyTotalContractCount>1</BillingPartyTotalContractCount>
                                <BillingPartyTotalAmount>165.2700</BillingPartyTotalAmount>
                            </RemittanceBillingParty>
                        </BillingParties>
                    </RemittanceInformation>
                </Remittances>
            </SubmitResult>
        </SubmitResponse>
    </soap:Body>
</soap:Envelope>

14 Submit Remittance API

SCS Submit Remittance API#

Overview#

Data Format#

SubmitRemittance Request Schema#

SubmitRequest Object#

ContractNumbers Object#

Sample Request (full request)#

Sample Request 1 (Sellers section removed, no seller number validation occurs)#

Sample Request 2 (with seller number validation)#

Response Schema#

SubmitResult Object#

Remittances Object#

RemittanceInformation Object#

Contracts Object#

BillingParties Object#

Message Object#

Error Messages#

Sample Response#