Invoice Object


A request for payment issued by a business to a customer, containing line items, taxes, discounts, and payment terms.

Properties
activityInfoActivityInfoRead-only

Read-only record of when the invoice was last sent and last viewed.


additionalFeesArray <AdditionalFee>maxItems 20

Additional fees applied to the invoice.


archivedbooleanRead-only

Whether the invoice is archived.


attachmentsArray <Attachment>maxItems 5

Files attached to the invoice.


availableActionsArray <string>Read-onlymaxItems 12

Actions that can be performed on this invoice based on its current status.


businessDetailsBusinessDetails

Business details displayed on the invoice, such as company name, address, email, phone, and logo. Automatically populated from the Site Properties API when the invoice is created, if not explicitly provided. These details aren't synced with Site Properties after creation and become permanently fixed once status reaches PARTIALLY_PAID, PAID, or VOIDED.


businessLocationBusinessLocation

Business location.


createdDatestringRead-onlyformat date-time

Date and time the invoice was created.


currencystringformat CURRENCYimmutable

Currency code for all monetary amounts on the invoice. Three-letter code in ISO-4217 alphabetic format. Set at creation and can't be changed.


customerInfoCustomerInfo

Customer information including contact details and billing address.


customFieldsCustomFields

Custom fields displayed on the invoice document.


depositDeposit

Deposit payment configuration.


discountsArray <Discount>maxItems 20

Invoice-level discounts.


documentInfoDocumentInfoRead-only

PDF document generation status.


dueDatestringformat date-time

Date when payment is due. Cannot be before issueDate.


hasSubscriptionsbooleanRead-only

Whether the invoice contains subscription line items. true when at least one line item carries subscription info.


idstringRead-onlyformat GUIDimmutable

Invoice ID.


issueDatestringformat date-time

Date the invoice was issued.


lineItemsArray <LineItem>minItems 0maxItems 300

Line items on the invoice.


linksLinksRead-only

Invoice URL.


numberingNumberingRead-only

Invoice numbering. Assigned when the invoice is published.


paymentsArray <Payment>Read-onlymaxItems 100

Payment records.


presetPropertiesPresetProperties

Invoice preset applied to this invoice. Determines the appearance and custom fields on the invoice document. If not provided, the default preset is used.


referenceReferenceimmutable

Invoice type and Wix eCommerce association. May change when an eligible legacy invoice is converted.


regionalPropertiesRegionalProperties

Regional properties for the invoice. When not provided, defaults are taken from the Site Properties API.


revisionstringRead-onlyformat int64

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

Ignored when creating an invoice.


shipmentInfoShipmentInfo

Delivery and shipping cost details (carrier, method, price, tax) tied to the Wix eCommerce integration. Defaults to using shippingInfo.shippingAddress as the delivery destination unless shipmentInfo.logistics.pickupDetails is specified.


shippingInfoShippingInfo

Shipping destination for the invoice, including the recipient's contact details and address. Can exist independently without a shipment. When a shipment is configured, shipmentInfo uses this address as the delivery destination unless a pickup address is specified.


sourceReferenceSourceReferenceimmutable

Information about the app that created the invoice.


statusstringRead-only

Invoice status.


statusQualifiersArray <string>Read-onlymaxItems 2

Additional flags providing context about the invoice's state, independent of its primary status. These flags are system-managed and read-only.


tagsTags

Tags for organizing invoices. publicTags are visible to anyone with access to the invoice. privateTags are restricted to site owners and require additional permissions to access.


taxInfoTaxInfoRead-only

Tax information.


titlestringminLength 1maxLength 200

Invoice title.


totalsTotalsRead-only

Financial summary including subtotal, taxes, and total amount.


updatedDatestringRead-onlyformat date-time

Date and time the invoice was last updated.

Did this help?