List

Sales Contract List

HTTP Request

[GET] /api/v6/sale_contracts

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
contract_code	string	Contract code
contract_name	string	Contract name
expiration_day_remain	integer	Remaining contract days
number_of_contract	integer	Number of contracts
contract_status	integer	Contract status
contract_status_label	string	Contract status label
new_contract_label	string	Contract type label
contract_type	integer	Contract type
effective_date	string	Effective date
expiration_date	string	Expiration date
vendor_account_id	integer	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_account_manager	integer	Customer manager
vendor_account_manager_name	string	Customer manager name
vendor_contact_name	string	Representative name (Party A)
vendor_contact_title	string	Customer contact title
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	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_contact_id	integer	Representative identifier (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
after_vat	integer	Apply discount after tax?
discount	float	Discount (%)
discount_amount	float	Discount amount ($)
vat	float	Vat (%)
vat_amount	float	Vat amount ($)
contract_terms	array	List of terms
quote_id	integer	Quote identifier
quote_code	string	Quote code
payment_methods	integer	Contract payment method
payment_methods_name	string	Contract payment method name
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_parent	integer	Related contract
contract_children	array	List of child contracts
total_payment	float	Revenue
total_sale_order_real_amount	float	Total sales order revenue
total_sale_order_remain_amount	float	Total remaining sales order amount (unpaid)
total_sale_order_f_amount	float	Total paid sales order amount
performed	string	Performed
number_performed	float	Amount performed (numeric)
custom_fields	object	Data definition

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
valid	eq	integer	Valid contract
expiration_year	eq	integer	Contract end year
expiration_month	eq	integer	Contract end month
expiration_day	eq	integer	Contract end day

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/sale_contracts?fields=contract_code&limit=1&offset=1&filtering[id]=1 HTTP/1.1
Host: example.getflycrm.com
Authorization: Bearer token

Status

200 OK

Response

{
  "data": [
    {
      "id": 1,
      "contract_code": "CONTRACT CODE"
    }
  ],
  "has_more": false,
  "offset": 1,
  "limited": 1
}

Purchase Contract List

HTTP Request

[GET] /api/v6/purchase_contracts

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
contract_code	string	Contract code
contract_name	string	Contract name
expiration_day_remain	integer	Remaining contract days
number_of_contract	integer	Number of contracts
contract_status	integer	Contract status
contract_status_label	string	Contract status label
new_contract_label	string	Contract type label
contract_type	integer	Contract type
effective_date	string	Effective date
expiration_date	string	Expiration date
vendor_account_id	integer	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_account_manager	integer	Customer manager
vendor_account_manager_name	string	Customer manager name
vendor_contact_name	string	Representative name (Party A)
vendor_contact_title	string	Customer contact title
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	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_contact_id	integer	Representative identifier (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
after_vat	integer	Apply discount after tax?
discount	float	Discount (%)
discount_amount	float	Discount amount ($)
vat	float	Vat (%)
vat_amount	float	Vat amount ($)
contract_terms	array	List of terms
quote_id	integer	Quote identifier
quote_code	string	Quote code
payment_methods	integer	Contract payment method
payment_methods_name	string	Contract payment method name
start_actual_time	string	Actual contract effective date
end_actual_time	string	Actual contract expiration date
contract_used	integer	Contract usage code
contract_used_label	string	Contract usage type
actual_value	float	Actual value
project_name	string	Project
project_address	string	Project location
contract_origin_code	string	Original contract code
payment_periods	array	List of payment periods
contract_date	string	Creation date
create_user	integer	Contract creator identifier
create_user_display_name	string	Contract creator name
approved_by	integer	Contract approver identifier
approved_at	string	Approval time
approved_by_display_name	string	Contract approver name
contract_parent_id	integer	Related contract identifier
contract_parent	integer	Related contract
contract_children	array	List of child contracts
total_payment	float	Revenue
total_purchase_order_real_amount	float	Total purchase order revenue
total_purchase_order_remain_amount	float	Total remaining purchase order amount (unpaid)
total_purchase_order_f_amount	float	Total paid purchase order amount
performed	string	Performed
number_performed	float	Amount performed (numeric)
custom_fields	object	Data definition

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
valid	eq	integer	Valid contract
expiration_year	eq	integer	Contract end year
expiration_month	eq	integer	Contract end month
expiration_day	eq	integer	Contract end day

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/purchase_contracts?fields=contract_code&limit=1&offset=1&filtering[id]=1 HTTP/1.1
Host: example.getflycrm.com
Authorization: Bearer token

Status

200 OK

Response

{
  "data": [
    {
      "id": 1,
      "contract_code": "CONTRACT CODE"
    }
  ],
  "has_more": false,
  "offset": 1,
  "limited": 1
}