Sign in
Quote

Get a specific Quote

get/api/quotes/{quoteId}

Path parameters

quoteIdstring required

Response

The Quote for the given id

idstring required

Unique id associated to this entity.

numberinteger required

Number

customerIdstring required

Customer identifier. Please reference /api/customers endpoint.

quotedDatestring date-time required

Quoted date (generally the creation date but can be post/pre-dated).

dueDatestring date-time nullable

The date the quote needs to be completed by. Null when the quote has no due date.

status'open' | 'draft' | 'needsApproval' | 'approved' | 'sent' | 'won' | 'lost' required

Quotes status

externalReferencesobject nullable

External references associated with this entity.

totalInPrimaryCurrencynumber double nullable

The total quote price in local currency of the fulcrum customer

customFieldsobject nullable

Custom fields that have been defined for the quote;

opportunitystring nullable

CRM Opportunity identifier.

salesPersonIdstring nullable

Unique identifier of the sales person attached to this sales order. Please reference /api/users endpoints.

companyIdstring nullable

Company identifier. Please reference /api/companies endpoint.

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

createdUtcstring date-time required

Date this record was created (UTC).

notesToCustomerstring nullable

A field for the seller to provide additional details or instructions for the customer relating to the order.

Changes

Changed in 1 of the 23 revisions of this API.2

  • ad309c11f9542See the full diff
    • ○

      added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/problem+json)

      response-optional-property-added