Update Sales Contract
This endpoint allows you to update an existing Sales Contract identified by the contractID. The request is made using the HTTP PUT method, and it requires a JSON payload that contains various insurance-related details.
Request Body Format
The request body must be in JSON format and include the following parameters:
-
insurance_policy_no (string): The policy number associated with the insurance.
-
insurance_until_cancelled (integer): Indicates if the insurance is valid until cancelled (1 for true).
-
insurance_fire (integer): Indicates if fire insurance is included (1 for true).
-
insurance_theft (integer): Indicates if theft insurance is included (1 for true).
-
insurance_collision_deductible (integer): Indicates if a collision deductible is applicable (1 for true).
-
insurance_collision_deductible_amount (integer): The amount for the collision deductible.
-
insurance_comprehensive_deductible (integer): Indicates if a comprehensive deductible is applicable (1 for true).
-
insurance_comprehensive_deductible_amount (integer): The amount for the comprehensive deductible.
-
doctype (string): The type of document, which should be "Sales Contract".
-
insurance_provider_addresses (array): An array of addresses related to the insurance provider (currently empty).
-
insurance_agent_contact_methods (array): An array of contact methods for the insurance agent, where each contact method includes:
-
phone (string): The phone number of the contact method.
-
do_not_call (boolean): Indicates if the contact prefers not to be called.
-
do_not_text (boolean): Indicates if the contact prefers not to be texted.
-
is_priority (integer): Indicates if this contact method is a priority (1 for true).
-
creation (string): The creation date of the contact method (currently empty).
-
name (string): The name associated with the contact method (currently empty).
-
type (string): The type of contact method (e.g., "Mobile").
-
-
insurance_company_phone_no (array): An array of phone numbers for the insurance company, structured similarly to the agent contact methods.
-
insurance_company (string): The name of the insurance company.
-
insurance_agent (string): The name of the insurance agent.
-
insurance_effective_date (string): The effective date of the insurance policy in YYYY-MM-DD format.
-
insurance_expire_cancel_date (string): The expiration or cancellation date of the insurance policy (can be empty).
Response Structure
The response from this request will typically include a confirmation of the update operation, along with the updated details of the Sales Contract. The exact structure of the response may vary, but it generally includes:
-
status (string): Indicates whether the update was successful or if there was an error.
-
message (string): Provides additional information about the result of the update.
-
data (object): Contains the updated Sales Contract details.
Make sure to provide valid values for each parameter when making the request to ensure successful processing.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Request Body
Sales contract ID is provided as path parameter.
Response structure
The response returns detailed information for a single Sales Contract, including contract metadata, vehicle details, buyer and lender information, accounting references, insurance details, and associated document templates.
Sales Contract
- name – Unique identifier of the Sales Contract
- owner – User who created the Sales Contract
- creation – Timestamp when the Sales Contract was created
- modified – Timestamp of the last modification
- modified_by – User who last modified the Sales Contract
- docstatus – Document status (1 = Submitted / Booked)
- workflow_state – Current workflow state of the Sales Contract
- status – Business status of the Sales Contract
- custom_risk_factor – Risk category assigned to the contract
- naming_series – Naming pattern used for the Sales Contract
- doctype – Document type (Sales Contract)
Quote & Sale Details
- quote – Linked quotation reference
- type_of_sale – Type of sale
- sale_date – Date on which the sale occurred
- year_of_sale – Year of the sale
- posting_date – Accounting posting date
- posting_time – Accounting posting time
- funded_date – Date when the contract was funded
Company & Branch Details
- company – Company under which the Sales Contract is created
- company_branch – Branch associated with the Sales Contract
- state – State where the sale took place
Vehicle Details
- stock_no – Stock number of the vehicle
- vehicle_item – Vehicle identifier including model and VIN
- odometer_reading_type – Type of odometer reading
- odometer_reading – Odometer value at the time of sale
- odometer_reading_date – Date when odometer reading was recorded
- basic_exterior_color – Basic exterior color of the vehicle
- exterior_color – Detailed exterior color of the vehicle
Customer & Lender Details
- customer – Customer identifier
- customer_name – Customer full name
- lender – Lender associated with the financing
- note – Notes added to the Sales Contract
Accounting Details
- sales_invoice – Linked Sales Invoice reference
- journal_entry – Linked Journal Entry reference
- customer_receivable_account – Customer accounts receivable account
- lender_receivable_account – Lender accounts receivable account
- deferred_down_receivable_account – Deferred down payment receivable account
- vit_account – Vehicle Inventory Tax account reference
- ad_valorem_classifier – Ad valorem tax classification
Insurance Details
- insurance_policy_no – Insurance policy number
- insurance_until_cancelled – Indicates if insurance is valid until cancelled
- is_cpi_provider – Indicates CPI provider usage
- insurance_fire – Fire insurance coverage indicator
- insurance_fire_deductible_amount – Fire insurance deductible amount
- fire_term – Fire insurance term
- insurance_theft – Theft insurance coverage indicator
- insurance_theft_deductible_amount – Theft insurance deductible amount
- theft_term – Theft insurance term
- insurance_collision_deductible – Collision insurance indicator
- insurance_collision_deductible_amount – Collision deductible amount
- collision_term – Collision insurance term
- insurance_comprehensive_deductible – Comprehensive insurance indicator
- insurance_comprehensive_deductible_amount – Comprehensive deductible amount
- comprehensive_term – Comprehensive insurance term
Document Package
- document_package – Document package applied to the Sales Contract
Emotive Document Print
Each entry represents a document associated with the Sales Contract.
- name – Unique identifier of the document record
- document – Display name of the document
- template – Template used for document generation
- is_default – Indicates default document
- idx – Display order of the document
- parent – Parent Sales Contract ID
- doctype – Document type (Emotive Document Print)
{
"data": {
"name": "C-0000007422",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.058116",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 9,
"custom_risk_factor": "High",
"workflow_state": "Booked",
"quote": "2026-QTE-01-00695",
"company": "Emotive Auto Sales Inc.",
"company_branch": "Emotive Auto Sales Inc. - 01",
"status": "Booked",
"type_of_sale": "In House Finance",
"sale_date": "2025-11-02",
"year_of_sale": 2025,
"posting_date": "2025-11-02",
"posting_time": "6:43:55.426266",
"naming_series": "C-.##########",
"stock_no": "P03238",
"vehicle_item": "2008 Dodge Charger-2B3KA53H08H306158",
"odometer_reading_type": "Actual",
"odometer_reading_date": "2025-03-25",
"basic_exterior_color": "",
"state": "TX-Texas",
"vit_account": "12900",
"ad_valorem_classifier": "MV",
"odometer_reading": "10000",
"exterior_color": "",
"customer": "2025-01703",
"customer_name": "Sravya D",
"lender": "Lender for Automation",
"funded_date": "2025-11-02",
"note": "add note",
"sales_invoice": "2026-SINV-01-0000487",
"journal_entry": "2026-JE-01-00658",
"customer_receivable_account": "1215 - A/R - Contract-In-Transit - ESI",
"lender_receivable_account": "1215 - A/R - Contract-In-Transit - ESI",
"deferred_down_receivable_account": "1210 - A/R - Deferred Down Payment - ESI",
"insurance_policy_no": "",
"insurance_until_cancelled": 0,
"is_cpi_provider": 1,
"insurance_fire": 0,
"insurance_fire_deductible_amount": 0.0,
"fire_term": 0,
"insurance_theft": 0,
"insurance_theft_deductible_amount": 0.0,
"theft_term": 0,
"insurance_collision_deductible": 0,
"insurance_collision_deductible_amount": 0.0,
"collision_term": 0,
"insurance_comprehensive_deductible": 0,
"insurance_comprehensive_deductible_amount": 0.0,
"comprehensive_term": 0,
"document_package": "Texas Document Package",
"doctype": "Sales Contract",
"emotive_document_print": [
{
"name": "fop4mabsjj",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.058116",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 1,
"document": "Buyers Guide Spanish",
"template": "Buyers Guide Spanish",
"is_default": 0,
"parent": "C-0000007422",
"parentfield": "emotive_document_print",
"parenttype": "Sales Contract",
"doctype": "Emotive Document Print"
},
{
"name": "fop4g0sagl",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.058116",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 2,
"document": "Buyers Guide English",
"template": "Buyers Guide English",
"is_default": 0,
"parent": "C-0000007422",
"parentfield": "emotive_document_print",
"parenttype": "Sales Contract",
"doctype": "Emotive Document Print"
},
{
"name": "fop4k8mo0i",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.058116",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 3,
"document": "Buyers Order",
"template": "Buyers order",
"is_default": 0,
"parent": "C-0000007422",
"parentfield": "emotive_document_print",
"parenttype": "Sales Contract",
"doctype": "Emotive Document Print"
},
{
"name": "fop47lfm8p",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.058116",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 4,
"document": "Agreeement to Provide Insurance",
"template": "Emotive -Multistate Agreement to Provide Insurance_V7",
"is_default": 0,
"parent": "C-0000007422",
"parentfield": "emotive_document_print",
"parenttype": "Sales Contract",
"doctype": "Emotive Document Print"
},
{
"name": "fop4744e7e",
"owner": "[email protected]",
"creation": "2026-01-21 06:43:22.078678",
"modified": "2026-01-21 06:43:55.044175",
"modified_by": "[email protected]",
"docstatus": 1,
"idx": 5,
"document": "Contract - TX Advanced - For Automation",
"template": "Retail Installment Contract V2",
"is_default": 1,
"parent": "C-0000007422",
"parentfield": "emotive_document_print",
"parenttype": "Sales Contract",
"doctype": "Emotive Document Print"
}
]
}
}