Bunq · Schema

Invoice

Banking

Properties

Name	Type	Description
status	string	The invoice status.
description	string	The description provided by the admin.
external_url	string	The external url provided by the admin.
id	integer	The id of the invoice object.
created	string	The timestamp of the invoice object's creation.
updated	string	The timestamp of the invoice object's last update.
invoice_date	string	The invoice date.
invoice_number	string	The invoice number.
category	string	The category to display to the user.
group	array	The invoice item groups.
total_vat_inclusive	object	The total discounted item price including VAT.
total_vat_exclusive	object	The total discounted item price excluding VAT.
total_vat	object	The VAT on the total discounted item price.
alias	object	The label that's displayed to the counterparty with the invoice. Includes user.
address	object	The customer's address.
counterparty_alias	object	The label of the counterparty of the invoice. Includes user.
counterparty_address	object	The company's address.
chamber_of_commerce_number	string	The company's chamber of commerce number.
vat_number	string	The company's chamber of commerce number.
request_reference_split_the_bill	array	The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Invoice",
  "title": "Invoice",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The invoice status.",
      "readOnly": false,
      "writeOnly": false
    },
    "description": {
      "type": "string",
      "description": "The description provided by the admin.",
      "readOnly": false,
      "writeOnly": true
    },
    "external_url": {
      "type": "string",
      "description": "The external url provided by the admin.",
      "readOnly": false,
      "writeOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The id of the invoice object.",
      "readOnly": true,
      "writeOnly": false
    },
    "created": {
      "type": "string",
      "description": "The timestamp of the invoice object's creation.",
      "readOnly": true,
      "writeOnly": false
    },
    "updated": {
      "type": "string",
      "description": "The timestamp of the invoice object's last update.",
      "readOnly": true,
      "writeOnly": false
    },
    "invoice_date": {
      "type": "string",
      "description": "The invoice date.",
      "readOnly": true,
      "writeOnly": false
    },
    "invoice_number": {
      "type": "string",
      "description": "The invoice number.",
      "readOnly": true,
      "writeOnly": false
    },
    "category": {
      "type": "string",
      "description": "The category to display to the user.",
      "readOnly": true,
      "writeOnly": false
    },
    "group": {
      "type": "array",
      "description": "The invoice item groups.",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/InvoiceItemGroup"
      }
    },
    "total_vat_inclusive": {
      "type": "object",
      "description": "The total discounted item price including VAT.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "total_vat_exclusive": {
      "type": "object",
      "description": "The total discounted item price excluding VAT.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "total_vat": {
      "type": "object",
      "description": "The VAT on the total discounted item price.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Amount"
    },
    "alias": {
      "type": "object",
      "description": "The label that's displayed to the counterparty with the invoice. Includes user.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "address": {
      "type": "object",
      "description": "The customer's address.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "counterparty_alias": {
      "type": "object",
      "description": "The label of the counterparty of the invoice. Includes user.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/LabelMonetaryAccount"
    },
    "counterparty_address": {
      "type": "object",
      "description": "The company's address.",
      "readOnly": true,
      "writeOnly": false,
      "$ref": "#/components/schemas/Address"
    },
    "chamber_of_commerce_number": {
      "type": "string",
      "description": "The company's chamber of commerce number.",
      "readOnly": true,
      "writeOnly": false
    },
    "vat_number": {
      "type": "string",
      "description": "The company's chamber of commerce number.",
      "readOnly": true,
      "writeOnly": false
    },
    "request_reference_split_the_bill": {
      "type": "array",
      "description": "The reference to the object used for split the bill. Can be RequestInquiry or RequestInquiryBatch",
      "readOnly": true,
      "writeOnly": false,
      "items": {
        "$ref": "#/components/schemas/RequestInquiryReference"
      }
    }
  },
  "required": [
    "description",
    "external_url"
  ]
}