Get invoice

Invoices API v2
GEThttps://api.mollie.com/v2/invoices/*id*

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.

Response

200 application/json

resource

string
Indicates the response contains an invoice object. Will always contain invoice for this endpoint.

id

string
The invoice’s unique identifier, for example inv_FrvewDA3Pr.

reference

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

vatNumber

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

status

string

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.

issuedAt

string
The invoice date in YYYY-MM-DD format.

paidAt

string
The date on which the invoice was paid, in YYYY-MM-DD format. Only for paid invoices.

dueAt

string
The date on which the invoice is due, in YYYY-MM-DD format. Only for due invoices.

netAmount

amount object

Total amount of the invoice excluding VAT, e.g. {"currency":"EUR", "value":"100.00"}.

currency

string
The ISO 4217 currency code.

value

string
A string containing the exact amount of the invoice excluding VAT in the given currency.

vatAmount

amount object

VAT amount of the invoice. 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.

currency

string
The ISO 4217 currency code.

value

string
A string containing the exact VAT amount in the given currency.

grossAmount

amount object

Total amount of the invoice including VAT.

currency

string
The ISO 4217 currency code.

value

string
A string containing the exact total amount of the invoice including VAT in the given currency.

lines

object

The collection of products which make up the invoice.

period

string
The administrative period in YYYY-MM on which the line should be booked.

description

string
Description of the product.

count

integer
Number of products invoiced (usually number of payments).

vatPercentage

decimal
VAT percentage rate that applies to this product.

amount

amount object

Amount excluding VAT.

currency

string
The ISO 4217 currency code.

value

string
A string containing the exact amount of this line excluding VAT in the given currency.

_links

object

Useful URLs to related resources.

self

URL object
The API resource URL of the invoice itself.

pdf

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

documentation

URL object
The URL to the invoice retrieval endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET "https://api.mollie.com/v2/invoices/inv_xBEbP9rvAq" \
-H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$invoice = $mollie->invoices->get("inv_xBEbP9rvAq");
1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "invoice",
    "id": "inv_xBEbP9rvAq",
    "reference": "2016.10000",
    "vatNumber": "NL001234567B01",
    "status": "open",
    "issuedAt": "2016-08-31",
    "dueAt": "2016-09-14",
    "netAmount": {
        "value": "45.00",
        "currency": "EUR"
    },
    "vatAmount": {
        "value": "9.45",
        "currency": "EUR"
    },
    "grossAmount": {
        "value": "54.45",
        "currency": "EUR"
    },
    "lines":[
        {
            "period": "2016-09",
            "description": "iDEAL transactiekosten",
            "count": 100,
            "vatPercentage": 21,
            "amount": {
                "value": "45.00",
                "currency": "EUR"
            }
        }
    ],
    "_links": {
        "self": {
             "href": "https://api.mollie.com/v2/invoices/inv_xBEbP9rvAq",
             "type": "application/hal+json"
        },
        "pdf": {
             "href": "https://www.mollie.com/merchant/download/invoice/xBEbP9rvAq/2ab44d60b35b1d06090bba955fa2c602",
             "type": "application/pdf",
             "expiresAt": "2018-11-09T14:10:36+00:00"
        }
    }
}