Create quote

post

https://api.wafeq.com/v1/quotes/

Endpoint for creating a new quote.

Body Params

Adds nested create feature

attachments

array of strings

Any files or documents attached to this quote.

attachments

branch

string | null

The branch associated with this quote.

contact

string

required

The contact (customer) associated with this quote.

currency

string

enum

required

The currency code for the quote.

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
AZN - AZN ман.
BAM - BAM KM
BDT - BDT ৳
BGN - BGN лв.
BHD - BHD د.ب.‏
BIF - BIF FBu
BND - BND $
BOB - BOB Bs
BRL - BRL R$
BWP - BWP P
BYN - BYN BYN
BZD - BZD $
CDF - CDF FrCD
CHF - CHF CHF
CLP - CLP $
CNY - CNY CN¥
COP - COP $
CRC - CRC ₡
CVE - CVE CV$
CZK - CZK Kč
DJF - DJF Fdj
DKK - DKK kr
DOP - DOP RD$
DZD - DZD د.ج.‏
EGP - EGP ج.م.‏
ERN - ERN Nfk
ETB - ETB Br
GBP - GBP £
GEL - GEL GEL
GHS - GHS GH₵
GNF - GNF FG
GTQ - GTQ Q
HKD - HKD $
HNL - HNL L
HRK - HRK kn
HUF - HUF Ft
IDR - IDR Rp
ILS - ILS ₪
INR - INR ₹
IQD - IQD د.ع.‏
IRR - IRR ﷼
ISK - ISK kr
JMD - JMD $
JOD - JOD د.أ.‏
JPY - JPY ￥
KES - KES Ksh
KHR - KHR ៛
KMF - KMF FC
KRW - KRW ₩
KWD - KWD د.ك.‏
KZT - KZT тңг.
LBP - LBP ل.ل.‏
LKR - LKR SL Re
LYD - LYD د.ل.‏
MAD - MAD د.م.‏
MDL - MDL MDL
MGA - MGA MGA
MKD - MKD MKD
MMK - MMK K
MOP - MOP MOP$
MUR - MUR MURs
MXN - MXN $
MYR - MYR RM
MZN - MZN MTn
NAD - NAD N$
NGN - NGN ₦
NIO - NIO C$
NOK - NOK kr
NPR - NPR नेरू
NZD - NZD $
OMR - OMR ر.ع.‏
PAB - PAB B/.
PEN - PEN S/.
PHP - PHP ₱
PKR - PKR ₨
PLN - PLN zł
PYG - PYG ₲
QAR - QAR ر.ق.‏
RON - RON RON
RSD - RSD дин.
RUB - RUB руб.
RWF - RWF FR
SDG - SDG SDG
SEK - SEK kr
SGD - SGD $
SOS - SOS Ssh
SYP - SYP ل.س.‏
THB - THB ฿
TND - TND د.ت.‏
TOP - TOP T$
TRY - TRY TL
TTD - TTD $
TWD - TWD NT$
TZS - TZS TSh
UAH - UAH ₴
UGX - UGX USh
UYU - UYU $
UZS - UZS UZS
VES - VES Bs.S.
VND - VND ₫
XAF - XAF FCFA
XOF - XOF CFA
YER - YER ر.ي.‏
ZAR - ZAR R
ZMW - ZMW ZK

custom_fields

object

A mapping of custom field IDs to their values.

discount_account

string

The account to which the discount will be booked, if applicable.

discount_amount

double

≥ 0

The discount amount to apply to the invoice.

discount_cost_center

string

The cost center associated with the discount, if applicable.

discount_tax_rate

string

The tax rate applied to the discount, if applicable.

exchange_rate

double | null

The exchange rate to the organization base currency at the time of the document.

external_id

string

length ≤ 255

External identifier for the quote.

language

string

enum

Defaults to en

The language in which the quote is written.

ar - Arabic
en - English

Allowed:

line_items

array of objects

required

The individual line items included in this quote.

line_items*

notes

string

Additional notes or comments about the invoice.

project

string | null

The project associated with this quote, if applicable.

purchase_order

string

An optional purchase order number or code for this quote.

quote_date

date

required

The date when the quote was issued.

quote_number

string

required

The number assigned to this quote.

reference

string

An optional reference number or code for this quote.

status

string

enum

Defaults to DRAFT

The current status of the quote (draft, sent, or invoiced).

DRAFT - DRAFT
SENT - SENT
INVOICED - INVOICED

Allowed:

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive.

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Allowed:

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

application/json

201