Документ

Ocost повертає кожен прочитаний документ як ocost.document.v1. Запитуйте його через GET /public/v1/files/{file_id}/document або GET /public/v1/documents/{document_id}. Поля відповідають EN 16931, стандарту, на якому базуються XRechnung, ZUGFeRD і Peppol UBL. Кожне поле називає свій бізнес-термін (BT-…) або групу (BG-…), тож воно відображається на UBL чи CII.

Перевіряйте документ за JSON Schema або генеруйте з неї типи. Поля і Значення нижче перелічують усе, що він містить.

Приклад

Вхідний рахунок із двома рядками за ставкою 19 % і знижкою Skonto 2 % за оплату протягом 14 днів:

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

Вид і напрям

Розгалужуйте логіку за kind. Він зводить типи документів Ocost до кількох, як-от invoice або delivery_note. kind_detail називає точний тип. type_code дає код рахунку за UNCL 1001, наприклад 380.

direction каже, чи документ incoming від постачальника, outgoing від вашої компанії, чи unsure. Ocost визначає це за вашими даними в Налаштуваннях › Реквізити, тож тримайте їх актуальними.

Ідентифікатори будь-якої країни

identifiers кожної сторони перелічує надруковані для неї номери за scheme, як-от UA_EDRPOU, UA_RNOKPP, UA_IPN або PL_NIP. Шаблон не потрібен. valid дорівнює false, коли контрольна цифра не збігається, і null, коли схема її не має.

Документи, ідентифікатори і правила ПДВ кожної країни мають власну сторінку: Німеччина, Україна, Велика Британія, США і Молдова.

Оплата фактору

На рахунку, відступленому фактору (Zession, факторинг), payment.iban — це банківський рахунок фактора. payment.assigned_to називає фактора, а payment.iban_holder — власника рахунку. payee містить фактора, якщо Ocost прочитав його як сторону.

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

Як записуються значення

ЗначенняЗаписується як
Суми й кількостіТочні числа JSON у найкоротшому записі, наприклад 1270.92 або 595. Щонайбільше 15 значущих цифр. Перед обчисленнями зчитуйте їх як десяткові.
СтавкиВідсотки, наприклад 19 або 5.5.
Дати й кодиISO 8601 (2026-11-03), ISO 4217 (EUR), ISO 3166-1 alpha-2 (DE), одиниці UNECE (HUR). Їх перелічує сторінка Одиниці та коди.
Неправильно прочитані кодиnull, ніколи не надрукований текст. Те саме стосується IBAN чи BIC.
Відсутні значенняnull, коли значення не надруковано або Ocost не був певен. Ocost ніколи не вгадує. Через MCP таке поле натомість пропускається.

Наскільки Ocost певен

sources каже для кожного значення за його шляхом, де його прочитано: page і quote. Його confidence має одне з трьох значень:

ВпевненістьЗміст
checkedПеревірка підтвердила його, або воно прийшло з електронного рахунку.
readНіщо не свідчить проти нього.
doubtПеревірка не пройшла, і why її називає. Або його слів не знайдено на його сторінці.

box позначає значення на його сторінці: x0, y0 (верхній лівий кут) і x1, y1 (нижній правий кут), як частки сторінки від її верхнього лівого кута, від 0 до 1. Сторінка — це page такою, як її показує GET /public/v1/files/{id}/content, з урахуванням повороту. На тексті PDF рамка точна, на скані її оцінює OCR. Без збереженої рамки вона null, і є лише quote.

checks перелічує кожну перевірку, яку Ocost виконав у коді, з passed. Перевірки з позначкою sums: true звіряють суми. Заповнюйте рахунок без перегляду людиною, лише коли пройшла кожна з них.

attention перелічує, на що людина має подивитися перед проведенням, наприклад можливий дублікат. tax_check містить перевірку вхідного рахунку за німецьким законом, як пояснює сторінка Німеччина.

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

Версії

У межах v1 Ocost може додати значення до переліку, але ніколи не перейменовує і не видаляє поле чи значення. Вважайте невідомий kind за other і ніколи не падайте на невідомому значенні. Несумісна зміна прийде як ocost.document.v2 під /public/v2, а v1 залишиться ще на 12 місяців.

Зміни

Журнал змін перелічує кожну зміну, найновішу першою.

Поля

Кожне поле, записане з коду Ocost. JSON Schema містить те саме. Описи там, як і тут, англійською.

Document

