Get invoice¶
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.
GET
https://api.mollie.com/v1/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
.
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
resource
stringinvoice
for this endpoint.id
stringinv_FrvewDA3Pr
.reference
string2018.10000
.vatNumber
stringstatus
stringStatus of the invoice.
Possible values:
open
The invoice is not paid yet.paid
The invoice is paid.overdue
Payment of the invoice is overdue.
issueDate
stringYYYY-MM-DD
format.paidDate
stringYYYY-MM-DD
format. Only for paid invoices.dueDate
stringYYYY-MM-DD
format. Only for due invoices.amount
objectThe total amount of the invoice with and without VAT.
net
decimalvat
decimalgross
decimallines
arrayOnly available if you require this field to be included – The collection of products which make up the invoice.
period
stringYYYY-MM
on which the line should be booked.description
stringcount
integervatPercentage
decimalamount
decimalsettlements
arraysettlements.read
permission for this field.links
objectUseful URLs to related resources.
pdf
stringExample¶
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" } } |