Skip to main content

Get entities from Quotations

GET 
/Quotations

Get entities from Quotations

Request​

Query Parameters

    $top integer

    Show only the first n items

    $skip integer

    Skip the first n items

    $search string

    Search items by search phrases

    $filter string

    Filter items by property values

    $count boolean

    Include count of items

    $orderby string[]

    Possible values: [sellerId, sellerId desc, sellerContactId, sellerContactId desc, debtorId, debtorId desc, debtorContactId, debtorContactId desc, shipToId, shipToId desc, shipToContactId, shipToContactId desc, languageIso, languageIso desc, currencyIso, currencyIso desc, synced, synced desc, quotationNumber, quotationNumber desc, versionNumber, versionNumber desc, status, status desc, statusId, statusId desc, subject, subject desc, totalPrice, totalPrice desc, totalPriceInclVat, totalPriceInclVat desc, isVerified, isVerified desc, customerReference, customerReference desc, quotationReference, quotationReference desc, deliverydate, deliverydate desc, remarks, remarks desc, expiresDate, expiresDate desc, quotationTemplateId, quotationTemplateId desc, propertyIds, propertyIds desc, exchangeRate, exchangeRate desc, purchaseDiscount, purchaseDiscount desc, id, id desc, createdDate, createdDate desc, updatedDate, updatedDate desc, organizationId, organizationId desc, reference, reference desc, creatorId, creatorId desc, customField1, customField1 desc, customField2, customField2 desc, customField3, customField3 desc, customField4, customField4 desc, customField5, customField5 desc]

    Order items by property values

    $select string[]

    Possible values: [sellerId, sellerContactId, debtorId, debtorContactId, shipToId, shipToContactId, languageIso, currencyIso, synced, quotationNumber, versionNumber, status, statusId, subject, totalPrice, totalPriceInclVat, isVerified, customerReference, quotationReference, deliverydate, remarks, expiresDate, quotationTemplateId, propertyIds, exchangeRate, purchaseDiscount, id, createdDate, updatedDate, organizationId, reference, creatorId, customField1, customField2, customField3, customField4, customField5, seller, sellerContact, debtor, debtorContact, shipTo, shipToContact, organization]

    Select properties to be returned

    $expand string[]

    Possible values: [*, seller, sellerContact, debtor, debtorContact, shipTo, shipToContact, organization]

    Expand related entities

Responses​

Retrieved entities

Schema

    value

    object[]

  • Array [

    • sellerId uuid
    sellerContactId uuid
    debtorId uuid
    debtorContactId uuid
    shipToId uuid
    shipToContactId uuid
    languageIso string
    currencyIso string
    synced boolean
    quotationNumber int64
    versionNumber int32

    Possible values: >= -2147483648 and <= 2147483647

    status

    This property will only return the right status for legacy quotation statuses. Use the StatusId property instead.

    statusId uuid
    subject string
    totalPrice decimal
    totalPriceInclVat decimal
    isVerified boolean
    customerReference string
    quotationReference string
    deliverydate date-time
    remarks string
    expiresDate date-time
    quotationTemplateId uuid
    propertyIds uuid[]

    Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    exchangeRate decimal
    purchaseDiscount decimal
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    reference string
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string
    seller
    sellerContact
    debtor
    debtorContact
    shipTo
    shipToContact
    organization

  • ]

Loading...