← All schemas

CoreApiInvoice

snowbee.coreapi.CoreApiPage_snowbee.coreapi.CoreApiInvoice

object · non-null

itemsarray of objectnon-nullrequired

Show item fields

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

Further nesting is omitted. See the schema for the full definition.

Allowed values"SALES_ORDER_LINE""RETURN_ORDER_LINE""PRODUCT""RESOURCE""SERVICE_ORDER""GIFT_CARD""TEXT"

View schema definition

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

Further nesting is omitted. See the schema for the full definition.

View schema definition

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 schema definition

next_cursorstringnullablerequired

sync_throughstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiInvoice"
      },
      "title": "List<CoreApiItem<CoreApiInvoice>>"
    },
    "next_cursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "sync_through": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    }
  },
  "required": [
    "items",
    "next_cursor",
    "sync_through"
  ],
  "title": "CoreApiPage<CoreApiInvoice>"
}