API Docs for: 1.3.12
Show:

Invoice Class

Schema.org/Invoice A statement of the money due for goods or services; a bill.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

accountId

Text

Schema.org/accountId The identifier for the account the payment will be applied to.

additionalType

URL

Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text

Schema.org/alternateName An alias for the item.

billingPeriod

Duration

Schema.org/billingPeriod The time interval used to compute the invoice.

broker

Person

Schema.org/broker An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

category

Text

Schema.org/category A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

confirmationNumber

Text

Schema.org/confirmationNumber A number that confirms the given order or payment has been received.

customer

Organization

Schema.org/customer Party placing the order or paying the invoice.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

minimumPaymentDue

MonetaryAmount

Schema.org/minimumPaymentDue The minimum payment required at this time.

name

Text

Schema.org/name The name of the item.

paymentDue

DateTime

Schema.org/paymentDue The date that payment is due.

paymentDueDate

DateTime

Schema.org/paymentDueDate The date that payment is due.

paymentMethod

PaymentMethod

Schema.org/paymentMethod The name of the credit card or other method of payment for the order.

paymentMethodId

Text

Schema.org/paymentMethodId An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

paymentStatus

PaymentStatusType

Schema.org/paymentStatus The status of payment; whether the invoice has been paid or not.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

provider

Person

Schema.org/provider The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

referencesOrder

Order

Schema.org/referencesOrder The Order(s) related to this Invoice. One or more Orders may be combined into a single Invoice.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

scheduledPaymentDate

Date

Schema.org/scheduledPaymentDate The date the invoice is scheduled to be paid.

totalPaymentDue

MonetaryAmount

Schema.org/totalPaymentDue The total amount due.

url

URL

Schema.org/url URL of the item.