Le document

Ocost renvoie chaque document qu'il a lu en ocost.document.v1. Demandez-le avec GET /public/v1/files/{file_id}/document ou GET /public/v1/documents/{document_id}. Les champs suivent l'EN 16931, la norme derrière XRechnung, ZUGFeRD et Peppol UBL. Chaque champ nomme son business term (BT-…) ou son groupe (BG-…), et se transpose donc en UBL ou en CII.

Validez avec le JSON Schema ou générez-en des types. Champs et Valeurs ci-dessous listent tout ce qu'il contient.

Un exemple

Une facture entrante avec deux lignes à 19 % et 2 % d'escompte (Skonto) sous 14 jours :

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

Type et sens

Décidez selon kind. Il regroupe les types de documents d'Ocost en quelques-uns, comme invoice ou delivery_note. kind_detail nomme le type exact. type_code donne le code UNCL 1001 de la facture, comme 380.

direction dit si le document est incoming, d'un fournisseur, outgoing, de votre entreprise, ou unsure. Ocost le déduit de vos données dans Paramètres › Données de l'entreprise. Tenez-les donc à jour.

Identifiants de tout pays

Les identifiers de chaque partie listent les numéros imprimés pour elle, par scheme, comme UA_EDRPOU, UA_RNOKPP, UA_IPN ou PL_NIP. Aucun modèle de document n'est nécessaire. valid vaut false quand un chiffre de contrôle échoue, null quand le schéma n'en a pas.

Les documents, les identifiants et les règles de TVA de chaque pays ont leur propre page : Allemagne, Ukraine, Royaume-Uni, États-Unis et Moldavie.

Payé à un factor

Sur une facture cédée à un factor (Zession, affacturage), payment.iban est le compte du factor. payment.assigned_to nomme le factor, payment.iban_holder le titulaire du compte. payee contient le factor quand Ocost l'a lu comme une partie.

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

Comment les valeurs sont écrites

ValeurÉcrite comme
Montants et quantitésDes nombres JSON exacts sous leur forme la plus courte, comme 1270.92 ou 595. Au plus 15 chiffres significatifs. Lisez-les en décimaux avant de calculer.
TauxDes pourcentages, comme 19 ou 5.5.
Dates et codesISO 8601 (2026-11-03), ISO 4217 (EUR), ISO 3166-1 alpha-2 (DE), unités UNECE (HUR). Unités et codes les liste.
Codes mal lusnull, jamais le texte imprimé. Il en va de même pour un IBAN ou un BIC.
Valeurs manquantesnull, quand rien n'est imprimé ou qu'Ocost n'était pas sûr. Ocost ne devine jamais. Par MCP, un tel champ est plutôt omis.

À quel point Ocost est sûr

sources dit, pour chaque valeur selon son chemin, où elle a été lue : sa page et sa quote. Sa confidence est l'une de trois :

ConfidenceSignification
checkedUn contrôle l'a confirmée, ou elle vient d'une facture électronique.
readRien ne s'y oppose.
doubtUn contrôle a échoué, et why le nomme. Ou ses mots n'ont pas été trouvés sur sa page.

box marque la valeur sur sa page : x0, y0 (en haut à gauche) et x1, y1 (en bas à droite). Ce sont des fractions de la page depuis son coin supérieur gauche, de 0 à 1. La page est page telle que GET /public/v1/files/{id}/content la montre, rotation appliquée. Sur le texte d'un PDF, le rectangle est exact, sur un scan l'OCR l'estime. Sans rectangle gardé, il vaut null, et quote est tout ce qu'il y a.

checks liste chaque contrôle qu'Ocost a exécuté dans le code, avec passed. Les contrôles marqués sums: true additionnent les montants. Ne remplissez une facture sans le regard d'une personne que si chacun d'eux a réussi.

attention liste ce qu'une personne devrait regarder avant de comptabiliser, comme un doublon possible. tax_check contient le contrôle d'une facture entrante selon le droit allemand, comme l'explique Allemagne.

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

Versions

Dans v1, Ocost peut ajouter une valeur à une liste, mais ne renomme ni ne supprime jamais un champ ou une valeur. Traitez un kind inconnu comme other, et n'échouez jamais sur une valeur inconnue. Un changement incompatible arrive en ocost.document.v2 sous /public/v2, et v1 reste 12 mois de plus.

Changements

Le journal des modifications liste chaque changement, du plus récent au plus ancien.

