EndPoint Get Quotes

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

get_quotes

Description

Parameters

Parameter

Label

Required

Options

Description

PageSize

CreatedBegin

Created Begin Date (yyyy-MM-dd)

Option	Value
2023-12-31	2023-12-31
today	today
yesterday	yesterday
yearstart-10y	yearstart-10y
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
monthend+1d-1y	monthend+1d-1y

filters results to include quotes created after the specified begin date (must be at least one day before the specified end date)

CreatedEnd

Created End Date (yyyy-MM-dd)

Option	Value
2023-12-31	2023-12-31
today	today
yesterday	yesterday
yearstart-10y	yearstart-10y
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
monthend+1d-1y	monthend+1d-1y

filters results to include quotes created before the specified end date

CreatedEmail

Created Email

QuoteId

SearchFor

Statuses

Option	Value
OPEN	OPEN
COMPLETED	COMPLETED
CANCELED	CANCELED
EXPIRED	EXPIRED

expiresBegin

Expires Begin Date (yyyy-MM-dd)

Option	Value
2023-12-31	2023-12-31
today	today
yesterday	yesterday
yearstart-10y	yearstart-10y
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
monthend+1d-1y	monthend+1d-1y

filters results to include quotes expiring after the specified begin date (must be at least one day before the specified end date)

expiresEnd

Expires End Date (yyyy-MM-dd)

Option	Value
2023-12-31	2023-12-31
today	today
yesterday	yesterday
yearstart-10y	yearstart-10y
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
monthend+1d-1y	monthend+1d-1y

filters results to include quotes expiring before the specified end date

expiresBefore

Expires Before Date (yyyy-MM-dd)

Option	Value
2023-12-31	2023-12-31
today	today
yesterday	yesterday
yearstart-10y	yearstart-10y
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
monthend+1d-1y	monthend+1d-1y

filters results to include quotes expiring before the specified end date

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(100)`	100	False
Name	`DT_WSTR`	`nvarchar(128)`	128	False
Status	`DT_WSTR`	`nvarchar(100)`	100	False
OrderReference	`DT_WSTR`	`nvarchar(100)`	100	False
Created	`DT_DBTIMESTAMP`	`datetime`		False
Currency	`DT_WSTR`	`nvarchar(12)`	12	False
TotalInPayoutCurrency	`DT_R8`	`float`		False
SubtotalInPayoutCurrency	`DT_R8`	`float`		False
Item_1	`DT_WSTR`	`nvarchar(100)`	100	False	First item from this quote
Item_2	`DT_WSTR`	`nvarchar(100)`	100	False	Second item from this quote
Item_3	`DT_WSTR`	`nvarchar(100)`	100	False	Third item from this quote
InvoiceId	`DT_WSTR`	`nvarchar(100)`	100	False
Coupon	`DT_WSTR`	`nvarchar(100)`	100	False
Subtotal	`DT_R8`	`float`		False
SubtotalDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
SubtotalInPayoutCurrencyDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	False
Tax	`DT_R8`	`float`		False
TaxRate	`DT_R8`	`float`		False
TaxType	`DT_WSTR`	`nvarchar(100)`	100	False
Total	`DT_R8`	`float`		False
TotalDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
TotalInPayoutCurrencyDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
Updated	`DT_DBTIMESTAMP`	`datetime`		False
TaxId	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientCompany	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientEmail	`DT_WSTR`	`nvarchar(255)`	255	False
RecipientFirst	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientLast	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientPhone	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientUserId	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressAddressLine1	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressAddressLine2	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressCity	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressCountry	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100	False
RecipientAddressRegion	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByCompany	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByEmail	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByFirst	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByLast	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByPhone	`DT_WSTR`	`nvarchar(100)`	100	False
CreatedByUserId	`DT_WSTR`	`nvarchar(100)`	100	False
Discount	`DT_R8`	`float`		False
DiscountDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
DiscountInPayoutCurrency	`DT_R8`	`float`		False
DiscountInPayoutCurrencyDisplay	`DT_WSTR`	`nvarchar(100)`	100	False
Expires	`DT_DBTIMESTAMP`	`datetime`		False
ExpirationDateDays	`DT_I8`	`bigint`		False
FulfillmentTerm	`DT_WSTR`	`nvarchar(100)`	100	False
BuyerGenerated	`DT_BOOL`	`bit`		False
CopyNotesToInvoice	`DT_BOOL`	`bit`		False
Items	`DT_NTEXT`	`nvarchar(MAX)`		False
Notes	`DT_WSTR`	`nvarchar(4000)`	4000	False
NetTermsDays	`DT_I8`	`bigint`		False
QuoteUrl	`DT_WSTR`	`nvarchar(448)`	448	False
SiteId	`DT_WSTR`	`nvarchar(100)`	100	False
StatusHistory	`DT_WSTR`	`nvarchar(4000)`	4000	False
Source	`DT_WSTR`	`nvarchar(100)`	100	False
SourceIP	`DT_WSTR`	`nvarchar(100)`	100	False
IsGrossTax	`DT_BOOL`	`bit`		False

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.