List invoices¶
Invoices API v2
GET
https://api.mollie.com/v2/invoices
Authentication:Organization access tokensApp access tokens
Retrieve all invoices on the account. Optionally filter on year or invoice number.
The results are paginated. See pagination for more information.
Parameters¶
string
optional
|
Use this parameter to filter for an invoice with a specific invoice number / reference. An example reference
would be 2018.10000 . |
integer
optional
|
Use this parameter to filter for invoices from a specific year (e.g. 2018 ). |
integer
optional
|
Used for pagination. Offset the result set to the invoice with this ID. The invoice with this ID is included in the result set as well. |
integer
optional
|
The number of invoices to return (with a maximum of 250). |
Response¶
200
application/json
integer
|
The number of invoices found in _embedded , which is either the requested number (with a maximum of 250) or
the default number. |
||||||||
object
|
The object containing the queried data.
|
||||||||
object
|
Links to help navigate through the lists of invoices. Every URL object will contain an
|
Example¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET "https://api.mollie.com/v2/invoices" \
-H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
|
1 2 3 4 | <?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$invoices = $mollie->invoices->page();
|
1 2 3 4 5 6 7 | require 'mollie-api-ruby'
Mollie::Client.configure do |config|
config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'
end
invoices = Mollie::Invoice.all
|
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 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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 | HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"count": 5,
"_embedded": {
"invoices": [
{
"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/2ab44d60b35955fa2c602",
"type": "application/pdf",
"expiresAt": "2018-11-09T14:10:36+00:00"
}
}
},
{ },
{ },
{ },
{ }
]
},
"_links": {
"self": {
"href": "https://api.mollie.nl/v2/invoices?limit=5",
"type": "application/hal+json"
},
"previous": null,
"next": {
"href": "https://api.mollie.nl/v2/invoices?from=inv_xBEbP9rvAq&limit=5",
"type": "application/hal+json"
},
"documentation": {
"href": "https://docs.mollie.com/reference/v2/invoices-api/list-invoices",
"type": "text/html"
}
}
}
|