Der Beleg

Ocost liefert jeden gelesenen Beleg als ocost.document.v1. Fragen Sie ihn mit GET /public/v1/files/{file_id}/document oder GET /public/v1/documents/{document_id} ab. Die Felder folgen der EN 16931, der Norm hinter XRechnung, ZUGFeRD und Peppol UBL. Jedes Feld nennt seinen Business Term (BT-…) oder seine Gruppe (BG-…), und lässt sich so auf UBL oder CII abbilden.

Prüfen Sie gegen das JSON Schema oder erzeugen Sie Typen daraus. Felder und Werte unten listen alles, was es enthält.

Ein Beispiel

Eine Eingangsrechnung mit zwei Positionen zu 19 % und 2 % Skonto innerhalb von 14 Tagen:

JSON
{
  "schema": "ocost.document.v1",
  "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
  "file_id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "pages": [1],
  "kind": "invoice",
  "kind_detail": "invoice",
  "direction": "incoming",
  "type_code": "380",
  "number": "RE-2026-1187",
  "issue_date": "2026-11-03",
  "due_date": "2026-12-03",
  "delivery_date": "2026-10-30",
  "invoicing_period_start": null,
  "invoicing_period_end": null,
  "valid_until": null,
  "currency": "EUR",
  "buyer_reference": null,
  "order_reference": "PO-2316",
  "order_references": ["PO-2316"],
  "preceding_invoice": null,
  "seller": {
    "name": "Musterbüro Lieferant GmbH",
    "vat_id": "DE123456789",
    "tax_registration_id": null,
    "legal_registration_id": "HRB 12345",
    "address": { "street": "Beispielweg 4", "postal_code": "50667", "city": "Köln", "country": "DE" },
    "contact": { "email": "rechnung@lieferant.example", "phone": null },
    "website": null
  },
  "buyer": {
    "name": "Beispiel Handel GmbH",
    "vat_id": "DE987654321",
    "tax_registration_id": null,
    "legal_registration_id": null,
    "address": { "street": "Hauptstraße 1", "postal_code": "40213", "city": "Düsseldorf", "country": "DE" },
    "contact": null,
    "website": null
  },
  "payee": null,
  "deliver_to": null,
  "other_parties": [],
  "payment": {
    "means_code": "58",
    "means": "transfer",
    "iban": "DE02120300000000202051",
    "bic": null,
    "iban_holder": null,
    "assigned_to": null,
    "terms": "14 Tage 2 % Skonto, 30 Tage netto",
    "net_days": 30,
    "paid_on": null
  },
  "early_payment_discounts": [
    { "days": 14, "percent": 2, "base_amount": null, "due_date": "2026-11-17" }
  ],
  "totals": { "net": 1068, "tax": 202.92, "gross": 1270.92, "payable": null, "prices_include_vat": false },
  "vat_breakdown": [
    { "category": "S", "rate": 19, "taxable_amount": 1068, "tax_amount": 202.92, "exemption_reason": null }
  ],
  "lines": [
    {
      "id": "1", "name": "Bürostuhl ErgoPlus schwarz", "seller_item_id": "ES-200", "standard_item_id": null,
      "quantity": 4, "unit": "H87", "price": 189, "base_quantity": null, "net_amount": 756,
      "discount_percent": null, "vat_category": "S", "vat_rate": 19,
      "ordered_quantity": null, "backordered_quantity": null, "batch": null, "pzn": null,
      "attributes": { "colour": "schwarz" }
    },
    {
      "id": "2", "name": "Montage", "seller_item_id": null, "standard_item_id": null,
      "quantity": 4, "unit": "HUR", "price": 78, "base_quantity": null, "net_amount": 312,
      "discount_percent": null, "vat_category": "S", "vat_rate": 19,
      "ordered_quantity": null, "backordered_quantity": null, "batch": null, "pzn": null,
      "attributes": {}
    }
  ],
  "deductions": [],
  "card": null,
  "worked_out": [],
  "sources": {
    "number": { "page": 1, "quote": "RE-2026-1187", "box": null, "confidence": "read", "why": null },
    "totals.gross": { "page": 1, "quote": "1.270,92 €", "box": { "x0": 0.7012, "y0": 0.6831, "x1": 0.8874, "y1": 0.6995 }, "confidence": "checked", "why": null },
    "seller.vat_id": { "page": 1, "quote": "DE123456789", "box": null, "confidence": "checked", "why": null }
  },
  "checks": [
    { "name": "vat", "passed": true, "sums": true, "fields": ["totals.net", "totals.tax"], "at": "19" },
    { "name": "gross", "passed": true, "sums": true, "fields": ["totals.net", "totals.tax", "totals.gross"], "at": null }
  ],
  "tax_check": { "case": "standard", "missing": [] },
  "attention": [],
  "possible_duplicate_of": null,
  "read_with": "reader"
}

