# Proposal

## Search proposals

> Search proposals

```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/proposals/":{"get":{"tags":["Proposal"],"summary":"Search proposals","description":"Search proposals","operationId":"search-proposals","parameters":[{"name":"Name","in":"query","description":"Proposal name","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Email","in":"query","description":"The bill to or sell to email","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"UpdatedAfter","in":"query","description":"The UTC date and time in ISO 8601 format","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"UpdatedBefore","in":"query","description":"The UTC date and time in ISO 8601 format","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"UpdatedBy","in":"query","description":"The unique external system user identifier","required":false,"style":"form","explode":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"CreatedBy","in":"query","description":"The unique external system user identifier","required":false,"style":"form","explode":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"Source","in":"query","description":"The source from where the proposal was created","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"CreatedAfter","in":"query","description":"The UTC date and time in ISO 8601 format","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"CreatedBefore","in":"query","description":"The UTC date and time in ISO 8601 format","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Locked","in":"query","description":"Retrieve proposals that are locked or not","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"Page","in":"query","description":"The page at which the proposals should be returned","required":true,"style":"form","explode":true,"schema":{"maximum":9999,"minimum":1,"maxLength":9999,"minLength":1,"type":"integer","default":1}},{"name":"Limit","in":"query","description":"The maximum number of proposals to return","required":true,"style":"form","explode":true,"schema":{"maximum":100,"minimum":1,"maxLength":9999,"minLength":0,"type":"integer","default":10}},{"name":"LinkId","in":"query","description":"The link id for any status","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_10"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"inline_response_200_10":{"required":["limit","page","proposals","proposalsCount","pagesCount"],"type":"object","properties":{"page":{"type":"integer","description":"The incoming page value"},"limit":{"type":"integer","description":"The incoming limit value"},"proposals":{"type":"array","description":"The matching proposals collection","items":{"$ref":"#/components/schemas/Proposal"}},"proposalsCount":{"type":"integer","description":"The total number of proposal matching the criterias"},"pagesCount":{"type":"integer","description":"The total number of pages for proposal matching the criterias"}}},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```

## Create proposal

> Create proposal

```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/proposals/":{"post":{"tags":["Proposal"],"summary":"Create proposal","description":"Create proposal","operationId":"create-proposal","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalCreateRequest"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"ProposalCreateRequest":{"title":"Proposal Create Request","type":"object","description":"Proposal create request","properties":{"Name":{"$ref":"#/components/schemas/PropProposalName"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToCreate"},"Content":{"$ref":"#/components/schemas/ProposalContentCreate"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Tac":{"$ref":"#/components/schemas/ProposalCreateRequest_Tac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"Source":{"type":"string","description":"The source from where the proposal was created"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToCreate"},"Scope":{"$ref":"#/components/schemas/PropProposalScope"}},"required":["Type","Source"]},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalBillToCreate":{"title":"BillTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address","default":""},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalContentCreate":{"title":"ProposalContent create","required":["Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"ProposalCreateRequest_Tac":{"required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSellToCreate":{"title":"SellTo create","required":["Company"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number for USA"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service"},"PropProposalScope":{"title":"ProposalScope","type":"string","description":"Amendment scope, send only for amendments. Use null to reset on update.","default":null,"nullable":true,"enum":["autorenewal"]},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```

## Retrieve a proposal

> Retrieve a proposal

```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/proposals/{proposalId}":{"get":{"tags":["Proposal"],"summary":"Retrieve a proposal","description":"Retrieve a proposal","operationId":"get-proposal-by-id","parameters":[{"name":"proposalId","in":"path","description":"The unique merchant proposal id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```

## Update proposal

> Update proposal

```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/proposals/{proposalId}":{"patch":{"tags":["Proposal"],"summary":"Update proposal","description":"Update proposal","operationId":"update-proposal-by-id","parameters":[{"name":"proposalId","in":"path","description":"The unique merchant proposal id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Proposal with the needed updated fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"ProposalUpdateRequest":{"title":"Proposal Update Request","type":"object","description":"Proposal update request","properties":{"Name":{"$ref":"#/components/schemas/PropProposalName"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToOptional"},"Content":{"$ref":"#/components/schemas/ProposalContentOptional"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Tac":{"$ref":"#/components/schemas/ProposalTacOptional"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToOptional"},"Scope":{"$ref":"#/components/schemas/PropProposalScope"}}},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalBillToOptional":{"title":"BillTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalContentOptional":{"title":"ProposalContent optional","type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItems"},"Terms":{"type":"integer","description":"Net X terms in days","nullable":true},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItems":{"title":"LineItems","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItem"}},"ProposalLineItem":{"title":"LineItem","required":["ContractPeriod","DiscountedPrice","Price","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"MerchantDealAutoRenewal":{"$ref":"#/components/schemas/PropMerchantDealAutoRenewal"},"ClientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"},"AmendmentScenario":{"$ref":"#/components/schemas/PropClientAmendmentScenario"}},"description":"Line item"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"PropMerchantDealAutoRenewal":{"title":"prop_merchant_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"PropClientAmendmentScenario":{"title":"prop_client_amendment_scenario","type":"string","description":"The scenario to use for amendments. The prolong value will make the current billing cycle from the immediateAction value increase with the defined billingCycle. The value does_not_affect will not alter the current billing cycle no matter what value billingCycle has.","enum":["prolong","does_not_affect"]},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalTacOptional":{"title":"tac","type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"ProposalSellToOptional":{"title":"SellTo optional","type":"object","properties":{"Address":{"type":"string","description":"The street address"},"Zip":{"type":"string","description":"The address zip code"},"City":{"type":"string","description":"The city for the address"},"State":{"type":"string","description":"The country state for the address"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Company":{"type":"string","description":"The company name"}},"description":"Used for tax calculation. Represents the entity using the service."},"PropProposalScope":{"title":"ProposalScope","type":"string","description":"Amendment scope, send only for amendments. Use null to reset on update.","default":null,"nullable":true,"enum":["autorenewal"]},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```

## Execute an action on the proposal

> Execute an action on the proposal

