Dokument

Ocost zwraca każdy odczytany dokument jako ocost.document.v1. Pobierz go przez GET /public/v1/files/{file_id}/document lub GET /public/v1/documents/{document_id}. Pola są zgodne z EN 16931, normą stojącą za XRechnung, ZUGFeRD i Peppol UBL. Każde pole wskazuje swój termin biznesowy (BT-…) lub grupę (BG-…), więc daje się odwzorować na UBL lub CII.

Waliduj względem JSON Schema albo generuj z niego typy. Pola i Wartości poniżej wymieniają wszystko, co zawiera.

Przykład

Faktura przychodząca z dwiema pozycjami po 19 % i 2 % Skonto w ciągu 14 dni:

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"
}

Rodzaj i kierunek

Rozgałęziaj logikę według kind. Grupuje on typy dokumentów Ocost w kilka, na przykład invoice lub delivery_note. kind_detail podaje dokładny typ. type_code podaje kod UNCL 1001 faktury, na przykład 380.

direction mówi, czy dokument jest incoming od dostawcy, outgoing od Twojej firmy, czy unsure. Ocost ustala to na podstawie Twoich danych w Ustawienia › Firma, więc dbaj o ich poprawność.

Identyfikatory z każdego kraju

identifiers każdej strony wymienia wydrukowane dla niej numery według scheme, na przykład UA_EDRPOU, UA_RNOKPP, UA_IPN lub PL_NIP. Żaden szablon nie jest potrzebny. valid ma wartość false, gdy cyfra kontrolna się nie zgadza, i null, gdy schemat jej nie ma.

Dokumenty, identyfikatory i zasady VAT każdego kraju mają własną stronę: Niemcy, Ukraina, Wielka Brytania, Stany Zjednoczone i Mołdawia.

Płatność na rzecz faktora

Na fakturze, której wierzytelność przelano na faktora (Zession, faktoring), payment.iban to rachunek faktora. payment.assigned_to podaje faktora, a payment.iban_holder posiadacza rachunku. payee zawiera faktora, gdy Ocost odczytał go jako stronę.

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

Jak zapisywane są wartości

WartośćZapis
Kwoty i ilościDokładne liczby JSON w najkrótszej postaci, na przykład 1270.92 lub 595. Najwyżej 15 cyfr znaczących. Przed obliczeniami wczytaj je jako liczby dziesiętne.
StawkiProcenty, na przykład 19 lub 5.5.
Daty i kodyISO 8601 (2026-11-03), ISO 4217 (EUR), ISO 3166-1 alpha-2 (DE), jednostki UNECE (HUR). Jednostki i kody je wymieniają.
Kody odczytane błędnienull, nigdy wydrukowany tekst. To samo dotyczy IBAN i BIC.
Brakujące wartościnull, gdy nie wydrukowano wartości lub Ocost nie był pewny. Ocost nigdy nie zgaduje. Przez MCP takie pole jest za to pomijane.

Jak pewny jest Ocost

sources podaje dla każdej wartości, według jej ścieżki, gdzie ją odczytano: jej page i jej quote. Jej confidence przyjmuje jedną z trzech wartości:

PewnośćZnaczenie
checkedPotwierdziła ją kontrola albo pochodzi z e-faktury.
readNic nie przemawia przeciwko niej.
doubtKontrola się nie powiodła, a why ją wskazuje. Albo jej słów nie znaleziono na jej stronie.

box zaznacza wartość na jej stronie: x0, y0 (lewy górny róg) i x1, y1 (prawy dolny róg), jako ułamki strony od jej lewego górnego rogu, od 0 do 1. Strona to page tak, jak pokazuje ją GET /public/v1/files/{id}/content, po uwzględnieniu obrotu. Na tekście pliku PDF ramka jest dokładna, na skanie szacuje ją OCR. Bez zapisanej ramki ma wartość null, a jedyną informacją jest quote.

checks wymienia każdą kontrolę, którą Ocost wykonał w kodzie, z passed. Kontrole oznaczone sums: true sumują kwoty. Wypełniaj fakturę bez spojrzenia człowieka tylko wtedy, gdy każda z nich przeszła.

attention wymienia to, na co człowiek powinien spojrzeć przed zaksięgowaniem, na przykład możliwy duplikat. tax_check zawiera kontrolę faktury przychodzącej według prawa niemieckiego, jak objaśnia strona Niemcy.

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"]

Wersje