Champs

Chaque champ, écrit à partir du code d'Ocost. Le JSON Schema contient la même chose. Les descriptions y sont en anglais, comme ici.

Document

ChampTypeSignification
schemaocost.document.v1Always this
iduuidThe document
file_iduuidThe file it is in
pagesliste de integerIts pages in the file, from 1
kindénumération, ValeursWhat a document is, grouped so an integrator branches on few; the exact kind is kind_detail.
kind_detailénumération, ValeursThe exact kind, one of Ocost's document types, for information
directionénumération, ValeursWhether the business received or issued it.
type_codestring (380) ou nullBT-3, UNCL 1001
numberstring ou nullBT-1
issue_datedate ou nullBT-2
due_datedate ou nullBT-9
delivery_datedate ou nullBT-72
invoicing_period_startdate ou nullBT-73
invoicing_period_enddate ou nullBT-74
valid_untildate ou nullA quote's
currencystring (EUR) ou nullBT-5, ISO 4217
buyer_referencestring ou nullBT-10
order_referencestring ou nullBT-13
order_referencesliste de stringEvery order it names
preceding_invoicestring ou nullBT-25; a tax invoice's: the invoice or act it is for
contract_referencestring ou nullBT-12: the contract it refers to (an act's)
tax_registrationTaxRegistration ou nullA tax invoice's registration, where printed
sellerParty ou nullBG-4
buyerParty ou nullBG-7
payeeParty ou nullBG-10: when not the seller
deliver_toAddress ou nullBG-15
other_partiesliste de OtherPartyEvery other party named
paymentPaymentBG-16.
early_payment_discountsliste de EarlyPaymentDiscountSkonto: XRechnung's #SKONTO# in BT-20.
totalsTotalsBG-22.
vat_breakdownliste de VatGroupBG-23.
linesliste de LineBG-25.
deductionsliste de DeductionA final invoice's: an earlier invoice it takes off.
cardCard ou nullWhat a document without fields of its own says: a title, a summary and its facts (deadlines first).
worked_outliste de WorkedOutAn amount Ocost worked out because the one read can't be it.
sourcestable de SourcePer value, by its path
checksliste de CheckA check Ocost ran in code, and whether it passed.
tax_checkTaxCheck ou nullAn incoming invoice's § 14 UStG check (Germany's rules).
attentionliste de énumération, ValeursWhat a person should look at before booking it.
possible_duplicate_ofuuid ou nullAn earlier document of the same kind, number and seller
read_withénumération, ValeursHow Ocost read it

TaxRegistration

ChampTypeSignification
numberstring ou nullIts registration number
datedate ou nullThe day it was registered

Party

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

Address

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

OtherParty

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

Payment

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

EarlyPaymentDiscount

ChampTypeSignification
daysinteger
percentdécimal2 for 2 %
base_amountdécimal ou nullWhat it is taken off, where printed; null: the amount due
due_datedate ou nullThe last day for it: the issue date plus days

Totals

ChampTypeSignification
netdécimal ou nullBT-109
taxdécimal ou nullBT-110
grossdécimal ou nullBT-112
payabledécimal ou 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

ChampTypeSignification
categoryénumération, Valeurs ou nullBT-118
ratedécimal ou nullBT-119, percent: 19
taxable_amountdécimalBT-116
tax_amountdécimalBT-117
exemption_reasonstring ou nullBT-120

Line

ChampTypeSignification
idstringBT-126: its position
namestringBT-153
seller_item_idstring ou nullBT-155: the article number
standard_item_idstring ou nullBT-157: the GTIN (scheme 0160)
quantitydécimal ou nullBT-129
unitstring (C62) ou nullBT-130: UNECE Rec 20 (C62, HUR, KGM) or Rec 21 (XCT); null when none is printed or it is no code
pricedécimal ou nullBT-146: the net price
base_quantitydécimal ou nullBT-149: how many units price is for; null: one
net_amountdécimal ou nullBT-131
discount_percentdécimal ou nullThe line's discount: 5
vat_categoryénumération, Valeurs ou nullBT-151
vat_ratedécimal ou nullBT-152, percent
tax_amountdécimal ou nullThe line's VAT, only as printed on it; null when it prints none
gross_amountdécimal ou nullThe line's total with VAT, only as printed on it; null when it prints none
ordered_quantitydécimal ou nullA delivery note's
backordered_quantitydécimal ou nullStill to come
batchstring ou nullIts batch (Charge), as printed
pznstring ou nullA medicine's PZN
attributestable de stringWhat it is, as printed: colour, size, material, brand, …

