Create quote

post

https://api.zenskar.com/quotes

Create a new quote with initial version (v1) in DRAFT status (or APPROVED if auto_approve=True)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

auto_approve

boolean

Defaults to false

Body Params

customer_id

Customer this quote is for. Required for new quotes, optional for amendments (inherits from existing contract).

business_entity_id

Business entity for this quote (inherits from customer if not provided)

contract_id

Existing contract ID for amendments (required when quote_type is AMENDMENT)

quote_mode

string

enum

Quote workflow mode: approval-based or self-serve (defaults to self-serve)

Allowed:

name

string

required

length between 1 and 255

Quote name/title

description

Detailed description of the quote

currency

string

required

length between 3 and 3

Currency code (ISO 4217, e.g., USD, EUR)

quote_type

string

enum

Type of quote: new_business, renewal, amendment, upsell, downsell

Allowed:

valid_from

When quote becomes valid (defaults to current date)

valid_until

When quote expires (null = no expiry)

validity_config

Rules for calculating validity dates

start_date

Contract start date (when service begins). Required for new_business/renewal/upsell/downsell quotes. Optional for amendment quotes (inherits from existing contract if not provided).

end_date

Contract end date (null = open-ended)

anchor_date

Reference date for billing cycle calculations. Determines when bills are generated in the billing period (e.g., if anchor_date is 15th, monthly bills generate on the 15th). Defaults to start_date if not provided.

provisioning_mode

string

enum

Provisioning mode determining when/how contract is created (immediate, payment_method_validation, charge_on_acceptance, charge_when_due)

Allowed:

contract_payment_config

Payment configuration for resulting contract

payment_method_id

Payment method ID for provisioning (required for payment_method_validation and charge_on_acceptance modes)

line_items

array of objects

required

length ≥ 1

Quote line items (at least one required)

Line Items*

custom_data

Custom data that apply to all versions

Responses

Language

Credentials

Loading…

Response

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

application/json

200Successful Response

422Validation Error