SCS Print Contract PDF API
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 |
Contract Reprint (PrintContractPDF)
This method allows a selling dealer to reprint a previously submitted contract. Only the dealer who sold the contract can request the reprint of a contract. The contract can only be reprinted if the contract is not in ‘void’, ‘rejected’, ‘expired’, and ‘cancelled’ status in SCS. If the contract cannot be reprinted, an error message is returned. In SCS the following note will be added to the contract: “Contract was reprinted by .”
Request Schema
PrintContractPDFRequest Object
| | | | | |
|---|
| Tag | Format | Req/ Opt/ Cond | Attributes | Valid values | Description |
| TpaCode | X(4) | R | | | Third Party Administrator Code |
| UserId | X(30) | R | | | User ID issued to the requesting system |
| Password | X(255) | R | | | Password issued to the requesting system |
| RequestingUser | X(50) | R | | | The name of the F&I manager, office manager or other user of the system that is requesting the contract reprint. |
| ContractNumber | X(20) | R | | | Contract Number for the contract to be reprinted. |
| DealerNumber | X(18) | R | | | Dealer Number |
Response Schema
PrintContractPDF Object
| | | |
|---|
| Tag | Content Items | Format | Description |
| PrintContractPDF | | | |
| ContractDocument | | Contract Document |
| Messages | Message Object | Collection of Message. |
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 | O | | Reserved for future use |
| Text | String | R | | Message Text |
Error Messages
| |
|---|
| Message Type | Message Text |
| Error | Invalid contract number. |
| Error | TPA Code is required. |
| Error | TPA is invalid. |
| Error | Invalid Seller Number. |
| Error | Contract Number is required. |
| Error | Only selling dealers can reprint contracts. |
| Error | Contract could not be reprinted. Please contact the provider for further assistance. |