Art und Richtung

Verzweigen Sie nach kind. Es fasst Ocosts Belegarten zu wenigen zusammen, etwa invoice oder delivery_note. kind_detail nennt die genaue Art. type_code gibt den UNCL-1001-Code der Rechnung, etwa 380.

direction sagt, ob der Beleg incoming von einem Lieferanten kommt, outgoing von Ihrem Unternehmen, oder unsure ist. Ocost ermittelt es aus Ihren Angaben unter Einstellungen › Unternehmen. Halten Sie diese also aktuell.

Kennungen aus jedem Land

identifiers listet die gedruckten Kennungen jeder Partei nach scheme, etwa UA_EDRPOU, UA_RNOKPP, UA_IPN oder PL_NIP. Eine Vorlage braucht es nicht. valid ist false, wenn eine Prüfziffer nicht stimmt, null ohne Prüfung.

Belege, Kennungen und Umsatzsteuer jedes Landes haben eine eigene Seite: Deutschland, Ukraine, Vereinigtes Königreich, Vereinigte Staaten und Moldau.

An einen Factor gezahlt

Auf einer Rechnung, deren Forderung an einen Factor abgetreten ist (Zession, Factoring), ist payment.iban das Konto des Factors. payment.assigned_to nennt den Factor, payment.iban_holder den Kontoinhaber. payee enthält den Factor, wo Ocost ihn als Partei gelesen hat.

JSON
{
  "payment": {
    "iban": "DE89370400440532013000",
    "iban_holder": "Muster Factoring GmbH",
    "assigned_to": { "name": "Muster Factoring GmbH" }
  }
}

Wie Werte geschrieben sind

WertGeschrieben als
Beträge und MengenExakte JSON-Zahlen in kürzester Form, etwa 1270.92 oder 595. Höchstens 15 signifikante Stellen. Lesen Sie sie vor dem Rechnen als Dezimalzahlen.
SätzeProzent, etwa 19 oder 5.5.
Daten und CodesISO 8601 (2026-11-03), ISO 4217 (EUR), ISO 3166-1 alpha-2 (DE), UNECE-Einheiten (HUR). Einheiten und Codes listet sie.
Falsch gelesene Codesnull, nie der gedruckte Text. Das gilt auch für IBAN und BIC.
Fehlende Wertenull, wenn nicht gedruckt oder wenn Ocost nicht sicher war. Ocost rät nie. Über MCP fehlt ein solches Feld stattdessen.

Wie sicher Ocost ist

sources sagt für jeden Wert, nach seinem Pfad, wo er gelesen wurde: seine page und sein quote. Seine confidence ist eine von dreien:

ConfidenceBedeutung
checkedEine Prüfung hat ihn bestätigt, oder er stammt aus einer E-Rechnung.
readNichts spricht dagegen.
doubtEine Prüfung schlug fehl, und why nennt sie. Oder seine Wörter fanden sich nicht auf seiner Seite.

box markiert den Wert auf seiner Seite: x0, y0 (links oben) und x1, y1 (rechts unten), als Anteile der Seite von links oben, 0 bis 1. Die Seite ist page, wie GET /public/v1/files/{id}/content sie zeigt, gedreht. Auf dem Text eines PDFs ist der Rahmen genau, auf einem Scan schätzt ihn die OCR. Ohne Rahmen ist er null, und es gibt nur quote.

