Edit Contract
Edit Sales Contract
HTTP Request
[PUT] /api/v6/sale_contracts/{id}
Body Parameters
| Parameter | Type | Default | Nullable | Require | Description |
|---|---|---|---|---|---|
| effective_date | string | yes | Effective date | ||
| expiration_date | string | yes | Expiration date | ||
| contract_date | string | yes | Creation date | ||
| contract_terms | array | List of terms | |||
| new_contract | integer | yes | Contract renewal type | ||
| contract_used | integer | yes | Contract usage code | ||
| use_workflow | integer | yes | Use workflow? (Y-m-d) | ||
| discount | float | Discount (%) | |||
| discount_amount | float | Discount amount ($) | |||
| transport | float | Shipping fee percentage | |||
| transport_amount | float | Shipping fee cash | |||
| installation_amount | float | Installation fee cash | |||
| installation | float | Installation fee percentage | |||
| vat | float | VAT percentage | |||
| vat_amount | float | VAT cash | |||
| contract_name | string | yes | Contract name | ||
| number_of_contract | integer | Number of contracts | |||
| contract_code | string | Contract code | |||
| vendor_account_id | integer | yes | Customer identifier | ||
| vendor_account_name | string | Customer name | |||
| vendor_account_address | string | Customer address | |||
| vendor_account_phone | string | Customer phone number | |||
| vendor_account_fax | string | Customer fax number | |||
| vendor_contact_name | string | Representative name (Party A) | |||
| vendor_contact_id | integer | Representative identifier (Party A) | |||
| vendor_positions | string | Representative position (Party A) | |||
| vendor_bank_address | string | Bank address (Party A) | |||
| vendor_bank_account_number | string | Bank account number (Party A) | |||
| vendor_sic_code | string | Customer tax code | |||
| buyers_account_id | integer | yes | Company identifier | ||
| buyers_account_name | string | Company name | |||
| buyers_account_address | string | Company address | |||
| buyers_account_phone | string | Company phone number | |||
| buyers_account_fax | string | Company fax number | |||
| buyers_contact_name | string | Representative name (Party B) | |||
| buyers_positions | string | Representative position (Party B) | |||
| buyers_bank_address | string | Bank address (Party B) | |||
| buyers_bank_account_number | string | Bank account number (Party B) | |||
| buyers_sic_code | string | Company tax code | |||
| service_charge_after_vat | integer | Apply shipping fee after VAT? | |||
| quote_id | integer | Quote identifier | |||
| payment_methods | integer | yes | Contract payment method | ||
| start_actual_time | string | Actual contract effective date | |||
| end_actual_time | string | Actual contract expiration date | |||
| actual_value | float | Actual value | |||
| project_name | string | Project | |||
| project_address | string | Project location | |||
| performed | string | Performed | |||
| contract_parent_id | integer | Related contract identifier | |||
| contract_details | array | yes | Product list | ||
| payment_periods | array | List of payment periods | |||
| custom_fields | array | Data 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
| Parameter | Type | Default | Nullable | Require | Description |
|---|---|---|---|---|---|
| effective_date | string | yes | Effective date | ||
| expiration_date | string | yes | Expiration date | ||
| contract_date | string | yes | Creation date | ||
| contract_terms | array | List of terms | |||
| new_contract | integer | yes | Contract renewal type | ||
| contract_used | integer | yes | Contract usage code | ||
| use_workflow | integer | yes | Use workflow? (Y-m-d) | ||
| discount | float | Discount (%) | |||
| discount_amount | float | Discount amount ($) | |||
| transport | float | Shipping fee percentage | |||
| transport_amount | float | Shipping fee cash | |||
| installation_amount | float | Installation fee cash | |||
| installation | float | Installation fee percentage | |||
| vat | float | VAT percentage | |||
| vat_amount | float | VAT cash | |||
| contract_name | string | yes | Contract name | ||
| number_of_contract | integer | Number of contracts | |||
| contract_code | string | Contract code | |||
| vendor_account_id | integer | yes | Customer identifier | ||
| vendor_account_name | string | Customer name | |||
| vendor_account_address | string | Customer address | |||
| vendor_account_phone | string | Customer phone number | |||
| vendor_account_fax | string | Customer fax number | |||
| vendor_contact_name | string | Representative name (Party A) | |||
| vendor_contact_id | integer | Representative identifier (Party A) | |||
| vendor_positions | string | Representative position (Party A) | |||
| vendor_bank_address | string | Bank address (Party A) | |||
| vendor_bank_account_number | string | Bank account number (Party A) | |||
| vendor_sic_code | string | Customer tax code | |||
| buyers_account_id | integer | yes | Company identifier | ||
| buyers_account_name | string | Company name | |||
| buyers_account_address | string | Company address | |||
| buyers_account_phone | string | Company phone number | |||
| buyers_account_fax | string | Company fax number | |||
| buyers_contact_name | string | Representative name (Party B) | |||
| buyers_positions | string | Representative position (Party B) | |||
| buyers_bank_address | string | Bank address (Party B) | |||
| buyers_bank_account_number | string | Bank account number (Party B) | |||
| buyers_sic_code | string | Company tax code | |||
| service_charge_after_vat | integer | Apply shipping fee after VAT? | |||
| quote_id | integer | Quote identifier | |||
| payment_methods | integer | yes | Contract payment method | ||
| start_actual_time | string | Actual contract effective date | |||
| end_actual_time | string | Actual contract expiration date | |||
| actual_value | float | Actual value | |||
| project_name | string | Project | |||
| project_address | string | Project location | |||
| performed | string | Performed | |||
| contract_parent_id | integer | Related contract identifier | |||
| contract_details | array | yes | Product list | ||
| payment_periods | array | List of payment periods | |||
| custom_fields | array | Data 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"
}