> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Package: receipts # Namespace: receiptPresets # Webhook link: https://dev.wix.com/docs/api-reference/business-management/get-paid/receipts/receipt-presets/receipt-preset-created.md ## Introduction Triggered when a receipt preset is created. --- ## REST API ### Schema ``` Webhook: Receipt Preset Created Description: Triggered when a receipt preset is created. Event body: - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events. - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event. - name: slug | type: string | description: Event name. - name: entityId | type: string | description: ID of the entity associated with the event. - name: eventTime | type: string (date-time) | description: Event timestamp. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR. - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: createdEvent | type: object | description: Created event details. - name: entity | type: ReceiptPreset | description: The created entity. - name: id | type: string | description: Receipt preset GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the receipt preset is updated. To prevent conflicting changes, the current revision must be passed when updating the receipt preset. - name: createdDate | type: string | description: Date and time the receipt preset was created. - name: updatedDate | type: string | description: Date and time the receipt preset was last updated. - name: name | type: string | description: Receipt preset name. - name: displaySettings | type: DisplaySettings | description: Display settings. - name: businessDisplayOptions | type: BusinessDisplayOptions | description: Business display options. - name: showBusinessEmail | type: boolean | description: Whether to display the business email in the receipt. - name: showBusinessPhoneNumber | type: boolean | description: Whether to display the business phone number in the receipt. - name: showBusinessAddress | type: boolean | description: Whether to display the business address in the receipt. - name: customerDisplayOptions | type: CustomerDisplayOptions | description: Customer display options. - name: showCustomerEmail | type: boolean | description: Whether to display the customer's email in the receipt. - name: showCustomerPhoneNumber | type: boolean | description: Whether to display the customer's phone number in the receipt. - name: showCustomerShippingAddress | type: boolean | description: Whether to display the customer's shipping address in the receipt. - name: showCustomerBillingAddress | type: boolean | description: Whether to display the customer's billing address in the receipt. - name: showCustomerVatId | type: boolean | description: Whether to display the customer's VAT GUID in the receipt. - name: showCustomerCompanyName | type: boolean | description: Whether to display the customer's company's name. - name: itemsDisplayOptions | type: ItemsDisplayOption | description: Item display options. - name: showItemsDescription | type: boolean | description: Whether to display item descriptions in the receipt. - name: showTax | type: boolean | description: Whether to display item taxes in the receipt. - name: totalsDisplayOptions | type: TotalsDisplayOption | description: Totals display options. - name: showTaxBreakdown | type: boolean | description: Whether to display the tax breakdown in the receipt. - name: showItemSubtotalPerTaxBreakdown | type: boolean | description: Whether to display the item subtotal per tax breakdown in the receipt. - name: customFields | type: CustomFields | description: Custom fields. Values appear on the receipt in the specified order. - name: headerCustomFields | type: array | description: Header custom fields. - name: title | type: string | description: Title. - name: value | type: string | description: Value. - name: businessCustomFields | type: array | description: Business custom fields. - name: customerCustomFields | type: array | description: Customer custom fields. - name: footerCustomFields | type: array | description: Footer custom fields. - name: title | type: string | description: Title. - name: value | type: string | description: Value. - name: default | type: boolean | description: Whether this is the default receipt preset. The default preset is used during receipt creation when a preset isn't specified or doesn't exist. - name: displayValues | type: DisplayValues | description: Display values. - name: titleOverride | type: string | description: Text override for receipt title. - name: extendedFields | type: ExtendedFields | description: Custom field data for the receipt preset. Extended fields must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). ``` ### Examples ```curl { "id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11", "entityFqdn": "wix.receipts.presets.v1.receipt_preset", "slug": "created", "entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "createdEvent": { "entity": { "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "revision": 1, "createdDate": "2024-10-30T17:22:10.299Z", "updatedDate": "2024-10-30T17:22:10.299Z", "name": "Invoice preset", "templateSettingsId": "4fd78c54-b722-4300-ac62-ea71ceaec00f", "displayValues": { "titleOverride": "INV-Receipt" }, "displaySettings": { "businessDisplayOptions": { "showBusinessEmail": true, "showBusinessPhoneNumber": true, "showBusinessAddress": true }, "customerDisplayOptions": { "showCustomerEmail": true, "showCustomerPhoneNumber": true, "showCustomerShippingAddress": true, "showCustomerBillingAddress": true, "showCustomerVatId": true }, "itemsDisplayOptions": { "showItemsDescription": true, "showTax": true }, "totalsDisplayOptions": { "showTaxBreakdown": true, "showItemSubtotalPerTaxBreakdown": true } }, "customFields": { "headerCustomFields": [ { "title": "Source", "value": "Invoices" } ], "businessCustomFields": [ { "title": "Company ID", "value": "12345" } ], "customerCustomFields": [ { "title": "Customer Type", "value": "Invoice Customer" } ], "footerCustomFields": [ { "title": "Terms", "value": "This receipt align to the requirements of an example." } ] }, "default": false } }, "eventTime": "2024-10-30T17:22:10.299Z", "triggeredByAnonymizeRequest": false } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onReceiptPresetCreated Description: Triggered when a receipt preset is created. Payload: ReceiptPresetCreatedEnvelope - name: entity | type: ReceiptPreset | description: none - name: _id | type: string | description: Receipt preset GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the receipt preset is updated. To prevent conflicting changes, the current revision must be passed when updating the receipt preset. - name: _createdDate | type: Date | description: Date and time the receipt preset was created. - name: _updatedDate | type: Date | description: Date and time the receipt preset was last updated. - name: name | type: string | description: Receipt preset name. - name: displaySettings | type: DisplaySettings | description: Display settings. - name: businessDisplayOptions | type: BusinessDisplayOptions | description: Business display options. - name: showBusinessEmail | type: boolean | description: Whether to display the business email in the receipt. - name: showBusinessPhoneNumber | type: boolean | description: Whether to display the business phone number in the receipt. - name: showBusinessAddress | type: boolean | description: Whether to display the business address in the receipt. - name: customerDisplayOptions | type: CustomerDisplayOptions | description: Customer display options. - name: showCustomerEmail | type: boolean | description: Whether to display the customer's email in the receipt. - name: showCustomerPhoneNumber | type: boolean | description: Whether to display the customer's phone number in the receipt. - name: showCustomerShippingAddress | type: boolean | description: Whether to display the customer's shipping address in the receipt. - name: showCustomerBillingAddress | type: boolean | description: Whether to display the customer's billing address in the receipt. - name: showCustomerVatId | type: boolean | description: Whether to display the customer's VAT GUID in the receipt. - name: showCustomerCompanyName | type: boolean | description: Whether to display the customer's company's name. - name: itemsDisplayOptions | type: ItemsDisplayOption | description: Item display options. - name: showItemsDescription | type: boolean | description: Whether to display item descriptions in the receipt. - name: showTax | type: boolean | description: Whether to display item taxes in the receipt. - name: totalsDisplayOptions | type: TotalsDisplayOption | description: Totals display options. - name: showTaxBreakdown | type: boolean | description: Whether to display the tax breakdown in the receipt. - name: showItemSubtotalPerTaxBreakdown | type: boolean | description: Whether to display the item subtotal per tax breakdown in the receipt. - name: customFields | type: CustomFields | description: Custom fields. Values appear on the receipt in the specified order. - name: headerCustomFields | type: array | description: Header custom fields. - name: title | type: string | description: Title. - name: value | type: string | description: Value. - name: businessCustomFields | type: array | description: Business custom fields. - name: customerCustomFields | type: array | description: Customer custom fields. - name: footerCustomFields | type: array | description: Footer custom fields. - name: title | type: string | description: Title. - name: value | type: string | description: Value. - name: default | type: boolean | description: Whether this is the default receipt preset. The default preset is used during receipt creation when a preset isn't specified or doesn't exist. - name: displayValues | type: DisplayValues | description: Display values. - name: titleOverride | type: string | description: Text override for receipt title. - name: extendedFields | type: ExtendedFields | description: Custom field data for the receipt preset. Extended fields must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: metadata | type: EventMetadata | description: none - name: instanceId | type: string | description: App instance GUID. - name: eventType | type: string | description: Event type. - name: identity | type: IdentificationData | description: The identification type and identity data. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: identityType | type: WebhookIdentityType | description: - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP - name: accountInfo | type: AccountInfo | description: Details related to the account - name: accountId | type: string | description: GUID of the Wix account associated with the event. - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account. - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site. - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them. - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. - name: entityId | type: string | description: GUID of the entity associated with the event. - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. ``` ### Examples ```javascript import { receiptPresets } from '@wix/get-paid'; receiptPresets.onReceiptPresetCreated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { receiptPresets } from '@wix/get-paid'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { receiptPresets, }, }); wixClient.receiptPresets.onReceiptPresetCreated((event) => { // handle your event here }); ``` ---