ПолеТипЗміст
schemaocost.document.v1Always this
iduuidThe document
file_iduuidThe file it is in
pagesсписок integerIts pages in the file, from 1
kindперелік, ЗначенняWhat a document is, grouped so an integrator branches on few; the exact kind is kind_detail.
kind_detailперелік, ЗначенняThe exact kind, one of Ocost's document types, for information
directionперелік, ЗначенняWhether the business received or issued it.
type_codestring (380) або nullBT-3, UNCL 1001
numberstring або nullBT-1
issue_datedate або nullBT-2
due_datedate або nullBT-9
delivery_datedate або nullBT-72
invoicing_period_startdate або nullBT-73
invoicing_period_enddate або nullBT-74
valid_untildate або nullA quote's
currencystring (EUR) або nullBT-5, ISO 4217
buyer_referencestring або nullBT-10
order_referencestring або nullBT-13
order_referencesсписок stringEvery order it names
preceding_invoicestring або nullBT-25; a tax invoice's: the invoice or act it is for
contract_referencestring або nullBT-12: the contract it refers to (an act's)
tax_registrationTaxRegistration або nullA tax invoice's registration, where printed
sellerParty або nullBG-4
buyerParty або nullBG-7
payeeParty або nullBG-10: when not the seller
deliver_toAddress або nullBG-15
other_partiesсписок OtherPartyEvery other party named
paymentPaymentBG-16.
early_payment_discountsсписок EarlyPaymentDiscountSkonto: XRechnung's #SKONTO# in BT-20.
totalsTotalsBG-22.
vat_breakdownсписок VatGroupBG-23.
linesсписок LineBG-25.
deductionsсписок DeductionA final invoice's: an earlier invoice it takes off.
cardCard або nullWhat a document without fields of its own says: a title, a summary and its facts (deadlines first).
worked_outсписок WorkedOutAn amount Ocost worked out because the one read can't be it.
sourcesсловник SourcePer value, by its path
checksсписок CheckA check Ocost ran in code, and whether it passed.
tax_checkTaxCheck або nullAn incoming invoice's § 14 UStG check (Germany's rules).
attentionсписок перелік, ЗначенняWhat a person should look at before booking it.
possible_duplicate_ofuuid або nullAn earlier document of the same kind, number and seller
read_withперелік, ЗначенняHow Ocost read it

TaxRegistration

ПолеТипЗміст
numberstring або nullIts registration number
datedate або nullThe day it was registered

Party

ПолеТипЗміст
namestring або nullBT-27 (seller), BT-44 (buyer)
identifiersсписок PartyIdentifierEvery identifier printed for it, by scheme (BT-29, BT-46 in any country): an ЄДРПОУ, a РНОКПП, an ІПН, a NIP, …
vat_idstring або nullBT-31, BT-48
tax_registration_idstring або nullBT-32: the tax number (Steuernummer)
legal_registration_idstring або nullBT-30, BT-47: the register entry (HRB …)
addressAddress або nullBG-5, BG-8
contactContact або nullBG-6, BG-9
websitestring або nullAs printed: a host, with or without its scheme

Address

ПолеТипЗміст
streetstring або nullBT-35 (seller), BT-50 (buyer)
postal_codestring або nullBT-38, BT-53
citystring або nullBT-37, BT-52
countrystring (DE) або nullBT-40, BT-55: ISO 3166-1 alpha-2

OtherParty

ПолеТипЗміст
namestring або nullBT-27 (seller), BT-44 (buyer)
identifiersсписок PartyIdentifierEvery identifier printed for it, by scheme (BT-29, BT-46 in any country): an ЄДРПОУ, a РНОКПП, an ІПН, a NIP, …
vat_idstring або nullBT-31, BT-48
tax_registration_idstring або nullBT-32: the tax number (Steuernummer)
legal_registration_idstring або nullBT-30, BT-47: the register entry (HRB …)
addressAddress або nullBG-5, BG-8
contactContact або nullBG-6, BG-9
websitestring або nullAs printed: a host, with or without its scheme
roleперелік, ЗначенняWhat it is to the document
printed_rolestring або nullThe words printed for its role

Payment

ПолеТипЗміст
means_codeперелік, Значення або nullBT-81, UNCL 4461; null when it doesn't say or it was paid already
meansперелік, Значення або nullThe same, as a word
ibanstring (DE02120300000000202051) або nullBT-84, without spaces
bicstring (BYLADEM1001) або nullBT-86
iban_holderstring або nullBT-85: the holder of iban, as printed
assigned_toFactor або nullThe factor its assignment note (Abtretung, Zession, factoring) names; iban is then the factor's
termsstring або nullBT-20, as printed
net_daysinteger або nullThe days the terms give to pay in full from the issue date
paid_ondate або nullThe day it says it was paid or charged, where printed

EarlyPaymentDiscount

ПолеТипЗміст
daysinteger
percentдесяткове число2 for 2 %
base_amountдесяткове число або nullWhat it is taken off, where printed; null: the amount due
due_datedate або nullThe last day for it: the issue date plus days

Totals

ПолеТипЗміст
netдесяткове число або nullBT-109
taxдесяткове число або nullBT-110
grossдесяткове число або nullBT-112
payableдесяткове число або 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

ПолеТипЗміст
categoryперелік, Значення або nullBT-118
rateдесяткове число або nullBT-119, percent: 19
taxable_amountдесяткове числоBT-116
tax_amountдесяткове числоBT-117
exemption_reasonstring або nullBT-120

Line