checks listet jede Prüfung, die Ocost im Code ausführte, mit passed. Die Prüfungen mit sums: true rechnen die Beträge nach. Füllen Sie eine Rechnung ohne Blick einer Person nur, wenn jede davon bestanden hat.

attention listet, was sich eine Person vor dem Buchen ansehen sollte, etwa ein mögliches Duplikat. tax_check enthält die Prüfung einer Eingangsrechnung nach deutschem Recht, wie Deutschland erklärt.

from decimal import Decimal

document = session.get(f"{API}/files/{file_id}/document", timeout=15).json()
sums_hold = all(c["passed"] for c in document["checks"] if c["sums"])
gross = document["totals"]["gross"]  # an exact JSON number, or None
gross = None if gross is None else Decimal(str(gross))
doubts = [path for path, s in document["sources"].items() if s["confidence"] == "doubt"]

Versionen

Innerhalb von v1 kann Ocost einer Liste Werte hinzufügen, benennt aber nie ein Feld oder einen Wert um und entfernt keines. Behandeln Sie ein unbekanntes kind als other, und scheitern Sie nie an einem unbekannten Wert. Eine inkompatible Änderung kommt als ocost.document.v2 unter /public/v2, und v1 bleibt 12 weitere Monate.

Änderungen

Das Änderungsprotokoll listet jede Änderung, die neueste zuerst.

Felder

Jedes Feld, aus Ocosts Code geschrieben. Das JSON Schema enthält dasselbe. Die Beschreibungen stehen dort wie hier auf Englisch.

Document

FeldTypBedeutung
schemaocost.document.v1Always this
iduuidThe document
file_iduuidThe file it is in
pagesListe aus integerIts pages in the file, from 1
kindAufzählung, WerteWhat a document is, grouped so an integrator branches on few; the exact kind is kind_detail.
kind_detailAufzählung, WerteThe exact kind, one of Ocost's document types, for information
directionAufzählung, WerteWhether the business received or issued it.
type_codestring (380) oder nullBT-3, UNCL 1001
numberstring oder nullBT-1
issue_datedate oder nullBT-2
due_datedate oder nullBT-9
delivery_datedate oder nullBT-72
invoicing_period_startdate oder nullBT-73
invoicing_period_enddate oder nullBT-74
valid_untildate oder nullA quote's
currencystring (EUR) oder nullBT-5, ISO 4217
buyer_referencestring oder nullBT-10
order_referencestring oder nullBT-13
order_referencesListe aus stringEvery order it names
preceding_invoicestring oder nullBT-25; a tax invoice's: the invoice or act it is for
contract_referencestring oder nullBT-12: the contract it refers to (an act's)
tax_registrationTaxRegistration oder nullA tax invoice's registration, where printed
sellerParty oder nullBG-4
buyerParty oder nullBG-7
payeeParty oder nullBG-10: when not the seller
deliver_toAddress oder nullBG-15
other_partiesListe aus OtherPartyEvery other party named
paymentPaymentBG-16.
early_payment_discountsListe aus EarlyPaymentDiscountSkonto: XRechnung's #SKONTO# in BT-20.
totalsTotalsBG-22.
vat_breakdownListe aus VatGroupBG-23.
linesListe aus LineBG-25.
deductionsListe aus DeductionA final invoice's: an earlier invoice it takes off.
cardCard oder nullWhat a document without fields of its own says: a title, a summary and its facts (deadlines first).
worked_outListe aus WorkedOutAn amount Ocost worked out because the one read can't be it.
sourcesZuordnung zu SourcePer value, by its path
checksListe aus CheckA check Ocost ran in code, and whether it passed.
tax_checkTaxCheck oder nullAn incoming invoice's § 14 UStG check (Germany's rules).
attentionListe aus Aufzählung, WerteWhat a person should look at before booking it.
possible_duplicate_ofuuid oder nullAn earlier document of the same kind, number and seller
read_withAufzählung, WerteHow Ocost read it

TaxRegistration

FeldTypBedeutung
numberstring oder nullIts registration number
datedate oder nullThe day it was registered

