Data formats
What an Offerium export contains
“Export everything” on Data & account gives a firm one ZIP file that opens without Offerium: every bid, its tender papers, the offer exactly as sent, company documents, invoices and the activity record. This page describes that file, folder by folder and field by field. It is the same text the archive carries in its schema/ folder.
Format archive-17. Every archive names its format in manifest.json, and this page keeps the description of every earlier format.
The folders
Every file in the archive belongs to one of these categories; manifest.json names each file’s category.
- Index
readme - manifest.json, which lists every other file with its size, SHA-256, category and source row, and README.html, the offline index, written last. manifest.json cannot list itself: its own SHA-256 is printed in README.html and shown on Data & account.
- Data
data - data/<entity>.csv and data/<entity>.json: one pair per entity, the same rows in both.
- Schemas
schema - schema/<entity>.schema.json: each entity's fields as JSON Schema 2020-12, the same text as this page.
- Bid pages
bid_page - bids/<reference> <project>/bid.html: one readable page per bid, with links to its files.
- Tender papers
tender - bids/…/tender/: the buyer's files exactly as received.
- Offer as sent
offer_as_ sent - bids/…/offer-as-sent/: the package files exactly as the buyer received them.
- Offer e-mail
offer_email - bids/…/offer-as-sent/email.txt: the covering e-mail as approved: sender, recipient, subject, text.
- Mail
mail - bids/…/mail/*.eml: the bid's kept messages, rebuilt from the text and attachments Offerium kept. Offerium never keeps a message's original bytes, so these are rebuilt, not the originals. Each carries the message's Message-ID and, where Offerium recorded them, the Message-IDs of the messages it answers (In-Reply-To, References), so a mail program threads them as they were.
- Company documents
document - documents/: every version of every company document, named with its validity.
- Calendar
calendar - calendar/bids.ics: the Bids calendar as iCalendar (RFC 5545).
- Invoices
invoice - billing/invoices/<year>/<number>.pdf: Offerium's invoices to the firm and the credit notes that corrected them, each with the e-invoice beside it where there is one.
- Other files
file - files/: every other file Offerium kept for the firm (a priced form someone dropped in, the letterhead logo, a portal receipt), so none is left behind.
The data, entity by entity
Each entity is written twice, as CSV and as JSON with the same rows, and described once as JSON Schema 2020-12. A field ending in _id holds the id of a row in another entity.
- Bids
- Requirements
- Priced lines
- Package versions
- Approvals
- Holds
- Sends
- Outcomes
- Follow-ups
- Timeline
- Buyers
- Buyer contacts
- Possible bids
- Past bids
- Framework contracts
- Company documents
- Approved references
- Standard texts
- Standard text history
- Additional sections
- Company profile
- Selling rates
- People
- Mailboxes
- Calendar events
- Drive choices
- Invoices from Offerium
- Billing details
- Overage charges
- Activity record
Bids bids
Every bid, one row each: the buyer's invitation Offerium found, and what became of it. Rows with source “rebuilt” are the priced forms recovered from your sent mail; their result is in past_bids. Key facts, addenda, approval requests, the buyer's own form lines, the possible matches Offerium proposed for them from your earlier bids, each reading of the tender documents, the words Offerium drafted for the offer, each market estimate, the prices chosen from them and Offerium's advice on whether the bid is worth making are kept with the bid they belong to.
Also carried here: extracted_facts, addenda, approval_requests, client_form_lines, bid_section_choices, bid_package_lines, bid_email_edits, bid_sending_choices, bid_text_edits, line_comparables, bid_readings, offer_word_drafts, price_estimates, price_estimate_lines, price_estimate_plans, price_choices, bid_fit_advice, bid_tax_facts, outcome_evidence.
Files:data/data/JSON Schema
The fields (73)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_ | reference · an id in buyers | The buyer who asked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
slug | text | The bid's short name in Offerium's web addresses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
project | text | The project, as the buyer named it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | text · may be empty | The buyer's own reference for the tender. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source | choice | How the bid came in: found in mail, confirmed from a possible bid, or rebuilt from your sent mail.one of: detected, from_, rebuilt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
owner_ | reference · an id in people · may be empty | The person responsible for the bid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_ | reference · an id in mailboxes · may be empty | The mailbox the buyer's request arrived in. Empty for a request that arrived in no connected mailbox, such as one uploaded or added by hand. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invitation_ | identifier · may be empty | The buyer's message that invited you; its text is in the bid's mail/ folder. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ | time (ISO 8601, UTC) · may be empty | The buyer's deadline for offers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ | identifier · may be empty | The key fact (in facts) the deadline was read from. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
planned_ | time (ISO 8601, UTC) · may be empty | When the offer is to go out, once chosen. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
send_ | true or false | Someone chose the send time, rather than Offerium's default. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
submission_ | choice | Whether the offer goes by e-mail, through the buyer's portal, or on paper.one of: email, portal, post | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
submit_ | text · may be empty | The address offers go to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
portal_ | text · may be empty | The buyer's portal, for portal submissions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
declined_ | time (ISO 8601, UTC) · may be empty | When the firm decided not to bid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
declined_ | reference · an id in people · may be empty | Who decided not to bid. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trust_ | time (ISO 8601, UTC) · may be empty | When a person said they checked a mail that looked like a trap with the buyer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trust_ | reference · an id in people · may be empty | Who said so. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decline_ | choice · may be empty | Why not.one of: too_, not_, deadline_, other | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decline_ | text · may be empty | The note written with it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decided_ | time (ISO 8601, UTC) · may be empty | When the buyer's decision became known. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
correspondence_ | choice · may be empty | The language the buyer is answered in: the covering e-mail, every other e-mail to the buyer on this bid and the offer document. “en” is English, “de” German. Empty: the language of the firm's market.one of: en, de | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
correspondence_ | choice · may be empty | How that language was decided: from the words of the buyer's request, from its documents, from the firm's market, or by a person. Empty when the language is empty.one of: request, documents, market, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trade_ | choice · may be empty | The trade of this bid's work: the one most of the buyer's positions name, else Offerium's reading of the documents, or a person's choice for this bid. Prices are looked up for it where a person chose it, or where the firm's own trade is not one Offerium looks up prices for. The firm's own trade never changes with it. Empty: none was read or chosen.one of: hvac_, electrical, fire_, facility_, maintenance, engineering_ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trade_ | choice · may be empty | Where that trade came from: the buyer's positions, Offerium's reading of the documents, or a person. Empty when the trade is empty.one of: lines, reader, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trade_ | time (ISO 8601, UTC) · may be empty | When Offerium checked that trade: the buyer's positions and Offerium's reading of the documents named the same trade, Offerium's check decided between them, or a person chose it. With no trade: when Offerium checked that the work is none of the trades it looks up prices for (outside_work names it). Empty: not checked yet. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outside_ | JSON · may be empty | The kind of work of a bid Offerium checked as none of the trades it looks up prices for, in a few words under en and de (“painting work”, “Malerarbeiten”). Only with no trade and trade_checked_at set; empty otherwise. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_ | identifier · may be empty | Set when the invitation came from a person's own mailbox that was later disconnected: its message was deleted then, and the bid kept everything it knew. When and by whom is in audit_log. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
facts | rows | Key facts read from the invitation and its papers, each with where it was read. Each row of facts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addenda | rows | Addenda the buyer sent after the invitation. Each row of addenda:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
approval_ | rows | Who was asked to approve the bid, and what came of it. Each row of approval_requests:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tender_ | choice · may be empty | Whether the bid is a public tender, which decides the texts its offer prints.one of: public, private | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tender_ | choice · may be empty | Read from the invitation, or set by a person.one of: reader, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tender_ | JSON · may be empty | What the reading was based on: the words or the sender's domain, with where they were found. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tender_ | reference · an id in people · may be empty | Who set it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tender_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | reference · an id in framework_contracts · may be empty | The framework contract the bid is priced under. Empty when none. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | choice · may be empty | Who linked it: Offerium's rules, from the request's words or the customer, or a person.one of: rules, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | JSON · may be empty | The words that linked it, and where they were. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | reference · an id in people · may be empty | Who linked it, when a person did. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | time (ISO 8601, UTC) · may be empty | When it was linked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | time (ISO 8601, UTC) · may be empty | When a person said the bid is not under a contract. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | reference · an id in people · may be empty | Who said so. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
section_ | rows | Additional sections a person ticked in or out for this bid. Each row of section_choices:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | choice · may be empty | The offer layout chosen on this bid; empty uses the firm's default (Classic for a public tender).one of: classic, modern, proposal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | text · may be empty | A note printed under the offer's opening, for this bid only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
acceptance_ | true or false · may be empty | Whether the offer prints the acceptance and signature block; empty uses the firm's default. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
show_ | true or false | A revised offer shows the previous total struck through. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | text · may be empty | The offer number (“HM-2026-058”), given at the first assembly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | choice | What the buyer sees of the price: the lines and the total (“lines”), or the single total in place of the lines (“total”). The lines stay in Offerium either way.one of: lines, total | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | text · may be empty | The currency the bid is offered in (ISO 4217), where it is not the firm's own; empty is the firm's. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fx | JSON · may be empty | The one exchange rate the bid's figures were converted at: from, to, the rate, the day, the source. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
earlier_ | JSON · may be empty | The firm's earlier offer for the same request, as the mail names it: its number and its day as written (empty where none is given), the sentence that names it, the message it was found in, whether that is the firm's own sent offer (own) or the buyer's words (buyer), and when it was found. Empty when no mail names one. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | identifier · may be empty | When the note began as a text Offerium drafted and a person used: that draft (in words). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | list of text · may be empty | The scope the offer prints for this bid, one entry per point, in order; empty when it prints none. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | identifier · may be empty | When the scope began as a text Offerium drafted and a person used: that draft (in words). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
package_ | rows | Package lines a person removed from this bid's package, and files a person added to it. Each row of package_choices:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email_ | rows | The covering e-mail as a person edited it before sending, with the text Offerium had written. Each row of email_edit:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sending_ | rows | Who a person chose to send this bid from, and which colleagues to put in copy. Each row of sending_choice:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
text_ | rows | Standard texts and sections reworded for this offer only, with the words they started from. Each row of text_edits:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client_ | rows | The lines of the buyer's own price form, as received (quantities, units), before pricing. Each row of client_form_lines:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
comparables | rows | Possible matches Offerium proposed for the buyer's open lines from your own earlier bids, and what a person decided. A proposal never priced a line by itself: a line priced from one says so in priced_lines (price_source archive). Each row of comparables:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
readings | rows | Each time Offerium read the tender documents for this bid (the first look, the full reading, an addendum, papers a person uploaded), and the dossier it wrote: the facts, requirements, quantities and terms it found, each with the sentence and page it was read from, or marked as not verifiable. Each row of readings:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
words | rows | The words Offerium drafted for this bid's offer (the covering e-mail's paragraph, the opening note, the scope, a suggested clarification or exclusion, a follow-up), each with placeholders for the bid's figures, dates and names, what Offerium's own check removed from it, and whether it was used, dismissed or replaced by a later draft. Only a draft in use is printed. Each row of words:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
estimates | rows | Market estimates Offerium made for this bid where your earlier bids could not price it: a cost build-up per line, each figure with its public source or marked as an assumption, and the range computed from it. An estimate never priced a line by itself: a line priced from one says so in priced_lines (price_source market_estimate). Each row of estimates:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | rows | Prices a person chose from a market estimate on the Offer step: the option, its figure when chosen, the range it was chosen against, the reasons shown, who chose and when. A choice priced only the lines still open, or the whole bid when the buyer sent no form; each line priced from one says so in priced_lines (price_source market_estimate). A change of mind is a new row. Each row of price_choices:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fit_ | rows | Offerium's advice on whether this bid is worth making: the facts it rests on, computed from your own records (the trade, the working days to the deadline, the other bids due around it, the buyer's record with you, your results of the last twelve months, whether the work is in your region), up to three reasons citing those facts, and a lean. Advice, not a decision. Each row of fit_advice:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | rows | The facts the offer's VAT or sales tax is decided from that a person entered or Offerium's rules read: the job site, the planned execution date, the contract form, the building, a PV system, the US job facts and the rates found for the site, and a person's choice of how the offer is taxed. At most one row. Each row of tax_facts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outcome_ | rows | Every piece of evidence about how the bid ended, kept for good, both sides of a later contrary statement included, also where no outcome is recorded. Each row of outcome_evidence:
|
Requirements requirements
The checklist of each bid: what the buyer asks for, and how the firm met it or why it does not apply.
Files:data/data/JSON Schema
The fields (43)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
label | text | The requirement, as shown. |
category | choice | What kind of requirement.one of: technical, commercial, legal, form, certificate |
source_ | text · may be empty | Where the buyer asks for it (file and page). |
source_ | text · may be empty | The buyer's sentence. |
met_ | text · may be empty | How it is met, in words. |
met_ | reference · an id in company_documents · may be empty | The company document that meets it. |
met_ | identifier · may be empty | The key fact that meets it. |
met_ | time (ISO 8601, UTC) · may be empty | When it was met. |
missing_ | text · may be empty | What is still missing, as shown. |
action_ | text · may be empty | The action Offerium offered for it. |
must_ | time (ISO 8601, UTC) · may be empty | A document must be valid until then. |
is_ | true or false | A site walk the buyer requires. |
site_ | time (ISO 8601, UTC) · may be empty | When the site walk is. |
site_ | reference · an id in people · may be empty | Who attends it. |
site_ | time (ISO 8601, UTC) · may be empty | When attendance was confirmed. |
needs_ | reference · an id in people · may be empty | Who has to sign. |
signed_ | time (ISO 8601, UTC) · may be empty | When it was signed. |
signed_ | text · may be empty | The name typed to sign. |
not_ | time (ISO 8601, UTC) · may be empty | When it was marked as not applying. |
not_ | reference · an id in people · may be empty | Who marked it. |
not_ | text · may be empty | Why it does not apply. |
remembered_ | true or false | Remembered for this buyer's next bids. |
document_ | text · may be empty | The kind of company document it asks for. |
max_ | whole number · may be empty | The document may be at most this many days old. |
needs_ | true or false | The certificate must name this buyer as its holder. |
buyer_ | choice · may be empty | The standard text the buyer's documents set their own terms for.one of: preamble, exclusions, warranty, validity, payment |
buyer_ | text · may be empty | The buyer's own words. |
buyer_ | text · may be empty | Their terms in short (“Net 45”). |
buyer_ | choice · may be empty | The answer: which terms the offer prints, the buyer's or the firm's own; or, for a term the offer does not print (retention, liquidated damages, insurance, bonds, prices, delivery terms), noted as read.one of: buyers, ours, noted |
buyer_ | reference · an id in people · may be empty | Who answered. |
buyer_ | time (ISO 8601, UTC) · may be empty | When. |
buyer_ | choice · may be empty | Which of the buyer's terms the question is about: payment, retention, liquidated damages, warranty, insurance, validity, exclusions, bonds, prices (fixed prices or a price adjustment) or delivery terms.one of: payment, retention, liquidated_, warranty, insurance, validity, exclusions, bonds, prices, delivery_ |
buyer_ | JSON · may be empty | Their terms as figures, read from the buyer's own sentence: payment days, retention and bonds in hundredths of a per cent, liquidated damages per day and insurance limits in the currency's minor unit (cents) with the currency, liquidated damages as a share per day, working day, business day or week and their cap (a share, with what it is of, or an amount), warranty in months, validity in days, fixed prices and until when, the Incoterm of the delivery terms. A figure the sentence does not state is absent. |
buyer_ | text · may be empty | The clarification Offerium suggested for it, if any. It is printed only if a person adds it. |
buyer_ | choice · may be empty | Who raised the question: Offerium, from the tender documents (reader); the demonstration data (seed); or a person.one of: reader, seed, person |
send_ | time (ISO 8601, UTC) · may be empty | When a person decided the document is sent later, not with this offer (at onboarding or on request). |
send_ | reference · an id in people · may be empty | Who decided it. |
send_ | text · may be empty | The note written with it. |
position | whole number | Order on the screen, lowest first. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Priced lines priced_ lines
Every priced line of every priced form, with the form it belongs to. A lump-sum price with no lines appears as the offer total in package_versions.
Also carried here: priced_forms, line_tax_facts.
Files:data/data/JSON Schema
The fields (80)
| Field | Type | Meaning | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||||||||||||||||||||||||||
bid_ | reference · an id in bids | The bid this belongs to. | |||||||||||||||||||||||||||||||||||||||
priced_ | identifier | The priced form the line is on. | |||||||||||||||||||||||||||||||||||||||
form_ | choice | Where the form came from: your earlier bids, a form someone dropped in, a lump sum, or a price for the whole bid a person chose from a market estimate.one of: archive, dropped_, lump_, market_ | |||||||||||||||||||||||||||||||||||||||
form_ | text · may be empty | The form's file name, if it was a file. | |||||||||||||||||||||||||||||||||||||||
form_ | amount · may be empty | The form's total. Empty for a price by the hours worked, whose price is its rates, and for a form whose every position is priced per unit only. | |||||||||||||||||||||||||||||||||||||||
form_ | true or false | The lines add up to the form's total. | |||||||||||||||||||||||||||||||||||||||
form_ | whole number · may be empty | When the form was written with the buyer's own workbook filled in: how many of its priced lines could not be written into that workbook (0: every one was). Empty when no workbook was filled in, and on forms written before this was recorded. | |||||||||||||||||||||||||||||||||||||||
form_ | time (ISO 8601, UTC) · may be empty | When a newer form replaced this one. | |||||||||||||||||||||||||||||||||||||||
form_ | JSON · may be empty | For a price by the hours worked: how a person set it to be charged — a rate per item, one all-in rate, or prices of the firm's own — with each rate. Empty where nobody changed it. | |||||||||||||||||||||||||||||||||||||||
form_ | text · may be empty | Which of the request's scenarios the form prices, by the name the request gives it, when the request asks for more than one; empty is the request's base scenario, which the offer, the approval and the totals take. | |||||||||||||||||||||||||||||||||||||||
form_ | identifier · may be empty | When the form was written for a price a person chose from a market estimate: that choice (in bids, price_choices). | |||||||||||||||||||||||||||||||||||||||
form_ | JSON | The changes of the whole price made on this bid up to this form, oldest first: each says whether a person typed a total (total_set) or applied a percentage (markup, in hundredths of a percent), who, when, the total before and after in minor units, and whether the difference was spread over the lines (spread) or written as one adjustment line (adjustment). | |||||||||||||||||||||||||||||||||||||||
form_ | identifier · may be empty | The form a “Start over” or “Back to the previous price” replaced with this one (in priced_lines, priced_form_id). | |||||||||||||||||||||||||||||||||||||||
position_ | text · may be empty | The line's number. | |||||||||||||||||||||||||||||||||||||||
description | text | What the line prices. | |||||||||||||||||||||||||||||||||||||||
quantity | text · may be empty | Quantity, as written. | |||||||||||||||||||||||||||||||||||||||
unit | text · may be empty | Unit of measure. | |||||||||||||||||||||||||||||||||||||||
unit_ | amount · may be empty | Price per unit. | |||||||||||||||||||||||||||||||||||||||
line_ | amount · may be empty | The line's total. | |||||||||||||||||||||||||||||||||||||||
carried_ | reference · an id in past_bids · may be empty | The past bid the price was carried from. | |||||||||||||||||||||||||||||||||||||||
carried_ | text · may be empty | That past bid, as shown. | |||||||||||||||||||||||||||||||||||||||
is_ | true or false | Still to be priced. | |||||||||||||||||||||||||||||||||||||||
price_ | choice · may be empty | Where the line's price came from: carried across from your earlier bids, an earlier price brought up to date by an official price index, a market estimate a person chose, typed by a person, from a priced form someone dropped in, a framework contract's rate (contract), your own selling rates (rate_card, also a percentage of one of them), a number a person accepted that Offerium computed (composed: from two of your own sources, or from a country's default surcharge or the line's own “time and a half” / “double time” a person chose — the price basis's rule says which), or the customer's own surcharge you recorded on its page (buyer_terms: its percentage, or the normal hour plus it). Empty on lines priced before this was recorded.one of: archive, escalated, market_, typed, dropped_, contract, rate_, composed, buyer_ | |||||||||||||||||||||||||||||||||||||||
base_ | amount · may be empty | For a price brought up to date by an index: the earlier price per unit it started from. On a line where a person took the index's update back (price_source archive, with an escalation), the unit price is this earlier price again. | |||||||||||||||||||||||||||||||||||||||
escalation | JSON · may be empty | For a price brought up to date by an index: the index (source: bls_ppi, destatis_bpi, destatis_tarif or destatis_ppi; series), the earlier and the later period (YYYY-MM or YYYY-Qn) and the index's value in each, times 1,000 as whole numbers. The unit price is the earlier price times the later value divided by the earlier value, rounded to the cent. Where a person took the update back (price_source archive), the unit price is the earlier price, and this records what the index would have made of it. A price brought up to date by the firm's own yearly increase instead says source own_rate, the rate in tenths of a percent (permille: 35 is 3.5 %) and the months from the earlier to the later month (months; both periods YYYY-MM); its earlier value is 1,000,000,000 and its later value the factor (1 + rate)^(months / 12) on that scale, so the same rule gives the unit price. A price whose labour and material parts were brought up to date one by one lists each part under components (part, index or the reason it was not moved, the values, the part before and after); the unit price is their sum. | |||||||||||||||||||||||||||||||||||||||
estimate_ | identifier · may be empty | For a market estimate a person chose: the line of the estimate it came from. | |||||||||||||||||||||||||||||||||||||||
priced_ | reference · an id in people · may be empty | Who typed the price, chose the estimate, or chose the earlier price over the index's update. Empty when Offerium carried the price across from your earlier bids. | |||||||||||||||||||||||||||||||||||||||
priced_ | time (ISO 8601, UTC) · may be empty | When the line's price was decided: when Offerium carried it across from your earlier bids (and brought it up to date by an index, or did not), or when a person typed it, chose the estimate or chose the earlier price. | |||||||||||||||||||||||||||||||||||||||
edits | JSON | Every change a person made to this line, oldest first: the kind (added, edited, adjustment, spread, markup, left_out or put_back), when, who, and the line as it was before (description, quantity, unit, unit price, line total, where its price came from) — empty for a line nobody touched. A line whose amount a person changed has price_source typed; its first source is the first entry's “was”. | |||||||||||||||||||||||||||||||||||||||
is_ | true or false | The one line “Adjustment” that carries the difference between the lines and a total a person set. | |||||||||||||||||||||||||||||||||||||||
left_ | time (ISO 8601, UTC) · may be empty | When a person left the line out. A line left out is kept, counts in no total and is not on the offer; “Put back” brings it back in a new form. Empty for a line on the offer. | |||||||||||||||||||||||||||||||||||||||
left_ | reference · an id in people · may be empty | Who left the line out. | |||||||||||||||||||||||||||||||||||||||
package_ | choice · may be empty | Where the line stands in your package, as the market estimate a person chose read the request: not_in_package — the request gives its work to the buyer or to others, or the form marks no cell of its row for you to fill, so Offerium left it out (no price, in no total); firm_share — priced for your share of the work only, its supply given to others; added — work the request asks to be included that no position of the buyer's form holds; option — the request asks for the position as an option or an alternative, so it is priced in full and shown, and in no total unless a person counts it in (option_in_total); in_total — your own work, in the total as the estimate read the request, whatever the line's words say; added_in_total — an added line, in the total as the estimate read the request, whatever its words say; firm — a person put a line Offerium had left out back on the offer. Empty: your own work.one of: not_, firm_, added, option, in_, added_, firm | |||||||||||||||||||||||||||||||||||||||
package_ | JSON · may be empty | The sentence that state rests on: the request's own words (sentence) and what the reading took them as (kind: package_limit, by_others, buyer_supplies, asked_unlisted), or Offerium's rule over the buyer's form (kind marking). | |||||||||||||||||||||||||||||||||||||||
option_ | true or false | An option (package_state option) a person counted into the offer's total: it stays an option and is shown as one, and its price is in the total as well. False on every other line. | |||||||||||||||||||||||||||||||||||||||
option_ | time (ISO 8601, UTC) · may be empty | When a person last counted the option in or out of the total; empty when nobody did. | |||||||||||||||||||||||||||||||||||||||
option_ | reference · an id in people · may be empty | Who last counted the option in or out of the total. | |||||||||||||||||||||||||||||||||||||||
origin_ | choice · may be empty | For a price carried across from an earlier bid: where that number was first set (typed by a person, read from a priced form, chosen from a market estimate …). Empty when it was not carried, or this was not recorded.one of: archive, escalated, market_, typed, dropped_, contract, rate_, composed, buyer_ | |||||||||||||||||||||||||||||||||||||||
recovered_ | JSON · may be empty | For a line read from an old offer: the message, the attachment and the place in the file (page, sheet and row, or the GAEB position). | |||||||||||||||||||||||||||||||||||||||
rate_ | choice · may be empty | What kind of rate the line is, as Offerium's rules read it: labour, crew, travel, travel_time, callout, standby, service, item, surcharge, markup (material at cost), small_parts, lump_sum, rental, discount, text or unknown. Empty until the line has been read.one of: labour, crew, travel, travel_, callout, standby, service, item, surcharge, markup, small_, lump_, rental, discount, text, unknown | |||||||||||||||||||||||||||||||||||||||
labour_ | choice · may be empty | The qualification an hour is charged at (leitung, meister, vorarbeiter, techniker, monteur, helfer, azubi, facility), or trade (a trade word such as “Elektrikerstunde”) or unspecified (no level named). Empty when not read, or not an hour.one of: leitung, meister, vorarbeiter, techniker, monteur, helfer, azubi, facility, trade, unspecified | |||||||||||||||||||||||||||||||||||||||
crew | JSON · may be empty | For a crew line: each level and how many (“1 Monteur + 1 Helfer”). | |||||||||||||||||||||||||||||||||||||||
band | list of text · may be empty | The time the rate is for: an empty list is normal hours; otherwise overtime, overtime_150, overtime_200, night, saturday, sunday, holiday, weekend, emergency or difficulty. Empty (null) when it could not be told. | |||||||||||||||||||||||||||||||||||||||
includes | list of text | What the rate explicitly includes: anfahrt (travel), fahrzeit (travel time), kleinmaterial (small parts). Empty when nothing is said to be included. | |||||||||||||||||||||||||||||||||||||||
supply_ | choice · may be empty | Supply and install, supply only, install only, or removal. Empty when the line does not say.one of: supply_, supply_, install_, remove | |||||||||||||||||||||||||||||||||||||||
item_ | text · may be empty | The material class, as Offerium's index map names it (a cable, a heat pump …). | |||||||||||||||||||||||||||||||||||||||
item_ | JSON · may be empty | The item's maker, model, article number and ratings (B16, 30 mA, IP44, R32 …), as read. | |||||||||||||||||||||||||||||||||||||||
sizes | list of text | The sizes the line names (DN, mm, kW, cross-sections). | |||||||||||||||||||||||||||||||||||||||
unit_ | text · may be empty | The unit in Offerium's words (hour, half_hour, day, each, lump, m, m2, percent …); raw:… for a unit it does not know. | |||||||||||||||||||||||||||||||||||||||
unit_ | whole number | How many units one price is for (100 for “per 100 m”). | |||||||||||||||||||||||||||||||||||||||
unit_ | choice · may be empty | A period the price is per, beside the unit (month, quarter, year or visit).one of: month, quarter, year, visit | |||||||||||||||||||||||||||||||||||||||
line_ | choice · may be empty | The trade the line's own words name.one of: heating, ventilation, cooling, plumbing, electrical, alarm, automation, facility, lightning, insulation | |||||||||||||||||||||||||||||||||||||||
pct_ | whole number · may be empty | For a percentage line: the percentage in hundredths of a percent (15 % is 1500; a discount is negative). | |||||||||||||||||||||||||||||||||||||||
pct_ | choice · may be empty | What the percentage is on: labour, material, ek (purchase price), list (list price), proof (delivery note), total, or unknown.one of: labour, material, ek, list, proof, total, unknown | |||||||||||||||||||||||||||||||||||||||
class_ | text · may be empty | The identity as one canonical text, which lines are compared by; ? marks what is not known. | |||||||||||||||||||||||||||||||||||||||
class_ | whole number · may be empty | The version of the rules that read it; empty until read. | |||||||||||||||||||||||||||||||||||||||
class_ | JSON | Where each part of the identity came from: rules, structure (the file's own columns), context (the section or the job), firm_term (your firm's own words), firm_setting, or person. | |||||||||||||||||||||||||||||||||||||||
class_ | JSON | The words each part was read from, and where (the line, its long text, its unit, its section, the job). | |||||||||||||||||||||||||||||||||||||||
class_ | list of text | Why a part stayed open (for example grade:trade_word, band:context, scope:not_stated). | |||||||||||||||||||||||||||||||||||||||
section_ | text · may be empty | The headings the line stood under, as written (“02 Stundenlohnarbeiten › 02.1 Notdienst”). | |||||||||||||||||||||||||||||||||||||||
long_ | text · may be empty | The position's long text, where the file has one. | |||||||||||||||||||||||||||||||||||||||
class_ | reference · an id in people · may be empty | Who last corrected the identity. | |||||||||||||||||||||||||||||||||||||||
class_ | time (ISO 8601, UTC) · may be empty | When. | |||||||||||||||||||||||||||||||||||||||
labour_ | amount · may be empty | The labour part (Lohn) of the unit price, when it is split; the parts add up to the unit price. | |||||||||||||||||||||||||||||||||||||||
material_ | amount · may be empty | The material part (Stoff). | |||||||||||||||||||||||||||||||||||||||
equipment_ | amount · may be empty | The equipment part (Geräte). | |||||||||||||||||||||||||||||||||||||||
other_ | amount · may be empty | Any other part (Sonstiges). | |||||||||||||||||||||||||||||||||||||||
split_ | choice · may be empty | Where the split came from: the GAEB file's price components, the workbook's columns, an EFB 223 sheet, a contract, or a person.one of: gaeb_, sheet_, efb_, contract, person | |||||||||||||||||||||||||||||||||||||||
labour_ | whole number · may be empty | The time allowance per unit (EFB 223), in hundredths of a minute. | |||||||||||||||||||||||||||||||||||||||
stated_ | whole number · may be empty | A labour share as the form states it (“Lohnanteil 40 %” is 4000), in hundredths of a percent; shown, never applied. | |||||||||||||||||||||||||||||||||||||||
metal_ | JSON · may be empty | A copper or metal clause as written: the metal, the basis per 100 kg, and whether the price includes it. | |||||||||||||||||||||||||||||||||||||||
source_ | identifier · may be empty | For a rate carried across: the earlier line it came from (in priced_lines). | |||||||||||||||||||||||||||||||||||||||
decision_ | text · may be empty | Which pricing decision of the firm the number belongs to: copies of one rate share it, so the rate counts once. Empty when the line is its own decision. | |||||||||||||||||||||||||||||||||||||||
price_ | JSON · may be empty | Why the number is what it is: the step it came from (contract, rate_card, same_buyer, same_type, firm, person_pick; buyer for a term the customer wrote on its form, buyer_terms for the customer's own surcharge you recorded, surcharge_default for a country's default a person chose), the rule, its inputs, the earlier line, selling rate or contract rate it cites, any unit conversion and index steps, the rates it compared and those it left out with the reason, and how sure it is. Offerium recomputes the number from this. | |||||||||||||||||||||||||||||||||||||||
rate_ | identifier · may be empty | For a price from your selling rates: the value it came from (in rate_cards, entries). | |||||||||||||||||||||||||||||||||||||||
contract_ | identifier · may be empty | For a price from a framework contract: the contract's rate (in framework_contracts, rates). | |||||||||||||||||||||||||||||||||||||||
position | whole number | Order on the screen, lowest first. | |||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||||||||||||||||||||||||||
tax_ | rows | What a person said of the line for its tax: the part of the offer it belongs to, its kind of work, and the US facts. At most one row. Each row of tax_facts:
|
Package versions package_ versions
Each version of a bid's offer package: the price, the standard texts as used, the covering e-mail and the files. The package that went out is also under the bid's offer-as-sent/ folder, byte for byte.
Also carried here: package_files.
Files:data/data/JSON Schema
The fields (49)
| Field | Type | Meaning | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||||||||||||||||||||
bid_ | reference · an id in bids | The bid this belongs to. | |||||||||||||||||||||||||||||||||
version_ | whole number | 1 for the first version, then counting up. | |||||||||||||||||||||||||||||||||
priced_ | identifier · may be empty | The priced form it was built from. | |||||||||||||||||||||||||||||||||
offer_ | amount · may be empty | The offer's total. | |||||||||||||||||||||||||||||||||
text_ | text · may be empty | Opening text, as used. | |||||||||||||||||||||||||||||||||
text_ | text · may be empty | Exclusions, as used. | |||||||||||||||||||||||||||||||||
text_ | text · may be empty | Warranty text, as used. | |||||||||||||||||||||||||||||||||
text_ | text · may be empty | Validity text, as used. | |||||||||||||||||||||||||||||||||
text_ | text · may be empty | Payment terms, as used. | |||||||||||||||||||||||||||||||||
currency | text | ISO 4217 currency code. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | The covering e-mail's sender. | |||||||||||||||||||||||||||||||||
email_ | reference · an id in mailboxes · may be empty | The mailbox the e-mail goes out from. | |||||||||||||||||||||||||||||||||
email_ | list of text | The colleagues in copy (Cc); empty is no one. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | Its recipient. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | Its subject. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | Its text. | |||||||||||||||||||||||||||||||||
lang | choice · may be empty | The language this version's offer document and e-mail are written in: “en” English, “de” German. Empty on versions from before this was recorded, which are in the language of the firm's market.one of: en, de | |||||||||||||||||||||||||||||||||
letterhead | JSON · may be empty | The letterhead as this version printed it: the firm's name, address, officers and statements at the moment it was assembled. | |||||||||||||||||||||||||||||||||
sender_ | text · may be empty | The bid owner's name as this version printed it: “Prepared by” on the offer and the e-mail's signature. Empty when the bid had no owner. | |||||||||||||||||||||||||||||||||
sender_ | text · may be empty | Their job title, as printed beside the name. | |||||||||||||||||||||||||||||||||
text_ | JSON · may be empty | The additional sections this version printed, in order, with their headings and words. Empty on versions from before sections existed. | |||||||||||||||||||||||||||||||||
text_ | JSON · may be empty | For each standard text: which wording printed (the firm's default, the public-tender or a buyer's version), which version of it, and why. | |||||||||||||||||||||||||||||||||
valid_ | time (ISO 8601, UTC) · may be empty | The offer's “Valid until”: the day it was assembled plus the validity text's days, at the end of that day in the firm's time zone. | |||||||||||||||||||||||||||||||||
design | JSON · may be empty | The offer's design as this version printed it: layout, logo, footer, acceptance block, greeting, recipient, note, signer and signature, revision. Empty on versions from before it existed. | |||||||||||||||||||||||||||||||||
offer_ | text · may be empty | The offer number this version printed. | |||||||||||||||||||||||||||||||||
revision | whole number | 0 for the offer as first priced, then one more each time it was re-priced. | |||||||||||||||||||||||||||||||||
price_ | choice | What the buyer saw of the price in this version's offer: the lines and the total (“lines”), or the single total (“total”).one of: lines, total | |||||||||||||||||||||||||||||||||
removed_ | JSON | Files Offerium proposed that a person removed from this version, with who and when. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | When a person edited the e-mail: the subject Offerium had written. | |||||||||||||||||||||||||||||||||
email_ | text · may be empty | And the text Offerium had written. | |||||||||||||||||||||||||||||||||
email_ | reference · an id in people · may be empty | Who edited the e-mail. | |||||||||||||||||||||||||||||||||
email_ | time (ISO 8601, UTC) · may be empty | When. | |||||||||||||||||||||||||||||||||
words_ | JSON · may be empty | Which of this version's words Offerium drafted (the covering e-mail's paragraph, the opening note, the scope), each with its draft (in bids, words) and the words as printed. Empty when nothing on it was drafted. | |||||||||||||||||||||||||||||||||
price_ | JSON · may be empty | When this version's price came from a market estimate a person chose: that choice as the version froze it (in bids, price_choices), with the option, the figure, the range, the estimate's confidence, how many lines it priced, who chose and when. It was shown to the approver and never printed for the buyer. Empty when no such choice priced the version. | |||||||||||||||||||||||||||||||||
assembled_ | time (ISO 8601, UTC) | When the version was assembled. | |||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||||||||||||||||||||
tax_ | choice · may be empty | Whose tax rules decided the offer's tax: German VAT or US sales tax. Empty when the version printed the fixed rate.one of: de, us | |||||||||||||||||||||||||||||||||
tax_ | whole number · may be empty | The version of the rules that decided it. | |||||||||||||||||||||||||||||||||
tax_ | JSON · may be empty | The offer's tax as decided and frozen with the version: its parts with their rates, net, tax and gross, the notes the offer printed, and, for the firm only, the reason, the evidence and how sure it was. | |||||||||||||||||||||||||||||||||
tax_ | text · may be empty | What Offerium's rules chose, kept beside a person's choice. | |||||||||||||||||||||||||||||||||
tax_ | choice · may be empty | How sure the rules were.one of: high, medium, low | |||||||||||||||||||||||||||||||||
tax_ | JSON · may be empty | A person's choice that applied, which won over the rules'. | |||||||||||||||||||||||||||||||||
tax_ | reference · an id in people · may be empty | Who chose it. | |||||||||||||||||||||||||||||||||
tax_ | time (ISO 8601, UTC) · may be empty | When. | |||||||||||||||||||||||||||||||||
tax_ | JSON · may be empty | The facts it was decided from (the lines' words are in priced_lines). | |||||||||||||||||||||||||||||||||
tax_ | time (ISO 8601, UTC) · may be empty | When it was decided. | |||||||||||||||||||||||||||||||||
price_ | JSON · may be empty | The price terms this version's offer printed under its totals, as they stood when it was assembled: material billed at cost with its percentage, the copper clause with its base per 100 kg, and the surcharges and billing of hours from the firm's selling rates or a framework contract. A term that did not apply is left out. Empty on versions from before this was recorded and on a package without an offer. | |||||||||||||||||||||||||||||||||
files | rows | The package's files, in order. Their bytes are identified by sha256 in manifest.json. Each row of files:
|
Approvals approvals
Every approval, with a snapshot of exactly what was approved: files, e-mail, send time and total. An approval that lapsed says when and why.
Files:data/data/JSON Schema
The fields (29)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
package_ | reference · an id in package_versions | The package version approved. |
kind | choice | Approved to go out at the chosen time, or at once.one of: scheduled_, send_ |
approved_ | reference · an id in people | Who approved. |
approved_ | time (ISO 8601, UTC) | When. |
approved_ | text · may be empty | Where the approval was given (the screen or the e-mail). |
prepared_ | true or false | The same person prepared and approved it. |
snapshot_ | JSON | The files as approved: name and SHA-256 of each. |
snapshot_ | text · may be empty | The e-mail's sender, as approved. |
snapshot_ | text · may be empty | Its recipient, as approved. |
snapshot_ | text · may be empty | Its subject, as approved. |
snapshot_ | text · may be empty | Its text, as approved. |
snapshot_ | list of text | The copies (Bcc) the Sending settings asked for, as approved; empty is no copies. |
snapshot_ | choice · may be empty | The language of the offer document and the e-mail, as approved. Empty on approvals from before this was recorded (the language of the firm's market).one of: en, de |
snapshot_ | reference · an id in mailboxes · may be empty | The mailbox the bid goes out from, as approved. |
snapshot_ | list of text | The colleagues in copy (Cc), as approved; empty is no one. |
snapshot_ | time (ISO 8601, UTC) · may be empty | The send time, as approved. |
snapshot_ | amount · may be empty | The total, as approved. |
snapshot_ | text · may be empty | Its currency. |
snapshot_ | JSON | Requirements marked as not applying, with their reasons, as approved. |
snapshot_ | JSON | Documents set to be sent later rather than with the offer, with who and their note, as approved. |
snapshot_ | JSON · may be empty | Which words of the approved version Offerium drafted, as the approver saw them marked; empty when none were. |
snapshot_ | JSON | Where the approved price came from, as the approver saw it: the lines counted by source (your earlier bids, brought up to date by an index, a market estimate, typed by a person, a dropped-in form); lines a person took from a country's default surcharge (surcharge_default) or as the line's own “time and a half” / “double time” (line_multiplier) counted apart from those put together from your rates; for a market estimate also the option, the estimate's confidence and who chose it. Empty on approvals from before this was recorded. |
save_ | true or false | The approver asked for the package to be saved to the firm's drive. |
lapsed_ | time (ISO 8601, UTC) · may be empty | When the approval lapsed. |
lapse_ | choice · may be empty | Why it lapsed.one of: new_, new_, requirement_, requirement_, addendum, changes_, papers_, requirement_, requirement_, package_ |
lapse_ | text · may be empty | The lapse, in words. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Holds holds
Every time an approved bid was held back from going out, and released.
Files:data/data/JSON Schema
The fields (8)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
held_ | reference · an id in people | Who held it. |
held_ | time (ISO 8601, UTC) | When. |
note | text · may be empty | The note written with it. |
released_ | reference · an id in people · may be empty | Who released it. |
released_ | time (ISO 8601, UTC) · may be empty | When. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Sends sends
Each time an offer went out, or was due to: when, from where, to whom, and what happened.
Files:data/data/JSON Schema
The fields (25)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
approval_ | reference · an id in approvals · may be empty | The approval it went out under. |
package_ | reference · an id in package_versions · may be empty | The package version sent. |
status | choice | What happened to it.one of: scheduled, held, sent, delivered, bounced, failed, submitted_, deadline_ |
scheduled_ | time (ISO 8601, UTC) · may be empty | When it was due to go out. |
sent_ | time (ISO 8601, UTC) · may be empty | When it went out. |
from_ | text · may be empty | The address it went from. |
to_ | list of text | The addresses it went to. |
bcc_ | list of text | The addresses it went to as copies (Bcc). |
from_ | reference · an id in mailboxes · may be empty | The mailbox it went from. |
cc_ | list of text | The colleagues it went to in copy (Cc). |
rfc_ | text · may be empty | The sent message's Message-ID header. |
file_ | whole number · may be empty | How many files went with it. |
delivered_ | time (ISO 8601, UTC) · may be empty | When delivery was confirmed. |
failure_ | text · may be empty | Why it failed or bounced. |
held_ | text · may be empty | Why it was held. |
portal_ | text · may be empty | The portal's receipt number. |
portal_ | text · may be empty | The portal's receipt file. |
portal_ | time (ISO 8601, UTC) · may be empty | When it was submitted through the portal. |
portal_ | reference · an id in people · may be empty | Who marked it submitted. |
sent_ | true or false | A person sent it from the firm's own mail program and recorded it here; Offerium did not send it. |
marked_ | reference · an id in people · may be empty | Who recorded that it was sent. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Outcomes outcomes
What the buyer decided, as Offerium proposed it and as a person confirmed it.
Files:data/data/JSON Schema
The fields (24)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
proposed_ | choice · may be empty | The result Offerium read from a reply.one of: won, lost, unknown, no_, no_ |
proposed_ | time (ISO 8601, UTC) · may be empty | When it was proposed. |
proposed_ | text · may be empty | The sentence it was read from. |
proposed_ | identifier · may be empty | The message that sentence is in. |
proposal_ | time (ISO 8601, UTC) · may be empty | When a person rejected the proposal. |
confirmed_ | choice · may be empty | The result a person confirmed.one of: won, lost, unknown, no_, no_ |
confirmed_ | reference · an id in people · may be empty | Who confirmed it. |
confirmed_ | time (ISO 8601, UTC) · may be empty | When. |
source | choice · may be empty | How the result became known.one of: reply, phone, portal, follow_, silence |
winning_ | amount · may be empty | The winning price, if known. |
told_ | text · may be empty | What the buyer said, in their words. |
proposed_ | amount · may be empty | The winning price Offerium read from a reply, in the currency named there; it becomes the winning price only when a person confirms it. |
proposed_ | text · may be empty | Its currency, ISO 4217. |
proposed_ | JSON · may be empty | Where it was read: the document, the page and the sentence, verbatim. |
proposed_ | JSON · may be empty | The sentence of a reply that says why the bid was lost or won, with where it stands, as Offerium read it. |
confirmed_ | true or false | The result was recorded from explicit or strong evidence, by no person; the evidence is in the bid's outcome_evidence. A person's change clears it. |
award_ | amount · may be empty | The price the job was awarded at, when it was not the firm's own (a negotiation, an order for less). |
award_ | choice · may be empty | Read from a document, or entered by a person.one of: evidence, person |
award_ | reference · an id in people · may be empty | Who entered it, when a person did. |
award_ | time (ISO 8601, UTC) · may be empty | When. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Follow-ups follow_ ups
Questions to the buyer about a decision: when due, the draft, and when sent and answered.
Files:data/data/JSON Schema
The fields (15)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids · may be empty | The bid asked about. |
past_ | reference · an id in past_bids · may be empty | The past bid asked about. |
due_ | time (ISO 8601, UTC) | When it is due. |
to_ | text · may be empty | Who it goes to. |
draft_ | text · may be empty | The draft. |
draft_ | choice · may be empty | Where the draft's words came from: Offerium's fixed template, drafted by Offerium from the sent bid's own facts, or written or changed by a person. Empty on drafts from before this was recorded.one of: template, offerium, person |
sent_ | time (ISO 8601, UTC) · may be empty | When it was sent. |
sent_ | reference · an id in people · may be empty | Who sent it. |
answered_ | time (ISO 8601, UTC) · may be empty | When it was answered. |
hand_ | time (ISO 8601, UTC) · may be empty | When no mailbox could send it, and the draft was offered to send yourself. |
sent_ | true or false | Sent by a person from their own mail program, then marked as sent. |
from_ | reference · an id in mailboxes · may be empty | The mailbox it is asked from, when a handover moved it; empty is the mailbox the bid went from. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Timeline timeline
Each bid's timeline, as the bid page shows it: one sentence per event. Nothing in Offerium edits a line once written.
Files:data/data/JSON Schema
The fields (6)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
at | time (ISO 8601, UTC) | When it happened. |
text | text | What happened, as written at the time. |
message_ | identifier · may be empty | The message it is about. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Buyers buyers
Everyone who has asked the firm for a price, with the record of bids won and lost and what they always ask for.
Also carried here: buyer_standing_requirements, buyer_tax_facts, tax_certificates, buyer_surcharge_terms.
Files:data/data/JSON Schema
The fields (18)
| Field | Type | Meaning | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
slug | text | The buyer's short name in Offerium's web addresses. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | text | Full name. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
short_ | text | Short name, as shown in lists. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
domains | list of text | Their mail domains. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
decision_ | whole number · may be empty | Days they usually take to decide. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind | choice · may be empty | What kind of customer this is: private_person, property_manager, housing_company, commercial, industrial, public, general_contractor, facility_manager or other. Recognised by Offerium in the background, or set by a person. Empty when not determined.one of: private_, property_, housing_, commercial, industrial, public, general_, facility_, other | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind_ | choice · may be empty | How: Offerium's rules, Offerium's rules over a passage read from a document, or a person, whose choice stays.one of: rules, model_, person | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind_ | choice · may be empty | How sure the recognition is. Only a high one, or a person's choice, is used in pricing.one of: high, medium, low | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind_ | JSON · may be empty | What it was recognised from: each signal, the words and where they were. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind_ | reference · an id in people · may be empty | Who set it, when a person did. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind_ | time (ISO 8601, UTC) · may be empty | When it was last set. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
standing_ | rows | What this buyer asks for on most bids. Each row of standing_requirements:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | rows | What is known of the buyer for VAT or sales tax: its seat, VAT ID and type, whether it is a construction or cleaning business and how that became known. At most one row. Each row of tax_facts:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | rows | The certificates the buyer gave: the tax office's USt 1 TG (it provides construction work or building cleaning), a § 48b certificate, or a US exemption certificate for a state. Kept when they lapse. Each row of tax_certificates:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
surcharge_ | rows | This customer's own surcharges on the normal hour, as the firm recorded them on the customer's page: one per time, used on this customer's bids before the firm's selling rates. Every value each has had; a value is never changed in place. Each row of surcharge_terms:
|
Buyer contacts buyer_ contacts
The people at each buyer who wrote to the firm.
Files:data/data/JSON Schema
The fields (12)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
buyer_ | reference · an id in buyers | Their buyer. |
name | text | Name. |
first_ | text · may be empty | First name, as used in greetings. |
email | text | E-mail address. |
role | text · may be empty | Their role, printed under the name on offers. |
salutation | choice · may be empty | How offers greet them, as a person chose it; empty is the neutral greeting.one of: ms, mr, mx, first_, full_, frau, herr, custom |
salutation_ | text · may be empty | The name the greeting prints. |
salutation_ | text · may be empty | A greeting written out in full. |
salutation_ | reference · an id in people · may be empty | Who chose the greeting. |
salutation_ | time (ISO 8601, UTC) · may be empty | When. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Possible bids possible_ bids
Messages that might have been invitations, and what a person decided about each. One that arrived only in a person's own mailbox and never became a bid is that person's, and is left out.
Files:data/data/JSON Schema
The fields (10)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
message_ | identifier | The message. |
subject_ | text | Its subject, as shown. |
context_ | text · may be empty | Sender and date, as shown. |
uncertainty_ | text | Why Offerium was not sure. |
sorted_ | time (ISO 8601, UTC) · may be empty | When a person decided. |
sorted_ | reference · an id in people · may be empty | Who decided. |
became_ | reference · an id in bids · may be empty | The bid it became, if it did. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Past bids past_ bids
Decided bids: the ones rebuilt from your sent mail and the ones Offerium carried through, with price, result and reason.
Files:data/data/JSON Schema
The fields (41)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_ | reference · an id in buyers | The buyer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bid_ | reference · an id in bids · may be empty | The bid it corresponds to, if Offerium carried it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
project | text | The project. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sent_ | time (ISO 8601, UTC) · may be empty | When the offer went out. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sent_ | text · may be empty | When, as shown (a month, when the day is not known). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
our_ | amount · may be empty | The firm's price. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result | choice | The result.one of: won, lost, unknown, no_, no_ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
winning_ | amount · may be empty | The winning price, if known. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result_ | text · may be empty | Why, if known. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
eligible_ | true or false | Its prices may be carried into new bids. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
needs_ | true or false | A person should check what was recovered. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asked_ | time (ISO 8601, UTC) · may be empty | When the buyer was asked about the result. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_ | identifier · may be empty | The sent message it was rebuilt from. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | text · may be empty | A note on the price ("from", "about"). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recovered_ | time (ISO 8601, UTC) · may be empty | When it was rebuilt. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_ | identifier · may be empty | Set when the mail it was rebuilt from came from a person's own mailbox that was later disconnected and was deleted then; the row and its result stay. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | text · may be empty | The day the offer's prices were decided (YYYY-MM-DD): the offer's own date, else the day it was sent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
job_ | list of text · may be empty | The times the whole job ran under (emergency, sunday …), as read from its project, subject or covering mail. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
job_ | choice · may be empty | Proposed by Offerium's rules, or confirmed or rejected by a person.one of: proposed, confirmed, rejected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
job_ | JSON · may be empty | The words it was read from, and where. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
job_ | reference · an id in people · may be empty | Who confirmed or rejected it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
job_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | choice · may be empty | For a lost bid: whether it was lost on price, for another reason, or unknown.one of: price, other, unknown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | choice · may be empty | Read by Offerium's rules from the buyer's words, or set by a person.one of: rules, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | reference · an id in people · may be empty | Who set it, when a person did. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | whole number · may be empty | A discount granted on the award (“abzgl. 3 % bei Auftrag” is 300), in hundredths of a percent, as a person recorded it; shown, never applied. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | reference · an id in people · may be empty | Who recorded it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | amount · may be empty | The price the job was awarded at, when it was not the firm's own (a negotiation, an order for less). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | choice · may be empty | Read from a document, or entered by a person.one of: evidence, person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | reference · an id in people · may be empty | Who entered it, when a person did. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
award_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
framework_ | reference · an id in framework_contracts · may be empty | The framework contract the offer was priced under. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
site_ | text · may be empty | The country of the job's site (ISO 3166 alpha-2, “CH”): read from the offer where it states the site, found again in the offer's own words, or the site of the bid Offerium sent. Empty when not known, as on every offer imported before archive-15. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
position | whole number | Order on the screen, lowest first. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
benchmarks | rows | Rates others named for one of its lines — the winner's, a competitor's or the buyer's budget — with the sentence they were named in. Shown beside your own rates, never used as a price. Each row of benchmarks:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outcome_ | rows | Every piece of evidence about how the past bid ended, kept for good. Each row of outcome_evidence:
|
Framework contracts framework_ contracts
The firm's framework contracts and agreed rates with its customers: read from the documents and mails the firm already had, with each figure's quoted place, or added by a person. The customers each one covers and its rates are kept with it. Figures that could not be verified are listed under not_taken and were never used.
Also carried here: framework_contract_buyers, framework_contract_rates.
Files:data/data/JSON Schema
The fields (28)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind | choice | A framework contract (Rahmenvertrag, Wartungsvertrag with rates, Zeitvertrag), or rates agreed with one customer.one of: framework, agreed_ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | text · may be empty | Its reference, as written (“RV-2025-07”). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
title | text | Its title. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valid_ | text · may be empty | The day it applies from (YYYY-MM-DD). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valid_ | text · may be empty | The day it ends (YYYY-MM-DD); empty when it runs until notice. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notice_ | text · may be empty | Its notice terms, as written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | text · may be empty | The currency of its rates (ISO code). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
basis | choice · may be empty | Whether its rates are net or gross.one of: net, gross | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price_ | JSON · may be empty | Its price clause: none, a fixed yearly percentage, an index, renegotiation, or unknown, with its words and page. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
catalogue_ | whole number · may be empty | A mark-up or discount on catalogue prices, in hundredths of a percent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_ | whole number · may be empty | How it bills hours: per started block of this many minutes. Empty when it does not say. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
min_ | whole number · may be empty | The least it bills for a call-out, in minutes. Empty when it does not say. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
origin | choice | Read from a document, read from a mail, added by a person, or saved from the firm's own agreeing offers.one of: document, mail, person, observations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source_ | JSON · may be empty | The file it was read from: its name, and the message and attachment it came with. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quotes | JSON | Where each of its own facts was found: the words and the page, sheet or row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
not_ | JSON | Figures it states that could not be verified at their place, each with the words and the reason. Never used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | choice | active (its rates apply to the bids linked to it, inside its validity), not_applied (it could not be read safely; never applied) or ended (by a person).one of: active, not_, ended | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
not_ | text · may be empty | Why it does not apply, when it does not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ended_ | time (ISO 8601, UTC) · may be empty | When a person ended it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ended_ | reference · an id in people · may be empty | Who ended it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | reference · an id in people · may be empty | Who added it, when a person did. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changed_ | reference · an id in people · may be empty | Who last corrected it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changed_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyers | rows | The customers it covers. Each row of buyers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rates | rows | Its rates, each with its identity and its quoted place, including those a later correction replaced (superseded_at). Each row of rates:
|
Company documents company_ documents
Certificates, licences and other documents the firm keeps for bids, every version. The files are under documents/.
Also carried here: company_document_versions.
Files:data/data/JSON Schema
The fields (32)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | text | The document's name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind | text | What kind of document. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filename | text · may be empty | The file's name as received. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachment_ | identifier · may be empty | The message attachment it came from. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source | choice | How it came in (upload_link: sent by its issuer through a single-use upload link, checked and accepted by a person).one of: uploaded, forwarded_, old_, past_, upload_ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | choice | In use, asked for from its holder, or archived.one of: active, requested, archived | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valid_ | time (ISO 8601, UTC) · may be empty | Valid until. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
has_ | true or false | It does not expire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
detail_ | text · may be empty | Detail shown with it (a policy number, a scope). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
superseded_ | reference · an id in company_documents · may be empty | The newer version that replaced it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uploaded_ | reference · an id in people · may be empty | Who added it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
holder_ | reference · an id in buyers · may be empty | The buyer who holds or issues it, when it is theirs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keeper_ | reference · an id in people · may be empty | Who at the firm looks after it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requested_ | time (ISO 8601, UTC) · may be empty | When a new copy was asked for. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requested_ | reference · an id in people · may be empty | Who asked for it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requested_ | choice · may be empty | How it was asked for: an e-mail to the broker, the issuer's own instructions, or an upload link.one of: broker_, issuer_, upload_ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuer_ | text · may be empty | Who issues it (a broker, an office). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
issuer_ | text · may be empty | The issuer's e-mail address, as given. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminder_ | JSON · may be empty | A reminder plan a person set for it: days before expiry, and when the owner is told too. Empty: the catalogue's plan for its kind. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reminders_ | true or false | Reminders are sent for it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
archived_ | time (ISO 8601, UTC) · may be empty | When it was archived. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
archived_ | reference · an id in people · may be empty | Who archived it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
number | text · may be empty | Its number (a licence or policy number). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jurisdiction | text · may be empty | Where it applies. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
board | text · may be empty | The body that issued it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
print_ | true or false | Printed on every offer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
position | whole number | Order on the screen, lowest first. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sha256 | text · may be empty | SHA-256 of the current file, lowercase hex: the fingerprint under documents/ and in manifest.json. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
versions | rows | Every version of the document, oldest first. Each file is under documents/. Each row of versions:
|
Approved references approved_ references
Past projects the firm allows Offerium to name as references.
Files:data/data/JSON Schema
The fields (11)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
past_ | reference · an id in past_bids | The past bid. |
buyer_ | reference · an id in buyers · may be empty | Only for this buyer, when set. |
label | text | The reference, as printed. |
show_ | true or false | The contract value may be printed with it. |
contact_ | true or false | The buyer's contact may be named. |
trade_ | choice · may be empty | The trade it counts as a reference for.one of: hvac_, electrical, fire_, facility_, maintenance, engineering_, other |
added_ | reference · an id in people · may be empty | Who added it. |
added_ | time (ISO 8601, UTC) · may be empty | When. |
position | whole number | Order on the screen, lowest first. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Standard texts standard_ texts
The texts every offer uses: opening, exclusions, warranty, validity, payment; with their versions for public tenders and for single buyers, and every wording each has had.
Also carried here: standard_text_versions.
Files:data/data/JSON Schema
The fields (19)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||
key | choice | Which text.one of: preamble, exclusions, warranty, validity, payment | ||||||||||||||||||||||||||||||||||||||||||
variant_ | choice | The firm's own text, its version for public tenders, or its version for one buyer.one of: default, public_, buyer | ||||||||||||||||||||||||||||||||||||||||||
buyer_ | reference · an id in buyers · may be empty | The buyer a buyer's version is for. | ||||||||||||||||||||||||||||||||||||||||||
name | text | Its name, as shown. | ||||||||||||||||||||||||||||||||||||||||||
text | text | The text now. | ||||||||||||||||||||||||||||||||||||||||||
leave_ | true or false | Left out of offers. | ||||||||||||||||||||||||||||||||||||||||||
validity_ | whole number · may be empty | For the validity text: the number of days it states, from which “Valid until” is worked out. | ||||||||||||||||||||||||||||||||||||||||||
buyer_ | text · may be empty | The sentence the offer prints when a buyer's documents set their own terms and the firm keeps its own. | ||||||||||||||||||||||||||||||||||||||||||
reviewed_ | time (ISO 8601, UTC) · may be empty | When a person marked it as reviewed. | ||||||||||||||||||||||||||||||||||||||||||
reviewed_ | reference · an id in people · may be empty | Who marked it. | ||||||||||||||||||||||||||||||||||||||||||
guardrail_ | JSON | Questions Offerium asked about the wording that a person answered “Keep as is”, for which version, by whom and when. | ||||||||||||||||||||||||||||||||||||||||||
removed_ | time (ISO 8601, UTC) · may be empty | When a version for public tenders or a buyer was removed. | ||||||||||||||||||||||||||||||||||||||||||
removed_ | reference · an id in people · may be empty | Who removed it. | ||||||||||||||||||||||||||||||||||||||||||
updated_ | reference · an id in people · may be empty | Who last changed it. | ||||||||||||||||||||||||||||||||||||||||||
position | whole number | Order on the screen, lowest first. | ||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||
versions | rows | Every wording it has had, oldest first; the last is the one in use. Each row of versions:
|
Standard text history standard_ text_ history
Every change to a standard text, before and after, from the activity record.
Read from the activity record.
Files:data/data/JSON Schema
The fields (7)
| Field | Type | Meaning |
|---|---|---|
id | identifier | The activity record entry's identifier. |
standard_ | reference · an id in standard_texts | The text changed. |
key | text · may be empty | Which text. |
previous_ | text · may be empty | The text before. |
text | text · may be empty | The text after. |
changed_ | reference · an id in people · may be empty | Who changed it. |
changed_ | time (ISO 8601, UTC) | When. |
Additional sections offer_ sections
The firm's own sections beyond the five standard texts (about us, clarifications, a schedule, a closing), their versions for public tenders and single buyers, and every wording each has had.
Files:data/data/JSON Schema
The fields (19)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||
variant_ | reference · an id in offer_sections · may be empty | For a version: the section it is a version of. | ||||||||||||||||||||||||||||||||||||||||||
variant_ | choice | The section itself, its version for public tenders, or its version for one buyer.one of: default, public_, buyer | ||||||||||||||||||||||||||||||||||||||||||
buyer_ | reference · an id in buyers · may be empty | The buyer a buyer's version is for. | ||||||||||||||||||||||||||||||||||||||||||
heading | text | Its heading, as printed. | ||||||||||||||||||||||||||||||||||||||||||
text | text | Its words now. | ||||||||||||||||||||||||||||||||||||||||||
kind | choice | Words, or a table (its words are then the lead-in).one of: text, table | ||||||||||||||||||||||||||||||||||||||||||
table | JSON · may be empty | A table section's column headings and rows. | ||||||||||||||||||||||||||||||||||||||||||
slot | choice | Where in the offer it prints.one of: about_, clarifications, schedule, closing | ||||||||||||||||||||||||||||||||||||||||||
include_ | choice | When it is included: always, when ticked on the bid, in public tenders only, or in private bids only.one of: always, when_, public_, private_ | ||||||||||||||||||||||||||||||||||||||||||
position | whole number | Order on the screen, lowest first. | ||||||||||||||||||||||||||||||||||||||||||
leave_ | true or false | Left out of offers. | ||||||||||||||||||||||||||||||||||||||||||
guardrail_ | JSON | Questions Offerium asked about the wording that a person answered “Keep as is”. | ||||||||||||||||||||||||||||||||||||||||||
archived_ | time (ISO 8601, UTC) · may be empty | When it was removed. | ||||||||||||||||||||||||||||||||||||||||||
archived_ | reference · an id in people · may be empty | Who removed it. | ||||||||||||||||||||||||||||||||||||||||||
updated_ | reference · an id in people · may be empty | Who last changed it. | ||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||
versions | rows | Every wording it has had, oldest first; the last is the one in use. Each row of versions:
|
Company profile company_ profile
One row: the firm as its letterhead prints it: legal name and form, register, officers, tax numbers, bank, address and logo. The logo file is under documents/. With it, the firm's own closed days and public-holiday choices (Region & formats), its Sending choices, its own pricing figures and the writing style Offerium learnt from its sent mail.
Also carried here: company_officers, company_closures, company_holiday_overrides, sending_settings, offer_number_sequences, company_pricing, tone_profiles, firm_rate_terms, company_tax_settings, company_tax_registrations.
Files:data/data/JSON Schema
The fields (58)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
legal_ | choice · may be empty | Legal form.one of: gmbh, ug, gmbh_, kg, ohg, ek, ag, einzelunternehmen, gbr, llc, corporation, partnership, sole_, other | ||||||||||||||||||||||||||||||||||||||||||||||||
registered_ | text · may be empty | The registered name. | ||||||||||||||||||||||||||||||||||||||||||||||||
dba | text · may be empty | The name traded under, when different. | ||||||||||||||||||||||||||||||||||||||||||||||||
seat | text · may be empty | Registered seat. | ||||||||||||||||||||||||||||||||||||||||||||||||
register_ | text · may be empty | Register court. | ||||||||||||||||||||||||||||||||||||||||||||||||
register_ | text · may be empty | Register number. | ||||||||||||||||||||||||||||||||||||||||||||||||
has_ | true or false | The firm has a supervisory board. | ||||||||||||||||||||||||||||||||||||||||||||||||
supervisory_ | text · may be empty | Chair of the supervisory board. | ||||||||||||||||||||||||||||||||||||||||||||||||
general_ | text · may be empty | General partner (a GmbH & Co. KG's GmbH). | ||||||||||||||||||||||||||||||||||||||||||||||||
general_ | text · may be empty | Its seat. | ||||||||||||||||||||||||||||||||||||||||||||||||
general_ | text · may be empty | Its register court. | ||||||||||||||||||||||||||||||||||||||||||||||||
general_ | text · may be empty | Its register number. | ||||||||||||||||||||||||||||||||||||||||||||||||
legal_ | text · may be empty | Further statements printed at the foot. | ||||||||||||||||||||||||||||||||||||||||||||||||
vat_ | text · may be empty | VAT identification number. | ||||||||||||||||||||||||||||||||||||||||||||||||
vat_ | text · may be empty | The number as last checked. | ||||||||||||||||||||||||||||||||||||||||||||||||
vat_ | time (ISO 8601, UTC) · may be empty | When it was checked. | ||||||||||||||||||||||||||||||||||||||||||||||||
vat_ | choice · may be empty | What the check said.one of: valid, invalid, unavailable | ||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text · may be empty | Tax number. | ||||||||||||||||||||||||||||||||||||||||||||||||
print_ | true or false | Printed on offers. | ||||||||||||||||||||||||||||||||||||||||||||||||
ein | text · may be empty | US Employer Identification Number. | ||||||||||||||||||||||||||||||||||||||||||||||||
iban | text · may be empty | IBAN printed on offers. | ||||||||||||||||||||||||||||||||||||||||||||||||
bic | text · may be empty | BIC. | ||||||||||||||||||||||||||||||||||||||||||||||||
bank_ | text · may be empty | Bank. | ||||||||||||||||||||||||||||||||||||||||||||||||
print_ | true or false | Bank details printed on offers. | ||||||||||||||||||||||||||||||||||||||||||||||||
street | text · may be empty | Street. | ||||||||||||||||||||||||||||||||||||||||||||||||
postcode | text · may be empty | Postal code. | ||||||||||||||||||||||||||||||||||||||||||||||||
city | text · may be empty | City. | ||||||||||||||||||||||||||||||||||||||||||||||||
region | text · may be empty | State or region. | ||||||||||||||||||||||||||||||||||||||||||||||||
country | text · may be empty | Country, ISO 3166 code. | ||||||||||||||||||||||||||||||||||||||||||||||||
phone | text · may be empty | Phone. | ||||||||||||||||||||||||||||||||||||||||||||||||
public_ | text · may be empty | E-mail printed on offers. | ||||||||||||||||||||||||||||||||||||||||||||||||
website | text · may be empty | Website. | ||||||||||||||||||||||||||||||||||||||||||||||||
no_ | true or false | The letterhead has no logo on purpose. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | text · may be empty | The logo's media type. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | whole number · may be empty | Logo width in pixels. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | whole number · may be empty | Logo height in pixels. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | JSON · may be empty | How the logo is cropped on the letterhead. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | reference · an id in people · may be empty | Who added the logo. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | time (ISO 8601, UTC) · may be empty | When. | ||||||||||||||||||||||||||||||||||||||||||||||||
logo_ | text · may be empty | SHA-256 of the logo file. | ||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | choice | The firm's default offer layout.one of: classic, modern, proposal | ||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | text · may be empty | The prefix of the offer numbers; empty uses the firm's initials. | ||||||||||||||||||||||||||||||||||||||||||||||||
confidential_ | true or false | Offers print “Confidential offer” and the page numbers in the footer. | ||||||||||||||||||||||||||||||||||||||||||||||||
acceptance_ | true or false | Offers for private work print the acceptance and signature block. | ||||||||||||||||||||||||||||||||||||||||||||||||
prepared_ | true or false | Offers print “Prepared with Offerium” in the footer. | ||||||||||||||||||||||||||||||||||||||||||||||||
offer_ | rows | Per year, the running number the next offer takes. Each row of offer_numbers:
| ||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | reference · an id in people · may be empty | Who last changed it. | ||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||
officers | rows | The people who represent the firm, as the letterhead names them. Each row of officers:
| ||||||||||||||||||||||||||||||||||||||||||||||||
closures | rows | Days the firm is closed (company holidays), on which no bid goes out. Each row of closures:
| ||||||||||||||||||||||||||||||||||||||||||||||||
holiday_ | rows | Public holidays on which the firm chose to be open, or closed, against its region's calendar. Each row of holiday_overrides:
| ||||||||||||||||||||||||||||||||||||||||||||||||
sending | rows | The Sending page's choices: when bids go out, who signs the covering e-mail, and the copies. None until someone changes them. Each row of sending:
| ||||||||||||||||||||||||||||||||||||||||||||||||
pricing | rows | The firm's own pricing figures, once someone saves them: labour rates per role, the minimum margin a market estimate's lowest option keeps above the cost, and whether earlier prices older than twelve months are brought up to date by an official price index. None until someone saves them. Each row of pricing:
| ||||||||||||||||||||||||||||||||||||||||||||||||
tone | rows | The writing style Offerium learnt from the firm's own sent mail, which its drafts are written in: how formal, the greetings and sign-offs, the sentence length, and short phrases the firm prefers or avoids, each one found in the firm's own mail. No whole message is kept. None until it has been learnt. Each row of tone:
| ||||||||||||||||||||||||||||||||||||||||||||||||
rate_ | rows | The firm's own words for its rates, which a person asked Offerium to remember (“KD-Techniker” is a monteur): Offerium reads them before its own word lists. Each row of rate_terms:
| ||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | rows | The firm's own tax settings: whether it charges no VAT as a small business (§ 19 UStG), and two US state facts. At most one row. Each row of tax_settings:
| ||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | rows | The firm's VAT or sales-tax registrations and establishments outside its seat (an Austrian UID, a Swiss MWST number, a US state permit). Each row of tax_registrations:
|
Selling rates rate_ cards
The firm's own selling rates: one list for every customer and, where kept, one per kind of customer, with every value each has had. Values are taken from the firm's own offers in the background or set by a person, whose value wins; a value is never changed in place, so a line priced from one can be checked against it.
Also carried here: rate_card_entries.
Files:data/data/JSON Schema
The fields (14)
| Field | Type | Meaning | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_ | choice · may be empty | The kind of customer the list is for; empty for every customer.one of: private_, property_, housing_, commercial, industrial, public, general_, facility_, other | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location | text · may be empty | The country whose jobs the list prices (ISO 3166 alpha-2, “AT”); empty is the firm's home country. A job in another country never takes the home list's plain rates. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | text · may be empty | The currency the list's amounts are in (ISO 4217), where it is not the firm's own; empty is the firm's. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | text · may be empty | Its name, when a person gave one. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unspecified_ | choice · may be empty | What an hour with no level, or a trade word, counts as; empty when Offerium asks each time.one of: leitung, meister, vorarbeiter, techniker, monteur, helfer, azubi, facility, trade, unspecified | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
combine_ | choice | When a line falls under two surcharged times the list states one by one: the highest, both added, or ask.one of: highest, additive, ask | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
aw_ | whole number · may be empty | Minutes per Arbeitswert (AW), when the firm bills so. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
copper | JSON · may be empty | Whether cable prices carry a copper clause, and its basis per 100 kg. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
settings_ | reference · an id in people · may be empty | Who last changed these settings. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
settings_ | time (ISO 8601, UTC) · may be empty | When. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
entries | rows | Every value, current and earlier. Each row of entries:
|
People people
Everyone at the firm in Offerium, including people removed, with what they may do and the terms they accepted. How anyone signs in is never exported, nor each person's own choices of what reaches them and when.
Also carried here: terms_acceptances.
Files:data/data/JSON Schema
The fields (20)
| Field | Type | Meaning | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||
name | text | Full name. | |||||||||||||||
first_ | text | First name, as used in greetings. | |||||||||||||||
email | text | E-mail address. | |||||||||||||||
job_ | text · may be empty | Job title, as printed on offers. | |||||||||||||||
direct_ | text · may be empty | Direct phone number. | |||||||||||||||
is_ | true or false | The account's owner. | |||||||||||||||
can_ | true or false | May approve bids. | |||||||||||||||
invited_ | time (ISO 8601, UTC) · may be empty | When they were invited. | |||||||||||||||
joined_ | time (ISO 8601, UTC) · may be empty | When they first signed in. | |||||||||||||||
removed_ | time (ISO 8601, UTC) · may be empty | When they were removed. | |||||||||||||||
removed_ | reference · an id in people · may be empty | Who removed them. | |||||||||||||||
signature_ | text · may be empty | Their signature image's media type, if they added one for the offers they sign. | |||||||||||||||
signature_ | whole number · may be empty | Its width in pixels. | |||||||||||||||
signature_ | whole number · may be empty | Its height in pixels. | |||||||||||||||
signature_ | time (ISO 8601, UTC) · may be empty | When they added it. | |||||||||||||||
signature_ | text · may be empty | SHA-256 of the signature image file. | |||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | |||||||||||||||
terms_ | rows | The terms and data processing agreement they accepted for the firm. Each row of terms_accepted:
|
Mailboxes mailboxes
The mailboxes Offerium reads or suggested, by address and kind only. The keys Offerium held for them are never exported.
Files:data/data/JSON Schema
The fields (7)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
address | text | The address. |
kind | choice | Shared, or one person's own; an earlier third kind is no longer created.one of: shared, personal, forwarded |
owner_ | reference · an id in people · may be empty | Whose own mailbox it is, for a personal one. |
is_ | true or false | Offers go out from it. |
connected_ | time (ISO 8601, UTC) · may be empty | When it was connected. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Calendar events calendar_ events
Deadlines and site walks on the Bids calendar. The same events are in calendar/bids.ics.
Files:data/data/JSON Schema
The fields (14)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
kind | choice | A bid's deadline, or someone's attendance (a site walk).one of: bid, attendance |
title | text | The event's title. |
description | text · may be empty | Its description. |
starts_ | time (ISO 8601, UTC) | Start. |
ends_ | time (ISO 8601, UTC) · may be empty | End. |
all_ | true or false | An all-day event. |
invitee_ | reference · an id in people · may be empty | Who is invited. |
provider_ | text · may be empty | The event's identifier in the firm's own calendar. |
last_ | time (ISO 8601, UTC) · may be empty | When it was last written to that calendar. |
deleted_ | time (ISO 8601, UTC) · may be empty | When it was removed. |
created_ | time (ISO 8601, UTC) | When the row was written. |
updated_ | time (ISO 8601, UTC) | When the row last changed. |
Drive choices drive_ choices
Where approvers chose to save approved packages in the firm's own drive, and each save made there with the files it wrote.
Also carried here: drive_saves, drive_save_files.
Files:data/data/JSON Schema
The fields (16)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bid_ | reference · an id in bids · may be empty | For this bid only, when set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scope | choice | This bid, every bid from then on, or ask at each approval.one of: this_, every_, ask | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider | choice · may be empty | Where the folder is: Google Drive, SharePoint or OneDrive.one of: google_, sharepoint, onedrive | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
web_ | text · may be empty | The folder's web address at the provider. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
folder_ | text | The folder, as shown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider_ | text · may be empty | The folder's identifier in the firm's drive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_ | true or false | A shared drive. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
chosen_ | reference · an id in people | Who chose it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
chosen_ | time (ISO 8601, UTC) | When. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stopped_ | time (ISO 8601, UTC) · may be empty | When saving there stopped. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stopped_ | reference · an id in people · may be empty | Who stopped it. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_ | time (ISO 8601, UTC) · may be empty | When a bid was last saved there. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
saves | rows | Each approved bid saved to this folder, with the files it wrote. Each row of saves:
|
Invoices from Offerium invoices
Offerium's invoices to the firm, with the bids each one counted, the reminders sent about it and any credit note that corrected it. The PDFs (and e-invoices) of both are under billing/invoices/<year>/. German law has you keep them eight years (§ 14b UStG).
Also carried here: invoice_bids, dunning_notices, credit_notes.
Files:data/data/JSON Schema
The fields (42)
| Field | Type | Meaning | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | identifier | Offerium's identifier for this row. | |||||||||||||||||||||||||||||||||||||||
number | text | Invoice number. | |||||||||||||||||||||||||||||||||||||||
status | text | Paid, open, void or uncollectible. | |||||||||||||||||||||||||||||||||||||||
kind | text | A plan invoice, a change of plan, bids beyond the plan, an Enterprise agreement, or one issued by hand. | |||||||||||||||||||||||||||||||||||||||
plan | choice · may be empty | The plan billed.one of: desk, growth, enterprise | |||||||||||||||||||||||||||||||||||||||
billing_ | choice · may be empty | Monthly or annual.one of: monthly, annual | |||||||||||||||||||||||||||||||||||||||
period_ | time (ISO 8601, UTC) · may be empty | Start of the period billed. | |||||||||||||||||||||||||||||||||||||||
period_ | time (ISO 8601, UTC) · may be empty | End of the period billed. | |||||||||||||||||||||||||||||||||||||||
collection_ | text | Charged automatically, or sent for payment by transfer. | |||||||||||||||||||||||||||||||||||||||
currency | text | ISO 4217 currency code. | |||||||||||||||||||||||||||||||||||||||
subtotal | amount | Net amount, after any discount: what the tax is charged on. | |||||||||||||||||||||||||||||||||||||||
discount | amount | Discount taken off the lines before tax (a promotion code); 0 without one. | |||||||||||||||||||||||||||||||||||||||
tax | amount | Tax. | |||||||||||||||||||||||||||||||||||||||
total | amount | Total, tax included. | |||||||||||||||||||||||||||||||||||||||
amount_ | amount | Amount due. | |||||||||||||||||||||||||||||||||||||||
amount_ | amount | Amount paid. | |||||||||||||||||||||||||||||||||||||||
tax_ | whole number · may be empty | Tax rate in hundredths of a percent (1900 = 19 %). | |||||||||||||||||||||||||||||||||||||||
taxability_ | text · may be empty | Why tax was or was not charged (reverse charge, for example). | |||||||||||||||||||||||||||||||||||||||
po_ | text · may be empty | Your purchase order number, as printed. | |||||||||||||||||||||||||||||||||||||||
due_ | time (ISO 8601, UTC) · may be empty | Due date. | |||||||||||||||||||||||||||||||||||||||
finalized_ | time (ISO 8601, UTC) | Date of issue. | |||||||||||||||||||||||||||||||||||||||
paid_ | time (ISO 8601, UTC) · may be empty | When it was paid. | |||||||||||||||||||||||||||||||||||||||
voided_ | time (ISO 8601, UTC) · may be empty | When it was voided. | |||||||||||||||||||||||||||||||||||||||
attempt_ | whole number | Payment attempts. | |||||||||||||||||||||||||||||||||||||||
next_ | time (ISO 8601, UTC) · may be empty | The next payment attempt. | |||||||||||||||||||||||||||||||||||||||
first_ | time (ISO 8601, UTC) · may be empty | When a payment first failed. | |||||||||||||||||||||||||||||||||||||||
last_ | time (ISO 8601, UTC) · may be empty | When a payment last failed. | |||||||||||||||||||||||||||||||||||||||
failure_ | text · may be empty | Why the payment failed, as a key. | |||||||||||||||||||||||||||||||||||||||
credited_ | amount | Amount credited back. | |||||||||||||||||||||||||||||||||||||||
credit_ | text · may be empty | The credit note's number. | |||||||||||||||||||||||||||||||||||||||
format | choice | PDF, ZUGFeRD (a PDF carrying the invoice data) or XRechnung (XML).one of: pdf, zugferd, xrechnung | |||||||||||||||||||||||||||||||||||||||
einvoice_ | time (ISO 8601, UTC) · may be empty | When the e-invoice passed validation. | |||||||||||||||||||||||||||||||||||||||
eur_ | text · may be empty | When an invoice in another currency charges German VAT: the euro reference rate its VAT is also stated in euros at (1 EUR = this many units of its currency). Its credit notes use the same rate. | |||||||||||||||||||||||||||||||||||||||
eur_ | text · may be empty | The day of that rate (YYYY-MM-DD). | |||||||||||||||||||||||||||||||||||||||
eur_ | choice · may be empty | Where that rate is from: ecb, the European Central Bank.one of: ecb | |||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | |||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | |||||||||||||||||||||||||||||||||||||||
sha256 | text · may be empty | SHA-256 of the PDF. | |||||||||||||||||||||||||||||||||||||||
einvoice_ | text · may be empty | SHA-256 of the e-invoice file, when there is a separate one. | |||||||||||||||||||||||||||||||||||||||
bids | rows | The bids this invoice counted: within the allowance, or charged as overage. Each row of bids:
| |||||||||||||||||||||||||||||||||||||||
reminders | rows | Reminders Offerium sent about this invoice. Each row of reminders:
| |||||||||||||||||||||||||||||||||||||||
credit_ | rows | Credit notes against this invoice: invoice corrections, such as a refund under the 30-day money-back guarantee. Each one's file is under billing/invoices/<year>/ beside the invoice's. Each row of credit_notes:
|
Billing details billing_ details
One row: the address and tax number Offerium's invoices carry, how they are delivered and paid, who receives them, an Enterprise contract where there is one, and each “Research deeper” run, included or charged. A card's number is never held by Offerium; only its brand and last four digits.
Also carried here: billing_contacts, enterprise_contracts, research_charges.
Files:data/data/JSON Schema
The fields (33)
| Field | Type | Meaning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
legal_ | text · may be empty | The name invoices are made out to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_ | true or false | The billing address differs from the letterhead's. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_ | text · may be empty | Address, first line. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_ | text · may be empty | Address, second line. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
postal_ | text · may be empty | Postal code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
city | text · may be empty | City. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | text · may be empty | State or region. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
country | text · may be empty | Country, ISO 3166 code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text · may be empty | Which tax number (EU VAT, US EIN …). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text · may be empty | The tax number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text · may be empty | What the tax authority's check said. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | time (ISO 8601, UTC) · may be empty | When it was checked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text · may be empty | The name the check returned. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tax_ | text | Taxed normally, exempt, or reverse charge. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
po_ | text · may be empty | Purchase order number printed on invoices. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_ | choice | The invoice format chosen.one of: pdf, zugferd, xrechnung | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
alert_ | true or false | Tell us near the plan's allowance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
alert_ | true or false | Tell us at the plan's allowance. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
ask_ | true or false | Ask before a bid is charged as overage. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | text · may be empty | Card, SEPA direct debit, PayPal or transfer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | text · may be empty | The card's brand. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | text · may be empty | The wallet used (Apple Pay, Google Pay), if any. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | text · may be empty | The last four digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | whole number · may be empty | Card expiry month. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | whole number · may be empty | Card expiry year. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_ | text · may be empty | The payment method's country. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
sepa_ | text · may be empty | The SEPA mandate's reference. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | reference · an id in people · may be empty | Who last changed them. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_ | time (ISO 8601, UTC) | When the row was written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_ | time (ISO 8601, UTC) | When the row last changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
contacts | rows | Who receives invoices, payment notices and usage alerts. Each row of contacts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
contracts | rows | An Enterprise contract's terms, where there is one. Each row of contracts:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
research_ | rows | Each “Research deeper” run, one row each: included in the plan's runs for its month, or charged, and on which invoice. Each row of research_charges:
|
Overage charges overage_ charges
Bids charged beyond the plan's allowance.
Files:data/data/JSON Schema
The fields (6)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
bid_ | reference · an id in bids | The bid this belongs to. |
amount | amount | Amount charged. |
currency | text | ISO 4217 currency code. |
payment_ | text | The line's reference at Offerium's payment provider. |
created_ | time (ISO 8601, UTC) | When the row was written. |
Activity record audit_ log
The record B.21 promises: approvals and holds, changes, exports, people added and removed, connections, hand-overs and deletions, with Offerium's own steps. Append-only. What is about one person rather than the firm's work — how they sign in, their sessions, the pages they opened, their e-mail choices — is left out, as the Activity page leaves it out. So is what Offerium recorded about mail that arrived only in a person's own mailbox and never became a bid.
Files:data/data/JSON Schema
The fields (7)
| Field | Type | Meaning |
|---|---|---|
id | identifier | Offerium's identifier for this row. |
at | time (ISO 8601, UTC) | When. |
action | text | What happened, as a key ("export.prepared"). |
subject | text | The identifier of the thing it happened to. |
actor_ | reference · an id in people · may be empty | Who did it. |
actor_ | text · may be empty | How it was done, when not by a person (a job, the reader). |
detail | JSON · may be empty | What changed, as recorded. |
How the files are written
- One ZIP
- One ZIP file with one top folder, offerium-<firm>-<date>/. Above 4 GB it is ZIP64, which every current system opens. Files that are already compressed (PDF, images, Office files) are stored as they are.
- Text
- UTF-8 everywhere. File names are Unicode NFC; characters Windows cannot hold in a name (< > : " / \ | ? *) are replaced by an underscore.
- CSV
- RFC 4180 with a byte-order mark and CRLF line ends, so Excel opens it directly. The separator is a comma in a US archive and a semicolon in a German one, and amounts use the market's decimal mark. A cell that begins with = + - @ is prefixed with an apostrophe so no spreadsheet runs it as a formula. The first row names the fields.
- JSON
- RFC 8259: an array of objects, one row per line, with the same fields as the CSV. Amounts are whole numbers in the currency's minor unit (cents); times are ISO 8601 in UTC; empty values are null.
- Identifiers
- Every row has an id; a field ending in _id holds the id of a row in another entity, so the files join without Offerium.
- Checking a file
- manifest.json lists every file with its SHA-256. Check one with sha256sum <file> (macOS: shasum -a 256, Windows: Get-FileHash). A copied document's hash is the one Offerium held for it from the day it arrived.
Never in an export
Some things Offerium holds are never exported, and each for a reason:
- Sign-ins, sessions, mailbox keys and device keys: a door, not a record, and useful only to an attacker. account, session, user, verificationToken, authenticator, mailbox_grants, tenant_grants, sign_in_codes, session_handoffs, push_subscriptions, imap_credentials, storage_grants, calendar_subscriptions, admin_requests, document_upload_links, admin_request_mailboxes, invitations
- Offerium's own machinery (queues, alerts, rate counters, payment-provider events, notification deliveries): about Offerium, not about the firm. jobs, ops_alerts, worker_heartbeats, rate_limits, payment_events, notification_deliveries, billing_deliveries, market_refresh_runs, market_research_runs
- Not the firm's: kept before anyone belonged to a firm. mail_domain_lookups, early_access_requests, signup_invitations, provider_waitlist, seller_invoices, price_indices, free_bid_claims, guarantee_claims, signup_reviews, erased_forwarding_addresses, market_facts, ted_notices
- Who opened what, per person: a security record about individual people, not part of the firm's bids. access_log
- The exports themselves; the activity record lists each one. data_exports, data_export_parts, data_export_entries
- Mail Offerium checked and left alone was never kept, so it cannot be exported. Other firms' data is never in your export.
Where Offerium’s other records go
Every other table Offerium keeps for a firm, and where its contents are in an archive:
stored_files - as files · Every file Offerium kept, as the file itself; its SHA-256 is in manifest.json.
attachments- as files · Attachments as received, under each bid's tender/ folder and inside its rebuilt messages.
messages- as files · The kept bid messages, rebuilt as .eml files under each bid's mail/ folder, with their Message-ID and the Message-IDs of the messages they answer (in_reply_to, reference_ids) as In-Reply-To and References headers.
bid_tax_ facts - in bids · In bids (tax_facts).
line_tax_ facts - in priced_lines · In priced_lines (tax_facts).
buyer_tax_ facts - in buyers · In buyers (tax_facts).
buyer_surcharge_ terms - in buyers · In buyers (surcharge_terms).
tax_certificates - in buyers · In buyers (tax_certificates).
outcome_evidence - in bids · In bids (outcome_evidence) and past_bids (outcome_evidence).
company_tax_ settings - in company_profile · In company_profile (tax_settings).
company_tax_ registrations - in company_profile · In company_profile (tax_registrations).
package_files - in package_versions · In package_versions (files), and as files under offer-as-sent/.
priced_forms - in priced_lines · On each priced line (form_*).
extracted_facts - in bids · In bids (facts).
addenda- in bids · In bids (addenda).
approval_requests - in bids · In bids (approval_requests).
client_form_ lines - in bids · In bids (client_form_lines).
buyer_standing_ requirements - in buyers · In buyers (standing_requirements).
terms_acceptances - in people · In people (terms_accepted).
company_document_ versions - in company_documents · In company_documents (versions), and each version's file under documents/.
company_profiles - in company_profile · In company_profile.
company_officers - in company_profile · In company_profile (officers).
company_closures - in company_profile · In company_profile (closures).
company_holiday_ overrides - in company_profile · In company_profile (holiday_overrides).
sending_settings - in company_profile · In company_profile (sending).
drive_saves - in drive_choices · In drive_choices (saves).
drive_save_ files - in drive_choices · In drive_choices (saves, files).
invoice_bids - in invoices · In invoices (bids).
dunning_notices - in invoices · In invoices (reminders).
credit_notes - in invoices · In invoices (credit_notes), and each one's file under billing/invoices/<year>/.
line_comparables - in bids · In bids (comparables).
bid_readings - in bids · In bids (readings).
offer_word_ drafts - in bids · In bids (words).
price_estimates - in bids · In bids (estimates).
price_estimate_ lines - in bids · In bids (estimates, lines).
price_estimate_ plans - in bids · In bids (estimates: crew_plan, crew_plan_by_person_id, crew_plan_at): a person's change of the crew plan. The rest of it, the checked plan behind each estimate with Offerium's own checks of it, is Offerium's working, derived from the estimate's lines and reasons, and never exported.
company_pricing - in company_profile · In company_profile (pricing).
tone_profiles - in company_profile · In company_profile (tone).
bid_fit_ advice - in bids · In bids (fit_advice).
price_choices - in bids · In bids (price_choices).
firm_rate_ terms - in company_profile · In company_profile (rate_terms).
line_benchmarks - in past_bids · In past_bids (benchmarks).
past_offer_ records - left out: Offerium’s own machinery · Offerium's own short note of each past offer, written by a model from the offer so that a later estimate can compare with it. The offers themselves are in past_bids, priced_lines and files.
rate_card_ entries - in rate_cards · In rate_cards (entries).
framework_contract_ buyers - in framework_contracts · In framework_contracts (buyers).
framework_contract_ rates - in framework_contracts · In framework_contracts (rates).
research_charges - in billing_details · In billing_details (research_charges): every run, included or charged, with the invoice that charged it.
billing_contacts - in billing_details · In billing_details (contacts).
enterprise_contracts - in billing_details · In billing_details (contracts).
document_candidates - left out: Offerium’s own machinery · Files Offerium proposed as company documents from your past offers or your certificates folder; the ones you added are in company_documents, and every file is under documents/ or files/.
ai_calls - left out: Offerium’s own machinery · A record of each reading or drafting request Offerium made for your firm: when, for what, which model, how many units and what it cost. It never holds the content.
storage_pauses - left out: Offerium’s own machinery · When Offerium paused importing the firm's mail or past offers because its storage had no room, why, and when it read on.
usage_alerts - left out: Offerium’s own machinery · The allowance alerts Offerium showed; what was counted is in invoices (bids).
forwarding_aliases - left out: Offerium’s own machinery · Addresses Offerium set aside for the firm before its name was corrected during setup; they stay the firm's.
companies- in README.html and manifest.json · The firm's name, market, currency and time zone, in README.html and manifest.json. Its billing identifiers are Offerium's, and so are its notes on the free first bid: whether it was withheld because the firm's domain, Microsoft 365 tenant or Google Workspace had already had one, and which bid was read in full before a plan. When Offerium deleted its keys to the firm's mailboxes after a plan ended is in the activity record.
ownership_transfers - in the activity record · Hand-overs of the account are in the activity record.
package_checks - left out: Offerium’s own machinery · The checks Offerium ran on a package before it went out; their result is in approvals and the timeline.
onboarding- left out: Offerium’s own machinery · Where setting up had got to, and how the first request came in.
rebuilds- left out: Offerium’s own machinery · Counters of the first read of your sent mail; what it found is in past_bids and buyers.
old_quotes_ sources - left out: Offerium’s own machinery · Counters of the read of your old-quotes folder; what it found is in past_bids.
request_packages - left out: Offerium’s own machinery · Big request packages added to a bid (a ZIP, a folder, a SharePoint or Drive folder): what each held, which documents were copied and what stayed where it was. The copied documents are with the bid's files.
request_package_ files - left out: Offerium’s own machinery · Which of a bid's files came from which package.
document_sources - left out: Offerium’s own machinery · The folders you chose for certificates and for new requests under File storage.
document_source_ items - left out: Offerium’s own machinery · The files Offerium saw in your certificates folder and when each last changed; the ones it proposed are in document_candidates.
mailbox_events - left out: Offerium’s own machinery · Each mailbox's connection log (connected, missed changes, access withdrawn, disconnected); what people did is in audit_log.
calendar_connections - left out: Offerium’s own machinery · How the Bids calendar is connected to the firm's own calendar and what its events show; the events are in calendar_events and calendar/bids.ics.
mailbox_connect_ requests - in the activity record · The owner's requests that a person connect their own mailbox are in the activity record.
mailbox_send_ agreements - in the activity record · A person's agreement that bids may go out from their own mailbox, and its withdrawal, are in the activity record.
mailbox_handovers - in the activity record · Who took over the open bids of a mailbox that could no longer send is in the activity record; each bid's choice is in bids (sending_choice).
source_removals - in the activity record · Mail deleted with a disconnected personal mailbox (counts only): the disconnection is in the activity record, and bids and past_bids name it (source_removal_id).
join_requests - left out: not the firm’s · Requests to join from people outside the firm; once added, a person is in people.
account_erasures - left out: not the firm’s · Receipts of firms already deleted: a firm that can export has none.
document_demand - left out: Offerium’s own machinery · Counts of how often your buyers' invitations asked for each kind of document (“Your buyers ask for these”), worked out from the bids and requirements in this archive.
document_absences - in the activity record · Your answers “We don't hold this” and “Not relevant to us” for a kind of document, with who and when, are in the activity record.
document_reminders - left out: Offerium’s own machinery · The document reminders Offerium decided and sent; the documents, their dates and their keepers are in company_documents.
quarantined_uploads - left out: Offerium’s own machinery · Files an issuer sent through an upload link, held in quarantine until a person checks them. An accepted one is a version in company_documents, its file under documents/; one not accepted (not yet checked, rejected, or refused by the malware scan) is not in the archive: it never became the firm's.
profile_proposals - left out: Offerium’s own machinery · Values Offerium found for your letterhead on your website, in past offers and in e-mail signatures. The ones you used are in company_profile, with their source; what you did with each is in the activity record.
standard_text_ versions - in standard_texts · In standard_texts (versions) and offer_sections (versions).
bid_section_ choices - in bids · In bids (section_choices).
text_proposals - left out: Offerium’s own machinery · Wordings Offerium proposed from your sent offers. One you used is a version in standard_texts or offer_sections, which names it; one you dismissed is in the activity record.
first_run_ states - left out: Offerium’s own machinery · Whether a person hid the optional items of the “Before your first bid goes out” checklist, and when setup was first complete.
memberships- left out: part of signing in · Which sign-in belongs to which person: part of signing in.
Earlier formats
An archive of an earlier format reads as described above, except where it differed. Each earlier format is listed with what it held differently from the format after it; its own schema/ folder describes it too.
archive-16
- Bids
bids - Did not yet say who checked a mail that looked like a trap with the buyer, and when (trust_confirmed_at, trust_confirmed_by_person_id).
archive-15
- Bids
bids - The package_state of its estimates' lines did not yet take in_total or added_in_total.
- Priced lines
priced_lines - Its package_state did not yet take in_total or added_in_total.
archive-14
- Bids
bids - Did not yet carry the firm's earlier offer for the same request (earlier_offer); its addenda did not yet say whether one is a re-issue (kind), and the package_state of its estimates' lines did not yet take option.
- Priced lines
priced_lines - Its package_state did not yet take option, and it did not yet carry an option counted into the total (option_in_total, option_in_total_at, option_in_total_by_person_id) or the scenario its form prices (form_scenario).
- Selling rates
rate_cards - Did not yet carry the country a list prices jobs in (location) or the currency of its amounts (currency).
- Past bids
past_bids - Did not yet carry the country of the job's site (site_country).
archive-13
- Bids
bids - Its estimates did not yet carry the exchange rate between euros and Swiss francs their market figures were converted at (home_fx).
archive-12
- Company profile
company_profile - Its pricing did not yet carry how the firm bills (rates_include, premiums_included, mobilisation_fee, travel_time_billed, contingency_bps) or where its crew is employed (crew_country).
- Bids
bids - Did not yet carry the currency the bid is offered in and its exchange rate (offer_currency, fx), nor did its estimates.
archive-11
- Bids
bids - Its client_form_lines did not yet carry bidder_cell, nor its estimates' lines package_state and package_quote.
- Priced lines
priced_lines - Did not yet carry package_state and package_quote.
archive-10
- Company profile
company_profile - Did not yet carry the firm's own premium for a short job abroad (pricing.abroad_premium_bps).
- Bids
bids - Its estimates did not yet carry a person's crew plan (crew_plan, crew_plan_by_person_id, crew_plan_at).
archive-9
- Bids
bids - Did not yet carry when the bid's trade was checked or the kind of work of a bid outside the trades Offerium looks up prices for (trade_checked_at, outside_work); its client_form_lines did not yet carry checked_trade, its estimates neither missing_trades nor each line's trade_key, and its facts not why a deadline is kept to confirm (to_confirm).
archive-8
- Billing details
billing_details - Its research_charges did not yet carry free_analysis, and included counted only the plan's runs for the month.
archive-7
- Overage charges
overage_charges - Carried payment_item_id under a field name that named Offerium's payment provider.
- Billing details
billing_details - Its research_charges carried payment_item_id under a field name that named Offerium's payment provider.
- Data
data - Also carried the name of the model that read or wrote a text: model in each entry of outcome_evidence (under bids and past_bids), of words_provenance and of snapshot_words_provenance, draft_model in follow_ups, and model in audit_log's detail. Later formats leave every model's name out.
archive-6
- Bids
bids - Did not yet carry the trade of the bid's own work and where it came from (trade_key, trade_source).
archive-5
- Mail
mail - The rebuilt messages did not yet carry the Message-IDs of the messages they answer (the In-Reply-To and References headers; in_reply_to, reference_ids), only their own Message-ID.
archive-4
- Bids
bids - Did not yet carry the language the buyer is answered in and how it was decided (correspondence_lang, correspondence_lang_source). Some archives labelled archive-4 already carry them.
- Package versions
package_versions - Did not yet carry the language a version's offer document and e-mail are written in (lang). Some archives labelled archive-4 already carry it.
- Approvals
approvals - Did not yet carry the language of the offer document and the e-mail as approved (snapshot_lang). Some archives labelled archive-4 already carry it.
archive-3
- Buyers
buyers - Also carried four stored figures for the buyer's record, which only Offerium's demonstration data ever set: 0 in every firm's own archive. Later formats leave them out; a buyer's record is counted from past_bids.
Field Type Meaning record_bids whole number Bids to them. record_won whole number Of which won. record_lost whole number Of which lost. record_unknown whole number Of which the result is unknown.
archive-2
- Priced lines
priced_lines - Did not yet carry where a carried number was first set and where a recovered line was read (origin_price_source, recovered_from), nor the line's identity, its labour and material split and its decision trail (rate_kind to class_set_at, labour_part to metal_clause, source_scope_item_id, decision_key, price_basis, rate_card_entry_id, contract_rate_id). Some archives labelled archive-2 already carry some of them. Nor what a person said of a line for its tax (tax_facts).
- Bids
bids - Did not yet carry the framework contract a bid is priced under (the framework_contract_ fields), nor, on the buyer's form lines, their identity and what the form states beside them (rate_kind to class_set_at, split_cells, wants_split, buyer_pct_bps, buyer_pct_base, buyer_budget). Nor the facts its VAT or sales tax is decided from (tax_facts), nor the evidence of how it ended (outcome_evidence).
- Past bids
past_bids - Did not yet carry the day the offer's prices were decided, the job's context, why a lost offer was lost, a discount granted on the award, the framework contract and the rates a buyer's reply named (offer_date, the job_context, price_reason and award_discount fields, framework_contract_id, benchmarks). Nor the price the job was awarded at and the evidence of how it ended (the award_price fields, outcome_evidence).
- Buyers
buyers - Did not yet carry the customer's type and how it was recognised (kind, kind_source, kind_confidence, kind_evidence, kind_set_by_person_id, kind_set_at). Nor its tax facts and certificates (tax_facts, tax_certificates).
- Framework contracts
framework_contracts - Not part of this format.
- Selling rates
rate_cards - Not part of this format.
- Company profile
company_profile - Did not yet carry the firm's own yearly increase (pricing.own_increase_permille), nor its own words for what a line is (rate_terms). Nor its own tax settings and registrations (tax_settings, tax_registrations).
- Outcomes
outcomes - Did not yet carry whether a result was recorded from evidence, nor the price the job was awarded at (confirmed_by_evidence, the award_price fields).
- Package versions
package_versions - Did not yet carry the offer's VAT or sales tax as decided and frozen with the version (the tax_ fields).
- Sends
sends - Did not yet carry whether a person sent the offer from the firm's own mail program (sent_by_hand, marked_sent_by_person_id).
- Invoices from Offerium
invoices - Did not yet carry the euro rate an invoice in another currency was converted at (eur_rate, eur_rate_day, eur_rate_source).
archive-1
- People
people - Also carried each person's own choices of what reaches them and when. Later formats leave them out: they are that person's alone, and no screen shows them to the account's owner.
Field Type Meaning email_preferences JSON Which e-mails they chose to get (only the choices they made). push_preferences JSON Which phone notifications they chose to get. push_quiet_ from whole number · may be empty Quiet hours start, in minutes after midnight in the firm's time zone. push_quiet_ until whole number · may be empty Quiet hours end, likewise. single_key_ shortcuts true or false Single-key keyboard shortcuts are on. - Activity record
audit_log - Carried every entry of the activity record, including those about one person rather than the firm's work: how they sign in, their sessions, the pages they opened, their e-mail choices. Later formats leave those out, as the Activity page does.
Questions
Questions about a format, or an archive that does not open as described here: write to hello@offerium.ai.