Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Quote

Find quotes based on search parameters.

post/api/quotes/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

numbersinteger[] nullable

Filter quotes to only given numbers

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

Quotes status

modifiedAfterUtcstring date-time nullable

Filter to quote records modified after the given datetime (in UTC)

Response

List of quotes matching the filters

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).

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.