Quotes

Get Quote record

Changed on

Retrieve a specific Quote record by its record number with all related data.

get/public/v2/quotes/{record_number}/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v2/quotes/{record_number}/
  • Auth: none declared

Path parameters

record_numberinteger required

The number attribute of the record.

Query parameters

searchstring nullable
codestring[] nullable
idinteger[] nullable
numberinteger[] nullable
company_idinteger[] nullable
customer_idinteger[] nullable
record_statusRecordStatus[] nullable
valid_until_fromstring date nullable
valid_until_tostring date nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable

Response

OK

bill_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_addressstring required

Deprecated: send the structured billing_address / shipping_address instead.

created_atstring date-time required
updated_atstring date-time required
completed_approvals_countinteger
total_approvals_countinteger
workflow_statusstring nullable
pending_approvers_countinteger
send_status'draft' | 'awaiting_approval' | 'approved' | 'rejected'
can_sendboolean
bank_match_statusstring nullable
idinteger required
numberinteger required
codestring nullable

Code from the company quote sequence, e.g. QT-0001

record_status'draft' | 'posted' | 'archived' required
valid_untilstring date required
company_idinteger required
company_namestring required
company_currencystring required
customer_idinteger nullable required
customer_namestring nullable required
namestring required
emailstring required
currency_iso_4217_codestring required
term_idinteger nullable required
term_namestring required
memostring required
close_datestring date required
contract_start_datestring date required
contract_end_type'after' | 'ongoing' | 'date' required
number_of_monthsinteger nullable required
contract_end_datestring date nullable required
contract_legal_termsstring nullable required
sent_atstring date-time nullable required
document_headline_total'tcv' | 'annual' | 'quarterly' | 'monthly' | 'first_year' required
document_total_rowsQuoteTotalRow[] required
document_year_by_yearboolean required
subtotalstring required

Sum of quantity x rate before discounts and tax

discount_totalstring required

Sum of inline line discounts

tax_totalstring required

Sum of line tax

amountstring required

Quote total for one billing period of each line, calculated like an invoice total

contract_valuestring required

Contract amount this quote converts to: quantity x rate over each line's term, before discount and tax; approvals compare this

Changes

  • f8de2ceea61dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 8f0a589ca348Revision changes
    • info

      endpoint added