Extensions and APIs for Invoicing Apps

Invoicing apps generate invoices, receipts, and manage billing for orders placed on Wix sites. This article lists the APIs and events you need to use to build an invoicing app.

When developing your app, make sure to create a dashboard extension to provide Wix users with an interface to view invoices, configure invoice templates, and manage billing settings.

Permissions

Your app needs the following permission scopes:

• Read Orders (SCOPE.DC-STORES.READ-ORDERS): Required for retrieving order details.
• Read Bookings - Including Participants (SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE): Required for retrieving booking details.
• Read Payments (SCOPE.DC-CASHIER.READ-PAYMENTS): Required for retrieving payment details.

APIs and events

Use these APIs and events to build your invoicing integration.

Orders

Receive order notifications and retrieve order details for invoicing.

• Order Approved event: Triggers when an order is approved.
• Order Paid event: Triggers when payment is confirmed.
• Order Updated event: Triggers when order details change.
• Get Order: Retrieve order details.
• List Invoices For Multiple Orders: Check if invoices exist for orders.

Billing

Handle payment authorization, capture, and refunds.

• Authorize Charge With Saved Payment Method: Authorizes a charge for an order.
• Capture Authorized Payments: Captures previously authorized payments.
• Void Authorized Payments: Voids previously authorized payments.
• Get Order Refundability / Calculate Refund: Check refund eligibility and calculate amounts.
• Refund Payments: Refunds order payments.
• Purchased Item Invoice Status Updated event: Triggers when invoice status changes.

Receipts

Generate and manage receipts for completed transactions.

• Create Receipt: Creates a receipt.
• Get Receipt / Query Receipts: Retrieve receipts.

Billable items

Manage custom products or services for invoicing.

• Create Billable Item / Update Billable Item: Create or update billable items.
• Query Billable Items: Retrieve billable items.

Extensions

Extensions add functionality to your app and integrate it with the Wix platform.

Dashboard extension (required)

Dashboard extensions add customizable features like a page or plugin to the Wix Dashboard. Use a dashboard extension to let Wix users view invoices, configure invoice templates, and manage billing settings.

See also

• About Launching Apps
• eCommerce Orders API
• Order Billing API
• Receipts API
• Billable Items API