v1

Swagger 2.02026-07-13107162315.5 KB
Estimate

Gets list of Estimates

EstimateStatusCode values are: "Draft", "Sent", "Accepted", "Converted", "Expired", "Rejected"

get/api/Estimate

Query parameters

UpdatedAfterstring date-time

Only return estimates updated after this date-time.

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

EstimateStatusCodestring

Filter by estimate status code

CompanyIDFKinteger

Filter estimates to a specific customer company by Company ID.

IssueDateFromstring date-time

Filter by issue date start range

IssueDateTostring date-time

Filter by issue date end range

ExpiryDateFromstring date-time

Filter by expiry date start range

ExpiryDateTostring date-time

Filter by expiry date end range

Sortstring

Sort results by: DateUpdated, DateCreated (append ' desc' for descending).

Response

Returns a paginated list of estimates with line items.

TotalCountinteger

Total number of records matching the query across all pages.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of records per page.