"Invoices" Collection Fields

To use the Invoices collection in code, refer to it as "Billing/Invoices".

wixData.query("Billing/Invoices")
  .find()
  .then( (results) => {
    // handle the results
  } );

javascript | Copy Code

This document describes the permissions and fields in your Invoices collection.

Permissions

The Invoices collection has the following permissions:

Read: Anyone
Create: None
Update: None
Delete: None

You cannot change the Invoices collection permissions.

Fields

Note: This app collection contains read-only fields that cannot be managed from the collection. You can update the fields from the relevant app in your site’s dashboard.

The field name is listed as the heading of each section, with the field key listed in parentheses, like this: Name (name). The fields appear in this document in the order in which they appear in your collection by default.

ID (_id)

Description: The ID of the invoice. This is a system field and is hidden by default.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Version (version)

Description: The version of the invoice.
Type: Number
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Status (status)

Description: The invoice's status.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: Yes
Can be filtered: No
Read-only: Yes
Notes: One of:

"Draft"
"Sent"
"Processing"
"Paid"
"Overdue"
"Void"
"Deleted"
"PartiallyPaid"
"PartialAndOverdue"

Number (number)

Description: Number of the invoice, unique within your site.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: Yes
Can be filtered: No
Read-only: Yes

Title (title)

Description: Invoice title.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: Yes
Can be sorted: Yes
Can be filtered: No
Read-only: Yes

Currency Code (currencyCode)

Description: Code representing the invoice's currency.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Customer (customer)

Description: Customer listed on the invoice.
Type: Object
Can connect to data: No
Can use in dynamic page URL: No
Can be sorted: Yes. Can sort by name.
Can be filtered: No
Read-only: Yes

{  
  "contactId": "4f7c6637-0657-4696-a00b-9bc2ae4e035d",
  "email": "john.doe@somedomain.com",
  "address": {  
    "street": "235 W 23rd St",
    "city": "New York",
    "zip": "10011",
    "state": "NY",
    "country": "USA"
  },
  "phone": "5555555555",
  "company": "Some Company",
  "fullName": "John Doe",
  "firstName": "John",
  "lastName": "Doe"
}

json | Copy Code

Was Sent (wasSent)

Description: Whether the invoice has been sent to the customer.
Type: Boolean
Can connect to data: No
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Total (total)

Description: Invoice total.
Type: Number
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: Yes
Can be filtered: No
Read-only: Yes

Paid (paid)

Description: Amount paid.
Type: Number
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Issue Date (issueDate)

Description: Date the invoice was issued.
Type: Date and Time
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: Yes
Can be filtered: No
Read-only: Yes

Due Date (dueDate)

Description: Date the invoice is due.
Type: Date and Time
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: Yes
Can be filtered: No
Read-only: Yes

Last Seen Date (lastSeenDate)

Description: Date the invoice was last seen.
Type: Date and Time
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Source (source)

Description: Source that triggered the action. For example, "stores".
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

SourceRefID (sourceRefId)

Description: ID of the trigger source. For example, an order ID.
Type: Text
Can connect to data: Yes
Can use in dynamic page URL: No
Can be sorted: No
Can be filtered: No
Read-only: Yes

Was this helpful?