WAwafeq
Quotes

Retrieve quote

Changed on

Endpoint for retrieving a single quote.

get/quotes/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/quotes/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, branch, contact, contact.persons, line_items, line_items.item, line_items.tax_rate, line_items.cost_center, project, discount_cost_center. Nested relations are joined with a dot.

Response

amountnumber double required

The total amount of the quote, including taxes.

attachmentsstring[]

Any files or documents attached to this quote.

branchstring nullable

The branch associated with this quote.

contactstring required

The contact (customer) associated with this quote.

created_tsstring date-time required

The timestamp in UTC when the invoice was created.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

An ISO 4217 currency code.

View the enum reference

custom_fieldsobject

A mapping of custom field IDs to their values.

discount_accountstring

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

discount_amountnumber double

The discount amount to apply to the invoice.

discount_cost_centerstring

The cost center associated with the discount, if applicable.

discount_tax_ratestring

The tax rate applied to the discount, if applicable.

exchange_ratenumber double nullable

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

external_idstring

External identifier for the quote.

idstring required

The unique identifier of the quote.

language'en' | 'ar'

The language of a document or response.

View the enum reference

legacy_idstring required

[Deprecated] The legacy identifier of the quote.

modified_tsstring date-time required

The timestamp in UTC when the invoice was last modified.

notesstring

Additional notes or comments about the invoice.

projectstring nullable

The project associated with this quote, if applicable.

purchase_orderstring

An optional purchase order number or code for this quote.

quote_datestring date required

The date when the quote was issued.

quote_numberstring required

The number assigned to this quote.

referencestring

An optional reference number or code for this quote.

rounding_amountnumber double required

The payable rounding amount for tax inclusive documents.

status'DRAFT' | 'SENT' | 'INVOICED'

The current lifecycle status of an estimate.

View the enum reference

tax_amountnumber double required

The total tax amount applied to this quote.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

Changes

  • b8f5e10134b4Revision changes
    • info

      added the new optional query request parameter expand

    • info

      added the required property to the response with the status