W ramach v1 Ocost może dodać wartość do listy, ale nigdy nie zmienia nazwy pola ani wartości i nigdy ich nie usuwa. Nieznany kind traktuj jako other i nigdy nie przerywaj działania z powodu nieznanej wartości. Zmiana niezgodna wstecz przyjdzie jako ocost.document.v2 pod /public/v2, a v1 zostanie jeszcze przez 12 miesięcy.

Zmiany

Dziennik zmian wymienia każdą zmianę, od najnowszej.

Pola

Każde pole, wypisane z kodu Ocost. JSON Schema zawiera to samo. Opisy są tam, tak jak tutaj, po angielsku.

Document

PoleTypZnaczenie
schemaocost.document.v1Always this
iduuidThe document
file_iduuidThe file it is in
pageslista integerIts pages in the file, from 1
kindwyliczenie, WartościWhat a document is, grouped so an integrator branches on few; the exact kind is kind_detail.
kind_detailwyliczenie, WartościThe exact kind, one of Ocost's document types, for information
directionwyliczenie, WartościWhether the business received or issued it.
type_codestring (380) lub nullBT-3, UNCL 1001
numberstring lub nullBT-1
issue_datedate lub nullBT-2
due_datedate lub nullBT-9
delivery_datedate lub nullBT-72
invoicing_period_startdate lub nullBT-73
invoicing_period_enddate lub nullBT-74
valid_untildate lub nullA quote's
currencystring (EUR) lub nullBT-5, ISO 4217
buyer_referencestring lub nullBT-10
order_referencestring lub nullBT-13
order_referenceslista stringEvery order it names
preceding_invoicestring lub nullBT-25; a tax invoice's: the invoice or act it is for
contract_referencestring lub nullBT-12: the contract it refers to (an act's)
tax_registrationTaxRegistration lub nullA tax invoice's registration, where printed
sellerParty lub nullBG-4
buyerParty lub nullBG-7
payeeParty lub nullBG-10: when not the seller
deliver_toAddress lub nullBG-15
other_partieslista OtherPartyEvery other party named
paymentPaymentBG-16.
early_payment_discountslista EarlyPaymentDiscountSkonto: XRechnung's #SKONTO# in BT-20.
totalsTotalsBG-22.
vat_breakdownlista VatGroupBG-23.
lineslista LineBG-25.
deductionslista DeductionA final invoice's: an earlier invoice it takes off.
cardCard lub nullWhat a document without fields of its own says: a title, a summary and its facts (deadlines first).
worked_outlista WorkedOutAn amount Ocost worked out because the one read can't be it.
sourcesmapa SourcePer value, by its path
checkslista CheckA check Ocost ran in code, and whether it passed.
tax_checkTaxCheck lub nullAn incoming invoice's § 14 UStG check (Germany's rules).
attentionlista wyliczenie, WartościWhat a person should look at before booking it.
possible_duplicate_ofuuid lub nullAn earlier document of the same kind, number and seller
read_withwyliczenie, WartościHow Ocost read it

TaxRegistration

PoleTypZnaczenie
numberstring lub nullIts registration number
datedate lub nullThe day it was registered

Party

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

Address

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

OtherParty

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

Payment

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

EarlyPaymentDiscount

PoleTypZnaczenie
daysinteger
percentliczba dziesiętna2 for 2 %
base_amountliczba dziesiętna lub nullWhat it is taken off, where printed; null: the amount due
due_datedate lub nullThe last day for it: the issue date plus days

Totals

PoleTypZnaczenie
netliczba dziesiętna lub nullBT-109
taxliczba dziesiętna lub nullBT-110
grossliczba dziesiętna lub nullBT-112
payableliczba dziesiętna lub 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

PoleTypZnaczenie
categorywyliczenie, Wartości lub nullBT-118
rateliczba dziesiętna lub nullBT-119, percent: 19
taxable_amountliczba dziesiętnaBT-116
tax_amountliczba dziesiętnaBT-117
exemption_reasonstring lub nullBT-120

Line

