Accueil / Home

Export : contrat de vente /sale contract

PHP example

Important Notes

<synchronisation>sale_contract</synchronisation>

Warning: You must use the dot as decimal character.

Query

<query>
	<date>unix time</date>
	<synchronisation>sale_contract</synchronisation>
	<mode>export</mode>
	<partner_id>string</partner_id>
	<partner_key>string</partner_key>
	<data>
		<seller>
			<id>integer</id>
		</seller>
		<customer>
			<id>integer</id><!-- Leave ID empty for indiquate a new customer -->
			<type>individual|dealer</type>
			<contact>
				<last_name>string</last_name>
				<first_name>string</first_name>
				<birth_date>YYYY-MM-DD</birth_date>
				<language>fr|en</language>
				<gender>male|female</gender>
				<address>string</address>
				<municipality>string</municipality>
				<province>string</province>
				<country>string</country>
				<postal_code>string</postal_code>
				<home_phone>(000) 000-0000</home_phone>
				<!-- Optional fields -->
				<home_phone_extension>string</home_phone_extension>
				<address_line2>string</address_line2>
				<secondary_phone>(000) 000-0000</secondary_phone>
				<secondary_phone_extension>integer</secondary_phone_extension>
				<email>string</email>
				<driver_licence>string</driver_licence>
				<saaq_file_number>string</saaq_file_number>
				<!-- /Optional fields -->
			</contact>
			<!-- Required if customer is dealer type -->
			<dealer>
				<company_name>string</company_name>
				<license_number>string</license_number>
				<!-- Optional fields -->
				<gst_number>string</gst_number>
				<pst_number>string</pst_number>
				<hst_number>string</hst_number>
				<exemption_number>string</exemption_number>
				<!-- /Optional fields -->
			</dealer>
			<!-- /Required if customer is dealer type -->
		</customer>
		<contract>
			<number>string</number>
			<date>YYYY-MM-DD</date>
			<date_delivery>YYYY-MM-DD</date_delivery>
			<creditor_name>string</creditor_name><!-- Optional field -->
			<vehicle_sold>
				<id>integer</id>
				<value>float</value>
				<market_value>float</market_value>
			</vehicle_sold>
			<vehicle_exchanged>
				<id>integer</id>
				<value>float</value>
				<value_due>float</value_due>
			</vehicle_exchanged>
			<tax>
				<type>integer</type>
				<!-- Percentage -->
				<gst>float</gst>
				<pst>float</pst>
				<hst>float</hst>
				<amf>float</amf>
				<loan_insurance>float</loan_insurance>
				<replacement_insurance>float</replacement_insurance>
			</tax>
			<dealer>
				<license_number>string</license_number>
				<sale_consultant>string</sale_consultant>
				<place>string</place>
				<gst_number>string</gst_number>
				<pst_number>string</pst_number>
				<hst_number>string</hst_number>
				<exemption_number>string</exemption_number>
			</dealer>
			<price>
				<misc_fees>float</misc_fees>
				<misc_discounts>float</misc_discounts>
				<accessory_list><!-- Optional field and max of 5 -->
					<accessory>
						<name>string</name>
						<value>float</value>
					</accessory>
					<accessory>...</accessory>
				</accessory_list>
				<additional_warranty>float</additional_warranty>
				<recycquebec_and_new_tires_tax>float</recycquebec_and_new_tires_tax>
				<rdprm_consultation_fee>float</rdprm_consultation_fee>
				<credit_insurance>float</credit_insurance>
				<assurance_remplacement>float</assurance_remplacement>
				<transit>float</transit>
				<deposit>float</deposit>
				<other_rebate><!-- Optional field -->
					<name>string</name>
					<value>float</value>
				</other_rebate>
			</price>
			<warranty>
				<legal>interger</legal>
				<seller>
					<included>1|0</included>
					<!-- Required if included -->
					<day>integer</day>
					<km>integer</km>
					<description>string</description>
					<!-- /Required if included -->
				</seller>
				<third_party>
					<included>1|0</included>
					<!-- Required if included -->
					<company>string</company>
					<month>integer</month>
					<km>integer</km>
					<description>string</description>
					<!-- /Required if included -->
				</third_party>
			</warranty>
			<note>string</note><!-- MAX 600 characters -->
		</contract>
	</data>
</query>

Response

<response>
	<date>date ISO 8601</date>
	<mode>export</mode>
	<synchronisation>sale_contract</synchronisation>
	<partner_id>string</partner_id>
	<status>success|error</status>
	<message>string</message>
	<data>
		<customer>
			<id>integer</id><!-- Customer ID in GVO -->
		</customer>
		<contract>
			<number>string</number>
			<!-- When success -->
			<id>integer</id><!-- Contract ID in GVO -->
			<total>float</total><!-- Contract total in GVO -->
			<!-- /When success -->
		</contract>
	</data>
</response>