--- title: "Search proposals" method: GET path: "/proposals/" tags: ["Proposal"] --- # Search proposals `GET /proposals/` Search proposals ## Query parameters - `Name` string - `Email` string - `UpdatedAfter` string - `UpdatedBefore` string - `UpdatedBy` string[] - `CreatedBy` string[] - `Source` string - `CreatedAfter` string - `CreatedBefore` string - `Locked` boolean - `Page` integer, required - `Limit` integer, required - `LinkId` string ## Headers - `Accept` 'application/json', required - `X-Avangate-Authentication` string, required ## Response `200` OK - InlineResponse20010 - `page` integer, required — The incoming page value - `limit` integer, required — The incoming limit value - `proposals` Proposal[], required — The matching proposals collection - `ProposalId` string, required — The unique merchant proposal id - `Version` integer, required — The version of the proposal. Every modification increments the version by 1. - `CreatedDate` string, date-time, required — The UTC creation date for the proposal in ISO 8601 format - `UpdatedDate` string, date-time, required — The UTC last update date for the proposal in ISO 8601 format - `CreatedBy` string, required — The unique external system user identifier - `UpdatedBy` string, required — The unique external system user identifier - `Locked` boolean, required — If the proposal is locked for buy modifications - `Source` string, required — The source from where the proposal was created - `Content` ProposalContent, required — The proposal content - `Language` string, required — The ISO 639-1 language code - `Currency` string, required — The ISO 4217 currency code - `LineItems` ProposalLineItemReturn[], required — Line items colection - `ProductName` string, required — The product name - `ProductCode` string, required — The product code - `Quantity` number, float, required — The quantity for the product - `Price` number, float, required — The list price for the product - `DiscountedPrice` number, float, required — The discounted price for the product - `PriceType` 'gross' | 'net', required — The type of the price - `SubscriptionReference` string — The subscription reference for upgrade of renewal - `ContractPeriod` integer, required — The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case. - `NextContractRenewalPeriod` integer — The number of billing cycles that will be defined for the next contract. - `ImmediateAction` 'now' | 'end_of_billing_cycle' | 'end_of_contract', required — If the contract starts now or at the end of current billing cycle or contract period - `BillingCycle` ProposalLineItemBillingCycle — The billing cycle - `Unit` 'day' | 'month', required — The unit for the billing cycle - `Value` integer, required — The number of days or months. Minimum for a day unit is 7. - `PriceOptions` ProposalPriceOption[], required — Array of selected price options - `GroupCode` string, required — The price options group code - `GroupOptions` string[], required — Selected group option code - `AdditionalFields` ProposalAdditionalField[], required — Product additional fields - `Code` string, required — The alpha-numeric characters, underscores and dashes that are set as the field identifier. - `Value` string, required — Selected field value. - `ProrationDate` string, date-time — The UTC proration date in ISO 8601 format. Is used only for amendments with net terms - `AmendmentScenario` 'prolong' | 'does_not_affect' | 'start_new_deal_contract_after_current_cycle' | 'start_new_deal_contract_now' — The type of the amendment scenario - `Terms` integer — Net X terms in days - `AdditionalFields` ProposalAdditionalField[], required — Order additional fields - `Code` string, required — The alpha-numeric characters, underscores and dashes that are set as the field identifier. - `Value` string, required — Selected field value. - `BillTo` ProposalBillToDetails, required — The entity paying for the service and who is getting the invoice - `Company` string, required — The company name - `FirstName` string, required — The first name for the contact - `LastName` string, required — The last name for the contact - `Email` string, required — The contact email address - `Phone` string, required — Contact phone number formatted as CCNN - `Country` string, required — The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2 - `State` string, required — The country state for the address - `City` string, required — The city for the address - `Zip` string, required — The address zip code - `Address` string, required — The street address - `Name` string, required — The name of the proposal - `Tac` ProposalTac, required - `Content` string, required — The Terms And Conditions content (resulted from an WYSIWYG HTML editor) - `AcceptedDate` string, date-time — The UTC date when the proposal terms and conditions were accepted in ISO 8601 format - `Type` 'renewal' | 'upgrade' | 'acquisition', required — The type of the proposal - `SentBy` ProposalSentBy — Represents the account manager from the vendor - `FirstName` string, required — The first name for the email sender - `LastName` string, required — The last name for the email sender - `Email` string, required — The email address of the email sender - `Links` ProposalLink[], required — The proposal links details - `LinkId` string, required — The unique link id - `Url` string, required — The link url for viewing - `Status` 'opened' | 'preview' | 'sent' | 'closed_won' | 'closed_lost' | 'declined' | 'expired' | 'accepted' | 'feedback', required — The status of the proposal - `Pdf` string, required — The link url for downloading the pdf - `Status` 'opened' | 'preview' | 'sent' | 'closed_won' | 'closed_lost' | 'declined' | 'expired' | 'accepted' | 'feedback', required — The status of the proposal - `ExpirationDate` string, date-time — The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to "sent". - `StatusComment` string, required — The associated comment for the status - `SellTo` ProposalSellToDetails, required — Used for tax calculation. Represents the entity using the service. - `Company` string, required — The company name - `FirstName` string, required — The first name for the contact - `LastName` string, required — The last name for the contact - `Email` string, required — The contact email address - `VatCode` string, required — Value-added tax identification number - `TaxExemptionId` string — Value-added tax identification number - `Phone` string, required — Contact phone number formatted as CCNN - `Country` string, required — The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2 - `State` string, required — The country state for the address - `City` string, required — The city for the address - `Zip` string, required — The address zip code - `Address` string, required — The street address - `proposalsCount` integer, required — The total number of proposal matching the criterias - `pagesCount` integer, required — The total number of pages for proposal matching the criterias ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found --- [API](https://skmtc.dev/2checkout/apis/api-rest-documentation.md) · [All operations](https://skmtc.dev/2checkout/apis/api-rest-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/2checkout/api-rest-documentation/revisions/8a7ea610933e/schema)