Sign in
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. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

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)

quotedDateFromstring date-time nullable

Filter to quotes whose quoted date falls on or after this date. The whole day is included, so any time component is ignored.

quotedDateTostring date-time nullable

Filter to quotes whose quoted date falls on or before this date. The whole day is included, so a quote quoted later that same day still matches.

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

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 2 of the 23 revisions of this API.10

  • d743ab8b105f8See the full diff
    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

  • 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