Developer docs

← All schemas

CoreApiInvoice

snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiInvoice

object · non-null

Exactly one of these shapes is allowed.

deleted objectnon-null
typestringnon-nullrequired
Allowed values"deleted"
idstringnon-nullrequired
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
deleted_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
entity objectnon-null
typestringnon-nullrequired
Allowed values"entity"
dataobjectnon-nullrequired
Show child fields
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"
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
View raw schema
{
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "deleted": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiInvoice",
      "entity": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiInvoice"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiInvoice"
    },
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiInvoice"
    }
  ],
  "title": "CoreApiItem<CoreApiInvoice>"
}