Party

FeldTypBedeutung
namestring oder nullBT-27 (seller), BT-44 (buyer)
identifiersListe aus PartyIdentifierEvery identifier printed for it, by scheme (BT-29, BT-46 in any country): an ЄДРПОУ, a РНОКПП, an ІПН, a NIP, …
vat_idstring oder nullBT-31, BT-48
tax_registration_idstring oder nullBT-32: the tax number (Steuernummer)
legal_registration_idstring oder nullBT-30, BT-47: the register entry (HRB …)
addressAddress oder nullBG-5, BG-8
contactContact oder nullBG-6, BG-9
websitestring oder nullAs printed: a host, with or without its scheme

Address

FeldTypBedeutung
streetstring oder nullBT-35 (seller), BT-50 (buyer)
postal_codestring oder nullBT-38, BT-53
citystring oder nullBT-37, BT-52
countrystring (DE) oder nullBT-40, BT-55: ISO 3166-1 alpha-2

OtherParty

FeldTypBedeutung
namestring oder nullBT-27 (seller), BT-44 (buyer)
identifiersListe aus PartyIdentifierEvery identifier printed for it, by scheme (BT-29, BT-46 in any country): an ЄДРПОУ, a РНОКПП, an ІПН, a NIP, …
vat_idstring oder nullBT-31, BT-48
tax_registration_idstring oder nullBT-32: the tax number (Steuernummer)
legal_registration_idstring oder nullBT-30, BT-47: the register entry (HRB …)
addressAddress oder nullBG-5, BG-8
contactContact oder nullBG-6, BG-9
websitestring oder nullAs printed: a host, with or without its scheme
roleAufzählung, WerteWhat it is to the document
printed_rolestring oder nullThe words printed for its role

Payment

FeldTypBedeutung
means_codeAufzählung, Werte oder nullBT-81, UNCL 4461; null when it doesn't say or it was paid already
meansAufzählung, Werte oder nullThe same, as a word
ibanstring (DE02120300000000202051) oder nullBT-84, without spaces
bicstring (BYLADEM1001) oder nullBT-86
iban_holderstring oder nullBT-85: the holder of iban, as printed
assigned_toFactor oder nullThe factor its assignment note (Abtretung, Zession, factoring) names; iban is then the factor's
termsstring oder nullBT-20, as printed
net_daysinteger oder nullThe days the terms give to pay in full from the issue date
paid_ondate oder nullThe day it says it was paid or charged, where printed

EarlyPaymentDiscount

FeldTypBedeutung
daysinteger
percentDezimalzahl2 for 2 %
base_amountDezimalzahl oder nullWhat it is taken off, where printed; null: the amount due
due_datedate oder nullThe last day for it: the issue date plus days

Totals

FeldTypBedeutung
netDezimalzahl oder nullBT-109
taxDezimalzahl oder nullBT-110
grossDezimalzahl oder nullBT-112
payableDezimalzahl oder nullBT-115: what is left to pay; null when it is the gross
prices_include_vatbooleanIts lines' prices and amounts include VAT (a receipt)

VatGroup

FeldTypBedeutung
categoryAufzählung, Werte oder nullBT-118
rateDezimalzahl oder nullBT-119, percent: 19
taxable_amountDezimalzahlBT-116
tax_amountDezimalzahlBT-117
exemption_reasonstring oder nullBT-120

Line

FeldTypBedeutung
idstringBT-126: its position
namestringBT-153
seller_item_idstring oder nullBT-155: the article number
standard_item_idstring oder nullBT-157: the GTIN (scheme 0160)
quantityDezimalzahl oder nullBT-129
unitstring (C62) oder nullBT-130: UNECE Rec 20 (C62, HUR, KGM) or Rec 21 (XCT); null when none is printed or it is no code
priceDezimalzahl oder nullBT-146: the net price
base_quantityDezimalzahl oder nullBT-149: how many units price is for; null: one
net_amountDezimalzahl oder nullBT-131
discount_percentDezimalzahl oder nullThe line's discount: 5
vat_categoryAufzählung, Werte oder nullBT-151
vat_rateDezimalzahl oder nullBT-152, percent
tax_amountDezimalzahl oder nullThe line's VAT, only as printed on it; null when it prints none
gross_amountDezimalzahl oder nullThe line's total with VAT, only as printed on it; null when it prints none
ordered_quantityDezimalzahl oder nullA delivery note's
backordered_quantityDezimalzahl oder nullStill to come
batchstring oder nullIts batch (Charge), as printed
pznstring oder nullA medicine's PZN
attributesZuordnung zu stringWhat it is, as printed: colour, size, material, brand, …

