Developer docs

← All schemas

CoreApiInvoice

snowbee.coreapi.CoreApiInvoice

object · non-null

idstringnon-nullrequired
bankstringnullableoptional
ibanstringnullableoptional
linesarray of objectnon-nullrequired
Show item fields
idstringnon-nullrequired
final_net_unit_sales_pricestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
gross_line_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
invoice_line_typestringnon-nullrequired
Allowed values"SALES_ORDER_LINE""RETURN_ORDER_LINE""PRODUCT""RESOURCE""SERVICE_ORDER""GIFT_CARD""TEXT"
invoice_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
item_namestringnon-nullrequired
item_numberstringnullableoptional
line_discount_percentagestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
net_line_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
net_unit_order_discount_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
net_unit_pricestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
source_referencesobjectnon-nullrequired
Show child fields
gift_card_idstringnullableoptional
return_order_line_idstringnullableoptional
sales_order_line_idstringnullableoptional
service_order_idstringnullableoptional
service_work_order_line_idstringnullableoptional
service_work_order_resource_line_idstringnullableoptional
unit_coststringnullableoptional
  • Format: BigDecimal
Example"100.0"
unit_cost_currency_iso_codestringnullableoptional
unit_of_measurestringnullableoptional
vat_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
vat_ratestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
paidbooleannon-nullrequired
referencestringnullableoptional
swiftstringnullableoptional
versionintegernon-nullrequired
  • Format: int64
bank_accountstringnullableoptional
company_idstringnon-nullrequired
created_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
creditor_referencestringnullableoptional
creditor_reference_algorithmstringnullableoptional
creditor_reference_numberstringnullableoptional
currency_iso_codestringnon-nullrequired
customer_idstringnon-nullrequired
customer_typestringnon-nullrequired
Allowed values"B2B""B2C""COMPANY""RETAIL_STORE""ECOM_STORE"
document_statusstringnon-nullrequired
due_datestringnon-nullrequired
  • Format: date
Example"2026-01-14"
exchange_ratestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
external_notesstringnullableoptional
invoice_addressobjectnon-nullrequired
Show child fields
citystringnon-nullrequired
namestringnon-nullrequired
streetstringnon-nullrequired
country_iso_codestringnon-nullrequired
post_codestringnon-nullrequired
invoice_datestringnon-nullrequired
  • Format: date
Example"2026-01-14"
invoice_email_addressstringnullableoptional
invoice_numberstringnon-nullrequired
invoiced_by_user_idstringnon-nullrequired
modified_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
organisational_unit_idstringnon-nullrequired
source_typestringnon-nullrequired
terms_of_payment_idstringnon-nullrequired
total_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
total_net_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
total_vat_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
View raw schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "bank": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "iban": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiInvoiceLine"
      },
      "title": "List<CoreApiInvoiceLine>"
    },
    "paid": {
      "type": "boolean",
      "title": "Boolean"
    },
    "reference": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "swift": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "version": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "bank_account": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "company_id": {
      "type": "string",
      "title": "String"
    },
    "created_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "creditor_reference": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "creditor_reference_algorithm": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "creditor_reference_number": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "currency_iso_code": {
      "type": "string",
      "title": "String"
    },
    "customer_id": {
      "type": "string",
      "title": "String"
    },
    "customer_type": {
      "$ref": "#/components/schemas/snowbee.entities.utils.CustomerType"
    },
    "document_status": {
      "type": "string",
      "title": "String"
    },
    "due_date": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "exchange_rate": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "external_notes": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "invoice_address": {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiInvoiceAddress"
    },
    "invoice_date": {
      "type": "string",
      "format": "date",
      "example": "2026-01-14",
      "title": "LocalDate"
    },
    "invoice_email_address": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "invoice_number": {
      "type": "string",
      "title": "String"
    },
    "invoiced_by_user_id": {
      "type": "string",
      "title": "String"
    },
    "modified_at": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    },
    "organisational_unit_id": {
      "type": "string",
      "title": "String"
    },
    "source_type": {
      "type": "string",
      "title": "String"
    },
    "terms_of_payment_id": {
      "type": "string",
      "title": "String"
    },
    "total_gross_amount": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "total_net_amount": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    },
    "total_vat_amount": {
      "type": "string",
      "format": "BigDecimal",
      "example": "100.0",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "id",
    "lines",
    "paid",
    "version",
    "company_id",
    "created_at",
    "currency_iso_code",
    "customer_id",
    "customer_type",
    "document_status",
    "due_date",
    "exchange_rate",
    "invoice_address",
    "invoice_date",
    "invoice_number",
    "invoiced_by_user_id",
    "modified_at",
    "organisational_unit_id",
    "source_type",
    "terms_of_payment_id",
    "total_gross_amount",
    "total_net_amount",
    "total_vat_amount"
  ],
  "title": "CoreApiInvoice"
}