ПолеТипЗміст
idstringBT-126: its position
namestringBT-153
seller_item_idstring або nullBT-155: the article number
standard_item_idstring або nullBT-157: the GTIN (scheme 0160)
quantityдесяткове число або nullBT-129
unitstring (C62) або nullBT-130: UNECE Rec 20 (C62, HUR, KGM) or Rec 21 (XCT); null when none is printed or it is no code
priceдесяткове число або nullBT-146: the net price
base_quantityдесяткове число або nullBT-149: how many units price is for; null: one
net_amountдесяткове число або nullBT-131
discount_percentдесяткове число або nullThe line's discount: 5
vat_categoryперелік, Значення або nullBT-151
vat_rateдесяткове число або nullBT-152, percent
tax_amountдесяткове число або nullThe line's VAT, only as printed on it; null when it prints none
gross_amountдесяткове число або nullThe line's total with VAT, only as printed on it; null when it prints none
ordered_quantityдесяткове число або nullA delivery note's
backordered_quantityдесяткове число або nullStill to come
batchstring або nullIts batch (Charge), as printed
pznstring або nullA medicine's PZN
attributesсловник stringWhat it is, as printed: colour, size, material, brand, …

Deduction

ПолеТипЗміст
numberstring або null
issue_datedate або null
netдесяткове число або null
taxдесяткове число або null
grossдесяткове число або null

Card

ПолеТипЗміст
titlestring або null
summarystring або null
factsсписок Fact

WorkedOut

ПолеТипЗміст
fieldперелік, ЗначенняIts path in this document
printedдесяткове число або nullWhat was read
ruleперелік, ЗначенняHow Ocost worked an amount out.

Source

ПолеТипЗміст
pageinteger або nullWhere it was read: the file's page, from 1
quotestring або nullThe words it was read from
boxBox або nullIts rectangle on page; null when Ocost kept none (then quote is all there is)
confidenceперелік, ЗначенняHow sure Ocost is of a value, from its checks: never a model's grade.
whystring або nullFor a doubt: the failed check's name

Check

ПолеТипЗміст
nameперелік, ЗначенняWhat 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
fieldsсписок string (totals.gross)The paths it is about, as sources names them
atstring або nullThe rate or the line it is about

TaxCheck

ПолеТипЗміст
caseперелік, ЗначенняWhich German rules an incoming invoice is held to.
missingсписок TaxItem

PartyIdentifier

ПолеТипЗміст
schemeперелік, ЗначенняWhat an identifier of a party is.
valuestringDigits only for the schemes of digits, a VAT ID without spaces, any other as printed
validboolean або nullIts length and check digit hold; false: in doubt, a misread (never matched on); null: its scheme has no check

Contact

ПолеТипЗміст
emailstring або nullBT-43, BT-58: an address as printed
phonestring або nullBT-42, BT-57: as printed

Factor

ПолеТипЗміст
namestringAs the assignment note prints it

Fact

ПолеТипЗміст
labelstringWhat it is, in the document's words
kindперелік, ЗначенняWhat a fact on a document's card is.
datedate або null
amountдесяткове число або null
currencystring (EUR) або nullISO 4217, of amount
numberдесяткове число або null
textstring або null
pageinteger або null

Box

ПолеТипЗміст
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

ПолеТипЗміст
itemперелік, ЗначенняWhat an invoice lacks, or has wrong, for its case.
lawstringThe paragraph that asks for it
at_stakebooleanMissing, it costs the input VAT deduction

Значення

Кожен перелік значень, записаний з коду Ocost. JSON Schema і довідник API містять те саме, значення описані англійською. Пізніша версія Ocost може додати значення в межах v1. Вважайте невідомий kind за other, а будь-яке інше невідоме значення пропускайте. У v1 жодне значення не перейменовується і не зникає.

kind

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

ЗначенняЗміст
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).

Кожен kind_detail за kind, до якого він належить:

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.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
58SEPA credit transfer
59SEPA direct debit
48Bank card

payment.means

How it is paid, as a word.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
totals.netBT-109
totals.taxBT-110
totals.grossBT-112

worked_out[].rule

How Ocost worked an amount out.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняСумаЗміст
totalтакA total was read
vatтакA VAT group's VAT is its net × rate (at the rate)
vat_netтакThe VAT groups' nets add up to the net
vat_taxтакThe VAT groups' VAT adds up to the VAT
grossтакNet plus VAT is the gross (the net, with no VAT printed)
payableтакWhat is left to pay is between nothing and the gross
signsтакNo total is negative
deductionтакA deducted invoice's net plus VAT is its gross (at which)
deductionsтакThe gross less the deductions is what is left to pay
quantityтакA delivered quantity is positive, or the line is backordered (at the line)
skontoтакA 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.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
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.

ЗначенняЗміст
e_invoiceFrom its XML, exactly
readerFrom its pages

type_code

UNCL 1001, від однієї до трьох цифр. Електронний рахунок може мати код, якого тут немає. Де документ не друкує жодного, Ocost пише код його виду:

ЗначенняЗміст
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

Шляхи, які називають sources, checks[].fields і worked_out[].field, n від 0. Пізніша версія Ocost може додати шляхи:

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

Див. також