Deduction

ChampTypeSignification
numberstring ou null
issue_datedate ou null
netdécimal ou null
taxdécimal ou null
grossdécimal ou null

Card

ChampTypeSignification
titlestring ou null
summarystring ou null
factsliste de Fact

WorkedOut

ChampTypeSignification
fieldénumération, ValeursIts path in this document
printeddécimal ou nullWhat was read
ruleénumération, ValeursHow Ocost worked an amount out.

Source

ChampTypeSignification
pageinteger ou nullWhere it was read: the file's page, from 1
quotestring ou nullThe words it was read from
boxBox ou nullIts rectangle on page; null when Ocost kept none (then quote is all there is)
confidenceénumération, ValeursHow sure Ocost is of a value, from its checks: never a model's grade.
whystring ou nullFor a doubt: the failed check's name

Check

ChampTypeSignification
nameénumération, ValeursWhat 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 de string (totals.gross)The paths it is about, as sources names them
atstring ou nullThe rate or the line it is about

TaxCheck

ChampTypeSignification
caseénumération, ValeursWhich German rules an incoming invoice is held to.
missingliste de TaxItem

PartyIdentifier

ChampTypeSignification
schemeénumération, ValeursWhat an identifier of a party is.
valuestringDigits only for the schemes of digits, a VAT ID without spaces, any other as printed
validboolean ou nullIts length and check digit hold; false: in doubt, a misread (never matched on); null: its scheme has no check

Contact

ChampTypeSignification
emailstring ou nullBT-43, BT-58: an address as printed
phonestring ou nullBT-42, BT-57: as printed

Factor

ChampTypeSignification
namestringAs the assignment note prints it

Fact

ChampTypeSignification
labelstringWhat it is, in the document's words
kindénumération, ValeursWhat a fact on a document's card is.
datedate ou null
amountdécimal ou null
currencystring (EUR) ou nullISO 4217, of amount
numberdécimal ou null
textstring ou null
pageinteger ou null

Box

ChampTypeSignification
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

ChampTypeSignification
iteménumération, ValeursWhat an invoice lacks, or has wrong, for its case.
lawstringThe paragraph that asks for it
at_stakebooleanMissing, it costs the input VAT deduction

Valeurs

Chaque liste de valeurs, écrite à partir du code d'Ocost. Le JSON Schema et la référence de l'API contiennent la même chose, les significations en anglais. Une version ultérieure d'Ocost peut ajouter une valeur dans v1. Traitez un kind inconnu comme other, et ignorez toute autre valeur inconnue. Aucune valeur n'est renommée ni supprimée dans v1.

kind

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

ValeurSignification
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).

Chaque kind_detail, selon le kind qu'il est :

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.

ValeurSignification
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.

ValeurSignification
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.

ValeurSignification
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.

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

payment.means

How it is paid, as a word.

ValeurSignification
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.

ValeurSignification
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.

ValeurSignification
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.

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

worked_out[].rule

How Ocost worked an amount out.

ValeurSignification
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.

ValeurSignification
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.

ValeurSommeSignification
totalouiA total was read
vatouiA VAT group's VAT is its net × rate (at the rate)
vat_netouiThe VAT groups' nets add up to the net
vat_taxouiThe VAT groups' VAT adds up to the VAT
grossouiNet plus VAT is the gross (the net, with no VAT printed)
payableouiWhat is left to pay is between nothing and the gross
signsouiNo total is negative
deductionouiA deducted invoice's net plus VAT is its gross (at which)
deductionsouiThe gross less the deductions is what is left to pay
quantityouiA delivered quantity is positive, or the line is backordered (at the line)
skontoouiA 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.

ValeurSignification
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.

ValeurSignification
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.

ValeurSignification
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.

ValeurSignification
e_invoiceFrom its XML, exactly
readerFrom its pages

type_code

UNCL 1001, un à trois chiffres. Une facture électronique peut porter un code absent d'ici. Là où le document n'en imprime aucun, Ocost écrit celui de son type :

ValeurSignification
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

Les chemins que nomment sources, checks[].fields et worked_out[].field, n à partir de 0. Une version ultérieure d'Ocost peut ajouter des chemins :

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

Voir aussi