Skip to main content

Edit Contract

Edit Sales Contract

HTTP Request

[PUT] /api/v6/sale_contracts/{id}

Body Parameters

ParameterTypeDefaultNullableRequireDescription
effective_datestringyesEffective date
expiration_datestringyesExpiration date
contract_datestringyesCreation date
contract_termsarrayList of terms
new_contractintegeryesContract renewal type
contract_usedintegeryesContract usage code
use_workflowintegeryesUse workflow? (Y-m-d)
discountfloatDiscount (%)
discount_amountfloatDiscount amount ($)
transportfloatShipping fee percentage
transport_amountfloatShipping fee cash
installation_amountfloatInstallation fee cash
installationfloatInstallation fee percentage
vatfloatVAT percentage
vat_amountfloatVAT cash
contract_namestringyesContract name
number_of_contractintegerNumber of contracts
contract_codestringContract code
vendor_account_idintegeryesCustomer identifier
vendor_account_namestringCustomer name
vendor_account_addressstringCustomer address
vendor_account_phonestringCustomer phone number
vendor_account_faxstringCustomer fax number
vendor_contact_namestringRepresentative name (Party A)
vendor_contact_idintegerRepresentative identifier (Party A)
vendor_positionsstringRepresentative position (Party A)
vendor_bank_addressstringBank address (Party A)
vendor_bank_account_numberstringBank account number (Party A)
vendor_sic_codestringCustomer tax code
buyers_account_idintegeryesCompany identifier
buyers_account_namestringCompany name
buyers_account_addressstringCompany address
buyers_account_phonestringCompany phone number
buyers_account_faxstringCompany fax number
buyers_contact_namestringRepresentative name (Party B)
buyers_positionsstringRepresentative position (Party B)
buyers_bank_addressstringBank address (Party B)
buyers_bank_account_numberstringBank account number (Party B)
buyers_sic_codestringCompany tax code
service_charge_after_vatintegerApply shipping fee after VAT?
quote_idintegerQuote identifier
payment_methodsintegeryesContract payment method
start_actual_timestringActual contract effective date
end_actual_timestringActual contract expiration date
actual_valuefloatActual value
project_namestringProject
project_addressstringProject location
performedstringPerformed
contract_parent_idintegerRelated contract identifier
contract_detailsarrayyesProduct list
payment_periodsarrayList of payment periods
custom_fieldsarrayData definition

custom_fields can be retrieved from API custom fields list

Example

HTTP Request

PUT api/v6/sale_contracts/4 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json
{
"contract_code": "contract_code",
}

Status

200 OK

Response

{
"message": "Successfully updated"
}

Edit purchase contract

HTTP Request

[PUT] /api/v6/purchase_contracts/{id}

Body Parameters

ParameterTypeDefaultNullableRequireDescription
effective_datestringyesEffective date
expiration_datestringyesExpiration date
contract_datestringyesCreation date
contract_termsarrayList of terms
new_contractintegeryesContract renewal type
contract_usedintegeryesContract usage code
use_workflowintegeryesUse workflow? (Y-m-d)
discountfloatDiscount (%)
discount_amountfloatDiscount amount ($)
transportfloatShipping fee percentage
transport_amountfloatShipping fee cash
installation_amountfloatInstallation fee cash
installationfloatInstallation fee percentage
vatfloatVAT percentage
vat_amountfloatVAT cash
contract_namestringyesContract name
number_of_contractintegerNumber of contracts
contract_codestringContract code
vendor_account_idintegeryesCustomer identifier
vendor_account_namestringCustomer name
vendor_account_addressstringCustomer address
vendor_account_phonestringCustomer phone number
vendor_account_faxstringCustomer fax number
vendor_contact_namestringRepresentative name (Party A)
vendor_contact_idintegerRepresentative identifier (Party A)
vendor_positionsstringRepresentative position (Party A)
vendor_bank_addressstringBank address (Party A)
vendor_bank_account_numberstringBank account number (Party A)
vendor_sic_codestringCustomer tax code
buyers_account_idintegeryesCompany identifier
buyers_account_namestringCompany name
buyers_account_addressstringCompany address
buyers_account_phonestringCompany phone number
buyers_account_faxstringCompany fax number
buyers_contact_namestringRepresentative name (Party B)
buyers_positionsstringRepresentative position (Party B)
buyers_bank_addressstringBank address (Party B)
buyers_bank_account_numberstringBank account number (Party B)
buyers_sic_codestringCompany tax code
service_charge_after_vatintegerApply shipping fee after VAT?
quote_idintegerQuote identifier
payment_methodsintegeryesContract payment method
start_actual_timestringActual contract effective date
end_actual_timestringActual contract expiration date
actual_valuefloatActual value
project_namestringProject
project_addressstringProject location
performedstringPerformed
contract_parent_idintegerRelated contract identifier
contract_detailsarrayyesProduct list
payment_periodsarrayList of payment periods
custom_fieldsarrayData definition

Example

HTTP Request

PUT api/v6/purchase_contracts/4 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json
{
"contract_code": "contract_code",
}

Status

200 OK

Response

{
"message": "Successfully updated"
}