Get invoice
Invoices API

GET
https://api.mollie.nl/v1/invoices/id
Authentication: OAuth access tokens

Retrieve details of an invoice, using the invoice's identifier.

If you want to retreive the details of an invoice by its invoice number, use the list API with the reference parameter.

Parameters

Replace id in the endpoint URL by the invoice's ID, for example inv_FrvewDA3Pr.

include
string

Optional – Include additional data. Must be a comma separated list of one or more includes.

Includes

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

  • lines Include invoice details such as which products were invoiced.
  • settlements Include settlements for which the invoice was created, if applicable.

Response

200
application/json; charset=utf-8
resource
string

Indicates the response contains a invoice.

Possible values: invoice

id
string

The invoice's unique identifier, for example inv_FrvewDA3Pr.

reference
string

The reference number of the invoice. An example value would be: 2016.10000.

vatNumber
string

Optional – The VAT number to which the invoice was issued to (if applicable).

status
string

Status of the invoices

Possible values:

  • open The invoice is not paid yet.
  • paid The invoice is paid.
  • overdue Payment of the invoice is overdue.
issueDate
string

The invoice date (in YYYY-MM-DD format).

paidDate
string

Optional – The date on which the invoice was paid (in YYYY-MM-DD format). Only for paid invoices.

dueDate
string

Optional – The date on which the invoice is due (in YYYY-MM-DD format). Only for due invoices.

amount
object

The total amount of the invoice with and without VAT.

net
decimal

Total amount of the invoice excluding VAT.

vat
decimal

Only for merchants registered in the Netherlands. For EU merchants, VAT will be shifted to recipient; article 44 and 196 EU VAT Directive 2006/112. For merchants outside the EU, no VAT will be charged. – VAT amount of the invoice.

gross
decimal

Total amount of the invoice including VAT.

lines
array

Only available if you require this field to be included – The collection of products which make up the invoice.

period
string

The administrative period (YYYY-MM) on which the line should be booked.

description
string

Description of the product.

count
int

Number of products invoiced (usually number of payments).

vatPercentage
decimal

Optional – VAT percentage rate that applies to this product.

amount
decimal

Amount excluding VAT.

settlements
array

Only available if you require this field to be included – A array of settlements that were invoiced on this invoice. You need the settlements.read permission for this field.

links
object

Useful URLs to related resources.

pdf
string

The URL to the PDF version of the invoice. The URL will expire after 60 minutes.

Example

Request code

// Not implemented. Create a pull request: https://github.com/mollie/mollie-api-php

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "resource":"invoice",
    "id":"inv_xBEbP9rvAq",
    "reference":"2016.10000",
    "vatNumber":"NL001234567B01",
    "status":"open",
    "issueDate":"2016-08-31",
    "dueDate":"2016-09-14",
    "amount": {
        "net":"45.00",
        "vat":"9.45",
        "gross":"54.45"
    },
    "lines":[
        {
            "period":"2016-09",
            "description":"iDEAL transactiekosten",
            "count":100,
            "vatPercentage":21,
            "amount":"45.00"
        }
    ],
    "links": {
        "pdf":"https://www.mollie.com/merchant/download/invoice/sbd9gu/52981a39788e5e0acaf71bbf570e941f"
    }
}