Get invoice

Invoices API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for retrieving invoices in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/invoices/*id*
Authentication:App access tokens

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

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

Parameters

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

Includes

This endpoint allows you to include additional information by appending the following values 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

resourcestring
Indicates the response contains an invoice object. Will always contain invoice for this endpoint.
idstring
The invoice’s unique identifier, for example inv_FrvewDA3Pr.
referencestring
The reference number of the invoice. An example value would be: 2018.10000.
vatNumberstring
The VAT number to which the invoice was issued to (if applicable).
statusstring

Status of the invoice.

Possible values:

  • open The invoice is not paid yet.
  • paid The invoice is paid.
  • overdue Payment of the invoice is overdue.
issueDatestring
The invoice date in YYYY-MM-DD format.
paidDatestring
The date on which the invoice was paid, in YYYY-MM-DD format. Only for paid invoices.
dueDatestring
The date on which the invoice is due, in YYYY-MM-DD format. Only for due invoices.
amountobject

The total amount of the invoice with and without VAT.

Show child parameters

netdecimal
Total amount of the invoice excluding VAT.
vatdecimal
VAT amount of the invoice. Only for merchants registered in the Netherlands. For EU merchants, VAT will be shifted to the recipient (see article 44 and 196 EU VAT Directive 2006/112). For merchants outside the EU, no VAT will be charged.
grossdecimal
Total amount of the invoice including VAT.
linesarray

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

Show child parameters

periodstring
The administrative period in YYYY-MM on which the line should be booked.
descriptionstring
Description of the product.
countinteger
Number of products invoiced (usually number of payments).
vatPercentagedecimal
VAT percentage rate that applies to this product.
amountdecimal
Amount excluding VAT.
settlementsarray
Only available if you require this field to be included – An array of settlements that were invoiced on this invoice. You need the settlements.read permission for this field.
linksobject

Useful URLs to related resources.

Show child parameters

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

Example

Request

1
2
curl -X GET "https://api.mollie.com/v1/invoice/inv_xBEbP9rvAq?include=lines" \
    -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
HTTP/1.1 200 OK
Content-Type: application/json

{
    "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"
    }
}