Deduction

FeldTypBedeutung
numberstring oder null
issue_datedate oder null
netDezimalzahl oder null
taxDezimalzahl oder null
grossDezimalzahl oder null

Card

FeldTypBedeutung
titlestring oder null
summarystring oder null
factsListe aus Fact

WorkedOut

FeldTypBedeutung
fieldAufzählung, WerteIts path in this document
printedDezimalzahl oder nullWhat was read
ruleAufzählung, WerteHow Ocost worked an amount out.

Source

FeldTypBedeutung
pageinteger oder nullWhere it was read: the file's page, from 1
quotestring oder nullThe words it was read from
boxBox oder nullIts rectangle on page; null when Ocost kept none (then quote is all there is)
confidenceAufzählung, WerteHow sure Ocost is of a value, from its checks: never a model's grade.
whystring oder nullFor a doubt: the failed check's name

Check

FeldTypBedeutung
nameAufzählung, WerteWhat it checked; sums says whether it is one of the sums
passedboolean
sumsbooleanOne of the sums (total, vat, vat_net, vat_tax, gross, payable, signs, skonto, deduction, deductions, quantity): fill a bill only when all pass
fieldsListe aus string (totals.gross)The paths it is about, as sources names them
atstring oder nullThe rate or the line it is about

TaxCheck

FeldTypBedeutung
caseAufzählung, WerteWhich German rules an incoming invoice is held to.
missingListe aus TaxItem

PartyIdentifier

FeldTypBedeutung
schemeAufzählung, WerteWhat an identifier of a party is.
valuestringDigits only for the schemes of digits, a VAT ID without spaces, any other as printed
validboolean oder nullIts length and check digit hold; false: in doubt, a misread (never matched on); null: its scheme has no check

Contact

FeldTypBedeutung
emailstring oder nullBT-43, BT-58: an address as printed
phonestring oder nullBT-42, BT-57: as printed

Factor

FeldTypBedeutung
namestringAs the assignment note prints it

Fact

FeldTypBedeutung
labelstringWhat it is, in the document's words
kindAufzählung, WerteWhat a fact on a document's card is.
datedate oder null
amountDezimalzahl oder null
currencystring (EUR) oder nullISO 4217, of amount
numberDezimalzahl oder null
textstring oder null
pageinteger oder null

Box

FeldTypBedeutung
x0numberIts left edge, from the page's left
y0numberIts top edge, from the page's top
x1numberIts right edge, from the page's left
y1numberIts bottom edge, from the page's top

TaxItem

FeldTypBedeutung
itemAufzählung, WerteWhat an invoice lacks, or has wrong, for its case.
lawstringThe paragraph that asks for it
at_stakebooleanMissing, it costs the input VAT deduction

Werte

Jede Werteliste, aus Ocosts Code geschrieben. Das JSON Schema und die API-Referenz enthalten dasselbe, die Bedeutungen auf Englisch. Eine spätere Ocost-Version kann in v1 Werte ergänzen. Behandeln Sie ein unbekanntes kind als other und lassen Sie jeden anderen unbekannten Wert beiseite. In v1 wird kein Wert umbenannt oder entfernt.

kind

What a document is, grouped so an integrator branches on few; the exact kind is kind_detail.

