Update a Contract

patch

https://api.zylo.com/v2/contracts/{contractId}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contractId

string

required

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Stringified UUIDv4.

Body Params

account_number

string | null

The account number associated with the contract.

application_id

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

The application associated with the contract. This is only set for single-application contracts. When a contract has line items, each application is associated through its line items instead, and this field is empty.

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.

custom_fields

string

Values for custom fields associated with this Contract.
See custom field details here.

end_date

date | null

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

month_to_month

boolean

Indicates if the contract is auto-renewing.

name

string

length ≥ 1

The contract name.
. *

native_contract_value_year

array

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

native_currency

string

enum

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

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

Start date of the contract.

supplier_id

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

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.

type

array of strings | null

The type of contract recorded.

type

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok