Proposal Object


A Proposal is an object containing business proposal data, such as title, customer, items that are being offered and also data about how payments for proposed items will be structured as defined in payment schedules.

Properties
acceptedDatestringRead-onlyformat date-time

Date when proposal was accepted.


additionalFeesArray <AdditionalFee>maxItems 100

Additional Fees.


appliedDiscountsArray <AppliedDiscount>maxItems 3

Applied discounts.


availableActionsArray <string>Read-onlymaxItems 20

Available actions for the proposal.


calculatedTotalsCalculatedTotalsRead-only

Calculated totals of the proposal.


createdDatestringRead-onlyimmutableformat date-time

Date and time the Proposal was created.


currencyCodestringRead-onlyformat CURRENCY

ISO 4217 currency code.


customerIdstringformat GUID

Customer that the proposal is meant for (reference to wix contact).


expirationDatestringformat date-time

Date when proposal expires and can not be accepted anymore.


extendedFieldsExtendedFields

Data Extensions.


idstringRead-onlyformat GUIDimmutable

Proposal ID.


lineItemsArray <LineItem>minItems 1maxItems 100

Items in the proposal.


linksLinksRead-only

Proposal links.


localeLocale

Locale used to describe proposal's language


paymentSettingsPaymentSettings

Payment settings.


previousStatusstringRead-onlyInternal

Proposal previous status, used to reverse status changes.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Proposal is updated. To prevent conflicting changes, the current revision must be passed when updating the Proposal.

Ignored when creating a Proposal.


sendStatusSendStatusRead-only

Proposal send status details.


sourceReferenceSourceReferenceimmutable

Source reference of the proposal.


statusstringRead-only

Status of the proposal.


tagsTags

Tags.


templateReferenceIdstringformat GUIDimmutable

Proposal Template Id, it's provided when Proposal is created from a Template


titlestringminLength 1maxLength 120

Title of the proposal


updatedDatestringRead-onlyformat date-time

Date and time the Proposal was last updated.

Did this help?