PoleTypZnaczenie
idstringBT-126: its position
namestringBT-153
seller_item_idstring lub nullBT-155: the article number
standard_item_idstring lub nullBT-157: the GTIN (scheme 0160)
quantityliczba dziesiętna lub nullBT-129
unitstring (C62) lub nullBT-130: UNECE Rec 20 (C62, HUR, KGM) or Rec 21 (XCT); null when none is printed or it is no code
priceliczba dziesiętna lub nullBT-146: the net price
base_quantityliczba dziesiętna lub nullBT-149: how many units price is for; null: one
net_amountliczba dziesiętna lub nullBT-131
discount_percentliczba dziesiętna lub nullThe line's discount: 5
vat_categorywyliczenie, Wartości lub nullBT-151
vat_rateliczba dziesiętna lub nullBT-152, percent
tax_amountliczba dziesiętna lub nullThe line's VAT, only as printed on it; null when it prints none
gross_amountliczba dziesiętna lub nullThe line's total with VAT, only as printed on it; null when it prints none
ordered_quantityliczba dziesiętna lub nullA delivery note's
backordered_quantityliczba dziesiętna lub nullStill to come
batchstring lub nullIts batch (Charge), as printed
pznstring lub nullA medicine's PZN
attributesmapa stringWhat it is, as printed: colour, size, material, brand, …

Deduction

PoleTypZnaczenie
numberstring lub null
issue_datedate lub null
netliczba dziesiętna lub null
taxliczba dziesiętna lub null
grossliczba dziesiętna lub null

Card

PoleTypZnaczenie
titlestring lub null
summarystring lub null
factslista Fact

WorkedOut

PoleTypZnaczenie
fieldwyliczenie, WartościIts path in this document
printedliczba dziesiętna lub nullWhat was read
rulewyliczenie, WartościHow Ocost worked an amount out.

Source

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

Check

PoleTypZnaczenie
namewyliczenie, WartościWhat 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
fieldslista string (totals.gross)The paths it is about, as sources names them
atstring lub nullThe rate or the line it is about

TaxCheck

PoleTypZnaczenie
casewyliczenie, WartościWhich German rules an incoming invoice is held to.
missinglista TaxItem

PartyIdentifier

PoleTypZnaczenie
schemewyliczenie, WartościWhat an identifier of a party is.
valuestringDigits only for the schemes of digits, a VAT ID without spaces, any other as printed
validboolean lub nullIts length and check digit hold; false: in doubt, a misread (never matched on); null: its scheme has no check

Contact

PoleTypZnaczenie
emailstring lub nullBT-43, BT-58: an address as printed
phonestring lub nullBT-42, BT-57: as printed

Factor

PoleTypZnaczenie
namestringAs the assignment note prints it

Fact

PoleTypZnaczenie
labelstringWhat it is, in the document's words
kindwyliczenie, WartościWhat a fact on a document's card is.
datedate lub null
amountliczba dziesiętna lub null
currencystring (EUR) lub nullISO 4217, of amount
numberliczba dziesiętna lub null
textstring lub null
pageinteger lub null

Box

PoleTypZnaczenie
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

PoleTypZnaczenie
itemwyliczenie, WartościWhat an invoice lacks, or has wrong, for its case.
lawstringThe paragraph that asks for it
at_stakebooleanMissing, it costs the input VAT deduction

Wartości

Każda lista wartości, wypisana z kodu Ocost. JSON Schema i dokumentacja API zawierają to samo, znaczenia po angielsku. Późniejsza wersja Ocost może dodać wartość w ramach v1. Nieznany kind traktuj jako other, a każdą inną nieznaną wartość pomiń. W v1 żadna wartość nie zmienia nazwy ani nie znika.

kind

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

WartośćZnaczenie
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).

Każdy kind_detail według kind, którym jest:

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.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
58SEPA credit transfer
59SEPA direct debit
48Bank card

payment.means

How it is paid, as a word.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
totals.netBT-109
totals.taxBT-110
totals.grossBT-112

worked_out[].rule

How Ocost worked an amount out.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćSumaZnaczenie
totaltakA total was read
vattakA VAT group's VAT is its net × rate (at the rate)
vat_nettakThe VAT groups' nets add up to the net
vat_taxtakThe VAT groups' VAT adds up to the VAT
grosstakNet plus VAT is the gross (the net, with no VAT printed)
payabletakWhat is left to pay is between nothing and the gross
signstakNo total is negative
deductiontakA deducted invoice's net plus VAT is its gross (at which)
deductionstakThe gross less the deductions is what is left to pay
quantitytakA delivered quantity is positive, or the line is backordered (at the line)
skontotakA 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.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
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.

WartośćZnaczenie
e_invoiceFrom its XML, exactly
readerFrom its pages

type_code

UNCL 1001, od jednej do trzech cyfr. E-faktura może nieść kod, którego tu nie ma. Gdy dokument nie drukuje żadnego, Ocost wpisuje kod jego rodzaju:

WartośćZnaczenie
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

Ścieżki, które wskazują sources, checks[].fields i worked_out[].field, n od 0. Późniejsza wersja Ocost może dodać ścieżki:

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

Zobacz też