MOmollie
Sales Invoices API

List sales invoices

Changed on

Retrieve a list of all sales invoices created through the API.

The results are paginated.

get/v2/sales-invoices

Request

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

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

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

A list of sales invoice objects. For a complete reference of the sales invoice object, refer to the Get sales invoice endpoint documentation.

countinteger

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "invoices": [
      {
        "resource": "sales-invoice",
        "id": "invoice_4Y0eZitmBnQ6IDoMqZQKh",
        "mode": "live",
        "invoiceNumber": "INV-0000001",
        "profileId": "pfl_QkEhN94Ba",
        "status": "draft",
        "eInvoiceStatus": "issuing",
        "vatScheme": "standard",
        "vatMode": "exclusive",
        "memo": "This is a memo!",
        "paymentTerm": "30 days",
        "paymentDetails": [
          {
            "source": "payment-link",
            "sourceReference": "pl_d9fQur83kFdhH8hIhaZfq"
          }
        ],
        "emailDetails": {
          "subject": "Your invoice is available",
          "body": "Please find your invoice enclosed."
        },
        "customerId": "cst_8wmqcHMN4U",
        "mandateId": "mdt_pWUnw6pkBN",
        "recipientIdentifier": "customer-xyz-0123",
        "recipient": {
          "type": "consumer",
          "title": "Mrs.",
          "givenName": "Jane",
          "familyName": "Doe",
          "organizationName": "Organization Corp.",
          "organizationNumber": "12345678",
          "vatNumber": "NL123456789B01",
          "email": "example@email.com",
          "phone": "+0123456789",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "4th floor",
          "postalCode": "5678AB",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL",
          "locale": "nl_NL"
        },
        "lines": [
          {
            "description": "LEGO 4440 Forest Police Station",
            "quantity": 1,
            "vatRate": "21.00",
            "unitPrice": {
              "currency": "EUR",
              "value": "10.00"
            },
            "discount": {
              "type": "amount",
              "value": "10.00"
            }
          }
        ],
        "discount": {
          "type": "amount",
          "value": "10.00"
        },
        "amountDue": {
          "currency": "EUR",
          "value": "10.00"
        },
        "subtotalAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "totalAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "totalVatAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "discountedSubtotalAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "createdAt": "2024-03-20T09:13:37+00:00",
        "issuedAt": "2024-10-03T10:47:38+00:00",
        "paidAt": "2024-10-04T10:47:38+00:00",
        "dueAt": "2024-11-01T10:47:38+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "invoicePayment": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "pdfLink": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "next": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "previous": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 01847046d5d0Revision changes
    • warning

      added the new payment-reversed enum value to the //// response property for the response status

    • info

      removed the payment_reversed enum value from the //// response property for the response status

  • b9d764add1c3Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status