Invoice - schema.org

# schema.org

- Documentation
- Schemas
- Home

# Invoice

#### Thing > Intangible > Invoice

A statement of the money due for goods or services; a bill.
Usage: Fewer than 10 domains

Property | Expected Type | Description
--- | --- | ---
[more...]

- Leave public feedback on this term 💬
- Check for open issues.
- 'Invoice' is mentioned in layer: core

Properties from Invoice
`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. Supersedes bookingAgent.
`category` | 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` | MonetaryAmount or PriceSpecification | The minimum payment required at this time.
`paymentDueDate` | DateTime | The date that payment is due. Supersedes paymentDue.
`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 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. Supersedes carrier.
`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` | MonetaryAmount or PriceSpecification | The total amount due.
Properties from Thing
`additionalType` | URL | 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 | An alias for the item.
`description` | Text | A description of the item.
`disambiguatingDescription` | Text | 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.
`image` | ImageObject or URL | An image of the item. This can be a URL or a fully described ImageObject.
`mainEntityOfPage` | CreativeWork or URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity.
`name` | Text | The name of the item.
`potentialAction` | Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
`sameAs` | URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
`url` | URL | URL of the item.

Instances of Invoice may appear as values for the following properties

Property | On Types | Description
--- | --- | ---
`partOfInvoice` | Order | The order is being paid as part of the referenced Invoice.

Examples
Example 1
Without Markup Microdata RDFa JSON-LD

    An example of a credit card bill (invoice).
    ACME Bank
    Bill for: January 2015 Visa
    invoice link: http://www.acmebank.com/invoice.pdf
    Customer: Jane Doe
    account ID: xxxx-xxxx-xxxx-1234
    payment due: 2015-01-30
    minimum payment: $15.00
    total due: $200.00
    billing period: 2014-12-21 to 2015-01-20
    payment due

    <div itemscope itemtype="http://schema.org/Invoice">
      <h1 itemprop="description">January 2015 Visa</h1>
      <a itemprop="url" href="http://acmebank.com/invoice.pdf" />Invoice PDF</a>
      <div itemprop="broker" itemscope itemtype="http://schema.org/BankOrCreditUnion">
        <b itemprop="name">ACME Bank</b>
      </div>
      <span itemprop="accountId">xxxx-xxxx-xxxx-1234</span>
      <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
        <b itemprop="name">Jane Doe</b>
      </div>
      <time itemprop="paymentDueDate">2015-01-30</time>
      <div itemprop="minimumPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">15.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <div itemprop="totalPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">200.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <meta itemprop="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
      <link itemprop="paymentStatus" href="http://schema.org/PaymentDue" />
    </div>

    <div vocab="http://schema.org/" typeof="Invoice">
      <h1 property="description">January 2015 Visa</h1>
      <a property="url" href="http://acmebank.com/invoice.pdf">Invoice PDF</a>
      <div property="broker" typeof="BankOrCreditUnion">
        <b property="name">ACME Bank</b>
      </div>
      <span property="accountId">xxxx-xxxx-xxxx-1234</span>
      <div property="customer" typeof="Person">
        <b property="name">Jane Doe</b>
      </div>
      <time property="paymentDueDate">2015-01-30</time>
      <div property="minimumPaymentDue" typeof="PriceSpecification">
        <span property="price">15.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <div property="totalPaymentDue" typeof="PriceSpecification">
        <span property="price">200.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <meta property="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
      <link property="paymentStatus" href="PaymentDue" />
    </div>

    <script type="application/ld+json">
    {
        "@context": "http://schema.org/",
        "@type": "Invoice",
        "description": "January 2015 Visa bill.",
        "url": "http://acmebank.com/invoice.pdf",
        "broker": {
          "@type": "BankOrCreditUnion",
          "name": "ACME Bank",
        },
        "accountId": "xxxx-xxxx-xxxx-1234",
        "customer": {
          "@type": "Person",
          "name": "Jane Doe"
        },
        "paymentDueDate": "2015-01-30",
        "minimumPaymentDue": {
          "@type": "PriceSpecification",
          "price": 15.00,
          "priceCurrency": "USD"
        },
        "totalPaymentDue": {
          "@type": "PriceSpecification",
          "price": 200.00,
          "priceCurrency": "USD"
        },
        "billingPeriod": "2014-12-21/P30D",
        "paymentStatus": "http://schema.org/PaymentDue"
    }
    </script>

Example 2
Without Markup Microdata RDFa JSON-LD

    An example of a invoice for a purchase and installation.
    ACME Home Heating
    Bill for: New furnace and installation
    Customer: Jane Doe
    payment due: 2015-01-30
    minimum payment: $0.00
    total due: $0.00
    payment status: paid
    order: furnace model ABC123
    order: installation labor

    <div itemscope itemtype="http://schema.org/Invoice">
      <h1 itemprop="description">New furnace and installation</h1>
      <div itemprop="broker" itemscope itemtype="http://schema.org/LocalBusiness">
        <b itemprop="name">ACME Home Heating</b>
      </div>
      <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
        <b itemprop="name">Jane Doe</b>
      </div>
      <time itemprop="paymentDueDate">2015-01-30</time>
      <div itemprop="minimumPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">0.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <div itemprop="totalPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">0.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <link itemprop="paymentStatus" href="http://schema.org/PaymentComplete" />
      <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order">
        <span itemprop="description">furnace</span>
        <time itemprop="orderDate">2014-12-01</time>
        <span itemprop="orderNumber">123ABC</span>
        <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
          <span itemprop="name">ACME Furnace 3000</span>
          <meta itemprop="productId" content="ABC123" />
        </div>
      </div>
      <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order">
        <span itemprop="description">furnace installation</span>
        <time itemprop="orderDate">2014-12-02</time>
        <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Service">
          <span itemprop="description">furnace installation</span>
        </div>
      </div>
    </div>

    <div vocab="http://schema.org/" typeof="Invoice">
      <h1 property="description">New furnace and installation</h1>
      <div property="broker" typeof="/LocalBusiness">
        <b property="name">ACME Home Heating</b>
      </div>
      <div property="customer" typeof="Person">
        <b property="name">Jane Doe</b>
      </div>
      <time property="paymentDueDate">2015-01-30</time>
      <div property="minimumPaymentDue" typeof="PriceSpecification">
        <span property="price">0.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <div property="totalPaymentDue" typeof="PriceSpecification">
        <span property="price">0.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <meta itemprop="paymentStatus" content="PaymentComplete" />
      <div property="referencesOrder" typeof="Order">
        <span property="description">furnace</span>
        <time property="orderDate">2014-12-01</time>
        <span property="orderNumber">123ABC</span>
        <div property="orderedItem" typeof="Product">
          <span property="name">ACME Furnace 3000</span>
          <meta property="productId" content="ABC123" />
        </div>
      </div>
      <div property="referencesOrder" typeof="Order">
        <span property="description">furnace installation</span>
        <time property="orderDate">2014-12-02</time>
        <div property="orderedItem" typeof="Service">
          <span property="description">furnace installation</span>
        </div>
      </div>
    </div>

    <script type="application/ld+json">
    {
        "@context": "http://schema.org/",
        "@type": "Invoice",
        "broker": {
          "@type": "LocalBusiness",
          "name": "ACME Home Heating",
        },
        "accountId": "xxxx-xxxx-xxxx-1234",
        "customer": {
          "@type": "Person",
          "name": "Jane Doe"
        },
        "paymentDueDate": "2015-01-30",
        "minimumPaymentDue": {
          "@type": "PriceSpecification",
          "price": 0.00,
          "priceCurrency": "USD"
        },
        "totalPaymentDue": {
          "@type": "PriceSpecification",
          "price": 0.00,
          "priceCurrency": "USD"
        },
        "paymentStatus": "http://schema.org/PaymentComplete",
        "referencesOrder": [
          {
            "@type": "Order",
            "description": "furnace",
            "orderDate": "2014-12-01",
            "orderNumber": "123ABC",
            "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice",
            "orderedItem": {
              "@type": "Product",
              "name": "ACME Furnace 3000",
              "productId": "ABC123"
            }
          },
          {
            "@type": "Order",
            "description": "furnace installation",
            "orderDate": "2014-12-02",
            "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice",
            "orderedItem": {
              "@type": "Service",
              "description": "furnace installation"
            }
          },
        ]
    }
    </script>

Schema Version 3.0