WertBedeutung
invoiceAn invoice to pay: partial, final, advance, collective, recurring, self-billed (type_code says which)
credit_noteA credit note
invoice_correctionA corrected invoice
receiptA receipt: paid already
pro_formaA pro forma invoice: not to pay
delivery_noteA delivery note
orderAn order: a purchase, service, work or project order
order_confirmationAn order's or a reservation's confirmation
quoteA quote (offer)
contractA contract: agreements, leases, insurance policies, mandates
statementA factor's statement
payment_reminderA payment reminder
tax_invoiceA tax invoice registered with the tax authority (a Ukrainian податкова накладна): VAT evidence, not to pay
otherAnything else: kind_detail and card say what

kind_detail

The exact kind, one of Ocost's document types, for information: branch on kind, which groups them (the guide's reference lists which).

Jedes kind_detail, nach dem kind, das es ist:

kindkind_detail
invoicecollective_invoice, invoice, recurring_rental_invoice, fee_invoice, advance_payment_invoice, credit_invoice, final_invoice, partial_invoice
credit_notecredit_note
invoice_correctioninvoice_correction
receiptreceipt, payment_voucher
pro_formapro_forma_invoice
delivery_notedelivery_note
orderorder, order_form, project_order, service_order, work_order, purchase_order
order_confirmationorder_confirmation, reservation_confirmation
quoteoffer
contractagreement, contract, insurance_policy, mandate, lease_contract
statementstatement
payment_reminderpayment_reminder
tax_invoicetax_invoice
otheracceptance_protocol, bonus_payment_notification, certificate, certificate_of_destruction, cost_statement, court_order, reimbursement, customer_statistics, decision, final_report, lump_sum_overview, test_report, laboratory_report, logistics_appendix, maintenance_log, maintenance_report, request_for_medical_consultation, notification, payroll, pay_slip, prescription, work_record, recommendation, report, inquiry, requirement, separator_sheet, service_report, service_documentation, declaration, time_sheet, work_report, settlement_amount, electronic_summary, administrative_fee, copy_of_invoice, bailiff, membership_fee, enforcement_case, information, cost_calculation, fee_notice, invoice_audit, annex, direct_debit_advice, process_history, internal_project_information, bank_transaction_report, request_for_quotation, rejection, form

direction

Whether the business received or issued it.

WertBedeutung
incomingTo the business: a supplier's
outgoingThe business issued it
unsureIts parties don't say

seller.identifiers[].scheme, buyer.identifiers[].scheme, payee.identifiers[].scheme, other_parties[].identifiers[].scheme

What an identifier of a party is.

WertBedeutung
UA_EDRPOUUkraine: a legal entity's code ЄДРПОУ, 8 digits
UA_RNOKPPUkraine: a person's or sole trader's (ФОП) РНОКПП, 10 digits
UA_IPNUkraine: the VAT payer's number ІПН, 12 digits
EU_VATA VAT ID with its country prefix (also vat_id)
DE_STNRGermany: a tax number, Steuernummer
COMMERCIAL_REGISTERA register entry with its court (HRB 1234)
PL_NIPPoland: NIP, 10 digits
PL_REGONPoland: REGON, 9 or 14 digits
PL_KRSPoland: KRS number, 10 digits
GB_CRNUK: Companies House number, 8 digits or 2 letters and 6
FR_SIRENFrance: SIREN, 9 digits
FR_SIRETFrance: SIRET, 14 digits
CZ_ICOCzechia: IČO, 8 digits
RO_CUIRomania: CUI, 2 to 10 digits
NO_ORGNRNorway: organisasjonsnummer, 9 digits
FI_YTUNNUSFinland: Y-tunnus, 8 digits (without its dash)
US_EINUnited States: EIN, 9 digits
US_STATE_FILEUnited States: a state's entity or file number
MD_IDNOMoldova: IDNO, 13 digits
MD_IDNPMoldova: a person's IDNP, 13 digits
MD_VATMoldova: cod TVA, 7 digits
OTHERAny other number that identifies the party

other_parties[].role

What another party is to the document; printed_role is its words.

