Get Contracts

get

https://api.zylo.com/v2/contracts

Required Permissions

contracts:read

Rate Limit

basic

Important Note

When trying to get a contract that has can_have_contract_lines set to true, then getting the corresponding Contract Line Items for that contract is necessary to get the full contract details.

Query Params

account_number

string

The account number associated with the contract.

application_id

string

Unique identifier for the application associated with the contract.

billing_frequency

string

enum

Billing frequency for the contract.

Allowed:

can_have_contract_lines

boolean

Indicates if the contract can have lines added

cancellation_policy

string

Cancellation policy for the contract.

contract_term

string

The term of duration of the contract.

contract_value_year

array of strings

Contract values by year for the contract.

contract_value_year

current_year_contract_value

string

Contract Year value that best relates to the Current Year.

end_date

string

End date of the contract. This is required unless the contract field month_to_month is true.

external_source_link

string

External link to contract data source.

string

Unique identifier for a contract.

month_to_month

boolean

Indicates if the contract is auto-renewing.

name

string

The contract name.

native_contract_value_year

array of strings

Total native value of the contract as entered in the contract record.

native_contract_value_year

native_currency

string

enum

Currency code of the currency the contract value is in.

native_total_contract_value

string

Total native value of the contract as entered in the contract record.

notification_period

string

Length of notice required to submit contract termination to supplier.

number

string

Contract Number from source system.

owner

string

Name of the primary contact for the contract.

payment_method

string

Payment method of the contract.

payment_term

string

The terms of payment for the contract.

price_protection

boolean

Is there price protection built into the contract.

purchase_order_number

array of strings

Purchase Order Number associated to this contract.

purchase_order_number

remit_to_address

string

Remittance address for this contract.

renewal_state

string

Next steps for renewal of this contract.

reseller

string

Reseller name for the contract.

source

string

Source system of the contract.

start_date

string

Start date of the contract.

status

string

enum

Status of the contract based on the current date and the contract start and end dates. "Active" indicates the contract is currently valid, "Expired" indicates the contract has ended, and "Inactive" indicates the contract has not yet started.

Allowed:

supplier_id

string

Supplier is the publisher of the Application(s) associated with this Contract. Please note that this may not represent the supplier you purchase from if your contract is through a reseller.

supplier_name

string

Supplier is the publisher of the Application(s) associated with this Contract. Please note that this may not represent the supplier you purchase from if your contract is through a reseller.

total_contract_value

string

Total value of the contract as entered in the contract record. Currency is converted if the Native Currency is different than the global currency set in Zylo. Zylo uses the currency exchange rate of the Contract Start Date.

total_licenses

string

The total licenses for the contract.

type

array of strings

The type of contract recorded.

type

zylo_created_at

string

Date and time the record was created in Zylo.

zylo_modified_at

string

Date and time the record was last modified in Zylo. Uses the created date by default.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

200Ok