Use this type to embed information about an Invoice for payment.
Use cases
The following use cases show common examples of how the Invoice
schema is
used. Use these examples to ensure that your markup is properly structured.
Invoice for automatic payment
This is an example of markup using the Invoice type, in this case with automatic payment specified.
JSON-LD
< scrip
t
t
ype='applica
t
io
n
/ld+jso
n
'
> {
"@context"
:
"http://schema.org"
,
"@type"
:
"Invoice"
,
"accountId"
:
"123-456-789"
,
"minimumPaymentDue"
:
{
"@type"
:
"PriceSpecification"
,
"price"
:
"$70.00"
},
"paymentDue"
:
"2015-11-22T08:00:00+00:00"
,
"paymentStatus"
:
"PaymentAutomaticallyApplied"
,
"provider"
:
{
"@type"
:
"Organization"
,
"name"
:
"Mountain View Utilities"
},
"totalPaymentDue"
:
{
"@type"
:
"PriceSpecification"
,
"price"
:
"$70.00"
}
}
< /scrip
t
>
Microdata
< div
itemscope
itemtype
=
"http://schema.org/Invoice"
>
< span
itemprop
=
"accountId"
> 123
-
456
-
789
< /
span
>
< div
itemprop
=
"minimumPaymentDue"
itemscope
itemtype
=
"http://schema.org/PriceSpecification"
>
< span
itemprop
=
"price"
> $
70.00
< /
span
>
< /
div
>
< span
itemprop
=
"paymentDue"
> 2015
-
11
-
22
T08
:
00
:
00
+
00
:
00
< /
span
>
< span
itemprop
=
"paymentStatus"
> PaymentAutomaticallyApplied
< /
span
>
< div
itemprop
=
"provider"
itemscope
itemtype
=
"http://schema.org/Organization"
>
< span
itemprop
=
"name"
> Mountain
View
Utilities
< /
span
>
< /
div
>
< div
itemprop
=
"totalPaymentDue"
itemscope
itemtype
=
"http://schema.org/PriceSpecification"
>
< span
itemprop
=
"price"
> $
70.00
< /
span
>
< /
div
>
< /
div
>
Test your markup
You can validate your markup using the Email Markup Tester Tool . Paste in your markup code and click the Validatebutton to scan the content and receive a report on any errors present.
Specification
Review the details of your email to see if any of these addional properties apply to your invoice. By marking up these additional properties you allow Google to display a richer description of the invoice.
Invoice
Type name: Invoice
Extends Intangible
| Name | Type | Description |
|---|---|---|
|
accountId
|
Text | The identifier for the account the payment will be applied to. |
|
billingPeriod
|
Duration | The time interval used to compute the invoice. |
|
broker
|
Organization or Person | 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
|
PhysicalActivityCategory , Text or Thing | A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
|
confirmationNumber
|
Text | A number that confirms the given order or payment has been received. |
|
customer
|
Organization or Person | Party placing the order or paying the invoice. |
|
minimumPaymentDue
|
PriceSpecification | The minimum payment required at this time. |
|
paymentDue
|
DateTime | The date that payment is due. |
|
paymentMethod
|
PaymentMethod | The name of the credit card or other method of payment for the order. |
|
paymentMethodId
|
Text | An identifier for the method of payment used (e.g. the last 4 digits of the credit card). |
|
paymentStatus
|
Text | The status of payment; whether the invoice has been paid or not. |
|
provider
|
Organization or Person | The organization providing the reservation. |
|
referencesOrder
|
Order | The Order(s) related to this Invoice. One or more Orders may be combined into a single Invoice. |
|
scheduledPaymentDate
|
Date | The date the invoice is scheduled to be paid. |
|
totalPaymentDue
|
PriceSpecification | The total amount due. |
