MOmollie
Invoices API

Get invoice

Changed on

Retrieve a single invoice by its ID.

If you want to retrieve the details of an invoice by its invoice number, call the List invoices endpoint with the reference parameter.

get/v2/invoices/{invoiceId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/invoices/{invoiceId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: invoices.read

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The invoice object.

resourcestring required

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

idstring required
referencestring required

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

vatNumberstring nullable required

The VAT number to which the invoice was issued to, if applicable.

status'open' | 'paid' | 'overdue' required

Status of the invoice.

issuedAtstring required

The invoice date in YYYY-MM-DD format.

paidAtstring nullable

The date on which the invoice was paid, if applicable, in YYYY-MM-DD format.

dueAtstring nullable

The date on which the invoice is due, if applicable, in YYYY-MM-DD format.

Example response

{
  "resource": "invoice",
  "id": "inv_aHbjjdrUdm",
  "reference": "2024.10000",
  "vatNumber": "NL123456789B01",
  "status": "open",
  "netAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "vatAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "grossAmount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "lines": [
    {
      "period": "2024-01",
      "description": "Product #1",
      "count": 3,
      "vatPercentage": 21,
      "amount": {
        "currency": "EUR",
        "value": "10.00"
      }
    }
  ],
  "issuedAt": "2024-01-15",
  "paidAt": "2024-01-20",
  "dueAt": "2024-01-30",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "pdf": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API