Документ

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. Без сохранённой рамки box равен 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

См. также