Bol · Schema

InvoiceRequestsResponse

E-CommerceRetailMarketplaceNetherlands

Properties

Name Type Description
invoiceRequests array
View JSON Schema on GitHub

JSON Schema

bol-com-invoice-requests-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-invoice-requests-response-schema.json",
  "title": "InvoiceRequestsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bol-com-shipments-api-openapi.yml#/components/schemas/InvoiceRequestsResponse",
  "required": [
    "invoiceRequests"
  ],
  "type": "object",
  "properties": {
    "invoiceRequests": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InvoiceRequests"
      }
    }
  },
  "$defs": {
    "InvoiceRequests": {
      "required": [
        "shipmentId",
        "status",
        "statusTransitions"
      ],
      "type": "object",
      "properties": {
        "shipmentId": {
          "type": "string",
          "description": "The id of the shipment associated with this invoice request."
        },
        "orderId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The id of the order associated with this shipment."
        },
        "customerAccountNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The account of the customer within bol.com associated with this shipment."
        },
        "billingDetails": {
          "allOf": [
            {
              "$ref": "#/$defs/InvoiceRequestsBillingDetails"
            }
          ]
        },
        "products": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/InvoiceRequestsProducts"
          }
        },
        "status": {
          "type": "string",
          "description": "The current status of the invoice request."
        },
        "statusTransitions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/StatusTransitions"
          }
        }
      }
    },
    "InvoiceRequestsBillingDetails": {
      "required": [
        "salutation"
      ],
      "type": "object",
      "properties": {
        "salutation": {
          "type": "string",
          "description": "The salutation of the customer.",
          "enum": [
            "MALE",
            "FEMALE",
            "UNKNOWN"
          ]
        },
        "firstName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The first name of the customer."
        },
        "surname": {
          "type": [
            "string",
            "null"
          ],
          "description": "The surname of the customer."
        },
        "streetName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The street name."
        },
        "houseNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The house number."
        },
        "houseNumberExtension": {
          "type": [
            "string",
            "null"
          ],
          "description": "The extension on the house number."
        },
        "zipCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ZIP code in '1234AB' format for NL orders and '0000' format for BE orders."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the city."
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "The country code."
        },
        "company": {
          "type": [
            "string",
            "null"
          ],
          "description": "The company name."
        },
        "vatNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Value Added Tax (VAT) / BTW number for business sellers situated in the Netherlands."
        },
        "kvkNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Kamer van Koophandel (KvK) number for organizations situated in the Netherlands or ondernemingsnummer for organizations situated in Belgium."
        }
      },
      "description": "The details of the customer that is responsible for the financial fulfillment of this shipment."
    },
    "InvoiceRequestsProducts": {
      "type": "object",
      "properties": {
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The description of the ordered product."
        },
        "quantity": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Amount of the product being ordered.",
          "format": "int32"
        },
        "unitPrice": {
          "type": [
            "number",
            "null"
          ],
          "description": "The selling price to the customer of a single unit including VAT."
        }
      }
    },
    "StatusTransitions": {
      "required": [
        "status",
        "statusDateTime"
      ],
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "Indicates the status of this invoice request.",
          "enum": [
            "INVOICE_REQUESTED",
            "INVOICE_UPLOADED",
            "INVOICE_INCORRECT",
            "INVOICE_VIRUS_DETECTED",
            "FINISHED"
          ]
        },
        "statusDateTime": {
          "type": "string",
          "description": "The date and time in ISO 8601 format that indicates when this status was updated for this invoice request.",
          "format": "date-time"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bol-com-invoice-requests-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.