WertBedeutung
sellerThe seller
buyerThe buyer
invoiceeWho it is addressed to, when not the buyer (Rechnungsempfänger)
service_recipientWho receives the service, when not the buyer (Leistungsempfänger)
payerWho pays, when not the buyer
payeeWho is paid, when not the seller
ship_toWhere the goods go (Warenempfänger)
carrierWho carries the goods
factorWho bought the receivable
debtorWhose receivable it is (a factor's debtor)
guarantorWho guarantees it (Bürge)
landlordThe landlord
tenantThe tenant
subtenantThe subtenant
contractorThe contractor
subcontractorThe subcontractor
principalWho commissions the work (Auftraggeber, Bauherr)
agentWho acts for a party: a property manager, a broker
insurerThe insurer
policyholderThe policyholder
otherAny other role: printed_role says which

payment.means_code

BT-81: how it is paid, UNCL 4461.

WertBedeutung
58SEPA credit transfer
59SEPA direct debit
48Bank card

payment.means

How it is paid, as a word.

WertBedeutung
transferA credit transfer (means_code 58)
direct_debitA direct debit (59)
cardA card (48)
already_paidIt says it is paid already (no code)

vat_breakdown[].category, lines[].vat_category

BT-118, BT-151: the VAT category, UNCL 5305 as EN 16931 uses it.

WertBedeutung
SStandard rate
ZZero rated goods
EExempt from VAT
AEReverse charge: the buyer owes the VAT
KIntra-community supply, VAT exempt
GExport outside the EU, free of VAT
OOutside the scope of VAT
LCanary Islands' IGIC
MCeuta and Melilla's IPSI
BTransferred VAT (Italy's split payment)

card.facts[].kind

What a fact on a document's card is.

WertBedeutung
deadlineA date something is due by; its label says what
valid_fromThe day it is valid from
valid_untilThe day it is valid until
referenceA number naming something else
amountAn amount
partySomeone besides its issuer and recipient
dateAny other date: an inspection, an acceptance
otherAnything else

worked_out[].field

The amount worked out, by its path.

WertBedeutung
totals.netBT-109
totals.taxBT-110
totals.grossBT-112

worked_out[].rule

How Ocost worked an amount out.

WertBedeutung
groupsThe VAT groups' sum
net_taxNet plus VAT
skontoThe gross read was the amount less Skonto
payableThe gross read was what is left to pay
outsideThe net with an amount outside the VAT groups: a deposit, a tip
tipThe gross read was the amount paid: the bill and its tip, read apart

sources.*.confidence

How sure Ocost is of a value, from its checks: never a model's grade.

WertBedeutung
checkedA check confirmed it, or it came from an e-invoice
readNothing speaks against it
doubtA check failed (why names it), or its words weren't on its page

checks[].name

A check Ocost ran in code on what it read.

WertSummeBedeutung
totaljaA total was read
vatjaA VAT group's VAT is its net × rate (at the rate)
vat_netjaThe VAT groups' nets add up to the net
vat_taxjaThe VAT groups' VAT adds up to the VAT
grossjaNet plus VAT is the gross (the net, with no VAT printed)
payablejaWhat is left to pay is between nothing and the gross
signsjaNo total is negative
deductionjaA deducted invoice's net plus VAT is its gross (at which)
deductionsjaThe gross less the deductions is what is left to pay
quantityjaA delivered quantity is positive, or the line is backordered (at the line)
skontojaA Skonto is plausible: up to 10 %, within a year
lineA line's quantity × price, less its discount, is its net (at the line)
lines_netThe lines add up to the net (the gross, priced with VAT)
lines_currencyThe lines are in another currency than the totals (at it)
vat_linesA VAT group's net is its lines' (at the rate)
line_taxA line's printed VAT is its net × rate, and its net plus VAT its printed gross (at the line)
lines_taxThe lines' printed VAT adds up to their VAT group's (at the rate)
ibanThe IBAN's check digits hold
vat_idA VAT ID has its country's format
identifierA party's identifier has its length and check digit (at its scheme: an ЄДРПОУ, a РНОКПП, a NIP)
issued_onThe issue date is neither years ago nor ahead
due_onThe due date isn't before the issue date
serviceThe service period starts before it ends
valid_untilA quote holds until after its issue date
delivery_onThe delivery date is near the issue date
statedThe amounts stated in a second currency add up
stated_rateThe amounts in both currencies agree at the rate printed, else the ECB's (at the rate)
payment_sumA contract's payment: net plus VAT is its gross (at which)
payment_vatA contract's payment: its VAT is its net × rate
payment_signA contract's payment: its amounts are positive
stepA stepped rent's step falls in the term, in order
first_paymentA contract's first payment falls in its term
depositA contract's deposit is positive

tax_check.case

Which German rules an incoming invoice is held to.

WertBedeutung
standard§ 14 Abs. 4 UStG: an invoice with VAT
small§ 33 UStDV: a small amount, up to 250 €
reverse_charge§ 13b, § 14a Abs. 5 UStG: the business owes the VAT
intra_eu§ 14a Abs. 3 UStG: an intra-community supply
exempt§ 14 Abs. 4 Satz 1 Nr. 8 UStG: an exempt supply

tax_check.missing[].item

What an invoice lacks, or has wrong, for its case.

WertBedeutung
supplier_nameThe supplier's full name
supplier_addressThe supplier's full address
supplier_tax_idThe supplier's tax number or VAT ID
recipient_nameThe recipient's full name
recipient_addressThe recipient's full address
recipient_not_usIt is addressed to someone else than the business
recipient_address_not_oursIt is addressed to an address that isn't the business's
issued_onThe issue date
numberThe invoice number
descriptionThe quantity and kind of the goods or services
service_dateThe day of the supply or service
netThe net per rate
tax_rateThe VAT rate
tax_amountThe VAT
exemption_noteThe note on why it is exempt
reverse_charge_noteThe note that the recipient owes the VAT (Steuerschuldnerschaft des Leistungsempfängers)
intra_eu_noteThe note that it is an intra-community supply
supplier_vat_idThe supplier's VAT ID
recipient_vat_idThe recipient's VAT ID
vat_chargedGerman VAT charged where the business owes it itself (§ 13b): not deductible, and paying it pays VAT twice
vat_non_payerUkraine: ПДВ charged by a supplier Ukraine's register says is no VAT payer (платник ПДВ): no tax credit for it
supplier_idnoMoldova: the supplier's IDNO
supplier_vat_codeMoldova: the supplier's VAT code (cod TVA), where it charges VAT
vat_rate_unknownMoldova: a VAT rate other than 20 %, 8 % or 0 %

attention[]

What a person should look at before booking it.

WertBedeutung
sumsA check with sums: true failed
outgoingThe business issued it
possible_duplicateAn earlier document has its kind, number and seller (possible_duplicate_of)
self_billedA self-billed invoice (Gutschrift): the buyer issued it

read_with

How Ocost read it: never a model's or provider's name.

WertBedeutung
e_invoiceFrom its XML, exactly
readerFrom its pages

type_code

UNCL 1001, ein bis drei Ziffern. Eine E-Rechnung kann einen Code tragen, der hier fehlt. Wo der Beleg keinen druckt, schreibt Ocost den seiner Art:

WertBedeutung
380Commercial invoice
381Credit note
384Corrected invoice
389Self-billed invoice
326Partial invoice
386Prepayment invoice
325Pro forma invoice
875Partial construction invoice
876Partial final construction invoice
877Final construction invoice
383Debit note
393Factored invoice
751Invoice information for accounting purposes
81Credit note related to goods or services
83Credit note related to financial adjustments
261Self-billed credit note
262Consolidated credit note, goods and services
396Factored credit note
532Forwarder's credit note

sources

Die Pfade, die sources, checks[].fields und worked_out[].field nennen, n ab 0. Eine spätere Ocost-Version kann Pfade ergänzen:

number, issue_date, due_date, delivery_date, valid_until, currency, order_reference, seller.name, buyer.name, seller.vat_id, buyer.vat_id, seller.contact.email, buyer.contact.email, seller.contact.phone, buyer.contact.phone, seller.website, buyer.website, seller.legal_registration_id, buyer.legal_registration_id, totals.net, totals.tax, totals.gross, totals.payable, payment.iban, payment.means_code, payment.paid_on, lines, other_parties[n].name, deductions[n].gross

Siehe auch