```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/proposals/{proposalId}/action":{"post":{"tags":["Proposal"],"summary":"Execute an action on the proposal","description":"Execute an action on the proposal","operationId":"action-proposal-by-id","parameters":[{"name":"proposalId","in":"path","description":"The unique merchant proposal id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProposalActionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Proposal"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"ProposalActionRequest":{"title":"Proposal Action Request","required":["Action"],"type":"object","properties":{"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"UserId":{"$ref":"#/components/schemas/PropProposalUserId"},"Action":{"type":"string","enum":["decline","accept","discard","reopen","send","close","preview","feedback"],"description":"The action to perform. For feedback, the statusComment parameter is mandatory to be provided. For send, the expirationDate and sentBy parameters are mandatory to be provided. For send, reopen and discard it is recommended to provide the userId parameter. For decline is recommended to provide the statusComment parameter."},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"content":{"$ref":"#/components/schemas/ActionRequestContent"},"SendEmail":{"type":"boolean","description":"used to skip sending notification email when set to false on sending or accepting a proposal","default":true}},"description":"Proposal action request"},"PropProposalExpirationDate":{"title":"ExpirationDate","type":"string","description":"The UTC expiration date for the proposal in ISO 8601 format. Set only when the status is changed to \"sent\".","format":"date-time"},"PropProposalUserId":{"title":"UserId","type":"string","description":"The unique external system user identifier"},"PropProposalStatusComment":{"title":"StatusComment","type":"string","description":"The associated comment for the status"},"ProposalSentBy":{"title":"SentBy","required":["Email","FirstName","LastName"],"type":"object","properties":{"FirstName":{"type":"string","description":"The first name for the email sender"},"LastName":{"type":"string","description":"The last name for the email sender"},"Email":{"type":"string","description":"The email address of the email sender"}},"description":"Represents the account manager from the vendor"},"ActionRequestContent":{"title":"action_proposal_content","type":"object","description":"The content configuration proposed by the client on accepting the proposal","properties":{"lineItems":{"$ref":"#/components/schemas/ActionRequestLineItems"}}},"ActionRequestLineItems":{"title":"action_request_line_items","type":"array","description":"The line items configuration proposed by the client","items":{"$ref":"#/components/schemas/ActionRequestLineItem"}},"ActionRequestLineItem":{"title":"action_request_line_item","type":"object","description":"The line item configuration proposed by the client","properties":{"productCode":{"$ref":"#/components/schemas/PropProductCode"},"clientDealAutoRenewal":{"$ref":"#/components/schemas/PropClientDealAutoRenewal"}},"required":["productCode","clientDealAutoRenewal"]},"PropProductCode":{"type":"string","title":"prop_product_code","minLength":0,"maxLength":100,"description":"The unique product code"},"PropClientDealAutoRenewal":{"title":"prop_client_deal_auto_renewal","type":"boolean","description":"If both merchant and client DealAutoRenewals are set to true, it will trigger a contract automatic renewal. Optional, defaults to false."},"Proposal":{"title":"Proposal","required":["BillTo","Content","CreatedBy","CreatedDate","Links","Locked","Name","ProposalId","SellTo","Source","Status","StatusComment","Tac","Type","UpdatedBy","UpdatedDate","Version"],"type":"object","properties":{"ProposalId":{"$ref":"#/components/schemas/PropProposalId"},"Version":{"type":"integer","description":"The version of the proposal. Every modification increments the version by 1."},"CreatedDate":{"type":"string","description":"The UTC creation date for the proposal in ISO 8601 format","format":"date-time"},"UpdatedDate":{"type":"string","description":"The UTC last update date for the proposal in ISO 8601 format","format":"date-time"},"CreatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"UpdatedBy":{"$ref":"#/components/schemas/PropProposalUserId"},"Locked":{"$ref":"#/components/schemas/PropProposalLocked"},"Source":{"type":"string","description":"The source from where the proposal was created"},"Content":{"$ref":"#/components/schemas/ProposalContent"},"BillTo":{"$ref":"#/components/schemas/ProposalBillToDetails"},"Name":{"$ref":"#/components/schemas/PropProposalName"},"Tac":{"$ref":"#/components/schemas/ProposalTac"},"Type":{"$ref":"#/components/schemas/PropProposalType"},"SentBy":{"$ref":"#/components/schemas/ProposalSentBy"},"Links":{"$ref":"#/components/schemas/ProposalLinks"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"ExpirationDate":{"$ref":"#/components/schemas/PropProposalExpirationDate"},"StatusComment":{"$ref":"#/components/schemas/PropProposalStatusComment"},"SellTo":{"$ref":"#/components/schemas/ProposalSellToDetails"}}},"PropProposalId":{"title":"ProposalId","type":"string","description":"The unique merchant proposal id"},"PropProposalLocked":{"title":"Locked","type":"boolean","description":"If the proposal is locked for buy modifications"},"ProposalContent":{"title":"ProposalContent","required":["AdditionalFields","Currency","Language","LineItems"],"type":"object","properties":{"Language":{"type":"string","description":"The ISO 639-1 language code"},"Currency":{"type":"string","description":"The ISO 4217 currency code"},"LineItems":{"$ref":"#/components/schemas/ProposalLineItemsReturn"},"Terms":{"minimum":1,"type":"integer","description":"Net X terms in days"},"AdditionalFields":{"type":"array","description":"Order additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}}},"description":"The proposal content"},"ProposalLineItemsReturn":{"title":"LineItems return","type":"array","description":"Line items colection","items":{"$ref":"#/components/schemas/ProposalLineItemReturn"}},"ProposalLineItemReturn":{"title":"LineItem return","required":["AdditionalFields","ContractPeriod","DiscountedPrice","ImmediateAction","Price","PriceOptions","PriceType","ProductCode","ProductName","Quantity"],"type":"object","properties":{"ProductName":{"type":"string","description":"The product name"},"ProductCode":{"type":"string","description":"The product code"},"Quantity":{"minimum":1,"type":"number","description":"The quantity for the product","format":"float"},"Price":{"type":"number","description":"The list price for the product","format":"float"},"DiscountedPrice":{"type":"number","description":"The discounted price for the product","format":"float"},"PriceType":{"type":"string","description":"The type of the price","enum":["gross","net"]},"SubscriptionReference":{"type":"string","description":"The subscription reference for upgrade of renewal"},"ContractPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles. A zero value means a lifetime contract period and billingCycle is not needed in this case."},"NextContractRenewalPeriod":{"minimum":0,"type":"integer","description":"The number of billing cycles that will be defined for the next contract.","default":0},"ImmediateAction":{"type":"string","description":"If the contract starts now or at the end of current billing cycle or contract period","default":"now","enum":["now","end_of_billing_cycle","end_of_contract"]},"BillingCycle":{"$ref":"#/components/schemas/ProposalLineItem_BillingCycle"},"PriceOptions":{"type":"array","description":"Array of selected price options","items":{"$ref":"#/components/schemas/ProposalPriceOption"}},"AdditionalFields":{"type":"array","description":"Product additional fields","items":{"$ref":"#/components/schemas/ProposalAdditionalField"}},"ProrationDate":{"type":"string","description":"The UTC proration date in ISO 8601 format. Is used only for amendments with net terms","format":"date-time"},"AmendmentScenario":{"type":"string","description":"The type of the amendment scenario","enum":["prolong","does_not_affect","start_new_deal_contract_after_current_cycle","start_new_deal_contract_now"]}},"description":"Line item return"},"ProposalLineItem_BillingCycle":{"required":["Unit","Value"],"type":"object","properties":{"Unit":{"type":"string","description":"The unit for the billing cycle","default":"month","enum":["day","month"]},"Value":{"minimum":1,"type":"integer","description":"The number of days or months. Minimum for a day unit is 7.","default":1}},"description":"The billing cycle"},"ProposalPriceOption":{"title":"PriceOption","required":["GroupCode","GroupOptions"],"type":"object","properties":{"GroupCode":{"type":"string","description":"The price options group code"},"GroupOptions":{"type":"array","description":"Selected group option code","items":{"type":"string"}}},"description":"Product price option"},"ProposalAdditionalField":{"title":"AdditionalField","required":["Code","Value"],"type":"object","properties":{"Code":{"type":"string","description":"The alpha-numeric characters, underscores and dashes that are set as the field identifier."},"Value":{"type":"string","description":"Selected field value."}},"description":"Product additional field"},"ProposalBillToDetails":{"title":"BillTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"The entity paying for the service and who is getting the invoice"},"PropProposalName":{"title":"Name","type":"string","description":"The name of the proposal"},"ProposalTac":{"title":"tac","required":["Content"],"type":"object","properties":{"Content":{"$ref":"#/components/schemas/PropProposalTacContent"},"AcceptedDate":{"type":"string","description":"The UTC date when the proposal terms and conditions were accepted in ISO 8601 format","format":"date-time"}}},"PropProposalTacContent":{"title":"TacContent","type":"string","description":"The Terms And Conditions content (resulted from an WYSIWYG HTML editor)"},"PropProposalType":{"title":"ProposalType","type":"string","description":"The type of the proposal","default":"acquisition","enum":["renewal","upgrade","acquisition"]},"ProposalLinks":{"title":"links","type":"array","description":"The proposal links details","items":{"$ref":"#/components/schemas/ProposalLink"}},"ProposalLink":{"title":"link","required":["LinkId","Pdf","Status","Url"],"type":"object","properties":{"LinkId":{"type":"string","description":"The unique link id"},"Url":{"type":"string","description":"The link url for viewing"},"Status":{"$ref":"#/components/schemas/PropProposalStatus"},"Pdf":{"type":"string","description":"The link url for downloading the pdf"}},"description":"The proposal links details"},"PropProposalStatus":{"title":"Status","type":"string","description":"The status of the proposal","default":"opened","enum":["opened","preview","sent","closed_won","closed_lost","declined","expired","accepted","feedback"]},"ProposalSellToDetails":{"title":"SellTo","required":["Address","City","Company","Country","Email","FirstName","LastName","Phone","State","VatCode","Zip"],"type":"object","properties":{"Company":{"type":"string","description":"The company name"},"FirstName":{"type":"string","description":"The first name for the contact"},"LastName":{"type":"string","description":"The last name for the contact"},"Email":{"type":"string","description":"The contact email address"},"VatCode":{"type":"string","description":"Value-added tax identification number"},"TaxExemptionId":{"type":"string","description":"Value-added tax identification number"},"Phone":{"type":"string","description":"Contact phone number formatted as CCNN"},"Country":{"type":"string","description":"The country for the address. Represents the country code as specified by ISO 3166-1 alpha-2"},"State":{"type":"string","description":"The country state for the address"},"City":{"type":"string","description":"The city for the address"},"Zip":{"type":"string","description":"The address zip code"},"Address":{"type":"string","description":"The street address"}},"description":"Used for tax calculation. Represents the entity using the service."},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.2checkout.com/api-reference/reference/proposal.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.