Create a Contract

post

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

Required Permissions

contracts:write

Rate Limit

limited

Important Note

If can_have_contract_lines is set to true, then application_id must not be provided. If can_have_contract_lines is set to false, then application_id must be provided.

Body Params

account_number

string | null

The account number associated with the contract.

application_id

string | null

Stringified UUIDv4.

billing_frequency

string | null

enum

Billing frequency for the contract.

Allowed:

can_have_contract_lines

boolean | null

Indicates if the contract can have lines added

cancellation_policy

string | null

Cancellation policy for the contract.

contract_term

string | null

The term of duration of the contract.

end_date

date | null

Displays dates as a string in the format "YYYY-MM-DD".

month_to_month

boolean

required

Indicates if the contract is auto-renewing.

name

string

required

length ≥ 1

The contract name. . *

native_contract_value_year

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

native_currency

string

enum

required

Currency code of the currency the contract value is in.

native_total_contract_value

string | null

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

notification_period

string | null

Length of notice required to submit contract termination to supplier.

number

string

required

length ≥ 1

Contract Number from source system. . *

owner

string | null

Name of the primary contact for the contract.

payment_method

string | null

Payment method of the contract.

payment_term

string | null

The terms of payment for the contract.

price_protection

boolean | null

Is there price protection built into the contract.

purchase_order_number

array of strings | null

Purchase Order Number associated to this contract.

purchase_order_number

remit_to_address

string | null

Remittance address for this contract.

renewal_state

string | null

Next steps for renewal of this contract.

reseller

string | null

Reseller name for the contract.

start_date

date

required

Start date of the contract.

supplier_id

string | null

Stringified UUIDv4.

type

array of strings | null

The type of contract recorded.

type

Response

200Ok